update samples, docs

OpenAPITools · May 28, 2021 · 28c3e1d · 28c3e1d
1 parent 12c34d4
commit 28c3e1d
Show file tree

Hide file tree

Showing 38 changed files with 351 additions and 350 deletions.
diff --git a/docs/generators.md b/docs/generators.md
@@ -142,6 +142,7 @@ The following generators are available:
 * [openapi](generators/openapi.md)  
 * [openapi-yaml](generators/openapi-yaml.md)  
 * [plantuml (beta)](generators/plantuml.md)  
+* [wsdl](generators/wsdl.md)  
 
 
 ## SCHEMA generators

diff --git a/docs/generators/fsharp-functions.md b/docs/generators/fsharp-functions.md
@@ -22,7 +22,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
 |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
 |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
-|sourceFolder|source folder for generated code| |OpenAPI\src|
+|sourceFolder|source folder for generated code| |OpenAPI/src|
 
 ## IMPORT MAPPING
 

diff --git a/docs/generators/fsharp-giraffe-server.md b/docs/generators/fsharp-giraffe-server.md
@@ -19,7 +19,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |packageVersion|F# package version.| |1.0.0|
 |returnICollection|Return ICollection&lt;T&gt; instead of the concrete type.| |false|
 |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
-|sourceFolder|source folder for generated code| |OpenAPI\src|
+|sourceFolder|source folder for generated code| |OpenAPI/src|
 |useCollection|Deserialize array types to Collection&lt;T&gt; instead of List&lt;T&gt;.| |false|
 |useDateTimeOffset|Use DateTimeOffset to model date-time properties| |false|
 |useSwashbuckle|Uses the Swashbuckle.AspNetCore NuGet package for documentation.| |false|

diff --git a/docs/generators/java-inflector.md b/docs/generators/java-inflector.md
@@ -48,7 +48,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |snapshotVersion|Uses a SNAPSHOT version.|<dl><dt>**true**</dt><dd>Use a SnapShot Version</dd><dt>**false**</dt><dd>Use a Release Version</dd></dl>|null|
 |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
 |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
-|sourceFolder|source folder for generated code| |src\gen\java|
+|sourceFolder|source folder for generated code| |src/gen/java|
 |withXml|whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)| |false|
 
 ## IMPORT MAPPING

diff --git a/docs/generators/jaxrs-cxf-client.md b/docs/generators/jaxrs-cxf-client.md
@@ -48,7 +48,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |snapshotVersion|Uses a SNAPSHOT version.|<dl><dt>**true**</dt><dd>Use a SnapShot Version</dd><dt>**false**</dt><dd>Use a Release Version</dd></dl>|null|
 |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
 |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
-|sourceFolder|source folder for generated code| |src\gen\java|
+|sourceFolder|source folder for generated code| |src/gen/java|
 |useBeanValidation|Use BeanValidation API annotations| |false|
 |useGenericResponse|Use generic response| |false|
 |useGzipFeatureForTests|Use Gzip Feature for tests| |false|

diff --git a/docs/generators/swift5.md b/docs/generators/swift5.md
@@ -36,10 +36,10 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |responseAs|Optionally use libraries to manage response.  Currently PromiseKit, RxSwift, Result, Combine are available.| |null|
 |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
 |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
-|swiftPackagePath|Set a custom source path instead of OpenAPIClient\Classes\OpenAPIs.| |null|
+|swiftPackagePath|Set a custom source path instead of OpenAPIClient/Classes/OpenAPIs.| |null|
 |swiftUseApiNamespace|Flag to make all the API classes inner-class of {{projectName}}API| |null|
 |useBacktickEscapes|Escape reserved words using backticks (default: false)| |false|
-|useSPMFileStructure|Use SPM file structure and set the source path to Sources\{{projectName}} (default: false).| |null|
+|useSPMFileStructure|Use SPM file structure and set the source path to Sources/{{projectName}} (default: false).| |null|
 
 ## IMPORT MAPPING
 

diff --git a/samples/client/petstore/R/.openapi-generator/FILES b/samples/client/petstore/R/.openapi-generator/FILES
@@ -3,7 +3,6 @@
 .travis.yml
 DESCRIPTION
 NAMESPACE
-README.md
 R/api_client.R
 R/api_response.R
 R/category.R
@@ -15,6 +14,7 @@ R/store_api.R
 R/tag.R
 R/user.R
 R/user_api.R
