From b43103a029c9ec0ea8043ec85e3445e04aca117a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dalibor=20Karlovi=C4=87?= Date: Wed, 28 Oct 2020 07:52:21 +0100 Subject: [PATCH] Tweaks for PHP client Markdown files suggested by markdownlint (#7779) --- .../src/main/resources/php/README.mustache | 81 +++-- .../src/main/resources/php/api_doc.mustache | 36 +-- .../src/main/resources/php/model_doc.mustache | 6 +- .../php/php_doc_auth_partial.mustache | 9 +- .../petstore/php/OpenAPIClient-php/README.md | 183 +++++------ .../docs/Api/AnotherFakeApi.md | 23 +- .../OpenAPIClient-php/docs/Api/DefaultApi.md | 20 +- .../php/OpenAPIClient-php/docs/Api/FakeApi.md | 291 +++++++++--------- .../docs/Api/FakeClassnameTags123Api.md | 22 +- .../php/OpenAPIClient-php/docs/Api/PetApi.md | 160 +++++----- .../OpenAPIClient-php/docs/Api/StoreApi.md | 73 +++-- .../php/OpenAPIClient-php/docs/Api/UserApi.md | 142 ++++----- .../docs/Model/AdditionalPropertiesClass.md | 8 +- .../OpenAPIClient-php/docs/Model/Animal.md | 6 +- .../docs/Model/ApiResponse.md | 10 +- .../docs/Model/ArrayOfArrayOfNumberOnly.md | 6 +- .../docs/Model/ArrayOfNumberOnly.md | 6 +- .../OpenAPIClient-php/docs/Model/ArrayTest.md | 10 +- .../docs/Model/Capitalization.md | 16 +- .../php/OpenAPIClient-php/docs/Model/Cat.md | 6 +- .../OpenAPIClient-php/docs/Model/CatAllOf.md | 6 +- .../OpenAPIClient-php/docs/Model/Category.md | 6 +- .../docs/Model/ClassModel.md | 6 +- .../OpenAPIClient-php/docs/Model/Client.md | 6 +- .../php/OpenAPIClient-php/docs/Model/Dog.md | 6 +- .../OpenAPIClient-php/docs/Model/DogAllOf.md | 6 +- .../docs/Model/EnumArrays.md | 8 +- .../OpenAPIClient-php/docs/Model/EnumClass.md | 4 +- .../OpenAPIClient-php/docs/Model/EnumTest.md | 20 +- .../php/OpenAPIClient-php/docs/Model/File.md | 6 +- .../docs/Model/FileSchemaTestClass.md | 8 +- .../php/OpenAPIClient-php/docs/Model/Foo.md | 4 +- .../docs/Model/FormatTest.md | 34 +- .../docs/Model/HasOnlyReadOnly.md | 8 +- .../docs/Model/HealthCheckResult.md | 6 +- .../docs/Model/InlineObject.md | 8 +- .../docs/Model/InlineObject1.md | 8 +- .../docs/Model/InlineObject2.md | 6 +- .../docs/Model/InlineObject3.md | 32 +- .../docs/Model/InlineObject4.md | 8 +- .../docs/Model/InlineObject5.md | 8 +- .../docs/Model/InlineResponseDefault.md | 6 +- .../OpenAPIClient-php/docs/Model/MapTest.md | 12 +- ...dPropertiesAndAdditionalPropertiesClass.md | 10 +- .../docs/Model/Model200Response.md | 8 +- .../OpenAPIClient-php/docs/Model/ModelList.md | 6 +- .../docs/Model/ModelReturn.md | 6 +- .../php/OpenAPIClient-php/docs/Model/Name.md | 12 +- .../docs/Model/NullableClass.md | 28 +- .../docs/Model/NumberOnly.md | 6 +- .../php/OpenAPIClient-php/docs/Model/Order.md | 14 +- .../docs/Model/OuterComposite.md | 10 +- .../OpenAPIClient-php/docs/Model/OuterEnum.md | 4 +- .../docs/Model/OuterEnumDefaultValue.md | 4 +- .../docs/Model/OuterEnumInteger.md | 4 +- .../Model/OuterEnumIntegerDefaultValue.md | 4 +- .../php/OpenAPIClient-php/docs/Model/Pet.md | 16 +- .../docs/Model/ReadOnlyFirst.md | 8 +- .../docs/Model/SpecialModelName.md | 6 +- .../php/OpenAPIClient-php/docs/Model/Tag.md | 8 +- .../php/OpenAPIClient-php/docs/Model/User.md | 20 +- 61 files changed, 683 insertions(+), 827 deletions(-) diff --git a/modules/openapi-generator/src/main/resources/php/README.mustache b/modules/openapi-generator/src/main/resources/php/README.mustache index 2bb063c5396a..332674c7294f 100644 --- a/modules/openapi-generator/src/main/resources/php/README.mustache +++ b/modules/openapi-generator/src/main/resources/php/README.mustache @@ -4,29 +4,19 @@ {{{appDescriptionWithNewLines}}} {{/appDescriptionWithNewLines}} -This PHP package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: - -- API version: {{appVersion}} -{{#artifactVersion}} -- Package version: {{artifactVersion}} -{{/artifactVersion}} -{{^hideGenerationTimestamp}} -- Build date: {{generatedDate}} -{{/hideGenerationTimestamp}} -- Build package: {{generatorClass}} {{#infoUrl}} -For more information, please visit [{{{infoUrl}}}]({{{infoUrl}}}) +For more information, please visit [{{{infoUrl}}}]({{{infoUrl}}}). {{/infoUrl}} -## Requirements - -PHP 7.2 and later - ## Installation & Usage +### Requirements + +PHP 7.2 and later. + ### Composer -To install the bindings via [Composer](http://getcomposer.org/), add the following to `composer.json`: +To install the bindings via [Composer](https://getcomposer.org/), add the following to `composer.json`: ```json { @@ -49,16 +39,8 @@ Then run `composer install` Download the files and include `autoload.php`: ```php - require_once('/path/to/{{packageName}}/vendor/autoload.php'); -``` - -## Tests - -To run the unit tests: - -```bash -composer install -./vendor/bin/phpunit +{{operationId}}: ', $e->getMessage(), PHP_EOL; } {{/-first}}{{/operation}}{{/operations}}{{/-first}}{{/apis}}{{/apiInfo}} -?> ``` -## Documentation for API Endpoints +## API Endpoints All URIs are relative to *{{basePath}}* @@ -98,22 +79,18 @@ Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- {{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}*{{classname}}* | [**{{operationId}}**]({{apiDocPath}}/{{classname}}.md#{{operationIdLowerCase}}) | **{{httpMethod}}** {{path}} | {{#summary}}{{summary}}{{/summary}} {{/operation}}{{/operations}}{{/apis}}{{/apiInfo}} +## Models -## Documentation For Models - -{{#models}}{{#model}} - [{{{classname}}}]({{modelDocPath}}/{{{classname}}}.md) -{{/model}}{{/models}} - -## Documentation For Authorization +{{#models}}{{#model}}- [{{{classname}}}]({{modelDocPath}}/{{{classname}}}.md){{/model}} +{{/models}} +## Authorization {{^authMethods}} All endpoints do not require authorization. {{/authMethods}} {{#authMethods}} {{#last}} Authentication schemes defined for the API:{{/last}} - -## {{{name}}} - +### {{{name}}} {{#isApiKey}} - **Type**: API key @@ -133,18 +110,38 @@ All endpoints do not require authorization. {{/isBasic}} {{#isOAuth}} -- **Type**: OAuth -- **Flow**: {{{flow}}} -- **Authorization URL**: {{{authorizationUrl}}} +- **Type**: `OAuth` +- **Flow**: `{{{flow}}}` +- **Authorization URL**: `{{{authorizationUrl}}}` - **Scopes**: {{^scopes}}N/A{{/scopes}} {{#scopes}} -- **{{{scope}}}**: {{{description}}} + - **{{{scope}}}**: {{{description}}} {{/scopes}} {{/isOAuth}} {{/authMethods}} +## Tests + +To run the tests, use: + +```bash +composer install +vendor/bin/phpunit +``` ## Author {{#apiInfo}}{{#apis}}{{^hasMore}}{{infoEmail}} {{/hasMore}}{{/apis}}{{/apiInfo}} +## About this package + +This PHP package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: + +- API version: `{{appVersion}}` +{{#artifactVersion}} + - Package version: `{{artifactVersion}}` +{{/artifactVersion}} +{{^hideGenerationTimestamp}} + - Build date: `{{generatedDate}}` +{{/hideGenerationTimestamp}} +- Build package: `{{generatorClass}}` diff --git a/modules/openapi-generator/src/main/resources/php/api_doc.mustache b/modules/openapi-generator/src/main/resources/php/api_doc.mustache index 87dbbf718901..75cdeda03c56 100644 --- a/modules/openapi-generator/src/main/resources/php/api_doc.mustache +++ b/modules/openapi-generator/src/main/resources/php/api_doc.mustache @@ -2,19 +2,18 @@ {{description}}{{/description}} -All URIs are relative to *{{basePath}}* +All URIs are relative to {{basePath}}. Method | HTTP request | Description ------------- | ------------- | ------------- -{{#operations}}{{#operation}}[**{{operationId}}**]({{classname}}.md#{{operationId}}) | **{{httpMethod}}** {{path}} | {{#summary}}{{summary}}{{/summary}} -{{/operation}}{{/operations}} +{{#operations}}{{#operation}}[**{{operationId}}()**]({{classname}}.md#{{operationId}}) | **{{httpMethod}}** {{path}} | {{#summary}}{{summary}}{{/summary}} +{{/operation}}{{/operations}}{{#operations}}{{#operation}} -{{#operations}} -{{#operation}} +## `{{{operationId}}}()` -## {{{operationId}}} - -> {{#returnType}}{{{returnType}}} {{/returnType}}{{{operationId}}}({{#allParams}}${{paramName}}{{#hasMore}}, {{/hasMore}}{{/allParams}}) +```php +{{{operationId}}}({{#allParams}}${{paramName}}{{#hasMore}}, {{/hasMore}}{{/allParams}}){{#returnType}}: {{{returnType}}}{{/returnType}} +``` {{{summary}}}{{#notes}} @@ -34,11 +33,11 @@ $apiInstance = new {{invokerPackage}}\Api\{{classname}}( $config{{/hasAuthMethods}} ); {{^vendorExtensions.x-group-parameters}} -{{#allParams}}${{paramName}} = {{{example}}}; // {{{dataType}}} | {{{description}}} +{{#allParams}}${{paramName}} = {{{example}}}; // {{{dataType}}}{{#description}} | {{{description}}}{{/description}} {{/allParams}} {{/vendorExtensions.x-group-parameters}} {{#vendorExtensions.x-group-parameters}} -{{#allParams}}$associate_array['{{paramName}}'] = {{{example}}}; // {{{dataType}}} | {{{description}}} +{{#allParams}}$associate_array['{{paramName}}'] = {{{example}}}; // {{{dataType}}}{{#description}} | {{{description}}}{{/description}} {{/allParams}} {{/vendorExtensions.x-group-parameters}} @@ -48,7 +47,6 @@ try { } catch (Exception $e) { echo 'Exception when calling {{classname}}->{{operationId}}: ', $e->getMessage(), PHP_EOL; } -?> ``` ### Parameters @@ -57,8 +55,7 @@ try { Note: the input parameter is an associative array with the keys listed as the parameter name below. {{/vendorExtensions.x-group-parameters}} -{{^allParams}}This endpoint does not need any parameter.{{/allParams}}{{#allParams}}{{#-last}} -Name | Type | Description | Notes +{{^allParams}}This endpoint does not need any parameter.{{/allParams}}{{#allParams}}{{#-last}}Name | Type | Description | Notes ------------- | ------------- | ------------- | -------------{{/-last}}{{/allParams}} {{#allParams}} **{{paramName}}** | {{#isFile}}**{{dataType}}**{{/isFile}}{{#isPrimitiveType}}**{{dataType}}**{{/isPrimitiveType}}{{^isPrimitiveType}}{{^isFile}}[**{{dataType}}**](../Model/{{baseType}}.md){{/isFile}}{{/isPrimitiveType}}| {{description}} |{{^required}} [optional]{{/required}}{{#defaultValue}} [default to {{defaultValue}}]{{/defaultValue}} {{/allParams}} @@ -73,12 +70,9 @@ Name | Type | Description | Notes ### HTTP request headers -- **Content-Type**: {{#consumes}}{{{mediaType}}}{{#hasMore}}, {{/hasMore}}{{/consumes}}{{^consumes}}Not defined{{/consumes}} -- **Accept**: {{#produces}}{{{mediaType}}}{{#hasMore}}, {{/hasMore}}{{/produces}}{{^produces}}Not defined{{/produces}} +- **Content-Type**: {{#consumes}}`{{{mediaType}}}`{{#hasMore}}, {{/hasMore}}{{/consumes}}{{^consumes}}Not defined{{/consumes}} +- **Accept**: {{#produces}}`{{{mediaType}}}`{{#hasMore}}, {{/hasMore}}{{/produces}}{{^produces}}Not defined{{/produces}} -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../../README.md#documentation-for-models) -[[Back to README]](../../README.md) - -{{/operation}} -{{/operations}} +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) +[[Back to README]](../../README.md){{/operation}}{{/operations}} diff --git a/modules/openapi-generator/src/main/resources/php/model_doc.mustache b/modules/openapi-generator/src/main/resources/php/model_doc.mustache index 82a4c3313fa5..ff3d2f6fbae2 100644 --- a/modules/openapi-generator/src/main/resources/php/model_doc.mustache +++ b/modules/openapi-generator/src/main/resources/php/model_doc.mustache @@ -4,9 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -{{#vars}}**{{name}}** | {{#isPrimitiveType}}**{{dataType}}**{{/isPrimitiveType}}{{^isPrimitiveType}}[**{{dataType}}**]({{complexType}}.md){{/isPrimitiveType}} | {{description}} | {{^required}}[optional] {{/required}}{{#isReadOnly}}[readonly] {{/isReadOnly}}{{#defaultValue}}[default to {{{.}}}]{{/defaultValue}} +{{#vars}}**{{name}}** | {{#isPrimitiveType}}**{{dataType}}**{{/isPrimitiveType}}{{^isPrimitiveType}}[**{{dataType}}**]({{complexType}}.md){{/isPrimitiveType}} | {{description}} |{{^required}} [optional]{{/required}}{{#isReadOnly}} [readonly]{{/isReadOnly}}{{#defaultValue}} [default to {{{.}}}]{{/defaultValue}} {{/vars}} -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - -{{/model}}{{/models}} +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md){{/model}}{{/models}} diff --git a/modules/openapi-generator/src/main/resources/php/php_doc_auth_partial.mustache b/modules/openapi-generator/src/main/resources/php/php_doc_auth_partial.mustache index 5c51e7c4e7e9..282150604ce9 100644 --- a/modules/openapi-generator/src/main/resources/php/php_doc_auth_partial.mustache +++ b/modules/openapi-generator/src/main/resources/php/php_doc_auth_partial.mustache @@ -1,6 +1,4 @@ -{{#hasAuthMethods}} - -{{#authMethods}} +{{#hasAuthMethods}}{{#authMethods}} {{#isBasic}} {{#isBasicBasic}} // Configure HTTP basic authorization: {{{name}}} @@ -22,7 +20,4 @@ $config = {{{invokerPackage}}}\Configuration::getDefaultConfiguration()->setApiK {{#isOAuth}} // Configure OAuth2 access token for authorization: {{{name}}} $config = {{{invokerPackage}}}\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN'); -{{/isOAuth}} - -{{/authMethods}} -{{/hasAuthMethods}} +{{/isOAuth}}{{/authMethods}}{{/hasAuthMethods}} diff --git a/samples/client/petstore/php/OpenAPIClient-php/README.md b/samples/client/petstore/php/OpenAPIClient-php/README.md index 4a8f02871582..d4c381a27c09 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/README.md +++ b/samples/client/petstore/php/OpenAPIClient-php/README.md @@ -2,20 +2,16 @@ This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\ -This PHP package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: - -- API version: 1.0.0 -- Build package: org.openapitools.codegen.languages.PhpClientCodegen - -## Requirements - -PHP 7.2 and later ## Installation & Usage +### Requirements + +PHP 7.2 and later. + ### Composer -To install the bindings via [Composer](http://getcomposer.org/), add the following to `composer.json`: +To install the bindings via [Composer](https://getcomposer.org/), add the following to `composer.json`: ```json { @@ -38,16 +34,8 @@ Then run `composer install` Download the files and include `autoload.php`: ```php - require_once('/path/to/OpenAPIClient-php/vendor/autoload.php'); -``` - -## Tests - -To run the unit tests: - -```bash -composer install -./vendor/bin/phpunit +call123TestSpecialTags: ', $e->getMessage(), PHP_EOL; } -?> ``` -## Documentation for API Endpoints +## API Endpoints All URIs are relative to *http://petstore.swagger.io:80/v2* @@ -123,66 +111,61 @@ Class | Method | HTTP request | Description *UserApi* | [**logoutUser**](docs/Api/UserApi.md#logoutuser) | **GET** /user/logout | Logs out current logged in user session *UserApi* | [**updateUser**](docs/Api/UserApi.md#updateuser) | **PUT** /user/{username} | Updated user +## Models -## Documentation For Models +- [AdditionalPropertiesClass](docs/Model/AdditionalPropertiesClass.md) +- [Animal](docs/Model/Animal.md) +- [ApiResponse](docs/Model/ApiResponse.md) +- [ArrayOfArrayOfNumberOnly](docs/Model/ArrayOfArrayOfNumberOnly.md) +- [ArrayOfNumberOnly](docs/Model/ArrayOfNumberOnly.md) +- [ArrayTest](docs/Model/ArrayTest.md) +- [Capitalization](docs/Model/Capitalization.md) +- [Cat](docs/Model/Cat.md) +- [CatAllOf](docs/Model/CatAllOf.md) +- [Category](docs/Model/Category.md) +- [ClassModel](docs/Model/ClassModel.md) +- [Client](docs/Model/Client.md) +- [Dog](docs/Model/Dog.md) +- [DogAllOf](docs/Model/DogAllOf.md) +- [EnumArrays](docs/Model/EnumArrays.md) +- [EnumClass](docs/Model/EnumClass.md) +- [EnumTest](docs/Model/EnumTest.md) +- [File](docs/Model/File.md) +- [FileSchemaTestClass](docs/Model/FileSchemaTestClass.md) +- [Foo](docs/Model/Foo.md) +- [FormatTest](docs/Model/FormatTest.md) +- [HasOnlyReadOnly](docs/Model/HasOnlyReadOnly.md) +- [HealthCheckResult](docs/Model/HealthCheckResult.md) +- [InlineObject](docs/Model/InlineObject.md) +- [InlineObject1](docs/Model/InlineObject1.md) +- [InlineObject2](docs/Model/InlineObject2.md) +- [InlineObject3](docs/Model/InlineObject3.md) +- [InlineObject4](docs/Model/InlineObject4.md) +- [InlineObject5](docs/Model/InlineObject5.md) +- [InlineResponseDefault](docs/Model/InlineResponseDefault.md) +- [MapTest](docs/Model/MapTest.md) +- [MixedPropertiesAndAdditionalPropertiesClass](docs/Model/MixedPropertiesAndAdditionalPropertiesClass.md) +- [Model200Response](docs/Model/Model200Response.md) +- [ModelList](docs/Model/ModelList.md) +- [ModelReturn](docs/Model/ModelReturn.md) +- [Name](docs/Model/Name.md) +- [NullableClass](docs/Model/NullableClass.md) +- [NumberOnly](docs/Model/NumberOnly.md) +- [Order](docs/Model/Order.md) +- [OuterComposite](docs/Model/OuterComposite.md) +- [OuterEnum](docs/Model/OuterEnum.md) +- [OuterEnumDefaultValue](docs/Model/OuterEnumDefaultValue.md) +- [OuterEnumInteger](docs/Model/OuterEnumInteger.md) +- [OuterEnumIntegerDefaultValue](docs/Model/OuterEnumIntegerDefaultValue.md) +- [Pet](docs/Model/Pet.md) +- [ReadOnlyFirst](docs/Model/ReadOnlyFirst.md) +- [SpecialModelName](docs/Model/SpecialModelName.md) +- [Tag](docs/Model/Tag.md) +- [User](docs/Model/User.md) - - [AdditionalPropertiesClass](docs/Model/AdditionalPropertiesClass.md) - - [Animal](docs/Model/Animal.md) - - [ApiResponse](docs/Model/ApiResponse.md) - - [ArrayOfArrayOfNumberOnly](docs/Model/ArrayOfArrayOfNumberOnly.md) - - [ArrayOfNumberOnly](docs/Model/ArrayOfNumberOnly.md) - - [ArrayTest](docs/Model/ArrayTest.md) - - [Capitalization](docs/Model/Capitalization.md) - - [Cat](docs/Model/Cat.md) - - [CatAllOf](docs/Model/CatAllOf.md) - - [Category](docs/Model/Category.md) - - [ClassModel](docs/Model/ClassModel.md) - - [Client](docs/Model/Client.md) - - [Dog](docs/Model/Dog.md) - - [DogAllOf](docs/Model/DogAllOf.md) - - [EnumArrays](docs/Model/EnumArrays.md) - - [EnumClass](docs/Model/EnumClass.md) - - [EnumTest](docs/Model/EnumTest.md) - - [File](docs/Model/File.md) - - [FileSchemaTestClass](docs/Model/FileSchemaTestClass.md) - - [Foo](docs/Model/Foo.md) - - [FormatTest](docs/Model/FormatTest.md) - - [HasOnlyReadOnly](docs/Model/HasOnlyReadOnly.md) - - [HealthCheckResult](docs/Model/HealthCheckResult.md) - - [InlineObject](docs/Model/InlineObject.md) - - [InlineObject1](docs/Model/InlineObject1.md) - - [InlineObject2](docs/Model/InlineObject2.md) - - [InlineObject3](docs/Model/InlineObject3.md) - - [InlineObject4](docs/Model/InlineObject4.md) - - [InlineObject5](docs/Model/InlineObject5.md) - - [InlineResponseDefault](docs/Model/InlineResponseDefault.md) - - [MapTest](docs/Model/MapTest.md) - - [MixedPropertiesAndAdditionalPropertiesClass](docs/Model/MixedPropertiesAndAdditionalPropertiesClass.md) - - [Model200Response](docs/Model/Model200Response.md) - - [ModelList](docs/Model/ModelList.md) - - [ModelReturn](docs/Model/ModelReturn.md) - - [Name](docs/Model/Name.md) - - [NullableClass](docs/Model/NullableClass.md) - - [NumberOnly](docs/Model/NumberOnly.md) - - [Order](docs/Model/Order.md) - - [OuterComposite](docs/Model/OuterComposite.md) - - [OuterEnum](docs/Model/OuterEnum.md) - - [OuterEnumDefaultValue](docs/Model/OuterEnumDefaultValue.md) - - [OuterEnumInteger](docs/Model/OuterEnumInteger.md) - - [OuterEnumIntegerDefaultValue](docs/Model/OuterEnumIntegerDefaultValue.md) - - [Pet](docs/Model/Pet.md) - - [ReadOnlyFirst](docs/Model/ReadOnlyFirst.md) - - [SpecialModelName](docs/Model/SpecialModelName.md) - - [Tag](docs/Model/Tag.md) - - [User](docs/Model/User.md) - - -## Documentation For Authorization - - - -## api_key +## Authorization +### api_key - **Type**: API key - **API key parameter name**: api_key @@ -190,9 +173,7 @@ Class | Method | HTTP request | Description - -## api_key_query - +### api_key_query - **Type**: API key - **API key parameter name**: api_key_query @@ -200,38 +181,44 @@ Class | Method | HTTP request | Description - -## bearer_test - +### bearer_test - **Type**: Bearer authentication (JWT) - -## http_basic_test - +### http_basic_test - **Type**: HTTP basic authentication - -## http_signature_test +### http_signature_test +### petstore_auth - -## petstore_auth - - -- **Type**: OAuth -- **Flow**: implicit -- **Authorization URL**: http://petstore.swagger.io/api/oauth/dialog +- **Type**: `OAuth` +- **Flow**: `implicit` +- **Authorization URL**: `http://petstore.swagger.io/api/oauth/dialog` - **Scopes**: -- **write:pets**: modify pets in your account -- **read:pets**: read your pets + - **write:pets**: modify pets in your account + - **read:pets**: read your pets +## Tests + +To run the tests, use: + +```bash +composer install +vendor/bin/phpunit +``` ## Author +## About this package + +This PHP package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: + +- API version: `1.0.0` +- Build package: `org.openapitools.codegen.languages.PhpClientCodegen` diff --git a/samples/client/petstore/php/OpenAPIClient-php/docs/Api/AnotherFakeApi.md b/samples/client/petstore/php/OpenAPIClient-php/docs/Api/AnotherFakeApi.md index 1ff76b69457c..20ee44a4bf0c 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/docs/Api/AnotherFakeApi.md +++ b/samples/client/petstore/php/OpenAPIClient-php/docs/Api/AnotherFakeApi.md @@ -1,16 +1,17 @@ # OpenAPI\Client\AnotherFakeApi -All URIs are relative to *http://petstore.swagger.io:80/v2* +All URIs are relative to http://petstore.swagger.io:80/v2. Method | HTTP request | Description ------------- | ------------- | ------------- -[**call123TestSpecialTags**](AnotherFakeApi.md#call123TestSpecialTags) | **PATCH** /another-fake/dummy | To test special tags +[**call123TestSpecialTags()**](AnotherFakeApi.md#call123TestSpecialTags) | **PATCH** /another-fake/dummy | To test special tags +## `call123TestSpecialTags()` -## call123TestSpecialTags - -> \OpenAPI\Client\Model\Client call123TestSpecialTags($client) +```php +call123TestSpecialTags($client): \OpenAPI\Client\Model\Client +``` To test special tags @@ -23,6 +24,7 @@ To test special tags and operation ID starting with number require_once(__DIR__ . '/vendor/autoload.php'); + $apiInstance = new OpenAPI\Client\Api\AnotherFakeApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. @@ -36,12 +38,10 @@ try { } catch (Exception $e) { echo 'Exception when calling AnotherFakeApi->call123TestSpecialTags: ', $e->getMessage(), PHP_EOL; } -?> ``` ### Parameters - Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **client** | [**\OpenAPI\Client\Model\Client**](../Model/Client.md)| client model | @@ -56,10 +56,9 @@ No authorization required ### HTTP request headers -- **Content-Type**: application/json -- **Accept**: application/json +- **Content-Type**: `application/json` +- **Accept**: `application/json` -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../../README.md#documentation-for-models) +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) [[Back to README]](../../README.md) - diff --git a/samples/client/petstore/php/OpenAPIClient-php/docs/Api/DefaultApi.md b/samples/client/petstore/php/OpenAPIClient-php/docs/Api/DefaultApi.md index eff99ef159d0..020bf4d8fb88 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/docs/Api/DefaultApi.md +++ b/samples/client/petstore/php/OpenAPIClient-php/docs/Api/DefaultApi.md @@ -1,16 +1,17 @@ # OpenAPI\Client\DefaultApi -All URIs are relative to *http://petstore.swagger.io:80/v2* +All URIs are relative to http://petstore.swagger.io:80/v2. Method | HTTP request | Description ------------- | ------------- | ------------- -[**fooGet**](DefaultApi.md#fooGet) | **GET** /foo | +[**fooGet()**](DefaultApi.md#fooGet) | **GET** /foo | +## `fooGet()` -## fooGet - -> \OpenAPI\Client\Model\InlineResponseDefault fooGet() +```php +fooGet(): \OpenAPI\Client\Model\InlineResponseDefault +``` @@ -21,6 +22,7 @@ Method | HTTP request | Description require_once(__DIR__ . '/vendor/autoload.php'); + $apiInstance = new OpenAPI\Client\Api\DefaultApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. @@ -33,7 +35,6 @@ try { } catch (Exception $e) { echo 'Exception when calling DefaultApi->fooGet: ', $e->getMessage(), PHP_EOL; } -?> ``` ### Parameters @@ -51,9 +52,8 @@ No authorization required ### HTTP request headers - **Content-Type**: Not defined -- **Accept**: application/json +- **Accept**: `application/json` -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../../README.md#documentation-for-models) +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) [[Back to README]](../../README.md) - diff --git a/samples/client/petstore/php/OpenAPIClient-php/docs/Api/FakeApi.md b/samples/client/petstore/php/OpenAPIClient-php/docs/Api/FakeApi.md index 5046a502e194..12fa1813000a 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/docs/Api/FakeApi.md +++ b/samples/client/petstore/php/OpenAPIClient-php/docs/Api/FakeApi.md @@ -1,30 +1,31 @@ # OpenAPI\Client\FakeApi -All URIs are relative to *http://petstore.swagger.io:80/v2* +All URIs are relative to http://petstore.swagger.io:80/v2. Method | HTTP request | Description ------------- | ------------- | ------------- -[**fakeHealthGet**](FakeApi.md#fakeHealthGet) | **GET** /fake/health | Health check endpoint -[**fakeHttpSignatureTest**](FakeApi.md#fakeHttpSignatureTest) | **GET** /fake/http-signature-test | test http signature authentication -[**fakeOuterBooleanSerialize**](FakeApi.md#fakeOuterBooleanSerialize) | **POST** /fake/outer/boolean | -[**fakeOuterCompositeSerialize**](FakeApi.md#fakeOuterCompositeSerialize) | **POST** /fake/outer/composite | -[**fakeOuterNumberSerialize**](FakeApi.md#fakeOuterNumberSerialize) | **POST** /fake/outer/number | -[**fakeOuterStringSerialize**](FakeApi.md#fakeOuterStringSerialize) | **POST** /fake/outer/string | -[**testBodyWithFileSchema**](FakeApi.md#testBodyWithFileSchema) | **PUT** /fake/body-with-file-schema | -[**testBodyWithQueryParams**](FakeApi.md#testBodyWithQueryParams) | **PUT** /fake/body-with-query-params | -[**testClientModel**](FakeApi.md#testClientModel) | **PATCH** /fake | To test \"client\" model -[**testEndpointParameters**](FakeApi.md#testEndpointParameters) | **POST** /fake | Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 -[**testEnumParameters**](FakeApi.md#testEnumParameters) | **GET** /fake | To test enum parameters -[**testGroupParameters**](FakeApi.md#testGroupParameters) | **DELETE** /fake | Fake endpoint to test group parameters (optional) -[**testInlineAdditionalProperties**](FakeApi.md#testInlineAdditionalProperties) | **POST** /fake/inline-additionalProperties | test inline additionalProperties -[**testJsonFormData**](FakeApi.md#testJsonFormData) | **GET** /fake/jsonFormData | test json serialization of form data -[**testQueryParameterCollectionFormat**](FakeApi.md#testQueryParameterCollectionFormat) | **PUT** /fake/test-query-paramters | +[**fakeHealthGet()**](FakeApi.md#fakeHealthGet) | **GET** /fake/health | Health check endpoint +[**fakeHttpSignatureTest()**](FakeApi.md#fakeHttpSignatureTest) | **GET** /fake/http-signature-test | test http signature authentication +[**fakeOuterBooleanSerialize()**](FakeApi.md#fakeOuterBooleanSerialize) | **POST** /fake/outer/boolean | +[**fakeOuterCompositeSerialize()**](FakeApi.md#fakeOuterCompositeSerialize) | **POST** /fake/outer/composite | +[**fakeOuterNumberSerialize()**](FakeApi.md#fakeOuterNumberSerialize) | **POST** /fake/outer/number | +[**fakeOuterStringSerialize()**](FakeApi.md#fakeOuterStringSerialize) | **POST** /fake/outer/string | +[**testBodyWithFileSchema()**](FakeApi.md#testBodyWithFileSchema) | **PUT** /fake/body-with-file-schema | +[**testBodyWithQueryParams()**](FakeApi.md#testBodyWithQueryParams) | **PUT** /fake/body-with-query-params | +[**testClientModel()**](FakeApi.md#testClientModel) | **PATCH** /fake | To test \"client\" model +[**testEndpointParameters()**](FakeApi.md#testEndpointParameters) | **POST** /fake | Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 +[**testEnumParameters()**](FakeApi.md#testEnumParameters) | **GET** /fake | To test enum parameters +[**testGroupParameters()**](FakeApi.md#testGroupParameters) | **DELETE** /fake | Fake endpoint to test group parameters (optional) +[**testInlineAdditionalProperties()**](FakeApi.md#testInlineAdditionalProperties) | **POST** /fake/inline-additionalProperties | test inline additionalProperties +[**testJsonFormData()**](FakeApi.md#testJsonFormData) | **GET** /fake/jsonFormData | test json serialization of form data +[**testQueryParameterCollectionFormat()**](FakeApi.md#testQueryParameterCollectionFormat) | **PUT** /fake/test-query-paramters | +## `fakeHealthGet()` -## fakeHealthGet - -> \OpenAPI\Client\Model\HealthCheckResult fakeHealthGet() +```php +fakeHealthGet(): \OpenAPI\Client\Model\HealthCheckResult +``` Health check endpoint @@ -35,6 +36,7 @@ Health check endpoint require_once(__DIR__ . '/vendor/autoload.php'); + $apiInstance = new OpenAPI\Client\Api\FakeApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. @@ -47,7 +49,6 @@ try { } catch (Exception $e) { echo 'Exception when calling FakeApi->fakeHealthGet: ', $e->getMessage(), PHP_EOL; } -?> ``` ### Parameters @@ -65,16 +66,17 @@ No authorization required ### HTTP request headers - **Content-Type**: Not defined -- **Accept**: application/json +- **Accept**: `application/json` -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../../README.md#documentation-for-models) +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) [[Back to README]](../../README.md) +## `fakeHttpSignatureTest()` -## fakeHttpSignatureTest - -> fakeHttpSignatureTest($pet, $query_1, $header_1) +```php +fakeHttpSignatureTest($pet, $query_1, $header_1) +``` test http signature authentication @@ -102,12 +104,10 @@ try { } catch (Exception $e) { echo 'Exception when calling FakeApi->fakeHttpSignatureTest: ', $e->getMessage(), PHP_EOL; } -?> ``` ### Parameters - Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pet** | [**\OpenAPI\Client\Model\Pet**](../Model/Pet.md)| Pet object that needs to be added to the store | @@ -124,17 +124,18 @@ void (empty response body) ### HTTP request headers -- **Content-Type**: application/json, application/xml +- **Content-Type**: `application/json`, `application/xml` - **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../../README.md#documentation-for-models) +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) [[Back to README]](../../README.md) +## `fakeOuterBooleanSerialize()` -## fakeOuterBooleanSerialize - -> bool fakeOuterBooleanSerialize($body) +```php +fakeOuterBooleanSerialize($body): bool +``` @@ -147,6 +148,7 @@ Test serialization of outer boolean types require_once(__DIR__ . '/vendor/autoload.php'); + $apiInstance = new OpenAPI\Client\Api\FakeApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. @@ -160,12 +162,10 @@ try { } catch (Exception $e) { echo 'Exception when calling FakeApi->fakeOuterBooleanSerialize: ', $e->getMessage(), PHP_EOL; } -?> ``` ### Parameters - Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **bool**| Input boolean as post body | [optional] @@ -180,17 +180,18 @@ No authorization required ### HTTP request headers -- **Content-Type**: application/json -- **Accept**: */* +- **Content-Type**: `application/json` +- **Accept**: `*/*` -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../../README.md#documentation-for-models) +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) [[Back to README]](../../README.md) +## `fakeOuterCompositeSerialize()` -## fakeOuterCompositeSerialize - -> \OpenAPI\Client\Model\OuterComposite fakeOuterCompositeSerialize($outer_composite) +```php +fakeOuterCompositeSerialize($outer_composite): \OpenAPI\Client\Model\OuterComposite +``` @@ -203,6 +204,7 @@ Test serialization of object with outer number type require_once(__DIR__ . '/vendor/autoload.php'); + $apiInstance = new OpenAPI\Client\Api\FakeApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. @@ -216,12 +218,10 @@ try { } catch (Exception $e) { echo 'Exception when calling FakeApi->fakeOuterCompositeSerialize: ', $e->getMessage(), PHP_EOL; } -?> ``` ### Parameters - Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **outer_composite** | [**\OpenAPI\Client\Model\OuterComposite**](../Model/OuterComposite.md)| Input composite as post body | [optional] @@ -236,17 +236,18 @@ No authorization required ### HTTP request headers -- **Content-Type**: application/json -- **Accept**: */* +- **Content-Type**: `application/json` +- **Accept**: `*/*` -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../../README.md#documentation-for-models) +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) [[Back to README]](../../README.md) +## `fakeOuterNumberSerialize()` -## fakeOuterNumberSerialize - -> float fakeOuterNumberSerialize($body) +```php +fakeOuterNumberSerialize($body): float +``` @@ -259,6 +260,7 @@ Test serialization of outer number types require_once(__DIR__ . '/vendor/autoload.php'); + $apiInstance = new OpenAPI\Client\Api\FakeApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. @@ -272,12 +274,10 @@ try { } catch (Exception $e) { echo 'Exception when calling FakeApi->fakeOuterNumberSerialize: ', $e->getMessage(), PHP_EOL; } -?> ``` ### Parameters - Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **float**| Input number as post body | [optional] @@ -292,17 +292,18 @@ No authorization required ### HTTP request headers -- **Content-Type**: application/json -- **Accept**: */* +- **Content-Type**: `application/json` +- **Accept**: `*/*` -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../../README.md#documentation-for-models) +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) [[Back to README]](../../README.md) +## `fakeOuterStringSerialize()` -## fakeOuterStringSerialize - -> string fakeOuterStringSerialize($body) +```php +fakeOuterStringSerialize($body): string +``` @@ -315,6 +316,7 @@ Test serialization of outer string types require_once(__DIR__ . '/vendor/autoload.php'); + $apiInstance = new OpenAPI\Client\Api\FakeApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. @@ -328,12 +330,10 @@ try { } catch (Exception $e) { echo 'Exception when calling FakeApi->fakeOuterStringSerialize: ', $e->getMessage(), PHP_EOL; } -?> ``` ### Parameters - Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **string**| Input string as post body | [optional] @@ -348,17 +348,18 @@ No authorization required ### HTTP request headers -- **Content-Type**: application/json -- **Accept**: */* +- **Content-Type**: `application/json` +- **Accept**: `*/*` -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../../README.md#documentation-for-models) +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) [[Back to README]](../../README.md) +## `testBodyWithFileSchema()` -## testBodyWithFileSchema - -> testBodyWithFileSchema($file_schema_test_class) +```php +testBodyWithFileSchema($file_schema_test_class) +``` @@ -371,24 +372,23 @@ For this test, the body for this request much reference a schema named `File`. require_once(__DIR__ . '/vendor/autoload.php'); + $apiInstance = new OpenAPI\Client\Api\FakeApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client() ); -$file_schema_test_class = new \OpenAPI\Client\Model\FileSchemaTestClass(); // \OpenAPI\Client\Model\FileSchemaTestClass | +$file_schema_test_class = new \OpenAPI\Client\Model\FileSchemaTestClass(); // \OpenAPI\Client\Model\FileSchemaTestClass try { $apiInstance->testBodyWithFileSchema($file_schema_test_class); } catch (Exception $e) { echo 'Exception when calling FakeApi->testBodyWithFileSchema: ', $e->getMessage(), PHP_EOL; } -?> ``` ### Parameters - Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **file_schema_test_class** | [**\OpenAPI\Client\Model\FileSchemaTestClass**](../Model/FileSchemaTestClass.md)| | @@ -403,17 +403,18 @@ No authorization required ### HTTP request headers -- **Content-Type**: application/json +- **Content-Type**: `application/json` - **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../../README.md#documentation-for-models) +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) [[Back to README]](../../README.md) +## `testBodyWithQueryParams()` -## testBodyWithQueryParams - -> testBodyWithQueryParams($query, $user) +```php +testBodyWithQueryParams($query, $user) +``` @@ -424,25 +425,24 @@ No authorization required require_once(__DIR__ . '/vendor/autoload.php'); + $apiInstance = new OpenAPI\Client\Api\FakeApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client() ); -$query = 'query_example'; // string | -$user = new \OpenAPI\Client\Model\User(); // \OpenAPI\Client\Model\User | +$query = 'query_example'; // string +$user = new \OpenAPI\Client\Model\User(); // \OpenAPI\Client\Model\User try { $apiInstance->testBodyWithQueryParams($query, $user); } catch (Exception $e) { echo 'Exception when calling FakeApi->testBodyWithQueryParams: ', $e->getMessage(), PHP_EOL; } -?> ``` ### Parameters - Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **query** | **string**| | @@ -458,17 +458,18 @@ No authorization required ### HTTP request headers -- **Content-Type**: application/json +- **Content-Type**: `application/json` - **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../../README.md#documentation-for-models) +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) [[Back to README]](../../README.md) +## `testClientModel()` -## testClientModel - -> \OpenAPI\Client\Model\Client testClientModel($client) +```php +testClientModel($client): \OpenAPI\Client\Model\Client +``` To test \"client\" model @@ -481,6 +482,7 @@ To test \"client\" model require_once(__DIR__ . '/vendor/autoload.php'); + $apiInstance = new OpenAPI\Client\Api\FakeApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. @@ -494,12 +496,10 @@ try { } catch (Exception $e) { echo 'Exception when calling FakeApi->testClientModel: ', $e->getMessage(), PHP_EOL; } -?> ``` ### Parameters - Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **client** | [**\OpenAPI\Client\Model\Client**](../Model/Client.md)| client model | @@ -514,17 +514,18 @@ No authorization required ### HTTP request headers -- **Content-Type**: application/json -- **Accept**: application/json +- **Content-Type**: `application/json` +- **Accept**: `application/json` -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../../README.md#documentation-for-models) +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) [[Back to README]](../../README.md) +## `testEndpointParameters()` -## testEndpointParameters - -> testEndpointParameters($number, $double, $pattern_without_delimiter, $byte, $integer, $int32, $int64, $float, $string, $binary, $date, $date_time, $password, $callback) +```php +testEndpointParameters($number, $double, $pattern_without_delimiter, $byte, $integer, $int32, $int64, $float, $string, $binary, $date, $date_time, $password, $callback) +``` Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 @@ -569,12 +570,10 @@ try { } catch (Exception $e) { echo 'Exception when calling FakeApi->testEndpointParameters: ', $e->getMessage(), PHP_EOL; } -?> ``` ### Parameters - Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **number** | **float**| None | @@ -602,17 +601,18 @@ void (empty response body) ### HTTP request headers -- **Content-Type**: application/x-www-form-urlencoded +- **Content-Type**: `application/x-www-form-urlencoded` - **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../../README.md#documentation-for-models) +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) [[Back to README]](../../README.md) +## `testEnumParameters()` -## testEnumParameters - -> testEnumParameters($enum_header_string_array, $enum_header_string, $enum_query_string_array, $enum_query_string, $enum_query_integer, $enum_query_double, $enum_form_string_array, $enum_form_string) +```php +testEnumParameters($enum_header_string_array, $enum_header_string, $enum_query_string_array, $enum_query_string, $enum_query_integer, $enum_query_double, $enum_form_string_array, $enum_form_string) +``` To test enum parameters @@ -625,6 +625,7 @@ To test enum parameters require_once(__DIR__ . '/vendor/autoload.php'); + $apiInstance = new OpenAPI\Client\Api\FakeApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. @@ -644,12 +645,10 @@ try { } catch (Exception $e) { echo 'Exception when calling FakeApi->testEnumParameters: ', $e->getMessage(), PHP_EOL; } -?> ``` ### Parameters - Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **enum_header_string_array** | [**string[]**](../Model/string.md)| Header parameter enum test (string array) | [optional] @@ -671,17 +670,18 @@ No authorization required ### HTTP request headers -- **Content-Type**: application/x-www-form-urlencoded +- **Content-Type**: `application/x-www-form-urlencoded` - **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../../README.md#documentation-for-models) +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) [[Back to README]](../../README.md) +## `testGroupParameters()` -## testGroupParameters - -> testGroupParameters($required_string_group, $required_boolean_group, $required_int64_group, $string_group, $boolean_group, $int64_group) +```php +testGroupParameters($required_string_group, $required_boolean_group, $required_int64_group, $string_group, $boolean_group, $int64_group) +``` Fake endpoint to test group parameters (optional) @@ -716,14 +716,12 @@ try { } catch (Exception $e) { echo 'Exception when calling FakeApi->testGroupParameters: ', $e->getMessage(), PHP_EOL; } -?> ``` ### Parameters Note: the input parameter is an associative array with the keys listed as the parameter name below. - Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **required_string_group** | **int**| Required String in group parameters | @@ -746,14 +744,15 @@ void (empty response body) - **Content-Type**: Not defined - **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../../README.md#documentation-for-models) +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) [[Back to README]](../../README.md) +## `testInlineAdditionalProperties()` -## testInlineAdditionalProperties - -> testInlineAdditionalProperties($request_body) +```php +testInlineAdditionalProperties($request_body) +``` test inline additionalProperties @@ -764,6 +763,7 @@ test inline additionalProperties require_once(__DIR__ . '/vendor/autoload.php'); + $apiInstance = new OpenAPI\Client\Api\FakeApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. @@ -776,12 +776,10 @@ try { } catch (Exception $e) { echo 'Exception when calling FakeApi->testInlineAdditionalProperties: ', $e->getMessage(), PHP_EOL; } -?> ``` ### Parameters - Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **request_body** | [**map[string,string]**](../Model/string.md)| request body | @@ -796,17 +794,18 @@ No authorization required ### HTTP request headers -- **Content-Type**: application/json +- **Content-Type**: `application/json` - **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../../README.md#documentation-for-models) +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) [[Back to README]](../../README.md) +## `testJsonFormData()` -## testJsonFormData - -> testJsonFormData($param, $param2) +```php +testJsonFormData($param, $param2) +``` test json serialization of form data @@ -817,6 +816,7 @@ test json serialization of form data require_once(__DIR__ . '/vendor/autoload.php'); + $apiInstance = new OpenAPI\Client\Api\FakeApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. @@ -830,12 +830,10 @@ try { } catch (Exception $e) { echo 'Exception when calling FakeApi->testJsonFormData: ', $e->getMessage(), PHP_EOL; } -?> ``` ### Parameters - Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **param** | **string**| field1 | @@ -851,17 +849,18 @@ No authorization required ### HTTP request headers -- **Content-Type**: application/x-www-form-urlencoded +- **Content-Type**: `application/x-www-form-urlencoded` - **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../../README.md#documentation-for-models) +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) [[Back to README]](../../README.md) +## `testQueryParameterCollectionFormat()` -## testQueryParameterCollectionFormat - -> testQueryParameterCollectionFormat($pipe, $ioutil, $http, $url, $context) +```php +testQueryParameterCollectionFormat($pipe, $ioutil, $http, $url, $context) +``` @@ -874,28 +873,27 @@ To test the collection format in query parameters require_once(__DIR__ . '/vendor/autoload.php'); + $apiInstance = new OpenAPI\Client\Api\FakeApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client() ); -$pipe = array('pipe_example'); // string[] | -$ioutil = array('ioutil_example'); // string[] | -$http = array('http_example'); // string[] | -$url = array('url_example'); // string[] | -$context = array('context_example'); // string[] | +$pipe = array('pipe_example'); // string[] +$ioutil = array('ioutil_example'); // string[] +$http = array('http_example'); // string[] +$url = array('url_example'); // string[] +$context = array('context_example'); // string[] try { $apiInstance->testQueryParameterCollectionFormat($pipe, $ioutil, $http, $url, $context); } catch (Exception $e) { echo 'Exception when calling FakeApi->testQueryParameterCollectionFormat: ', $e->getMessage(), PHP_EOL; } -?> ``` ### Parameters - Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pipe** | [**string[]**](../Model/string.md)| | @@ -917,7 +915,6 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../../README.md#documentation-for-models) +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) [[Back to README]](../../README.md) - diff --git a/samples/client/petstore/php/OpenAPIClient-php/docs/Api/FakeClassnameTags123Api.md b/samples/client/petstore/php/OpenAPIClient-php/docs/Api/FakeClassnameTags123Api.md index 3faeaf3043ae..58088ff9def6 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/docs/Api/FakeClassnameTags123Api.md +++ b/samples/client/petstore/php/OpenAPIClient-php/docs/Api/FakeClassnameTags123Api.md @@ -1,16 +1,17 @@ # OpenAPI\Client\FakeClassnameTags123Api -All URIs are relative to *http://petstore.swagger.io:80/v2* +All URIs are relative to http://petstore.swagger.io:80/v2. Method | HTTP request | Description ------------- | ------------- | ------------- -[**testClassname**](FakeClassnameTags123Api.md#testClassname) | **PATCH** /fake_classname_test | To test class name in snake case +[**testClassname()**](FakeClassnameTags123Api.md#testClassname) | **PATCH** /fake_classname_test | To test class name in snake case +## `testClassname()` -## testClassname - -> \OpenAPI\Client\Model\Client testClassname($client) +```php +testClassname($client): \OpenAPI\Client\Model\Client +``` To test class name in snake case @@ -43,12 +44,10 @@ try { } catch (Exception $e) { echo 'Exception when calling FakeClassnameTags123Api->testClassname: ', $e->getMessage(), PHP_EOL; } -?> ``` ### Parameters - Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **client** | [**\OpenAPI\Client\Model\Client**](../Model/Client.md)| client model | @@ -63,10 +62,9 @@ Name | Type | Description | Notes ### HTTP request headers -- **Content-Type**: application/json -- **Accept**: application/json +- **Content-Type**: `application/json` +- **Accept**: `application/json` -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../../README.md#documentation-for-models) +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) [[Back to README]](../../README.md) - diff --git a/samples/client/petstore/php/OpenAPIClient-php/docs/Api/PetApi.md b/samples/client/petstore/php/OpenAPIClient-php/docs/Api/PetApi.md index d96e2f2fb9b0..079f8c03a356 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/docs/Api/PetApi.md +++ b/samples/client/petstore/php/OpenAPIClient-php/docs/Api/PetApi.md @@ -1,24 +1,25 @@ # OpenAPI\Client\PetApi -All URIs are relative to *http://petstore.swagger.io:80/v2* +All URIs are relative to http://petstore.swagger.io:80/v2. Method | HTTP request | Description ------------- | ------------- | ------------- -[**addPet**](PetApi.md#addPet) | **POST** /pet | Add a new pet to the store -[**deletePet**](PetApi.md#deletePet) | **DELETE** /pet/{petId} | Deletes a pet -[**findPetsByStatus**](PetApi.md#findPetsByStatus) | **GET** /pet/findByStatus | Finds Pets by status -[**findPetsByTags**](PetApi.md#findPetsByTags) | **GET** /pet/findByTags | Finds Pets by tags -[**getPetById**](PetApi.md#getPetById) | **GET** /pet/{petId} | Find pet by ID -[**updatePet**](PetApi.md#updatePet) | **PUT** /pet | Update an existing pet -[**updatePetWithForm**](PetApi.md#updatePetWithForm) | **POST** /pet/{petId} | Updates a pet in the store with form data -[**uploadFile**](PetApi.md#uploadFile) | **POST** /pet/{petId}/uploadImage | uploads an image -[**uploadFileWithRequiredFile**](PetApi.md#uploadFileWithRequiredFile) | **POST** /fake/{petId}/uploadImageWithRequiredFile | uploads an image (required) +[**addPet()**](PetApi.md#addPet) | **POST** /pet | Add a new pet to the store +[**deletePet()**](PetApi.md#deletePet) | **DELETE** /pet/{petId} | Deletes a pet +[**findPetsByStatus()**](PetApi.md#findPetsByStatus) | **GET** /pet/findByStatus | Finds Pets by status +[**findPetsByTags()**](PetApi.md#findPetsByTags) | **GET** /pet/findByTags | Finds Pets by tags +[**getPetById()**](PetApi.md#getPetById) | **GET** /pet/{petId} | Find pet by ID +[**updatePet()**](PetApi.md#updatePet) | **PUT** /pet | Update an existing pet +[**updatePetWithForm()**](PetApi.md#updatePetWithForm) | **POST** /pet/{petId} | Updates a pet in the store with form data +[**uploadFile()**](PetApi.md#uploadFile) | **POST** /pet/{petId}/uploadImage | uploads an image +[**uploadFileWithRequiredFile()**](PetApi.md#uploadFileWithRequiredFile) | **POST** /fake/{petId}/uploadImageWithRequiredFile | uploads an image (required) +## `addPet()` -## addPet - -> addPet($pet) +```php +addPet($pet) +``` Add a new pet to the store @@ -46,12 +47,10 @@ try { } catch (Exception $e) { echo 'Exception when calling PetApi->addPet: ', $e->getMessage(), PHP_EOL; } -?> ``` ### Parameters - Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pet** | [**\OpenAPI\Client\Model\Pet**](../Model/Pet.md)| Pet object that needs to be added to the store | @@ -66,17 +65,18 @@ void (empty response body) ### HTTP request headers -- **Content-Type**: application/json, application/xml +- **Content-Type**: `application/json`, `application/xml` - **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../../README.md#documentation-for-models) +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) [[Back to README]](../../README.md) +## `deletePet()` -## deletePet - -> deletePet($pet_id, $api_key) +```php +deletePet($pet_id, $api_key) +``` Deletes a pet @@ -98,19 +98,17 @@ $apiInstance = new OpenAPI\Client\Api\PetApi( $config ); $pet_id = 56; // int | Pet id to delete -$api_key = 'api_key_example'; // string | +$api_key = 'api_key_example'; // string try { $apiInstance->deletePet($pet_id, $api_key); } catch (Exception $e) { echo 'Exception when calling PetApi->deletePet: ', $e->getMessage(), PHP_EOL; } -?> ``` ### Parameters - Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pet_id** | **int**| Pet id to delete | @@ -129,14 +127,15 @@ void (empty response body) - **Content-Type**: Not defined - **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../../README.md#documentation-for-models) +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) [[Back to README]](../../README.md) +## `findPetsByStatus()` -## findPetsByStatus - -> \OpenAPI\Client\Model\Pet[] findPetsByStatus($status) +```php +findPetsByStatus($status): \OpenAPI\Client\Model\Pet[] +``` Finds Pets by status @@ -167,12 +166,10 @@ try { } catch (Exception $e) { echo 'Exception when calling PetApi->findPetsByStatus: ', $e->getMessage(), PHP_EOL; } -?> ``` ### Parameters - Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **status** | [**string[]**](../Model/string.md)| Status values that need to be considered for filter | @@ -188,16 +185,17 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: Not defined -- **Accept**: application/xml, application/json +- **Accept**: `application/xml`, `application/json` -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../../README.md#documentation-for-models) +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) [[Back to README]](../../README.md) +## `findPetsByTags()` -## findPetsByTags - -> \OpenAPI\Client\Model\Pet[] findPetsByTags($tags) +```php +findPetsByTags($tags): \OpenAPI\Client\Model\Pet[] +``` Finds Pets by tags @@ -228,12 +226,10 @@ try { } catch (Exception $e) { echo 'Exception when calling PetApi->findPetsByTags: ', $e->getMessage(), PHP_EOL; } -?> ``` ### Parameters - Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **tags** | [**string[]**](../Model/string.md)| Tags to filter by | @@ -249,16 +245,17 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: Not defined -- **Accept**: application/xml, application/json +- **Accept**: `application/xml`, `application/json` -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../../README.md#documentation-for-models) +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) [[Back to README]](../../README.md) +## `getPetById()` -## getPetById - -> \OpenAPI\Client\Model\Pet getPetById($pet_id) +```php +getPetById($pet_id): \OpenAPI\Client\Model\Pet +``` Find pet by ID @@ -291,12 +288,10 @@ try { } catch (Exception $e) { echo 'Exception when calling PetApi->getPetById: ', $e->getMessage(), PHP_EOL; } -?> ``` ### Parameters - Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pet_id** | **int**| ID of pet to return | @@ -312,16 +307,17 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: Not defined -- **Accept**: application/xml, application/json +- **Accept**: `application/xml`, `application/json` -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../../README.md#documentation-for-models) +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) [[Back to README]](../../README.md) +## `updatePet()` -## updatePet - -> updatePet($pet) +```php +updatePet($pet) +``` Update an existing pet @@ -349,12 +345,10 @@ try { } catch (Exception $e) { echo 'Exception when calling PetApi->updatePet: ', $e->getMessage(), PHP_EOL; } -?> ``` ### Parameters - Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pet** | [**\OpenAPI\Client\Model\Pet**](../Model/Pet.md)| Pet object that needs to be added to the store | @@ -369,17 +363,18 @@ void (empty response body) ### HTTP request headers -- **Content-Type**: application/json, application/xml +- **Content-Type**: `application/json`, `application/xml` - **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../../README.md#documentation-for-models) +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) [[Back to README]](../../README.md) +## `updatePetWithForm()` -## updatePetWithForm - -> updatePetWithForm($pet_id, $name, $status) +```php +updatePetWithForm($pet_id, $name, $status) +``` Updates a pet in the store with form data @@ -409,12 +404,10 @@ try { } catch (Exception $e) { echo 'Exception when calling PetApi->updatePetWithForm: ', $e->getMessage(), PHP_EOL; } -?> ``` ### Parameters - Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pet_id** | **int**| ID of pet that needs to be updated | @@ -431,17 +424,18 @@ void (empty response body) ### HTTP request headers -- **Content-Type**: application/x-www-form-urlencoded +- **Content-Type**: `application/x-www-form-urlencoded` - **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../../README.md#documentation-for-models) +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) [[Back to README]](../../README.md) +## `uploadFile()` -## uploadFile - -> \OpenAPI\Client\Model\ApiResponse uploadFile($pet_id, $additional_metadata, $file) +```php +uploadFile($pet_id, $additional_metadata, $file): \OpenAPI\Client\Model\ApiResponse +``` uploads an image @@ -472,12 +466,10 @@ try { } catch (Exception $e) { echo 'Exception when calling PetApi->uploadFile: ', $e->getMessage(), PHP_EOL; } -?> ``` ### Parameters - Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pet_id** | **int**| ID of pet to update | @@ -494,17 +486,18 @@ Name | Type | Description | Notes ### HTTP request headers -- **Content-Type**: multipart/form-data -- **Accept**: application/json +- **Content-Type**: `multipart/form-data` +- **Accept**: `application/json` -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../../README.md#documentation-for-models) +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) [[Back to README]](../../README.md) +## `uploadFileWithRequiredFile()` -## uploadFileWithRequiredFile - -> \OpenAPI\Client\Model\ApiResponse uploadFileWithRequiredFile($pet_id, $required_file, $additional_metadata) +```php +uploadFileWithRequiredFile($pet_id, $required_file, $additional_metadata): \OpenAPI\Client\Model\ApiResponse +``` uploads an image (required) @@ -535,12 +528,10 @@ try { } catch (Exception $e) { echo 'Exception when calling PetApi->uploadFileWithRequiredFile: ', $e->getMessage(), PHP_EOL; } -?> ``` ### Parameters - Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pet_id** | **int**| ID of pet to update | @@ -557,10 +548,9 @@ Name | Type | Description | Notes ### HTTP request headers -- **Content-Type**: multipart/form-data -- **Accept**: application/json +- **Content-Type**: `multipart/form-data` +- **Accept**: `application/json` -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../../README.md#documentation-for-models) +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) [[Back to README]](../../README.md) - diff --git a/samples/client/petstore/php/OpenAPIClient-php/docs/Api/StoreApi.md b/samples/client/petstore/php/OpenAPIClient-php/docs/Api/StoreApi.md index 318f68c2c6a0..7d36587c2e08 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/docs/Api/StoreApi.md +++ b/samples/client/petstore/php/OpenAPIClient-php/docs/Api/StoreApi.md @@ -1,19 +1,20 @@ # OpenAPI\Client\StoreApi -All URIs are relative to *http://petstore.swagger.io:80/v2* +All URIs are relative to http://petstore.swagger.io:80/v2. Method | HTTP request | Description ------------- | ------------- | ------------- -[**deleteOrder**](StoreApi.md#deleteOrder) | **DELETE** /store/order/{order_id} | Delete purchase order by ID -[**getInventory**](StoreApi.md#getInventory) | **GET** /store/inventory | Returns pet inventories by status -[**getOrderById**](StoreApi.md#getOrderById) | **GET** /store/order/{order_id} | Find purchase order by ID -[**placeOrder**](StoreApi.md#placeOrder) | **POST** /store/order | Place an order for a pet +[**deleteOrder()**](StoreApi.md#deleteOrder) | **DELETE** /store/order/{order_id} | Delete purchase order by ID +[**getInventory()**](StoreApi.md#getInventory) | **GET** /store/inventory | Returns pet inventories by status +[**getOrderById()**](StoreApi.md#getOrderById) | **GET** /store/order/{order_id} | Find purchase order by ID +[**placeOrder()**](StoreApi.md#placeOrder) | **POST** /store/order | Place an order for a pet +## `deleteOrder()` -## deleteOrder - -> deleteOrder($order_id) +```php +deleteOrder($order_id) +``` Delete purchase order by ID @@ -26,6 +27,7 @@ For valid response try integer IDs with value < 1000. Anything above 1000 or non require_once(__DIR__ . '/vendor/autoload.php'); + $apiInstance = new OpenAPI\Client\Api\StoreApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. @@ -38,12 +40,10 @@ try { } catch (Exception $e) { echo 'Exception when calling StoreApi->deleteOrder: ', $e->getMessage(), PHP_EOL; } -?> ``` ### Parameters - Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **order_id** | **string**| ID of the order that needs to be deleted | @@ -61,14 +61,15 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../../README.md#documentation-for-models) +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) [[Back to README]](../../README.md) +## `getInventory()` -## getInventory - -> map[string,int] getInventory() +```php +getInventory(): map[string,int] +``` Returns pet inventories by status @@ -100,7 +101,6 @@ try { } catch (Exception $e) { echo 'Exception when calling StoreApi->getInventory: ', $e->getMessage(), PHP_EOL; } -?> ``` ### Parameters @@ -118,16 +118,17 @@ This endpoint does not need any parameter. ### HTTP request headers - **Content-Type**: Not defined -- **Accept**: application/json +- **Accept**: `application/json` -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../../README.md#documentation-for-models) +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) [[Back to README]](../../README.md) +## `getOrderById()` -## getOrderById - -> \OpenAPI\Client\Model\Order getOrderById($order_id) +```php +getOrderById($order_id): \OpenAPI\Client\Model\Order +``` Find purchase order by ID @@ -140,6 +141,7 @@ For valid response try integer IDs with value <= 5 or > 10. Other values will ge require_once(__DIR__ . '/vendor/autoload.php'); + $apiInstance = new OpenAPI\Client\Api\StoreApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. @@ -153,12 +155,10 @@ try { } catch (Exception $e) { echo 'Exception when calling StoreApi->getOrderById: ', $e->getMessage(), PHP_EOL; } -?> ``` ### Parameters - Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **order_id** | **int**| ID of pet that needs to be fetched | @@ -174,16 +174,17 @@ No authorization required ### HTTP request headers - **Content-Type**: Not defined -- **Accept**: application/xml, application/json +- **Accept**: `application/xml`, `application/json` -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../../README.md#documentation-for-models) +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) [[Back to README]](../../README.md) +## `placeOrder()` -## placeOrder - -> \OpenAPI\Client\Model\Order placeOrder($order) +```php +placeOrder($order): \OpenAPI\Client\Model\Order +``` Place an order for a pet @@ -194,6 +195,7 @@ Place an order for a pet require_once(__DIR__ . '/vendor/autoload.php'); + $apiInstance = new OpenAPI\Client\Api\StoreApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. @@ -207,12 +209,10 @@ try { } catch (Exception $e) { echo 'Exception when calling StoreApi->placeOrder: ', $e->getMessage(), PHP_EOL; } -?> ``` ### Parameters - Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **order** | [**\OpenAPI\Client\Model\Order**](../Model/Order.md)| order placed for purchasing the pet | @@ -227,10 +227,9 @@ No authorization required ### HTTP request headers -- **Content-Type**: application/json -- **Accept**: application/xml, application/json +- **Content-Type**: `application/json` +- **Accept**: `application/xml`, `application/json` -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../../README.md#documentation-for-models) +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) [[Back to README]](../../README.md) - diff --git a/samples/client/petstore/php/OpenAPIClient-php/docs/Api/UserApi.md b/samples/client/petstore/php/OpenAPIClient-php/docs/Api/UserApi.md index 0784a1645181..04fb1b76378a 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/docs/Api/UserApi.md +++ b/samples/client/petstore/php/OpenAPIClient-php/docs/Api/UserApi.md @@ -1,23 +1,24 @@ # OpenAPI\Client\UserApi -All URIs are relative to *http://petstore.swagger.io:80/v2* +All URIs are relative to http://petstore.swagger.io:80/v2. Method | HTTP request | Description ------------- | ------------- | ------------- -[**createUser**](UserApi.md#createUser) | **POST** /user | Create user -[**createUsersWithArrayInput**](UserApi.md#createUsersWithArrayInput) | **POST** /user/createWithArray | Creates list of users with given input array -[**createUsersWithListInput**](UserApi.md#createUsersWithListInput) | **POST** /user/createWithList | Creates list of users with given input array -[**deleteUser**](UserApi.md#deleteUser) | **DELETE** /user/{username} | Delete user -[**getUserByName**](UserApi.md#getUserByName) | **GET** /user/{username} | Get user by user name -[**loginUser**](UserApi.md#loginUser) | **GET** /user/login | Logs user into the system -[**logoutUser**](UserApi.md#logoutUser) | **GET** /user/logout | Logs out current logged in user session -[**updateUser**](UserApi.md#updateUser) | **PUT** /user/{username} | Updated user +[**createUser()**](UserApi.md#createUser) | **POST** /user | Create user +[**createUsersWithArrayInput()**](UserApi.md#createUsersWithArrayInput) | **POST** /user/createWithArray | Creates list of users with given input array +[**createUsersWithListInput()**](UserApi.md#createUsersWithListInput) | **POST** /user/createWithList | Creates list of users with given input array +[**deleteUser()**](UserApi.md#deleteUser) | **DELETE** /user/{username} | Delete user +[**getUserByName()**](UserApi.md#getUserByName) | **GET** /user/{username} | Get user by user name +[**loginUser()**](UserApi.md#loginUser) | **GET** /user/login | Logs user into the system +[**logoutUser()**](UserApi.md#logoutUser) | **GET** /user/logout | Logs out current logged in user session +[**updateUser()**](UserApi.md#updateUser) | **PUT** /user/{username} | Updated user +## `createUser()` -## createUser - -> createUser($user) +```php +createUser($user) +``` Create user @@ -30,6 +31,7 @@ This can only be done by the logged in user. require_once(__DIR__ . '/vendor/autoload.php'); + $apiInstance = new OpenAPI\Client\Api\UserApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. @@ -42,12 +44,10 @@ try { } catch (Exception $e) { echo 'Exception when calling UserApi->createUser: ', $e->getMessage(), PHP_EOL; } -?> ``` ### Parameters - Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **user** | [**\OpenAPI\Client\Model\User**](../Model/User.md)| Created user object | @@ -62,17 +62,18 @@ No authorization required ### HTTP request headers -- **Content-Type**: application/json +- **Content-Type**: `application/json` - **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../../README.md#documentation-for-models) +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) [[Back to README]](../../README.md) +## `createUsersWithArrayInput()` -## createUsersWithArrayInput - -> createUsersWithArrayInput($user) +```php +createUsersWithArrayInput($user) +``` Creates list of users with given input array @@ -83,6 +84,7 @@ Creates list of users with given input array require_once(__DIR__ . '/vendor/autoload.php'); + $apiInstance = new OpenAPI\Client\Api\UserApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. @@ -95,12 +97,10 @@ try { } catch (Exception $e) { echo 'Exception when calling UserApi->createUsersWithArrayInput: ', $e->getMessage(), PHP_EOL; } -?> ``` ### Parameters - Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **user** | [**\OpenAPI\Client\Model\User[]**](../Model/User.md)| List of user object | @@ -115,17 +115,18 @@ No authorization required ### HTTP request headers -- **Content-Type**: application/json +- **Content-Type**: `application/json` - **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../../README.md#documentation-for-models) +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) [[Back to README]](../../README.md) +## `createUsersWithListInput()` -## createUsersWithListInput - -> createUsersWithListInput($user) +```php +createUsersWithListInput($user) +``` Creates list of users with given input array @@ -136,6 +137,7 @@ Creates list of users with given input array require_once(__DIR__ . '/vendor/autoload.php'); + $apiInstance = new OpenAPI\Client\Api\UserApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. @@ -148,12 +150,10 @@ try { } catch (Exception $e) { echo 'Exception when calling UserApi->createUsersWithListInput: ', $e->getMessage(), PHP_EOL; } -?> ``` ### Parameters - Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **user** | [**\OpenAPI\Client\Model\User[]**](../Model/User.md)| List of user object | @@ -168,17 +168,18 @@ No authorization required ### HTTP request headers -- **Content-Type**: application/json +- **Content-Type**: `application/json` - **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../../README.md#documentation-for-models) +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) [[Back to README]](../../README.md) +## `deleteUser()` -## deleteUser - -> deleteUser($username) +```php +deleteUser($username) +``` Delete user @@ -191,6 +192,7 @@ This can only be done by the logged in user. require_once(__DIR__ . '/vendor/autoload.php'); + $apiInstance = new OpenAPI\Client\Api\UserApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. @@ -203,12 +205,10 @@ try { } catch (Exception $e) { echo 'Exception when calling UserApi->deleteUser: ', $e->getMessage(), PHP_EOL; } -?> ``` ### Parameters - Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **string**| The name that needs to be deleted | @@ -226,14 +226,15 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../../README.md#documentation-for-models) +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) [[Back to README]](../../README.md) +## `getUserByName()` -## getUserByName - -> \OpenAPI\Client\Model\User getUserByName($username) +```php +getUserByName($username): \OpenAPI\Client\Model\User +``` Get user by user name @@ -244,6 +245,7 @@ Get user by user name require_once(__DIR__ . '/vendor/autoload.php'); + $apiInstance = new OpenAPI\Client\Api\UserApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. @@ -257,12 +259,10 @@ try { } catch (Exception $e) { echo 'Exception when calling UserApi->getUserByName: ', $e->getMessage(), PHP_EOL; } -?> ``` ### Parameters - Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **string**| The name that needs to be fetched. Use user1 for testing. | @@ -278,16 +278,17 @@ No authorization required ### HTTP request headers - **Content-Type**: Not defined -- **Accept**: application/xml, application/json +- **Accept**: `application/xml`, `application/json` -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../../README.md#documentation-for-models) +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) [[Back to README]](../../README.md) +## `loginUser()` -## loginUser - -> string loginUser($username, $password) +```php +loginUser($username, $password): string +``` Logs user into the system @@ -298,6 +299,7 @@ Logs user into the system require_once(__DIR__ . '/vendor/autoload.php'); + $apiInstance = new OpenAPI\Client\Api\UserApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. @@ -312,12 +314,10 @@ try { } catch (Exception $e) { echo 'Exception when calling UserApi->loginUser: ', $e->getMessage(), PHP_EOL; } -?> ``` ### Parameters - Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **string**| The user name for login | @@ -334,16 +334,17 @@ No authorization required ### HTTP request headers - **Content-Type**: Not defined -- **Accept**: application/xml, application/json +- **Accept**: `application/xml`, `application/json` -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../../README.md#documentation-for-models) +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) [[Back to README]](../../README.md) +## `logoutUser()` -## logoutUser - -> logoutUser() +```php +logoutUser() +``` Logs out current logged in user session @@ -354,6 +355,7 @@ Logs out current logged in user session require_once(__DIR__ . '/vendor/autoload.php'); + $apiInstance = new OpenAPI\Client\Api\UserApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. @@ -365,7 +367,6 @@ try { } catch (Exception $e) { echo 'Exception when calling UserApi->logoutUser: ', $e->getMessage(), PHP_EOL; } -?> ``` ### Parameters @@ -385,14 +386,15 @@ No authorization required - **Content-Type**: Not defined - **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../../README.md#documentation-for-models) +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) [[Back to README]](../../README.md) +## `updateUser()` -## updateUser - -> updateUser($username, $user) +```php +updateUser($username, $user) +``` Updated user @@ -405,6 +407,7 @@ This can only be done by the logged in user. require_once(__DIR__ . '/vendor/autoload.php'); + $apiInstance = new OpenAPI\Client\Api\UserApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. @@ -418,12 +421,10 @@ try { } catch (Exception $e) { echo 'Exception when calling UserApi->updateUser: ', $e->getMessage(), PHP_EOL; } -?> ``` ### Parameters - Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **string**| name that need to be deleted | @@ -439,10 +440,9 @@ No authorization required ### HTTP request headers -- **Content-Type**: application/json +- **Content-Type**: `application/json` - **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../../README.md#documentation-for-models) +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) [[Back to README]](../../README.md) - diff --git a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/AdditionalPropertiesClass.md b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/AdditionalPropertiesClass.md index 8c2be69f6945..9fd32db3019a 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/AdditionalPropertiesClass.md +++ b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/AdditionalPropertiesClass.md @@ -4,9 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**map_property** | **map[string,string]** | | [optional] -**map_of_map_property** | [**map[string,map[string,string]]**](map.md) | | [optional] - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - +**map_property** | **map[string,string]** | | [optional] +**map_of_map_property** | [**map[string,map[string,string]]**](map.md) | | [optional] +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/Animal.md b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/Animal.md index 026fdd6a1d37..ee79377b5661 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/Animal.md +++ b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/Animal.md @@ -4,9 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**class_name** | **string** | | +**class_name** | **string** | | **color** | **string** | | [optional] [default to 'red'] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - - +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/ApiResponse.md b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/ApiResponse.md index ad7e93b6f0a6..bd084f0b741e 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/ApiResponse.md +++ b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/ApiResponse.md @@ -4,10 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**code** | **int** | | [optional] -**type** | **string** | | [optional] -**message** | **string** | | [optional] - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - +**code** | **int** | | [optional] +**type** | **string** | | [optional] +**message** | **string** | | [optional] +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/ArrayOfArrayOfNumberOnly.md b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/ArrayOfArrayOfNumberOnly.md index 1b76031a82aa..d035d7a47076 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/ArrayOfArrayOfNumberOnly.md +++ b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/ArrayOfArrayOfNumberOnly.md @@ -4,8 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**array_array_number** | [**float[][]**](array.md) | | [optional] - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - +**array_array_number** | [**float[][]**](array.md) | | [optional] +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/ArrayOfNumberOnly.md b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/ArrayOfNumberOnly.md index 294930cb2b6b..f21a9758c4cf 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/ArrayOfNumberOnly.md +++ b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/ArrayOfNumberOnly.md @@ -4,8 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**array_number** | **float[]** | | [optional] - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - +**array_number** | **float[]** | | [optional] +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/ArrayTest.md b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/ArrayTest.md index a150d9cea0d4..184244105328 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/ArrayTest.md +++ b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/ArrayTest.md @@ -4,10 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**array_of_string** | **string[]** | | [optional] -**array_array_of_integer** | [**int[][]**](array.md) | | [optional] -**array_array_of_model** | [**\OpenAPI\Client\Model\ReadOnlyFirst[][]**](array.md) | | [optional] - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - +**array_of_string** | **string[]** | | [optional] +**array_array_of_integer** | [**int[][]**](array.md) | | [optional] +**array_array_of_model** | [**\OpenAPI\Client\Model\ReadOnlyFirst[][]**](array.md) | | [optional] +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/Capitalization.md b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/Capitalization.md index 4166caadef96..9984c623ab54 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/Capitalization.md +++ b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/Capitalization.md @@ -4,13 +4,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**small_camel** | **string** | | [optional] -**capital_camel** | **string** | | [optional] -**small_snake** | **string** | | [optional] -**capital_snake** | **string** | | [optional] -**sca_eth_flow_points** | **string** | | [optional] -**att_name** | **string** | Name of the pet | [optional] - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - +**small_camel** | **string** | | [optional] +**capital_camel** | **string** | | [optional] +**small_snake** | **string** | | [optional] +**capital_snake** | **string** | | [optional] +**sca_eth_flow_points** | **string** | | [optional] +**att_name** | **string** | Name of the pet | [optional] +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/Cat.md b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/Cat.md index f9652f72ae15..28dff94a0897 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/Cat.md +++ b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/Cat.md @@ -4,8 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**declawed** | **bool** | | [optional] - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - +**declawed** | **bool** | | [optional] +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/CatAllOf.md b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/CatAllOf.md index 0c5312a61449..3452570c1e7b 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/CatAllOf.md +++ b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/CatAllOf.md @@ -4,8 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**declawed** | **bool** | | [optional] - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - +**declawed** | **bool** | | [optional] +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/Category.md b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/Category.md index eb71223a787c..55a1f51150c3 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/Category.md +++ b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/Category.md @@ -4,9 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **int** | | [optional] +**id** | **int** | | [optional] **name** | **string** | | [default to 'default-name'] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - - +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/ClassModel.md b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/ClassModel.md index b56b2fa26f6c..8c9707bfd4fd 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/ClassModel.md +++ b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/ClassModel.md @@ -4,8 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**_class** | **string** | | [optional] - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - +**_class** | **string** | | [optional] +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/Client.md b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/Client.md index c0f76ca86f2c..3ba14006da72 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/Client.md +++ b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/Client.md @@ -4,8 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**client** | **string** | | [optional] - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - +**client** | **string** | | [optional] +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/Dog.md b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/Dog.md index d3a9f50ef638..1face18443cf 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/Dog.md +++ b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/Dog.md @@ -4,8 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**breed** | **string** | | [optional] - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - +**breed** | **string** | | [optional] +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/DogAllOf.md b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/DogAllOf.md index 82f34a6e6c83..88effd4297bc 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/DogAllOf.md +++ b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/DogAllOf.md @@ -4,8 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**breed** | **string** | | [optional] - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - +**breed** | **string** | | [optional] +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/EnumArrays.md b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/EnumArrays.md index 231f4afc15f7..39c30a915ffd 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/EnumArrays.md +++ b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/EnumArrays.md @@ -4,9 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**just_symbol** | **string** | | [optional] -**array_enum** | **string[]** | | [optional] - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - +**just_symbol** | **string** | | [optional] +**array_enum** | **string[]** | | [optional] +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/EnumClass.md b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/EnumClass.md index dd38a0f0837e..223d52573618 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/EnumClass.md +++ b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/EnumClass.md @@ -5,6 +5,4 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - - +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/EnumTest.md b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/EnumTest.md index 9a1ffa8a7e38..28781e6a3826 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/EnumTest.md +++ b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/EnumTest.md @@ -4,15 +4,13 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**enum_string** | **string** | | [optional] -**enum_string_required** | **string** | | -**enum_integer** | **int** | | [optional] -**enum_number** | **double** | | [optional] -**outer_enum** | [**\OpenAPI\Client\Model\OuterEnum**](OuterEnum.md) | | [optional] -**outer_enum_integer** | [**\OpenAPI\Client\Model\OuterEnumInteger**](OuterEnumInteger.md) | | [optional] -**outer_enum_default_value** | [**\OpenAPI\Client\Model\OuterEnumDefaultValue**](OuterEnumDefaultValue.md) | | [optional] -**outer_enum_integer_default_value** | [**\OpenAPI\Client\Model\OuterEnumIntegerDefaultValue**](OuterEnumIntegerDefaultValue.md) | | [optional] - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - +**enum_string** | **string** | | [optional] +**enum_string_required** | **string** | | +**enum_integer** | **int** | | [optional] +**enum_number** | **double** | | [optional] +**outer_enum** | [**\OpenAPI\Client\Model\OuterEnum**](OuterEnum.md) | | [optional] +**outer_enum_integer** | [**\OpenAPI\Client\Model\OuterEnumInteger**](OuterEnumInteger.md) | | [optional] +**outer_enum_default_value** | [**\OpenAPI\Client\Model\OuterEnumDefaultValue**](OuterEnumDefaultValue.md) | | [optional] +**outer_enum_integer_default_value** | [**\OpenAPI\Client\Model\OuterEnumIntegerDefaultValue**](OuterEnumIntegerDefaultValue.md) | | [optional] +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/File.md b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/File.md index 77c48da80316..3d29f9163b4b 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/File.md +++ b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/File.md @@ -4,8 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**source_uri** | **string** | Test capitalization | [optional] - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - +**source_uri** | **string** | Test capitalization | [optional] +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/FileSchemaTestClass.md b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/FileSchemaTestClass.md index b8c5ea236b0b..9c0512213038 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/FileSchemaTestClass.md +++ b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/FileSchemaTestClass.md @@ -4,9 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**file** | [**\OpenAPI\Client\Model\File**](File.md) | | [optional] -**files** | [**\OpenAPI\Client\Model\File[]**](File.md) | | [optional] - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - +**file** | [**\OpenAPI\Client\Model\File**](File.md) | | [optional] +**files** | [**\OpenAPI\Client\Model\File[]**](File.md) | | [optional] +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/Foo.md b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/Foo.md index 9acc83cb6fa6..b2f50b38d5cb 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/Foo.md +++ b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/Foo.md @@ -6,6 +6,4 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **bar** | **string** | | [optional] [default to 'bar'] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - - +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/FormatTest.md b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/FormatTest.md index b0b8785234a1..c6be0ac72914 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/FormatTest.md +++ b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/FormatTest.md @@ -4,22 +4,20 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**integer** | **int** | | [optional] -**int32** | **int** | | [optional] -**int64** | **int** | | [optional] -**number** | **float** | | -**float** | **float** | | [optional] -**double** | **double** | | [optional] -**string** | **string** | | [optional] -**byte** | **string** | | -**binary** | [**\SplFileObject**](\SplFileObject.md) | | [optional] -**date** | [**\DateTime**](\DateTime.md) | | -**date_time** | [**\DateTime**](\DateTime.md) | | [optional] -**uuid** | **string** | | [optional] -**password** | **string** | | -**pattern_with_digits** | **string** | A string that is a 10 digit number. Can have leading zeros. | [optional] -**pattern_with_digits_and_delimiter** | **string** | A string starting with 'image_' (case insensitive) and one to three digits following i.e. Image_01. | [optional] - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - +**integer** | **int** | | [optional] +**int32** | **int** | | [optional] +**int64** | **int** | | [optional] +**number** | **float** | | +**float** | **float** | | [optional] +**double** | **double** | | [optional] +**string** | **string** | | [optional] +**byte** | **string** | | +**binary** | [**\SplFileObject**](\SplFileObject.md) | | [optional] +**date** | [**\DateTime**](\DateTime.md) | | +**date_time** | [**\DateTime**](\DateTime.md) | | [optional] +**uuid** | **string** | | [optional] +**password** | **string** | | +**pattern_with_digits** | **string** | A string that is a 10 digit number. Can have leading zeros. | [optional] +**pattern_with_digits_and_delimiter** | **string** | A string starting with 'image_' (case insensitive) and one to three digits following i.e. Image_01. | [optional] +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/HasOnlyReadOnly.md b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/HasOnlyReadOnly.md index 3f4d729d5624..7a1bb5647236 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/HasOnlyReadOnly.md +++ b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/HasOnlyReadOnly.md @@ -4,9 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**bar** | **string** | | [optional] [readonly] -**foo** | **string** | | [optional] [readonly] - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - +**bar** | **string** | | [optional] [readonly] +**foo** | **string** | | [optional] [readonly] +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/HealthCheckResult.md b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/HealthCheckResult.md index 7ec9e85b4d24..940bcc96ee44 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/HealthCheckResult.md +++ b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/HealthCheckResult.md @@ -4,8 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**nullable_message** | **string** | | [optional] - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - +**nullable_message** | **string** | | [optional] +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/InlineObject.md b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/InlineObject.md index b21b3c6d8877..147910e8f503 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/InlineObject.md +++ b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/InlineObject.md @@ -4,9 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **string** | Updated name of the pet | [optional] -**status** | **string** | Updated status of the pet | [optional] - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - +**name** | **string** | Updated name of the pet | [optional] +**status** | **string** | Updated status of the pet | [optional] +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/InlineObject1.md b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/InlineObject1.md index 25eb866417bc..2aa9afa20851 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/InlineObject1.md +++ b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/InlineObject1.md @@ -4,9 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**additional_metadata** | **string** | Additional data to pass to server | [optional] -**file** | [**\SplFileObject**](\SplFileObject.md) | file to upload | [optional] - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - +**additional_metadata** | **string** | Additional data to pass to server | [optional] +**file** | [**\SplFileObject**](\SplFileObject.md) | file to upload | [optional] +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/InlineObject2.md b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/InlineObject2.md index a862611a011c..1bc037b38ddc 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/InlineObject2.md +++ b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/InlineObject2.md @@ -4,9 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**enum_form_string_array** | **string[]** | Form parameter enum test (string array) | [optional] +**enum_form_string_array** | **string[]** | Form parameter enum test (string array) | [optional] **enum_form_string** | **string** | Form parameter enum test (string) | [optional] [default to '-efg'] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - - +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/InlineObject3.md b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/InlineObject3.md index 8cd0a80c044c..b71d41094909 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/InlineObject3.md +++ b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/InlineObject3.md @@ -4,21 +4,19 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**integer** | **int** | None | [optional] -**int32** | **int** | None | [optional] -**int64** | **int** | None | [optional] -**number** | **float** | None | -**float** | **float** | None | [optional] -**double** | **double** | None | -**string** | **string** | None | [optional] -**pattern_without_delimiter** | **string** | None | -**byte** | **string** | None | -**binary** | [**\SplFileObject**](\SplFileObject.md) | None | [optional] -**date** | [**\DateTime**](\DateTime.md) | None | [optional] -**date_time** | [**\DateTime**](\DateTime.md) | None | [optional] -**password** | **string** | None | [optional] -**callback** | **string** | None | [optional] - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - +**integer** | **int** | None | [optional] +**int32** | **int** | None | [optional] +**int64** | **int** | None | [optional] +**number** | **float** | None | +**float** | **float** | None | [optional] +**double** | **double** | None | +**string** | **string** | None | [optional] +**pattern_without_delimiter** | **string** | None | +**byte** | **string** | None | +**binary** | [**\SplFileObject**](\SplFileObject.md) | None | [optional] +**date** | [**\DateTime**](\DateTime.md) | None | [optional] +**date_time** | [**\DateTime**](\DateTime.md) | None | [optional] +**password** | **string** | None | [optional] +**callback** | **string** | None | [optional] +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/InlineObject4.md b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/InlineObject4.md index 6a940e80aca1..c16cf834eb80 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/InlineObject4.md +++ b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/InlineObject4.md @@ -4,9 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**param** | **string** | field1 | -**param2** | **string** | field2 | - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - +**param** | **string** | field1 | +**param2** | **string** | field2 | +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/InlineObject5.md b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/InlineObject5.md index 240eb36860c6..a0f3dbae385e 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/InlineObject5.md +++ b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/InlineObject5.md @@ -4,9 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**additional_metadata** | **string** | Additional data to pass to server | [optional] -**required_file** | [**\SplFileObject**](\SplFileObject.md) | file to upload | - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - +**additional_metadata** | **string** | Additional data to pass to server | [optional] +**required_file** | [**\SplFileObject**](\SplFileObject.md) | file to upload | +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/InlineResponseDefault.md b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/InlineResponseDefault.md index a00c32479623..57ae8e09d5ce 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/InlineResponseDefault.md +++ b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/InlineResponseDefault.md @@ -4,8 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**string** | [**\OpenAPI\Client\Model\Foo**](Foo.md) | | [optional] - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - +**string** | [**\OpenAPI\Client\Model\Foo**](Foo.md) | | [optional] +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/MapTest.md b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/MapTest.md index 221e7ce7139b..396ccc05666d 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/MapTest.md +++ b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/MapTest.md @@ -4,11 +4,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**map_map_of_string** | [**map[string,map[string,string]]**](map.md) | | [optional] -**map_of_enum_string** | **map[string,string]** | | [optional] -**direct_map** | **map[string,bool]** | | [optional] -**indirect_map** | **map[string,bool]** | | [optional] - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - +**map_map_of_string** | [**map[string,map[string,string]]**](map.md) | | [optional] +**map_of_enum_string** | **map[string,string]** | | [optional] +**direct_map** | **map[string,bool]** | | [optional] +**indirect_map** | **map[string,bool]** | | [optional] +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/MixedPropertiesAndAdditionalPropertiesClass.md b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/MixedPropertiesAndAdditionalPropertiesClass.md index a8ea4f7a193e..a2c845641b01 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/MixedPropertiesAndAdditionalPropertiesClass.md +++ b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/MixedPropertiesAndAdditionalPropertiesClass.md @@ -4,10 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**uuid** | **string** | | [optional] -**date_time** | [**\DateTime**](\DateTime.md) | | [optional] -**map** | [**map[string,\OpenAPI\Client\Model\Animal]**](Animal.md) | | [optional] - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - +**uuid** | **string** | | [optional] +**date_time** | [**\DateTime**](\DateTime.md) | | [optional] +**map** | [**map[string,\OpenAPI\Client\Model\Animal]**](Animal.md) | | [optional] +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/Model200Response.md b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/Model200Response.md index 7e2a475f327f..3e60cc4f3946 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/Model200Response.md +++ b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/Model200Response.md @@ -4,9 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **int** | | [optional] -**class** | **string** | | [optional] - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - +**name** | **int** | | [optional] +**class** | **string** | | [optional] +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/ModelList.md b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/ModelList.md index 5c8d3be7d080..61e65e27c063 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/ModelList.md +++ b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/ModelList.md @@ -4,8 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**_123_list** | **string** | | [optional] - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - +**_123_list** | **string** | | [optional] +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/ModelReturn.md b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/ModelReturn.md index a1b0105d3a95..efd1e85f1b2f 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/ModelReturn.md +++ b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/ModelReturn.md @@ -4,8 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**return** | **int** | | [optional] - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - +**return** | **int** | | [optional] +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/Name.md b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/Name.md index a501f9bb0d51..fd9ef873e70c 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/Name.md +++ b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/Name.md @@ -4,11 +4,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **int** | | -**snake_case** | **int** | | [optional] [readonly] -**property** | **string** | | [optional] -**_123_number** | **int** | | [optional] [readonly] - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - +**name** | **int** | | +**snake_case** | **int** | | [optional] [readonly] +**property** | **string** | | [optional] +**_123_number** | **int** | | [optional] [readonly] +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/NullableClass.md b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/NullableClass.md index d32595abb6f9..a861edb107fe 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/NullableClass.md +++ b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/NullableClass.md @@ -4,19 +4,17 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**integer_prop** | **int** | | [optional] -**number_prop** | **float** | | [optional] -**boolean_prop** | **bool** | | [optional] -**string_prop** | **string** | | [optional] -**date_prop** | [**\DateTime**](\DateTime.md) | | [optional] -**datetime_prop** | [**\DateTime**](\DateTime.md) | | [optional] -**array_nullable_prop** | **object[]** | | [optional] -**array_and_items_nullable_prop** | **object[]** | | [optional] -**array_items_nullable** | **object[]** | | [optional] -**object_nullable_prop** | **map[string,object]** | | [optional] -**object_and_items_nullable_prop** | **map[string,object]** | | [optional] -**object_items_nullable** | **map[string,object]** | | [optional] - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - +**integer_prop** | **int** | | [optional] +**number_prop** | **float** | | [optional] +**boolean_prop** | **bool** | | [optional] +**string_prop** | **string** | | [optional] +**date_prop** | [**\DateTime**](\DateTime.md) | | [optional] +**datetime_prop** | [**\DateTime**](\DateTime.md) | | [optional] +**array_nullable_prop** | **object[]** | | [optional] +**array_and_items_nullable_prop** | **object[]** | | [optional] +**array_items_nullable** | **object[]** | | [optional] +**object_nullable_prop** | **map[string,object]** | | [optional] +**object_and_items_nullable_prop** | **map[string,object]** | | [optional] +**object_items_nullable** | **map[string,object]** | | [optional] +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/NumberOnly.md b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/NumberOnly.md index 9495c7bafb86..736fa0125dfc 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/NumberOnly.md +++ b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/NumberOnly.md @@ -4,8 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**just_number** | **float** | | [optional] - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - +**just_number** | **float** | | [optional] +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/Order.md b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/Order.md index 78509578e216..14c7ef9fbe5b 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/Order.md +++ b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/Order.md @@ -4,13 +4,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **int** | | [optional] -**pet_id** | **int** | | [optional] -**quantity** | **int** | | [optional] -**ship_date** | [**\DateTime**](\DateTime.md) | | [optional] -**status** | **string** | Order Status | [optional] +**id** | **int** | | [optional] +**pet_id** | **int** | | [optional] +**quantity** | **int** | | [optional] +**ship_date** | [**\DateTime**](\DateTime.md) | | [optional] +**status** | **string** | Order Status | [optional] **complete** | **bool** | | [optional] [default to false] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - - +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/OuterComposite.md b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/OuterComposite.md index e17e22f1c5c3..9d5f885b9d03 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/OuterComposite.md +++ b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/OuterComposite.md @@ -4,10 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**my_number** | **float** | | [optional] -**my_string** | **string** | | [optional] -**my_boolean** | **bool** | | [optional] - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - +**my_number** | **float** | | [optional] +**my_string** | **string** | | [optional] +**my_boolean** | **bool** | | [optional] +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/OuterEnum.md b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/OuterEnum.md index 8e65cbf70bb0..ae6fde5fb656 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/OuterEnum.md +++ b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/OuterEnum.md @@ -5,6 +5,4 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - - +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/OuterEnumDefaultValue.md b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/OuterEnumDefaultValue.md index 63a41b79c0fe..41e73b701d04 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/OuterEnumDefaultValue.md +++ b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/OuterEnumDefaultValue.md @@ -5,6 +5,4 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - - +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/OuterEnumInteger.md b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/OuterEnumInteger.md index c88c528933f6..7253448cd6a4 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/OuterEnumInteger.md +++ b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/OuterEnumInteger.md @@ -5,6 +5,4 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - - +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/OuterEnumIntegerDefaultValue.md b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/OuterEnumIntegerDefaultValue.md index 923ad5d678c6..6e4ed357ff5b 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/OuterEnumIntegerDefaultValue.md +++ b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/OuterEnumIntegerDefaultValue.md @@ -5,6 +5,4 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - - +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/Pet.md b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/Pet.md index bb2421ea9d6c..c9edeaf65b64 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/Pet.md +++ b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/Pet.md @@ -4,13 +4,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **int** | | [optional] -**category** | [**\OpenAPI\Client\Model\Category**](Category.md) | | [optional] -**name** | **string** | | -**photo_urls** | **string[]** | | -**tags** | [**\OpenAPI\Client\Model\Tag[]**](Tag.md) | | [optional] -**status** | **string** | pet status in the store | [optional] - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - +**id** | **int** | | [optional] +**category** | [**\OpenAPI\Client\Model\Category**](Category.md) | | [optional] +**name** | **string** | | +**photo_urls** | **string[]** | | +**tags** | [**\OpenAPI\Client\Model\Tag[]**](Tag.md) | | [optional] +**status** | **string** | pet status in the store | [optional] +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/ReadOnlyFirst.md b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/ReadOnlyFirst.md index 40bf46c3ed8c..5b67e7fdecfb 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/ReadOnlyFirst.md +++ b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/ReadOnlyFirst.md @@ -4,9 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**bar** | **string** | | [optional] [readonly] -**baz** | **string** | | [optional] - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - +**bar** | **string** | | [optional] [readonly] +**baz** | **string** | | [optional] +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/SpecialModelName.md b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/SpecialModelName.md index 55e145b79f00..7a178c13e576 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/SpecialModelName.md +++ b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/SpecialModelName.md @@ -4,8 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**special_property_name** | **int** | | [optional] - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - +**special_property_name** | **int** | | [optional] +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/Tag.md b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/Tag.md index b564d27f7486..4cf7084738b0 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/Tag.md +++ b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/Tag.md @@ -4,9 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **int** | | [optional] -**name** | **string** | | [optional] - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - +**id** | **int** | | [optional] +**name** | **string** | | [optional] +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/User.md b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/User.md index 22ca738723be..dde68f38fc0b 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/docs/Model/User.md +++ b/samples/client/petstore/php/OpenAPIClient-php/docs/Model/User.md @@ -4,15 +4,13 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **int** | | [optional] -**username** | **string** | | [optional] -**first_name** | **string** | | [optional] -**last_name** | **string** | | [optional] -**email** | **string** | | [optional] -**password** | **string** | | [optional] -**phone** | **string** | | [optional] -**user_status** | **int** | User Status | [optional] - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - +**id** | **int** | | [optional] +**username** | **string** | | [optional] +**first_name** | **string** | | [optional] +**last_name** | **string** | | [optional] +**email** | **string** | | [optional] +**password** | **string** | | [optional] +**phone** | **string** | | [optional] +**user_status** | **int** | User Status | [optional] +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)