+README.md
 docs/Category.md
 docs/ModelApiResponse.md
 docs/Order.md

diff --git a/samples/client/petstore/php/OpenAPIClient-php/.openapi-generator/FILES b/samples/client/petstore/php/OpenAPIClient-php/.openapi-generator/FILES
@@ -55,14 +55,14 @@ docs/Model/SpecialModelName.md
 docs/Model/Tag.md
 docs/Model/User.md
 git_push.sh
-lib/ApiException.php
 lib/Api/AnotherFakeApi.php
 lib/Api/DefaultApi.php
 lib/Api/FakeApi.php
 lib/Api/FakeClassnameTags123Api.php
 lib/Api/PetApi.php
 lib/Api/StoreApi.php
 lib/Api/UserApi.php
+lib/ApiException.php
 lib/Configuration.php
 lib/HeaderSelector.php
 lib/Model/AdditionalPropertiesClass.php

diff --git a/samples/client/petstore/php/OpenAPIClient-php/phpunit.xml.dist b/samples/client/petstore/php/OpenAPIClient-php/phpunit.xml.dist
@@ -13,8 +13,8 @@
     </testsuites>
     <filter>
         <whitelist processUncoveredFilesFromWhitelist="true">
-            <directory suffix=".php">./lib\/Api</directory>
-            <directory suffix=".php">./lib\/Model</directory>
+            <directory suffix=".php">./lib/Api</directory>
+            <directory suffix=".php">./lib/Model</directory>
         </whitelist>
     </filter>
     <php>

diff --git a/samples/client/petstore/powershell/README.md b/samples/client/petstore/powershell/README.md
@@ -79,12 +79,12 @@ Class | Method | HTTP request | Description
 
 ## Documentation for Models
 
- - [PSPetstore\Model.ApiResponse](docs/ApiResponse.md)
- - [PSPetstore\Model.Category](docs/Category.md)
- - [PSPetstore\Model.Order](docs/Order.md)
- - [PSPetstore\Model.Pet](docs/Pet.md)
- - [PSPetstore\Model.Tag](docs/Tag.md)
- - [PSPetstore\Model.User](docs/User.md)
+ - [PSPetstore/Model.ApiResponse](docs/ApiResponse.md)
+ - [PSPetstore/Model.Category](docs/Category.md)
+ - [PSPetstore/Model.Order](docs/Order.md)
+ - [PSPetstore/Model.Pet](docs/Pet.md)
+ - [PSPetstore/Model.Tag](docs/Tag.md)
+ - [PSPetstore/Model.User](docs/User.md)
 
 
 ## Documentation for Authorization

diff --git a/samples/client/petstore/powershell/docs/PSPetApi.md b/samples/client/petstore/powershell/docs/PSPetApi.md
@@ -1,4 +1,4 @@
-# PSPetstore.PSPetstore\Api.PSPetApi
+# PSPetstore.PSPetstore/Api.PSPetApi
 
 All URIs are relative to *http://petstore.swagger.io:80/v2*
 

diff --git a/samples/client/petstore/powershell/docs/PSStoreApi.md b/samples/client/petstore/powershell/docs/PSStoreApi.md
@@ -1,4 +1,4 @@
-# PSPetstore.PSPetstore\Api.PSStoreApi
+# PSPetstore.PSPetstore/Api.PSStoreApi
 
 All URIs are relative to *http://petstore.swagger.io:80/v2*
 

diff --git a/samples/client/petstore/powershell/docs/PSUserApi.md b/samples/client/petstore/powershell/docs/PSUserApi.md
@@ -1,4 +1,4 @@
-# PSPetstore.PSPetstore\Api.PSUserApi
+# PSPetstore.PSPetstore/Api.PSUserApi
 
 All URIs are relative to *http://petstore.swagger.io:80/v2*
 

diff --git a/samples/client/petstore/typescript-fetch/builds/default-v3.0/models/Capitalization.ts b/samples/client/petstore/typescript-fetch/builds/default-v3.0/models/Capitalization.ts
@@ -51,7 +51,6 @@ export interface Capitalization {
     sCAETHFlowPoints?: string;
     /**
      * Name of the pet
-
      * @type {string}
      * @memberof Capitalization
      */

diff --git a/samples/openapi3/client/petstore/dart-dio-next/petstore_client_lib_fake/README.md b/samples/openapi3/client/petstore/dart-dio-next/petstore_client_lib_fake/README.md
@@ -105,52 +105,53 @@ Class | Method | HTTP request | Description
 [*UserApi*](doc/UserApi.md) | [**logoutUser**](doc/UserApi.md#logoutuser) | **GET** /user/logout | Logs out current logged in user session
 [*UserApi*](doc/UserApi.md) | [**updateUser**](doc/UserApi.md#updateuser) | **PUT** /user/{username} | Updated user
 
+
 ## Documentation For Models
 
- - [AdditionalPropertiesClass](doc\AdditionalPropertiesClass.md)
- - [Animal](doc\Animal.md)
- - [ApiResponse](doc\ApiResponse.md)
- - [ArrayOfArrayOfNumberOnly](doc\ArrayOfArrayOfNumberOnly.md)
- - [ArrayOfNumberOnly](doc\ArrayOfNumberOnly.md)
- - [ArrayTest](doc\ArrayTest.md)
- - [Capitalization](doc\Capitalization.md)
- - [Cat](doc\Cat.md)
- - [CatAllOf](doc\CatAllOf.md)
- - [Category](doc\Category.md)
- - [ClassModel](doc\ClassModel.md)
- - [Dog](doc\Dog.md)
- - [DogAllOf](doc\DogAllOf.md)
- - [EnumArrays](doc\EnumArrays.md)
- - [EnumTest](doc\EnumTest.md)
- - [FileSchemaTestClass](doc\FileSchemaTestClass.md)
- - [Foo](doc\Foo.md)
- - [FormatTest](doc\FormatTest.md)
- - [HasOnlyReadOnly](doc\HasOnlyReadOnly.md)
- - [HealthCheckResult](doc\HealthCheckResult.md)
- - [InlineResponseDefault](doc\InlineResponseDefault.md)
- - [MapTest](doc\MapTest.md)
- - [MixedPropertiesAndAdditionalPropertiesClass](doc\MixedPropertiesAndAdditionalPropertiesClass.md)
- - [Model200Response](doc\Model200Response.md)
- - [ModelClient](doc\ModelClient.md)
- - [ModelEnumClass](doc\ModelEnumClass.md)
- - [ModelFile](doc\ModelFile.md)
- - [ModelList](doc\ModelList.md)
- - [ModelReturn](doc\ModelReturn.md)
- - [Name](doc\Name.md)
- - [NullableClass](doc\NullableClass.md)
- - [NumberOnly](doc\NumberOnly.md)
- - [Order](doc\Order.md)
- - [OuterComposite](doc\OuterComposite.md)
- - [OuterEnum](doc\OuterEnum.md)
- - [OuterEnumDefaultValue](doc\OuterEnumDefaultValue.md)
- - [OuterEnumInteger](doc\OuterEnumInteger.md)
- - [OuterEnumIntegerDefaultValue](doc\OuterEnumIntegerDefaultValue.md)
- - [OuterObjectWithEnumProperty](doc\OuterObjectWithEnumProperty.md)
- - [Pet](doc\Pet.md)
- - [ReadOnlyFirst](doc\ReadOnlyFirst.md)
- - [SpecialModelName](doc\SpecialModelName.md)
- - [Tag](doc\Tag.md)
- - [User](doc\User.md)
+ - [AdditionalPropertiesClass](doc/AdditionalPropertiesClass.md)
+ - [Animal](doc/Animal.md)
+ - [ApiResponse](doc/ApiResponse.md)
+ - [ArrayOfArrayOfNumberOnly](doc/ArrayOfArrayOfNumberOnly.md)
+ - [ArrayOfNumberOnly](doc/ArrayOfNumberOnly.md)
+ - [ArrayTest](doc/ArrayTest.md)
+ - [Capitalization](doc/Capitalization.md)
+ - [Cat](doc/Cat.md)
+ - [CatAllOf](doc/CatAllOf.md)
+ - [Category](doc/Category.md)
+ - [ClassModel](doc/ClassModel.md)
+ - [Dog](doc/Dog.md)
+ - [DogAllOf](doc/DogAllOf.md)
+ - [EnumArrays](doc/EnumArrays.md)
+ - [EnumTest](doc/EnumTest.md)
+ - [FileSchemaTestClass](doc/FileSchemaTestClass.md)
+ - [Foo](doc/Foo.md)
+ - [FormatTest](doc/FormatTest.md)
+ - [HasOnlyReadOnly](doc/HasOnlyReadOnly.md)
+ - [HealthCheckResult](doc/HealthCheckResult.md)
+ - [InlineResponseDefault](doc/InlineResponseDefault.md)
+ - [MapTest](doc/MapTest.md)
+ - [MixedPropertiesAndAdditionalPropertiesClass](doc/MixedPropertiesAndAdditionalPropertiesClass.md)
+ - [Model200Response](doc/Model200Response.md)
+ - [ModelClient](doc/ModelClient.md)
+ - [ModelEnumClass](doc/ModelEnumClass.md)
+ - [ModelFile](doc/ModelFile.md)
+ - [ModelList](doc/ModelList.md)
+ - [ModelReturn](doc/ModelReturn.md)
+ - [Name](doc/Name.md)
+ - [NullableClass](doc/NullableClass.md)
+ - [NumberOnly](doc/NumberOnly.md)
+ - [Order](doc/Order.md)
+ - [OuterComposite](doc/OuterComposite.md)
+ - [OuterEnum](doc/OuterEnum.md)
+ - [OuterEnumDefaultValue](doc/OuterEnumDefaultValue.md)
+ - [OuterEnumInteger](doc/OuterEnumInteger.md)
+ - [OuterEnumIntegerDefaultValue](doc/OuterEnumIntegerDefaultValue.md)
+ - [OuterObjectWithEnumProperty](doc/OuterObjectWithEnumProperty.md)
+ - [Pet](doc/Pet.md)
+ - [ReadOnlyFirst](doc/ReadOnlyFirst.md)
+ - [SpecialModelName](doc/SpecialModelName.md)
+ - [Tag](doc/Tag.md)
+ - [User](doc/User.md)
 
 
 ## Documentation For Authorization

diff --git a/samples/openapi3/client/petstore/dart-dio/petstore_client_lib/README.md b/samples/openapi3/client/petstore/dart-dio/petstore_client_lib/README.md
@@ -82,12 +82,12 @@ Class | Method | HTTP request | Description
 
 ## Documentation For Models
 
- - [ApiResponse](doc\ApiResponse.md)
- - [Category](doc\Category.md)
- - [Order](doc\Order.md)
- - [Pet](doc\Pet.md)
- - [Tag](doc\Tag.md)
- - [User](doc\User.md)
+ - [ApiResponse](doc/ApiResponse.md)
+ - [Category](doc/Category.md)
+ - [Order](doc/Order.md)
+ - [Pet](doc/Pet.md)
+ - [Tag](doc/Tag.md)
+ - [User](doc/User.md)
 
 
 ## Documentation For Authorization

diff --git a/samples/openapi3/client/petstore/dart-dio/petstore_client_lib_fake/README.md b/samples/openapi3/client/petstore/dart-dio/petstore_client_lib_fake/README.md
@@ -102,50 +102,50 @@ Class | Method | HTTP request | Description
 
 ## Documentation For Models
 
- - [AdditionalPropertiesClass](doc\AdditionalPropertiesClass.md)
- - [Animal](doc\Animal.md)
- - [ApiResponse](doc\ApiResponse.md)
- - [ArrayOfArrayOfNumberOnly](doc\ArrayOfArrayOfNumberOnly.md)
- - [ArrayOfNumberOnly](doc\ArrayOfNumberOnly.md)
- - [ArrayTest](doc\ArrayTest.md)
- - [Capitalization](doc\Capitalization.md)
- - [Cat](doc\Cat.md)
- - [CatAllOf](doc\CatAllOf.md)
- - [Category](doc\Category.md)
- - [ClassModel](doc\ClassModel.md)
- - [Dog](doc\Dog.md)
- - [DogAllOf](doc\DogAllOf.md)
- - [EnumArrays](doc\EnumArrays.md)
- - [EnumTest](doc\EnumTest.md)
- - [FileSchemaTestClass](doc\FileSchemaTestClass.md)
- - [Foo](doc\Foo.md)
- - [FormatTest](doc\FormatTest.md)
- - [HasOnlyReadOnly](doc\HasOnlyReadOnly.md)
- - [HealthCheckResult](doc\HealthCheckResult.md)
- - [InlineResponseDefault](doc\InlineResponseDefault.md)
- - [MapTest](doc\MapTest.md)
- - [MixedPropertiesAndAdditionalPropertiesClass](doc\MixedPropertiesAndAdditionalPropertiesClass.md)
- - [Model200Response](doc\Model200Response.md)
- - [ModelClient](doc\ModelClient.md)
- - [ModelEnumClass](doc\ModelEnumClass.md)
- - [ModelFile](doc\ModelFile.md)
- - [ModelList](doc\ModelList.md)
- - [ModelReturn](doc\ModelReturn.md)
- - [Name](doc\Name.md)
- - [NullableClass](doc\NullableClass.md)
- - [NumberOnly](doc\NumberOnly.md)
- - [Order](doc\Order.md)
- - [OuterComposite](doc\OuterComposite.md)
- - [OuterEnum](doc\OuterEnum.md)
- - [OuterEnumDefaultValue](doc\OuterEnumDefaultValue.md)
- - [OuterEnumInteger](doc\OuterEnumInteger.md)
- - [OuterEnumIntegerDefaultValue](doc\OuterEnumIntegerDefaultValue.md)
- - [OuterObjectWithEnumProperty](doc\OuterObjectWithEnumProperty.md)
- - [Pet](doc\Pet.md)
- - [ReadOnlyFirst](doc\ReadOnlyFirst.md)
- - [SpecialModelName](doc\SpecialModelName.md)
- - [Tag](doc\Tag.md)
- - [User](doc\User.md)
+ - [AdditionalPropertiesClass](doc/AdditionalPropertiesClass.md)
+ - [Animal](doc/Animal.md)
+ - [ApiResponse](doc/ApiResponse.md)
+ - [ArrayOfArrayOfNumberOnly](doc/ArrayOfArrayOfNumberOnly.md)
+ - [ArrayOfNumberOnly](doc/ArrayOfNumberOnly.md)
+ - [ArrayTest](doc/ArrayTest.md)
+ - [Capitalization](doc/Capitalization.md)
+ - [Cat](doc/Cat.md)
+ - [CatAllOf](doc/CatAllOf.md)
+ - [Category](doc/Category.md)
+ - [ClassModel](doc/ClassModel.md)
+ - [Dog](doc/Dog.md)
+ - [DogAllOf](doc/DogAllOf.md)
+ - [EnumArrays](doc/EnumArrays.md)
+ - [EnumTest](doc/EnumTest.md)
+ - [FileSchemaTestClass](doc/FileSchemaTestClass.md)
+ - [Foo](doc/Foo.md)
+ - [FormatTest](doc/FormatTest.md)
+ - [HasOnlyReadOnly](doc/HasOnlyReadOnly.md)
+ - [HealthCheckResult](doc/HealthCheckResult.md)
+ - [InlineResponseDefault](doc/InlineResponseDefault.md)
+ - [MapTest](doc/MapTest.md)
+ - [MixedPropertiesAndAdditionalPropertiesClass](doc/MixedPropertiesAndAdditionalPropertiesClass.md)
+ - [Model200Response](doc/Model200Response.md)
+ - [ModelClient](doc/ModelClient.md)
+ - [ModelEnumClass](doc/ModelEnumClass.md)
+ - [ModelFile](doc/ModelFile.md)
+ - [ModelList](doc/ModelList.md)
+ - [ModelReturn](doc/ModelReturn.md)
+ - [Name](doc/Name.md)
+ - [NullableClass](doc/NullableClass.md)
+ - [NumberOnly](doc/NumberOnly.md)
+ - [Order](doc/Order.md)
+ - [OuterComposite](doc/OuterComposite.md)
+ - [OuterEnum](doc/OuterEnum.md)
+ - [OuterEnumDefaultValue](doc/OuterEnumDefaultValue.md)
+ - [OuterEnumInteger](doc/OuterEnumInteger.md)
+ - [OuterEnumIntegerDefaultValue](doc/OuterEnumIntegerDefaultValue.md)
+ - [OuterObjectWithEnumProperty](doc/OuterObjectWithEnumProperty.md)
+ - [Pet](doc/Pet.md)
+ - [ReadOnlyFirst](doc/ReadOnlyFirst.md)
+ - [SpecialModelName](doc/SpecialModelName.md)
+ - [Tag](doc/Tag.md)
+ - [User](doc/User.md)
 
 
 ## Documentation For Authorization