From 2c235ad762cf4443eda22e383b4f253e4f368f68 Mon Sep 17 00:00:00 2001 From: William Cheng Date: Mon, 15 Apr 2019 21:50:20 +0800 Subject: [PATCH 1/9] add auto-generated doc to swift4 generators --- .../codegen/languages/Swift4Codegen.java | 123 +++ .../src/main/resources/swift4/README.mustache | 14 +- .../main/resources/swift4/api_doc.mustache | 94 +++ .../main/resources/swift4/model_doc.mustache | 11 + .../client/petstore/swift4/default/README.md | 139 ++++ .../default/docs/AdditionalPropertiesClass.md | 11 + .../petstore/swift4/default/docs/Animal.md | 11 + .../swift4/default/docs/AnimalFarm.md | 9 + .../swift4/default/docs/AnotherFakeAPI.md | 60 ++ .../swift4/default/docs/ApiResponse.md | 12 + .../default/docs/ArrayOfArrayOfNumberOnly.md | 10 + .../swift4/default/docs/ArrayOfNumberOnly.md | 10 + .../petstore/swift4/default/docs/ArrayTest.md | 12 + .../swift4/default/docs/Capitalization.md | 15 + .../petstore/swift4/default/docs/Cat.md | 10 + .../petstore/swift4/default/docs/Category.md | 11 + .../swift4/default/docs/ClassModel.md | 10 + .../petstore/swift4/default/docs/Client.md | 10 + .../petstore/swift4/default/docs/Dog.md | 10 + .../swift4/default/docs/EnumArrays.md | 11 + .../petstore/swift4/default/docs/EnumClass.md | 9 + .../petstore/swift4/default/docs/EnumTest.md | 14 + .../petstore/swift4/default/docs/FakeAPI.md | 674 ++++++++++++++++ .../default/docs/FakeClassnameTags123API.md | 60 ++ .../petstore/swift4/default/docs/File.md | 10 + .../default/docs/FileSchemaTestClass.md | 11 + .../swift4/default/docs/FormatTest.md | 22 + .../swift4/default/docs/HasOnlyReadOnly.md | 11 + .../petstore/swift4/default/docs/List.md | 10 + .../petstore/swift4/default/docs/MapTest.md | 13 + ...dPropertiesAndAdditionalPropertiesClass.md | 12 + .../swift4/default/docs/Model200Response.md | 11 + .../petstore/swift4/default/docs/Name.md | 13 + .../swift4/default/docs/NumberOnly.md | 10 + .../petstore/swift4/default/docs/Order.md | 15 + .../swift4/default/docs/OuterComposite.md | 12 + .../petstore/swift4/default/docs/OuterEnum.md | 9 + .../petstore/swift4/default/docs/Pet.md | 15 + .../petstore/swift4/default/docs/PetAPI.md | 478 ++++++++++++ .../swift4/default/docs/ReadOnlyFirst.md | 11 + .../petstore/swift4/default/docs/Return.md | 10 + .../swift4/default/docs/SpecialModelName.md | 10 + .../petstore/swift4/default/docs/StoreAPI.md | 210 +++++ .../swift4/default/docs/StringBooleanMap.md | 9 + .../petstore/swift4/default/docs/Tag.md | 11 + .../swift4/default/docs/TypeHolderDefault.md | 14 + .../swift4/default/docs/TypeHolderExample.md | 14 + .../petstore/swift4/default/docs/User.md | 17 + .../petstore/swift4/default/docs/UserAPI.md | 414 ++++++++++ .../petstore/swift4/objcCompatible/README.md | 146 ++++ .../docs/AdditionalPropertiesAnyType.md | 10 + .../docs/AdditionalPropertiesArray.md | 10 + .../docs/AdditionalPropertiesBoolean.md | 10 + .../docs/AdditionalPropertiesClass.md | 20 + .../docs/AdditionalPropertiesInteger.md | 10 + .../docs/AdditionalPropertiesNumber.md | 10 + .../docs/AdditionalPropertiesObject.md | 10 + .../docs/AdditionalPropertiesString.md | 10 + .../swift4/objcCompatible/docs/Animal.md | 11 + .../objcCompatible/docs/AnotherFakeAPI.md | 60 ++ .../swift4/objcCompatible/docs/ApiResponse.md | 12 + .../docs/ArrayOfArrayOfNumberOnly.md | 10 + .../objcCompatible/docs/ArrayOfNumberOnly.md | 10 + .../swift4/objcCompatible/docs/ArrayTest.md | 12 + .../objcCompatible/docs/Capitalization.md | 15 + .../swift4/objcCompatible/docs/Cat.md | 10 + .../swift4/objcCompatible/docs/Category.md | 11 + .../swift4/objcCompatible/docs/ClassModel.md | 10 + .../swift4/objcCompatible/docs/Client.md | 10 + .../swift4/objcCompatible/docs/Dog.md | 10 + .../swift4/objcCompatible/docs/EnumArrays.md | 11 + .../swift4/objcCompatible/docs/EnumClass.md | 9 + .../swift4/objcCompatible/docs/EnumTest.md | 14 + .../swift4/objcCompatible/docs/FakeAPI.md | 726 ++++++++++++++++++ .../docs/FakeClassnameTags123API.md | 60 ++ .../swift4/objcCompatible/docs/File.md | 10 + .../docs/FileSchemaTestClass.md | 11 + .../swift4/objcCompatible/docs/FormatTest.md | 22 + .../objcCompatible/docs/HasOnlyReadOnly.md | 11 + .../swift4/objcCompatible/docs/List.md | 10 + .../swift4/objcCompatible/docs/MapTest.md | 13 + ...dPropertiesAndAdditionalPropertiesClass.md | 12 + .../objcCompatible/docs/Model200Response.md | 11 + .../swift4/objcCompatible/docs/Name.md | 13 + .../swift4/objcCompatible/docs/NumberOnly.md | 10 + .../swift4/objcCompatible/docs/Order.md | 15 + .../objcCompatible/docs/OuterComposite.md | 12 + .../swift4/objcCompatible/docs/OuterEnum.md | 9 + .../swift4/objcCompatible/docs/Pet.md | 15 + .../swift4/objcCompatible/docs/PetAPI.md | 478 ++++++++++++ .../objcCompatible/docs/ReadOnlyFirst.md | 11 + .../swift4/objcCompatible/docs/Return.md | 10 + .../objcCompatible/docs/SpecialModelName.md | 10 + .../swift4/objcCompatible/docs/StoreAPI.md | 210 +++++ .../swift4/objcCompatible/docs/Tag.md | 11 + .../objcCompatible/docs/TypeHolderDefault.md | 14 + .../objcCompatible/docs/TypeHolderExample.md | 14 + .../swift4/objcCompatible/docs/User.md | 17 + .../swift4/objcCompatible/docs/UserAPI.md | 414 ++++++++++ .../swift4/objcCompatible/docs/XmlItem.md | 38 + .../petstore/swift4/promisekit/README.md | 139 ++++ .../docs/AdditionalPropertiesClass.md | 11 + .../petstore/swift4/promisekit/docs/Animal.md | 11 + .../swift4/promisekit/docs/AnimalFarm.md | 9 + .../swift4/promisekit/docs/AnotherFakeAPI.md | 58 ++ .../swift4/promisekit/docs/ApiResponse.md | 12 + .../docs/ArrayOfArrayOfNumberOnly.md | 10 + .../promisekit/docs/ArrayOfNumberOnly.md | 10 + .../swift4/promisekit/docs/ArrayTest.md | 12 + .../swift4/promisekit/docs/Capitalization.md | 15 + .../petstore/swift4/promisekit/docs/Cat.md | 10 + .../swift4/promisekit/docs/Category.md | 11 + .../swift4/promisekit/docs/ClassModel.md | 10 + .../petstore/swift4/promisekit/docs/Client.md | 10 + .../petstore/swift4/promisekit/docs/Dog.md | 10 + .../swift4/promisekit/docs/EnumArrays.md | 11 + .../swift4/promisekit/docs/EnumClass.md | 9 + .../swift4/promisekit/docs/EnumTest.md | 14 + .../swift4/promisekit/docs/FakeAPI.md | 650 ++++++++++++++++ .../docs/FakeClassnameTags123API.md | 58 ++ .../petstore/swift4/promisekit/docs/File.md | 10 + .../promisekit/docs/FileSchemaTestClass.md | 11 + .../swift4/promisekit/docs/FormatTest.md | 22 + .../swift4/promisekit/docs/HasOnlyReadOnly.md | 11 + .../petstore/swift4/promisekit/docs/List.md | 10 + .../swift4/promisekit/docs/MapTest.md | 13 + ...dPropertiesAndAdditionalPropertiesClass.md | 12 + .../promisekit/docs/Model200Response.md | 11 + .../petstore/swift4/promisekit/docs/Name.md | 13 + .../swift4/promisekit/docs/NumberOnly.md | 10 + .../petstore/swift4/promisekit/docs/Order.md | 15 + .../swift4/promisekit/docs/OuterComposite.md | 12 + .../swift4/promisekit/docs/OuterEnum.md | 9 + .../petstore/swift4/promisekit/docs/Pet.md | 15 + .../petstore/swift4/promisekit/docs/PetAPI.md | 460 +++++++++++ .../swift4/promisekit/docs/ReadOnlyFirst.md | 11 + .../petstore/swift4/promisekit/docs/Return.md | 10 + .../promisekit/docs/SpecialModelName.md | 10 + .../swift4/promisekit/docs/StoreAPI.md | 202 +++++ .../promisekit/docs/StringBooleanMap.md | 9 + .../petstore/swift4/promisekit/docs/Tag.md | 11 + .../promisekit/docs/TypeHolderDefault.md | 14 + .../promisekit/docs/TypeHolderExample.md | 14 + .../petstore/swift4/promisekit/docs/User.md | 17 + .../swift4/promisekit/docs/UserAPI.md | 398 ++++++++++ .../client/petstore/swift4/rxswift/README.md | 139 ++++ .../rxswift/docs/AdditionalPropertiesClass.md | 11 + .../petstore/swift4/rxswift/docs/Animal.md | 11 + .../swift4/rxswift/docs/AnimalFarm.md | 9 + .../swift4/rxswift/docs/AnotherFakeAPI.md | 48 ++ .../swift4/rxswift/docs/ApiResponse.md | 12 + .../rxswift/docs/ArrayOfArrayOfNumberOnly.md | 10 + .../swift4/rxswift/docs/ArrayOfNumberOnly.md | 10 + .../petstore/swift4/rxswift/docs/ArrayTest.md | 12 + .../swift4/rxswift/docs/Capitalization.md | 15 + .../petstore/swift4/rxswift/docs/Cat.md | 10 + .../petstore/swift4/rxswift/docs/Category.md | 11 + .../swift4/rxswift/docs/ClassModel.md | 10 + .../petstore/swift4/rxswift/docs/Client.md | 10 + .../petstore/swift4/rxswift/docs/Dog.md | 10 + .../swift4/rxswift/docs/EnumArrays.md | 11 + .../petstore/swift4/rxswift/docs/EnumClass.md | 9 + .../petstore/swift4/rxswift/docs/EnumTest.md | 14 + .../petstore/swift4/rxswift/docs/FakeAPI.md | 536 +++++++++++++ .../rxswift/docs/FakeClassnameTags123API.md | 48 ++ .../petstore/swift4/rxswift/docs/File.md | 10 + .../rxswift/docs/FileSchemaTestClass.md | 11 + .../swift4/rxswift/docs/FormatTest.md | 22 + .../swift4/rxswift/docs/HasOnlyReadOnly.md | 11 + .../petstore/swift4/rxswift/docs/List.md | 10 + .../petstore/swift4/rxswift/docs/MapTest.md | 13 + ...dPropertiesAndAdditionalPropertiesClass.md | 12 + .../swift4/rxswift/docs/Model200Response.md | 11 + .../petstore/swift4/rxswift/docs/Name.md | 13 + .../swift4/rxswift/docs/NumberOnly.md | 10 + .../petstore/swift4/rxswift/docs/Order.md | 15 + .../swift4/rxswift/docs/OuterComposite.md | 12 + .../petstore/swift4/rxswift/docs/OuterEnum.md | 9 + .../petstore/swift4/rxswift/docs/Pet.md | 15 + .../petstore/swift4/rxswift/docs/PetAPI.md | 370 +++++++++ .../swift4/rxswift/docs/ReadOnlyFirst.md | 11 + .../petstore/swift4/rxswift/docs/Return.md | 10 + .../swift4/rxswift/docs/SpecialModelName.md | 10 + .../petstore/swift4/rxswift/docs/StoreAPI.md | 162 ++++ .../swift4/rxswift/docs/StringBooleanMap.md | 9 + .../petstore/swift4/rxswift/docs/Tag.md | 11 + .../swift4/rxswift/docs/TypeHolderDefault.md | 14 + .../swift4/rxswift/docs/TypeHolderExample.md | 14 + .../petstore/swift4/rxswift/docs/User.md | 17 + .../petstore/swift4/rxswift/docs/UserAPI.md | 318 ++++++++ .../petstore/swift4/unwrapRequired/README.md | 139 ++++ .../docs/AdditionalPropertiesClass.md | 11 + .../swift4/unwrapRequired/docs/Animal.md | 11 + .../swift4/unwrapRequired/docs/AnimalFarm.md | 9 + .../unwrapRequired/docs/AnotherFakeAPI.md | 60 ++ .../swift4/unwrapRequired/docs/ApiResponse.md | 12 + .../docs/ArrayOfArrayOfNumberOnly.md | 10 + .../unwrapRequired/docs/ArrayOfNumberOnly.md | 10 + .../swift4/unwrapRequired/docs/ArrayTest.md | 12 + .../unwrapRequired/docs/Capitalization.md | 15 + .../swift4/unwrapRequired/docs/Cat.md | 10 + .../swift4/unwrapRequired/docs/Category.md | 11 + .../swift4/unwrapRequired/docs/ClassModel.md | 10 + .../swift4/unwrapRequired/docs/Client.md | 10 + .../swift4/unwrapRequired/docs/Dog.md | 10 + .../swift4/unwrapRequired/docs/EnumArrays.md | 11 + .../swift4/unwrapRequired/docs/EnumClass.md | 9 + .../swift4/unwrapRequired/docs/EnumTest.md | 14 + .../swift4/unwrapRequired/docs/FakeAPI.md | 674 ++++++++++++++++ .../docs/FakeClassnameTags123API.md | 60 ++ .../swift4/unwrapRequired/docs/File.md | 10 + .../docs/FileSchemaTestClass.md | 11 + .../swift4/unwrapRequired/docs/FormatTest.md | 22 + .../unwrapRequired/docs/HasOnlyReadOnly.md | 11 + .../swift4/unwrapRequired/docs/List.md | 10 + .../swift4/unwrapRequired/docs/MapTest.md | 13 + ...dPropertiesAndAdditionalPropertiesClass.md | 12 + .../unwrapRequired/docs/Model200Response.md | 11 + .../swift4/unwrapRequired/docs/Name.md | 13 + .../swift4/unwrapRequired/docs/NumberOnly.md | 10 + .../swift4/unwrapRequired/docs/Order.md | 15 + .../unwrapRequired/docs/OuterComposite.md | 12 + .../swift4/unwrapRequired/docs/OuterEnum.md | 9 + .../swift4/unwrapRequired/docs/Pet.md | 15 + .../swift4/unwrapRequired/docs/PetAPI.md | 478 ++++++++++++ .../unwrapRequired/docs/ReadOnlyFirst.md | 11 + .../swift4/unwrapRequired/docs/Return.md | 10 + .../unwrapRequired/docs/SpecialModelName.md | 10 + .../swift4/unwrapRequired/docs/StoreAPI.md | 210 +++++ .../unwrapRequired/docs/StringBooleanMap.md | 9 + .../swift4/unwrapRequired/docs/Tag.md | 11 + .../unwrapRequired/docs/TypeHolderDefault.md | 14 + .../unwrapRequired/docs/TypeHolderExample.md | 14 + .../swift4/unwrapRequired/docs/User.md | 17 + .../swift4/unwrapRequired/docs/UserAPI.md | 414 ++++++++++ 235 files changed, 12311 insertions(+), 5 deletions(-) create mode 100644 modules/openapi-generator/src/main/resources/swift4/api_doc.mustache create mode 100644 modules/openapi-generator/src/main/resources/swift4/model_doc.mustache create mode 100644 samples/client/petstore/swift4/default/README.md create mode 100644 samples/client/petstore/swift4/default/docs/AdditionalPropertiesClass.md create mode 100644 samples/client/petstore/swift4/default/docs/Animal.md create mode 100644 samples/client/petstore/swift4/default/docs/AnimalFarm.md create mode 100644 samples/client/petstore/swift4/default/docs/AnotherFakeAPI.md create mode 100644 samples/client/petstore/swift4/default/docs/ApiResponse.md create mode 100644 samples/client/petstore/swift4/default/docs/ArrayOfArrayOfNumberOnly.md create mode 100644 samples/client/petstore/swift4/default/docs/ArrayOfNumberOnly.md create mode 100644 samples/client/petstore/swift4/default/docs/ArrayTest.md create mode 100644 samples/client/petstore/swift4/default/docs/Capitalization.md create mode 100644 samples/client/petstore/swift4/default/docs/Cat.md create mode 100644 samples/client/petstore/swift4/default/docs/Category.md create mode 100644 samples/client/petstore/swift4/default/docs/ClassModel.md create mode 100644 samples/client/petstore/swift4/default/docs/Client.md create mode 100644 samples/client/petstore/swift4/default/docs/Dog.md create mode 100644 samples/client/petstore/swift4/default/docs/EnumArrays.md create mode 100644 samples/client/petstore/swift4/default/docs/EnumClass.md create mode 100644 samples/client/petstore/swift4/default/docs/EnumTest.md create mode 100644 samples/client/petstore/swift4/default/docs/FakeAPI.md create mode 100644 samples/client/petstore/swift4/default/docs/FakeClassnameTags123API.md create mode 100644 samples/client/petstore/swift4/default/docs/File.md create mode 100644 samples/client/petstore/swift4/default/docs/FileSchemaTestClass.md create mode 100644 samples/client/petstore/swift4/default/docs/FormatTest.md create mode 100644 samples/client/petstore/swift4/default/docs/HasOnlyReadOnly.md create mode 100644 samples/client/petstore/swift4/default/docs/List.md create mode 100644 samples/client/petstore/swift4/default/docs/MapTest.md create mode 100644 samples/client/petstore/swift4/default/docs/MixedPropertiesAndAdditionalPropertiesClass.md create mode 100644 samples/client/petstore/swift4/default/docs/Model200Response.md create mode 100644 samples/client/petstore/swift4/default/docs/Name.md create mode 100644 samples/client/petstore/swift4/default/docs/NumberOnly.md create mode 100644 samples/client/petstore/swift4/default/docs/Order.md create mode 100644 samples/client/petstore/swift4/default/docs/OuterComposite.md create mode 100644 samples/client/petstore/swift4/default/docs/OuterEnum.md create mode 100644 samples/client/petstore/swift4/default/docs/Pet.md create mode 100644 samples/client/petstore/swift4/default/docs/PetAPI.md create mode 100644 samples/client/petstore/swift4/default/docs/ReadOnlyFirst.md create mode 100644 samples/client/petstore/swift4/default/docs/Return.md create mode 100644 samples/client/petstore/swift4/default/docs/SpecialModelName.md create mode 100644 samples/client/petstore/swift4/default/docs/StoreAPI.md create mode 100644 samples/client/petstore/swift4/default/docs/StringBooleanMap.md create mode 100644 samples/client/petstore/swift4/default/docs/Tag.md create mode 100644 samples/client/petstore/swift4/default/docs/TypeHolderDefault.md create mode 100644 samples/client/petstore/swift4/default/docs/TypeHolderExample.md create mode 100644 samples/client/petstore/swift4/default/docs/User.md create mode 100644 samples/client/petstore/swift4/default/docs/UserAPI.md create mode 100644 samples/client/petstore/swift4/objcCompatible/README.md create mode 100644 samples/client/petstore/swift4/objcCompatible/docs/AdditionalPropertiesAnyType.md create mode 100644 samples/client/petstore/swift4/objcCompatible/docs/AdditionalPropertiesArray.md create mode 100644 samples/client/petstore/swift4/objcCompatible/docs/AdditionalPropertiesBoolean.md create mode 100644 samples/client/petstore/swift4/objcCompatible/docs/AdditionalPropertiesClass.md create mode 100644 samples/client/petstore/swift4/objcCompatible/docs/AdditionalPropertiesInteger.md create mode 100644 samples/client/petstore/swift4/objcCompatible/docs/AdditionalPropertiesNumber.md create mode 100644 samples/client/petstore/swift4/objcCompatible/docs/AdditionalPropertiesObject.md create mode 100644 samples/client/petstore/swift4/objcCompatible/docs/AdditionalPropertiesString.md create mode 100644 samples/client/petstore/swift4/objcCompatible/docs/Animal.md create mode 100644 samples/client/petstore/swift4/objcCompatible/docs/AnotherFakeAPI.md create mode 100644 samples/client/petstore/swift4/objcCompatible/docs/ApiResponse.md create mode 100644 samples/client/petstore/swift4/objcCompatible/docs/ArrayOfArrayOfNumberOnly.md create mode 100644 samples/client/petstore/swift4/objcCompatible/docs/ArrayOfNumberOnly.md create mode 100644 samples/client/petstore/swift4/objcCompatible/docs/ArrayTest.md create mode 100644 samples/client/petstore/swift4/objcCompatible/docs/Capitalization.md create mode 100644 samples/client/petstore/swift4/objcCompatible/docs/Cat.md create mode 100644 samples/client/petstore/swift4/objcCompatible/docs/Category.md create mode 100644 samples/client/petstore/swift4/objcCompatible/docs/ClassModel.md create mode 100644 samples/client/petstore/swift4/objcCompatible/docs/Client.md create mode 100644 samples/client/petstore/swift4/objcCompatible/docs/Dog.md create mode 100644 samples/client/petstore/swift4/objcCompatible/docs/EnumArrays.md create mode 100644 samples/client/petstore/swift4/objcCompatible/docs/EnumClass.md create mode 100644 samples/client/petstore/swift4/objcCompatible/docs/EnumTest.md create mode 100644 samples/client/petstore/swift4/objcCompatible/docs/FakeAPI.md create mode 100644 samples/client/petstore/swift4/objcCompatible/docs/FakeClassnameTags123API.md create mode 100644 samples/client/petstore/swift4/objcCompatible/docs/File.md create mode 100644 samples/client/petstore/swift4/objcCompatible/docs/FileSchemaTestClass.md create mode 100644 samples/client/petstore/swift4/objcCompatible/docs/FormatTest.md create mode 100644 samples/client/petstore/swift4/objcCompatible/docs/HasOnlyReadOnly.md create mode 100644 samples/client/petstore/swift4/objcCompatible/docs/List.md create mode 100644 samples/client/petstore/swift4/objcCompatible/docs/MapTest.md create mode 100644 samples/client/petstore/swift4/objcCompatible/docs/MixedPropertiesAndAdditionalPropertiesClass.md create mode 100644 samples/client/petstore/swift4/objcCompatible/docs/Model200Response.md create mode 100644 samples/client/petstore/swift4/objcCompatible/docs/Name.md create mode 100644 samples/client/petstore/swift4/objcCompatible/docs/NumberOnly.md create mode 100644 samples/client/petstore/swift4/objcCompatible/docs/Order.md create mode 100644 samples/client/petstore/swift4/objcCompatible/docs/OuterComposite.md create mode 100644 samples/client/petstore/swift4/objcCompatible/docs/OuterEnum.md create mode 100644 samples/client/petstore/swift4/objcCompatible/docs/Pet.md create mode 100644 samples/client/petstore/swift4/objcCompatible/docs/PetAPI.md create mode 100644 samples/client/petstore/swift4/objcCompatible/docs/ReadOnlyFirst.md create mode 100644 samples/client/petstore/swift4/objcCompatible/docs/Return.md create mode 100644 samples/client/petstore/swift4/objcCompatible/docs/SpecialModelName.md create mode 100644 samples/client/petstore/swift4/objcCompatible/docs/StoreAPI.md create mode 100644 samples/client/petstore/swift4/objcCompatible/docs/Tag.md create mode 100644 samples/client/petstore/swift4/objcCompatible/docs/TypeHolderDefault.md create mode 100644 samples/client/petstore/swift4/objcCompatible/docs/TypeHolderExample.md create mode 100644 samples/client/petstore/swift4/objcCompatible/docs/User.md create mode 100644 samples/client/petstore/swift4/objcCompatible/docs/UserAPI.md create mode 100644 samples/client/petstore/swift4/objcCompatible/docs/XmlItem.md create mode 100644 samples/client/petstore/swift4/promisekit/README.md create mode 100644 samples/client/petstore/swift4/promisekit/docs/AdditionalPropertiesClass.md create mode 100644 samples/client/petstore/swift4/promisekit/docs/Animal.md create mode 100644 samples/client/petstore/swift4/promisekit/docs/AnimalFarm.md create mode 100644 samples/client/petstore/swift4/promisekit/docs/AnotherFakeAPI.md create mode 100644 samples/client/petstore/swift4/promisekit/docs/ApiResponse.md create mode 100644 samples/client/petstore/swift4/promisekit/docs/ArrayOfArrayOfNumberOnly.md create mode 100644 samples/client/petstore/swift4/promisekit/docs/ArrayOfNumberOnly.md create mode 100644 samples/client/petstore/swift4/promisekit/docs/ArrayTest.md create mode 100644 samples/client/petstore/swift4/promisekit/docs/Capitalization.md create mode 100644 samples/client/petstore/swift4/promisekit/docs/Cat.md create mode 100644 samples/client/petstore/swift4/promisekit/docs/Category.md create mode 100644 samples/client/petstore/swift4/promisekit/docs/ClassModel.md create mode 100644 samples/client/petstore/swift4/promisekit/docs/Client.md create mode 100644 samples/client/petstore/swift4/promisekit/docs/Dog.md create mode 100644 samples/client/petstore/swift4/promisekit/docs/EnumArrays.md create mode 100644 samples/client/petstore/swift4/promisekit/docs/EnumClass.md create mode 100644 samples/client/petstore/swift4/promisekit/docs/EnumTest.md create mode 100644 samples/client/petstore/swift4/promisekit/docs/FakeAPI.md create mode 100644 samples/client/petstore/swift4/promisekit/docs/FakeClassnameTags123API.md create mode 100644 samples/client/petstore/swift4/promisekit/docs/File.md create mode 100644 samples/client/petstore/swift4/promisekit/docs/FileSchemaTestClass.md create mode 100644 samples/client/petstore/swift4/promisekit/docs/FormatTest.md create mode 100644 samples/client/petstore/swift4/promisekit/docs/HasOnlyReadOnly.md create mode 100644 samples/client/petstore/swift4/promisekit/docs/List.md create mode 100644 samples/client/petstore/swift4/promisekit/docs/MapTest.md create mode 100644 samples/client/petstore/swift4/promisekit/docs/MixedPropertiesAndAdditionalPropertiesClass.md create mode 100644 samples/client/petstore/swift4/promisekit/docs/Model200Response.md create mode 100644 samples/client/petstore/swift4/promisekit/docs/Name.md create mode 100644 samples/client/petstore/swift4/promisekit/docs/NumberOnly.md create mode 100644 samples/client/petstore/swift4/promisekit/docs/Order.md create mode 100644 samples/client/petstore/swift4/promisekit/docs/OuterComposite.md create mode 100644 samples/client/petstore/swift4/promisekit/docs/OuterEnum.md create mode 100644 samples/client/petstore/swift4/promisekit/docs/Pet.md create mode 100644 samples/client/petstore/swift4/promisekit/docs/PetAPI.md create mode 100644 samples/client/petstore/swift4/promisekit/docs/ReadOnlyFirst.md create mode 100644 samples/client/petstore/swift4/promisekit/docs/Return.md create mode 100644 samples/client/petstore/swift4/promisekit/docs/SpecialModelName.md create mode 100644 samples/client/petstore/swift4/promisekit/docs/StoreAPI.md create mode 100644 samples/client/petstore/swift4/promisekit/docs/StringBooleanMap.md create mode 100644 samples/client/petstore/swift4/promisekit/docs/Tag.md create mode 100644 samples/client/petstore/swift4/promisekit/docs/TypeHolderDefault.md create mode 100644 samples/client/petstore/swift4/promisekit/docs/TypeHolderExample.md create mode 100644 samples/client/petstore/swift4/promisekit/docs/User.md create mode 100644 samples/client/petstore/swift4/promisekit/docs/UserAPI.md create mode 100644 samples/client/petstore/swift4/rxswift/README.md create mode 100644 samples/client/petstore/swift4/rxswift/docs/AdditionalPropertiesClass.md create mode 100644 samples/client/petstore/swift4/rxswift/docs/Animal.md create mode 100644 samples/client/petstore/swift4/rxswift/docs/AnimalFarm.md create mode 100644 samples/client/petstore/swift4/rxswift/docs/AnotherFakeAPI.md create mode 100644 samples/client/petstore/swift4/rxswift/docs/ApiResponse.md create mode 100644 samples/client/petstore/swift4/rxswift/docs/ArrayOfArrayOfNumberOnly.md create mode 100644 samples/client/petstore/swift4/rxswift/docs/ArrayOfNumberOnly.md create mode 100644 samples/client/petstore/swift4/rxswift/docs/ArrayTest.md create mode 100644 samples/client/petstore/swift4/rxswift/docs/Capitalization.md create mode 100644 samples/client/petstore/swift4/rxswift/docs/Cat.md create mode 100644 samples/client/petstore/swift4/rxswift/docs/Category.md create mode 100644 samples/client/petstore/swift4/rxswift/docs/ClassModel.md create mode 100644 samples/client/petstore/swift4/rxswift/docs/Client.md create mode 100644 samples/client/petstore/swift4/rxswift/docs/Dog.md create mode 100644 samples/client/petstore/swift4/rxswift/docs/EnumArrays.md create mode 100644 samples/client/petstore/swift4/rxswift/docs/EnumClass.md create mode 100644 samples/client/petstore/swift4/rxswift/docs/EnumTest.md create mode 100644 samples/client/petstore/swift4/rxswift/docs/FakeAPI.md create mode 100644 samples/client/petstore/swift4/rxswift/docs/FakeClassnameTags123API.md create mode 100644 samples/client/petstore/swift4/rxswift/docs/File.md create mode 100644 samples/client/petstore/swift4/rxswift/docs/FileSchemaTestClass.md create mode 100644 samples/client/petstore/swift4/rxswift/docs/FormatTest.md create mode 100644 samples/client/petstore/swift4/rxswift/docs/HasOnlyReadOnly.md create mode 100644 samples/client/petstore/swift4/rxswift/docs/List.md create mode 100644 samples/client/petstore/swift4/rxswift/docs/MapTest.md create mode 100644 samples/client/petstore/swift4/rxswift/docs/MixedPropertiesAndAdditionalPropertiesClass.md create mode 100644 samples/client/petstore/swift4/rxswift/docs/Model200Response.md create mode 100644 samples/client/petstore/swift4/rxswift/docs/Name.md create mode 100644 samples/client/petstore/swift4/rxswift/docs/NumberOnly.md create mode 100644 samples/client/petstore/swift4/rxswift/docs/Order.md create mode 100644 samples/client/petstore/swift4/rxswift/docs/OuterComposite.md create mode 100644 samples/client/petstore/swift4/rxswift/docs/OuterEnum.md create mode 100644 samples/client/petstore/swift4/rxswift/docs/Pet.md create mode 100644 samples/client/petstore/swift4/rxswift/docs/PetAPI.md create mode 100644 samples/client/petstore/swift4/rxswift/docs/ReadOnlyFirst.md create mode 100644 samples/client/petstore/swift4/rxswift/docs/Return.md create mode 100644 samples/client/petstore/swift4/rxswift/docs/SpecialModelName.md create mode 100644 samples/client/petstore/swift4/rxswift/docs/StoreAPI.md create mode 100644 samples/client/petstore/swift4/rxswift/docs/StringBooleanMap.md create mode 100644 samples/client/petstore/swift4/rxswift/docs/Tag.md create mode 100644 samples/client/petstore/swift4/rxswift/docs/TypeHolderDefault.md create mode 100644 samples/client/petstore/swift4/rxswift/docs/TypeHolderExample.md create mode 100644 samples/client/petstore/swift4/rxswift/docs/User.md create mode 100644 samples/client/petstore/swift4/rxswift/docs/UserAPI.md create mode 100644 samples/client/petstore/swift4/unwrapRequired/README.md create mode 100644 samples/client/petstore/swift4/unwrapRequired/docs/AdditionalPropertiesClass.md create mode 100644 samples/client/petstore/swift4/unwrapRequired/docs/Animal.md create mode 100644 samples/client/petstore/swift4/unwrapRequired/docs/AnimalFarm.md create mode 100644 samples/client/petstore/swift4/unwrapRequired/docs/AnotherFakeAPI.md create mode 100644 samples/client/petstore/swift4/unwrapRequired/docs/ApiResponse.md create mode 100644 samples/client/petstore/swift4/unwrapRequired/docs/ArrayOfArrayOfNumberOnly.md create mode 100644 samples/client/petstore/swift4/unwrapRequired/docs/ArrayOfNumberOnly.md create mode 100644 samples/client/petstore/swift4/unwrapRequired/docs/ArrayTest.md create mode 100644 samples/client/petstore/swift4/unwrapRequired/docs/Capitalization.md create mode 100644 samples/client/petstore/swift4/unwrapRequired/docs/Cat.md create mode 100644 samples/client/petstore/swift4/unwrapRequired/docs/Category.md create mode 100644 samples/client/petstore/swift4/unwrapRequired/docs/ClassModel.md create mode 100644 samples/client/petstore/swift4/unwrapRequired/docs/Client.md create mode 100644 samples/client/petstore/swift4/unwrapRequired/docs/Dog.md create mode 100644 samples/client/petstore/swift4/unwrapRequired/docs/EnumArrays.md create mode 100644 samples/client/petstore/swift4/unwrapRequired/docs/EnumClass.md create mode 100644 samples/client/petstore/swift4/unwrapRequired/docs/EnumTest.md create mode 100644 samples/client/petstore/swift4/unwrapRequired/docs/FakeAPI.md create mode 100644 samples/client/petstore/swift4/unwrapRequired/docs/FakeClassnameTags123API.md create mode 100644 samples/client/petstore/swift4/unwrapRequired/docs/File.md create mode 100644 samples/client/petstore/swift4/unwrapRequired/docs/FileSchemaTestClass.md create mode 100644 samples/client/petstore/swift4/unwrapRequired/docs/FormatTest.md create mode 100644 samples/client/petstore/swift4/unwrapRequired/docs/HasOnlyReadOnly.md create mode 100644 samples/client/petstore/swift4/unwrapRequired/docs/List.md create mode 100644 samples/client/petstore/swift4/unwrapRequired/docs/MapTest.md create mode 100644 samples/client/petstore/swift4/unwrapRequired/docs/MixedPropertiesAndAdditionalPropertiesClass.md create mode 100644 samples/client/petstore/swift4/unwrapRequired/docs/Model200Response.md create mode 100644 samples/client/petstore/swift4/unwrapRequired/docs/Name.md create mode 100644 samples/client/petstore/swift4/unwrapRequired/docs/NumberOnly.md create mode 100644 samples/client/petstore/swift4/unwrapRequired/docs/Order.md create mode 100644 samples/client/petstore/swift4/unwrapRequired/docs/OuterComposite.md create mode 100644 samples/client/petstore/swift4/unwrapRequired/docs/OuterEnum.md create mode 100644 samples/client/petstore/swift4/unwrapRequired/docs/Pet.md create mode 100644 samples/client/petstore/swift4/unwrapRequired/docs/PetAPI.md create mode 100644 samples/client/petstore/swift4/unwrapRequired/docs/ReadOnlyFirst.md create mode 100644 samples/client/petstore/swift4/unwrapRequired/docs/Return.md create mode 100644 samples/client/petstore/swift4/unwrapRequired/docs/SpecialModelName.md create mode 100644 samples/client/petstore/swift4/unwrapRequired/docs/StoreAPI.md create mode 100644 samples/client/petstore/swift4/unwrapRequired/docs/StringBooleanMap.md create mode 100644 samples/client/petstore/swift4/unwrapRequired/docs/Tag.md create mode 100644 samples/client/petstore/swift4/unwrapRequired/docs/TypeHolderDefault.md create mode 100644 samples/client/petstore/swift4/unwrapRequired/docs/TypeHolderExample.md create mode 100644 samples/client/petstore/swift4/unwrapRequired/docs/User.md create mode 100644 samples/client/petstore/swift4/unwrapRequired/docs/UserAPI.md diff --git a/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/Swift4Codegen.java b/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/Swift4Codegen.java index 84bc225f3f18..0f5c4c3ab0d8 100644 --- a/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/Swift4Codegen.java +++ b/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/Swift4Codegen.java @@ -67,6 +67,8 @@ public class Swift4Codegen extends DefaultCodegen implements CodegenConfig { protected String[] responseAs = new String[0]; protected String sourceFolder = "Classes" + File.separator + "OpenAPIs"; protected HashSet objcReservedWords; + protected String apiDocPath = "docs/"; + protected String modelDocPath = "docs/"; /** * Constructor for the swift4 language codegen module. @@ -79,6 +81,8 @@ public Swift4Codegen() { embeddedTemplateDir = templateDir = "swift4"; apiPackage = File.separator + "APIs"; modelPackage = File.separator + "Models"; + modelDocTemplateFiles.put("model_doc.mustache", ".md"); + apiDocTemplateFiles.put("api_doc.mustache", ".md"); languageSpecificPrimitives = new HashSet<>( Arrays.asList( @@ -365,6 +369,10 @@ public void processOpts() { setLenientTypeCast(convertPropertyToBooleanAndWriteBack(LENIENT_TYPE_CAST)); + // make api and model doc path available in mustache template + additionalProperties.put("apiDocPath", apiDocPath); + additionalProperties.put("modelDocPath", modelDocPath); + supportingFiles.add(new SupportingFile("Podspec.mustache", "", projectName + ".podspec")); @@ -404,6 +412,9 @@ public void processOpts() { supportingFiles.add(new SupportingFile("gitignore.mustache", "", ".gitignore")); + supportingFiles.add(new SupportingFile("README.mustache", + "", + "README.md")); } @@ -565,6 +576,26 @@ public String toApiName(String name) { return camelize(name) + "API"; } + @Override + public String apiDocFileFolder() { + return (outputFolder + "/" + apiDocPath).replace("/", File.separator); + } + + @Override + public String modelDocFileFolder() { + return (outputFolder + "/" + modelDocPath).replace("/", File.separator); + } + + @Override + public String toModelDocFilename(String name) { + return toModelName(name); + } + + @Override + public String toApiDocFilename(String name) { + return toApiName(name); + } + @Override public String toOperationId(String operationId) { operationId = camelize(sanitizeName(operationId), true); @@ -880,4 +911,96 @@ public void postProcessFile(File file, String fileType) { } } } + + @Override + public Map postProcessOperationsWithModels(Map objs, List allModels) { + Map objectMap = (Map) objs.get("operations"); + + HashMap modelMaps = new HashMap(); + for (Object o : allModels) { + HashMap h = (HashMap) o; + CodegenModel m = (CodegenModel) h.get("model"); + modelMaps.put(m.classname, m); + } + + List operations = (List) objectMap.get("operation"); + for (CodegenOperation operation : operations) { + for (CodegenParameter cp : operation.allParams) { + cp.vendorExtensions.put("x-swift-example", constructExampleCode(cp, modelMaps)); + } + } + return objs; + } + + public String constructExampleCode(CodegenParameter codegenParameter, HashMap modelMaps) { + if (codegenParameter.isListContainer) { // array + return "[" + constructExampleCode(codegenParameter.items, modelMaps) + "]"; + } else if (codegenParameter.isMapContainer || codegenParameter.isFile) { // TODO: map, file type + return "\"TODO\""; + } else if (languageSpecificPrimitives.contains(codegenParameter.dataType)) { // primitive type + if ("String".equals(codegenParameter.dataType) || "Character".equals(codegenParameter.dataType)) { + if (StringUtils.isEmpty(codegenParameter.example)) { + return "\"" + codegenParameter.example + "\""; + } else { + return "\"" + codegenParameter.paramName + "_example\""; + } + } else { // numeric + if (StringUtils.isEmpty(codegenParameter.example)) { + return codegenParameter.example; + } else { + return "987"; + } + } + } else { // model + // look up the model + if (modelMaps.containsKey(codegenParameter.dataType)) { + return constructExampleCode(modelMaps.get(codegenParameter.dataType), modelMaps); + } else { + //LOGGER.error("Error in constructing examples. Failed to look up the model " + codegenParameter.dataType); + return "TODO"; + } + } + } + + public String constructExampleCode(CodegenProperty codegenProperty, HashMap modelMaps) { + if (codegenProperty.isListContainer) { // array + return "[" + constructExampleCode(codegenProperty.items, modelMaps) + "]"; + } else if (codegenProperty.isMapContainer || codegenProperty.isFile) { // TODO: map, file type + return "\"TODO\""; + } else if (languageSpecificPrimitives.contains(codegenProperty.dataType)) { // primitive type + if ("String".equals(codegenProperty.dataType) || "Character".equals(codegenProperty.dataType)) { + if (StringUtils.isEmpty(codegenProperty.example)) { + return "\"" + codegenProperty.example + "\""; + } else { + return "\"" + codegenProperty.name + "_example\""; + } + } else { // numeric + if (StringUtils.isEmpty(codegenProperty.example)) { + return codegenProperty.example; + } else { + return "123"; + } + } + } else { + // look up the model + if (modelMaps.containsKey(codegenProperty.dataType)) { + return constructExampleCode(modelMaps.get(codegenProperty.dataType), modelMaps); + } else { + //LOGGER.error("Error in constructing examples. Failed to look up the model " + codegenProperty.dataType); + return "\"TODO\""; + } + } + } + + public String constructExampleCode(CodegenModel codegenModel, HashMap modelMaps) { + String example; + example = codegenModel.name + "("; + List propertyExamples = new ArrayList<>(); + for (CodegenProperty codegenProperty : codegenModel.vars) { + propertyExamples.add(constructExampleCode(codegenProperty, modelMaps)); + } + example += StringUtils.join(propertyExamples, ", "); + example += ")"; + return example; + } } diff --git a/modules/openapi-generator/src/main/resources/swift4/README.mustache b/modules/openapi-generator/src/main/resources/swift4/README.mustache index 99f1e0b441ab..8fe60510aa88 100644 --- a/modules/openapi-generator/src/main/resources/swift4/README.mustache +++ b/modules/openapi-generator/src/main/resources/swift4/README.mustache @@ -1,4 +1,4 @@ -# Swift4 API client for {{packageName}} +# Swift4 API client for {{{projectName}}} {{#appDescription}} {{{appDescription}}} @@ -18,10 +18,14 @@ For more information, please visit [{{{infoUrl}}}]({{{infoUrl}}}) {{/infoUrl}} ## Installation -Put the package under your project folder and add the following in import: -``` - "./{{packageName}}" -``` + +### Carthage + +Run `carthage update` + +### CocoaPods + +Run `pod install` ## Documentation for API Endpoints diff --git a/modules/openapi-generator/src/main/resources/swift4/api_doc.mustache b/modules/openapi-generator/src/main/resources/swift4/api_doc.mustache new file mode 100644 index 000000000000..2a0092db9d32 --- /dev/null +++ b/modules/openapi-generator/src/main/resources/swift4/api_doc.mustache @@ -0,0 +1,94 @@ +# {{classname}}{{#description}} +{{description}}{{/description}} + +All URIs are relative to *{{{basePath}}}* + +Method | HTTP request | Description +------------- | ------------- | ------------- +{{#operations}}{{#operation}}[**{{operationId}}**]({{classname}}.md#{{operationIdLowerCase}}) | **{{httpMethod}}** {{path}} | {{#summary}}{{summary}}{{/summary}} +{{/operation}}{{/operations}} + +{{#operations}} +{{#operation}} +# **{{{operationId}}}** +```swift +{{^usePromiseKit}} +{{^useRxSwift}} + open class func {{operationId}}({{#allParams}}{{paramName}}: {{#isEnum}}{{#isContainer}}{{{dataType}}}{{/isContainer}}{{^isContainer}}{{{datatypeWithEnum}}}_{{operationId}}{{/isContainer}}{{/isEnum}}{{^isEnum}}{{{dataType}}}{{/isEnum}}{{^required}}? = nil{{/required}}{{#hasMore}}, {{/hasMore}}{{/allParams}}{{#hasParams}}, {{/hasParams}}completion: @escaping ((_ data: {{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}Void{{/returnType}}?,_ error: Error?) -> Void)) +{{/useRxSwift}} +{{/usePromiseKit}} +{{#usePromiseKit}} + open class func {{operationId}}({{#allParams}} {{paramName}}: {{#isEnum}}{{#isContainer}}{{{dataType}}}{{/isContainer}}{{^isContainer}}{{{datatypeWithEnum}}}_{{operationId}}{{/isContainer}}{{/isEnum}}{{^isEnum}}{{{dataType}}}{{/isEnum}}{{^required}}? = nil{{/required}}{{#hasMore}}, {{/hasMore}}{{/allParams}}) -> Promise<{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}Void{{/returnType}}> +{{/usePromiseKit}} +{{#useRxSwift}} + open class func {{operationId}}({{#allParams}}{{paramName}}: {{#isEnum}}{{#isContainer}}{{{dataType}}}{{/isContainer}}{{^isContainer}}{{{datatypeWithEnum}}}_{{operationId}}{{/isContainer}}{{/isEnum}}{{^isEnum}}{{{dataType}}}{{/isEnum}}{{^required}}? = nil{{/required}}{{#hasMore}}, {{/hasMore}}{{/allParams}}) -> Observable<{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}Void{{/returnType}}> +{{/useRxSwift}} +``` + +{{{summary}}}{{#notes}} + +{{{notes}}}{{/notes}} + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import {{{projectName}}} + +{{#allParams}}let {{paramName}} = {{{vendorExtensions.x-swift-example}}} // {{{dataType}}} | {{{description}}}{{^required}} (optional){{/required}}{{#defaultValue}} (default to {{{.}}}){{/defaultValue}} +{{/allParams}} + +{{^usePromiseKit}} +{{^useRxSwift}} +{{#summary}}// {{{.}}} +{{/summary}}{{classname}}.{{{operationId}}}({{#allParams}}{{paramName}}: {{paramName}}{{#hasMore}}, {{/hasMore}}{{/allParams}}) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +{{/useRxSwift}} +{{/usePromiseKit}} +{{#usePromiseKit}} +{{#summary}}// {{{.}}} +{{/summary}}{{classname}}.{{{operationId}}}({{#allParams}}{{paramName}}: {{paramName}}{{#hasMore}}, {{/hasMore}}{{/allParams}}).then { + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected + } +} +{{/usePromiseKit}} +{{^useRxSwift}} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +{{/useRxSwift}} +``` + +### Parameters +{{^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}}**]({{baseType}}.md){{/isFile}}{{/isPrimitiveType}}| {{description}} | {{^required}}[optional] {{/required}}{{#defaultValue}}[default to {{defaultValue}}]{{/defaultValue}} +{{/allParams}} + +### Return type + +{{#returnType}}{{#returnTypeIsPrimitive}}**{{{returnType}}}**{{/returnTypeIsPrimitive}}{{^returnTypeIsPrimitive}}[**{{{returnType}}}**]({{returnBaseType}}.md){{/returnTypeIsPrimitive}}{{/returnType}}{{^returnType}}void (empty response body){{/returnType}} + +### Authorization + +{{^authMethods}}No authorization required{{/authMethods}}{{#authMethods}}[{{{name}}}](../README.md#{{{name}}}){{^-last}}, {{/-last}}{{/authMethods}} + +### HTTP request headers + + - **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}} diff --git a/modules/openapi-generator/src/main/resources/swift4/model_doc.mustache b/modules/openapi-generator/src/main/resources/swift4/model_doc.mustache new file mode 100644 index 000000000000..0216a3372cdb --- /dev/null +++ b/modules/openapi-generator/src/main/resources/swift4/model_doc.mustache @@ -0,0 +1,11 @@ +{{#models}}{{#model}}# {{classname}} + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +{{#vars}}**{{name}}** | {{#isPrimitiveType}}**{{dataType}}**{{/isPrimitiveType}}{{^isPrimitiveType}}[**{{dataType}}**]({{complexType}}.md){{/isPrimitiveType}} | {{description}} | {{^required}}[optional] {{/required}}{{#readOnly}}[readonly] {{/readOnly}}{{#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}} diff --git a/samples/client/petstore/swift4/default/README.md b/samples/client/petstore/swift4/default/README.md new file mode 100644 index 000000000000..1e7f0a59ea01 --- /dev/null +++ b/samples/client/petstore/swift4/default/README.md @@ -0,0 +1,139 @@ +# Swift4 API client for PetstoreClient + +This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\ + +## Overview +This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [openapi-spec from a remote server, you can easily generate an API client. + +- API version: 1.0.0 +- Package version: +- Build package: org.openapitools.codegen.languages.Swift4Codegen + +## Installation + +### Carthage + +Run `carthage update` + +### CocoaPods + +Run `pod install` + +## Documentation for API Endpoints + +All URIs are relative to *http://petstore.swagger.io:80/v2* + +Class | Method | HTTP request | Description +------------ | ------------- | ------------- | ------------- +*AnotherFakeAPI* | [**call123testSpecialTags**](docs/AnotherFakeAPI.md#call123testspecialtags) | **PATCH** /another-fake/dummy | To test special tags +*FakeAPI* | [**fakeOuterBooleanSerialize**](docs/FakeAPI.md#fakeouterbooleanserialize) | **POST** /fake/outer/boolean | +*FakeAPI* | [**fakeOuterCompositeSerialize**](docs/FakeAPI.md#fakeoutercompositeserialize) | **POST** /fake/outer/composite | +*FakeAPI* | [**fakeOuterNumberSerialize**](docs/FakeAPI.md#fakeouternumberserialize) | **POST** /fake/outer/number | +*FakeAPI* | [**fakeOuterStringSerialize**](docs/FakeAPI.md#fakeouterstringserialize) | **POST** /fake/outer/string | +*FakeAPI* | [**testBodyWithFileSchema**](docs/FakeAPI.md#testbodywithfileschema) | **PUT** /fake/body-with-file-schema | +*FakeAPI* | [**testBodyWithQueryParams**](docs/FakeAPI.md#testbodywithqueryparams) | **PUT** /fake/body-with-query-params | +*FakeAPI* | [**testClientModel**](docs/FakeAPI.md#testclientmodel) | **PATCH** /fake | To test \"client\" model +*FakeAPI* | [**testEndpointParameters**](docs/FakeAPI.md#testendpointparameters) | **POST** /fake | Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 +*FakeAPI* | [**testEnumParameters**](docs/FakeAPI.md#testenumparameters) | **GET** /fake | To test enum parameters +*FakeAPI* | [**testGroupParameters**](docs/FakeAPI.md#testgroupparameters) | **DELETE** /fake | Fake endpoint to test group parameters (optional) +*FakeAPI* | [**testInlineAdditionalProperties**](docs/FakeAPI.md#testinlineadditionalproperties) | **POST** /fake/inline-additionalProperties | test inline additionalProperties +*FakeAPI* | [**testJsonFormData**](docs/FakeAPI.md#testjsonformdata) | **GET** /fake/jsonFormData | test json serialization of form data +*FakeClassnameTags123API* | [**testClassname**](docs/FakeClassnameTags123API.md#testclassname) | **PATCH** /fake_classname_test | To test class name in snake case +*PetAPI* | [**addPet**](docs/PetAPI.md#addpet) | **POST** /pet | Add a new pet to the store +*PetAPI* | [**deletePet**](docs/PetAPI.md#deletepet) | **DELETE** /pet/{petId} | Deletes a pet +*PetAPI* | [**findPetsByStatus**](docs/PetAPI.md#findpetsbystatus) | **GET** /pet/findByStatus | Finds Pets by status +*PetAPI* | [**findPetsByTags**](docs/PetAPI.md#findpetsbytags) | **GET** /pet/findByTags | Finds Pets by tags +*PetAPI* | [**getPetById**](docs/PetAPI.md#getpetbyid) | **GET** /pet/{petId} | Find pet by ID +*PetAPI* | [**updatePet**](docs/PetAPI.md#updatepet) | **PUT** /pet | Update an existing pet +*PetAPI* | [**updatePetWithForm**](docs/PetAPI.md#updatepetwithform) | **POST** /pet/{petId} | Updates a pet in the store with form data +*PetAPI* | [**uploadFile**](docs/PetAPI.md#uploadfile) | **POST** /pet/{petId}/uploadImage | uploads an image +*PetAPI* | [**uploadFileWithRequiredFile**](docs/PetAPI.md#uploadfilewithrequiredfile) | **POST** /fake/{petId}/uploadImageWithRequiredFile | uploads an image (required) +*StoreAPI* | [**deleteOrder**](docs/StoreAPI.md#deleteorder) | **DELETE** /store/order/{order_id} | Delete purchase order by ID +*StoreAPI* | [**getInventory**](docs/StoreAPI.md#getinventory) | **GET** /store/inventory | Returns pet inventories by status +*StoreAPI* | [**getOrderById**](docs/StoreAPI.md#getorderbyid) | **GET** /store/order/{order_id} | Find purchase order by ID +*StoreAPI* | [**placeOrder**](docs/StoreAPI.md#placeorder) | **POST** /store/order | Place an order for a pet +*UserAPI* | [**createUser**](docs/UserAPI.md#createuser) | **POST** /user | Create user +*UserAPI* | [**createUsersWithArrayInput**](docs/UserAPI.md#createuserswitharrayinput) | **POST** /user/createWithArray | Creates list of users with given input array +*UserAPI* | [**createUsersWithListInput**](docs/UserAPI.md#createuserswithlistinput) | **POST** /user/createWithList | Creates list of users with given input array +*UserAPI* | [**deleteUser**](docs/UserAPI.md#deleteuser) | **DELETE** /user/{username} | Delete user +*UserAPI* | [**getUserByName**](docs/UserAPI.md#getuserbyname) | **GET** /user/{username} | Get user by user name +*UserAPI* | [**loginUser**](docs/UserAPI.md#loginuser) | **GET** /user/login | Logs user into the system +*UserAPI* | [**logoutUser**](docs/UserAPI.md#logoutuser) | **GET** /user/logout | Logs out current logged in user session +*UserAPI* | [**updateUser**](docs/UserAPI.md#updateuser) | **PUT** /user/{username} | Updated user + + +## Documentation For Models + + - [AdditionalPropertiesClass](docs/AdditionalPropertiesClass.md) + - [Animal](docs/Animal.md) + - [AnimalFarm](docs/AnimalFarm.md) + - [ApiResponse](docs/ApiResponse.md) + - [ArrayOfArrayOfNumberOnly](docs/ArrayOfArrayOfNumberOnly.md) + - [ArrayOfNumberOnly](docs/ArrayOfNumberOnly.md) + - [ArrayTest](docs/ArrayTest.md) + - [Capitalization](docs/Capitalization.md) + - [Cat](docs/Cat.md) + - [Category](docs/Category.md) + - [ClassModel](docs/ClassModel.md) + - [Client](docs/Client.md) + - [Dog](docs/Dog.md) + - [EnumArrays](docs/EnumArrays.md) + - [EnumClass](docs/EnumClass.md) + - [EnumTest](docs/EnumTest.md) + - [File](docs/File.md) + - [FileSchemaTestClass](docs/FileSchemaTestClass.md) + - [FormatTest](docs/FormatTest.md) + - [HasOnlyReadOnly](docs/HasOnlyReadOnly.md) + - [List](docs/List.md) + - [MapTest](docs/MapTest.md) + - [MixedPropertiesAndAdditionalPropertiesClass](docs/MixedPropertiesAndAdditionalPropertiesClass.md) + - [Model200Response](docs/Model200Response.md) + - [Name](docs/Name.md) + - [NumberOnly](docs/NumberOnly.md) + - [Order](docs/Order.md) + - [OuterComposite](docs/OuterComposite.md) + - [OuterEnum](docs/OuterEnum.md) + - [Pet](docs/Pet.md) + - [ReadOnlyFirst](docs/ReadOnlyFirst.md) + - [Return](docs/Return.md) + - [SpecialModelName](docs/SpecialModelName.md) + - [StringBooleanMap](docs/StringBooleanMap.md) + - [Tag](docs/Tag.md) + - [TypeHolderDefault](docs/TypeHolderDefault.md) + - [TypeHolderExample](docs/TypeHolderExample.md) + - [User](docs/User.md) + + +## Documentation For Authorization + + +## api_key + +- **Type**: API key +- **API key parameter name**: api_key +- **Location**: HTTP header + +## api_key_query + +- **Type**: API key +- **API key parameter name**: api_key_query +- **Location**: URL query string + +## http_basic_test + +- **Type**: HTTP basic authentication + +## petstore_auth + +- **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 + + +## Author + + + diff --git a/samples/client/petstore/swift4/default/docs/AdditionalPropertiesClass.md b/samples/client/petstore/swift4/default/docs/AdditionalPropertiesClass.md new file mode 100644 index 000000000000..a524730eb652 --- /dev/null +++ b/samples/client/petstore/swift4/default/docs/AdditionalPropertiesClass.md @@ -0,0 +1,11 @@ +# AdditionalPropertiesClass + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**mapString** | **[String:String]** | | [optional] +**mapMapString** | [**[String:[String:String]]**](Dictionary.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) + + diff --git a/samples/client/petstore/swift4/default/docs/Animal.md b/samples/client/petstore/swift4/default/docs/Animal.md new file mode 100644 index 000000000000..69c601455cd8 --- /dev/null +++ b/samples/client/petstore/swift4/default/docs/Animal.md @@ -0,0 +1,11 @@ +# Animal + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**className** | **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) + + diff --git a/samples/client/petstore/swift4/default/docs/AnimalFarm.md b/samples/client/petstore/swift4/default/docs/AnimalFarm.md new file mode 100644 index 000000000000..df6bab21dae8 --- /dev/null +++ b/samples/client/petstore/swift4/default/docs/AnimalFarm.md @@ -0,0 +1,9 @@ +# AnimalFarm + +## Properties +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) + + diff --git a/samples/client/petstore/swift4/default/docs/AnotherFakeAPI.md b/samples/client/petstore/swift4/default/docs/AnotherFakeAPI.md new file mode 100644 index 000000000000..f6fc23dd02b3 --- /dev/null +++ b/samples/client/petstore/swift4/default/docs/AnotherFakeAPI.md @@ -0,0 +1,60 @@ +# AnotherFakeAPI + +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** +```swift + open class func call123testSpecialTags(body: Client, completion: @escaping ((_ data: Client?,_ error: Error?) -> Void)) +``` + +To test special tags + +To test special tags and operation ID starting with number + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = Client("client_example") // Client | client model + +// To test special tags +AnotherFakeAPI.call123testSpecialTags(body: body) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**Client**](Client.md)| client model | + +### Return type + +[**Client**](Client.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + diff --git a/samples/client/petstore/swift4/default/docs/ApiResponse.md b/samples/client/petstore/swift4/default/docs/ApiResponse.md new file mode 100644 index 000000000000..c6d9768fe9bf --- /dev/null +++ b/samples/client/petstore/swift4/default/docs/ApiResponse.md @@ -0,0 +1,12 @@ +# ApiResponse + +## Properties +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) + + diff --git a/samples/client/petstore/swift4/default/docs/ArrayOfArrayOfNumberOnly.md b/samples/client/petstore/swift4/default/docs/ArrayOfArrayOfNumberOnly.md new file mode 100644 index 000000000000..3f78a9584d82 --- /dev/null +++ b/samples/client/petstore/swift4/default/docs/ArrayOfArrayOfNumberOnly.md @@ -0,0 +1,10 @@ +# ArrayOfArrayOfNumberOnly + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**arrayArrayNumber** | [**[[Double]]**](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) + + diff --git a/samples/client/petstore/swift4/default/docs/ArrayOfNumberOnly.md b/samples/client/petstore/swift4/default/docs/ArrayOfNumberOnly.md new file mode 100644 index 000000000000..f09f8fa6f70f --- /dev/null +++ b/samples/client/petstore/swift4/default/docs/ArrayOfNumberOnly.md @@ -0,0 +1,10 @@ +# ArrayOfNumberOnly + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**arrayNumber** | **[Double]** | | [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) + + diff --git a/samples/client/petstore/swift4/default/docs/ArrayTest.md b/samples/client/petstore/swift4/default/docs/ArrayTest.md new file mode 100644 index 000000000000..dd9be9d5876b --- /dev/null +++ b/samples/client/petstore/swift4/default/docs/ArrayTest.md @@ -0,0 +1,12 @@ +# ArrayTest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**arrayOfString** | **[String]** | | [optional] +**arrayArrayOfInteger** | [**[[Int64]]**](Array.md) | | [optional] +**arrayArrayOfModel** | [**[[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) + + diff --git a/samples/client/petstore/swift4/default/docs/Capitalization.md b/samples/client/petstore/swift4/default/docs/Capitalization.md new file mode 100644 index 000000000000..95374216c773 --- /dev/null +++ b/samples/client/petstore/swift4/default/docs/Capitalization.md @@ -0,0 +1,15 @@ +# Capitalization + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**smallCamel** | **String** | | [optional] +**capitalCamel** | **String** | | [optional] +**smallSnake** | **String** | | [optional] +**capitalSnake** | **String** | | [optional] +**sCAETHFlowPoints** | **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) + + diff --git a/samples/client/petstore/swift4/default/docs/Cat.md b/samples/client/petstore/swift4/default/docs/Cat.md new file mode 100644 index 000000000000..fb5949b15761 --- /dev/null +++ b/samples/client/petstore/swift4/default/docs/Cat.md @@ -0,0 +1,10 @@ +# Cat + +## Properties +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) + + diff --git a/samples/client/petstore/swift4/default/docs/Category.md b/samples/client/petstore/swift4/default/docs/Category.md new file mode 100644 index 000000000000..5ca5408c0f96 --- /dev/null +++ b/samples/client/petstore/swift4/default/docs/Category.md @@ -0,0 +1,11 @@ +# Category + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **Int64** | | [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) + + diff --git a/samples/client/petstore/swift4/default/docs/ClassModel.md b/samples/client/petstore/swift4/default/docs/ClassModel.md new file mode 100644 index 000000000000..e3912fdf0fd5 --- /dev/null +++ b/samples/client/petstore/swift4/default/docs/ClassModel.md @@ -0,0 +1,10 @@ +# ClassModel + +## Properties +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) + + diff --git a/samples/client/petstore/swift4/default/docs/Client.md b/samples/client/petstore/swift4/default/docs/Client.md new file mode 100644 index 000000000000..0de1b238c36f --- /dev/null +++ b/samples/client/petstore/swift4/default/docs/Client.md @@ -0,0 +1,10 @@ +# Client + +## Properties +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) + + diff --git a/samples/client/petstore/swift4/default/docs/Dog.md b/samples/client/petstore/swift4/default/docs/Dog.md new file mode 100644 index 000000000000..4824786da049 --- /dev/null +++ b/samples/client/petstore/swift4/default/docs/Dog.md @@ -0,0 +1,10 @@ +# Dog + +## Properties +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) + + diff --git a/samples/client/petstore/swift4/default/docs/EnumArrays.md b/samples/client/petstore/swift4/default/docs/EnumArrays.md new file mode 100644 index 000000000000..b9a9807d3c8e --- /dev/null +++ b/samples/client/petstore/swift4/default/docs/EnumArrays.md @@ -0,0 +1,11 @@ +# EnumArrays + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**justSymbol** | **String** | | [optional] +**arrayEnum** | **[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) + + diff --git a/samples/client/petstore/swift4/default/docs/EnumClass.md b/samples/client/petstore/swift4/default/docs/EnumClass.md new file mode 100644 index 000000000000..67f017becd0c --- /dev/null +++ b/samples/client/petstore/swift4/default/docs/EnumClass.md @@ -0,0 +1,9 @@ +# EnumClass + +## Properties +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) + + diff --git a/samples/client/petstore/swift4/default/docs/EnumTest.md b/samples/client/petstore/swift4/default/docs/EnumTest.md new file mode 100644 index 000000000000..bc9b036dd769 --- /dev/null +++ b/samples/client/petstore/swift4/default/docs/EnumTest.md @@ -0,0 +1,14 @@ +# EnumTest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enumString** | **String** | | [optional] +**enumStringRequired** | **String** | | +**enumInteger** | **Int** | | [optional] +**enumNumber** | **Double** | | [optional] +**outerEnum** | [**OuterEnum**](OuterEnum.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) + + diff --git a/samples/client/petstore/swift4/default/docs/FakeAPI.md b/samples/client/petstore/swift4/default/docs/FakeAPI.md new file mode 100644 index 000000000000..5a6edfb6a6e9 --- /dev/null +++ b/samples/client/petstore/swift4/default/docs/FakeAPI.md @@ -0,0 +1,674 @@ +# FakeAPI + +All URIs are relative to *http://petstore.swagger.io:80/v2* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**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 + + +# **fakeOuterBooleanSerialize** +```swift + open class func fakeOuterBooleanSerialize(body: Bool? = nil, completion: @escaping ((_ data: Bool?,_ error: Error?) -> Void)) +``` + + + +Test serialization of outer boolean types + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = 987 // Bool | Input boolean as post body (optional) + +FakeAPI.fakeOuterBooleanSerialize(body: body) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **Bool**| Input boolean as post body | [optional] + +### Return type + +**Bool** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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 README]](../README.md) + +# **fakeOuterCompositeSerialize** +```swift + open class func fakeOuterCompositeSerialize(body: OuterComposite? = nil, completion: @escaping ((_ data: OuterComposite?,_ error: Error?) -> Void)) +``` + + + +Test serialization of object with outer number type + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = OuterComposite(123, "myString_example", 123) // OuterComposite | Input composite as post body (optional) + +FakeAPI.fakeOuterCompositeSerialize(body: body) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**OuterComposite**](OuterComposite.md)| Input composite as post body | [optional] + +### Return type + +[**OuterComposite**](OuterComposite.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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 README]](../README.md) + +# **fakeOuterNumberSerialize** +```swift + open class func fakeOuterNumberSerialize(body: Double? = nil, completion: @escaping ((_ data: Double?,_ error: Error?) -> Void)) +``` + + + +Test serialization of outer number types + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = 987 // Double | Input number as post body (optional) + +FakeAPI.fakeOuterNumberSerialize(body: body) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **Double**| Input number as post body | [optional] + +### Return type + +**Double** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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 README]](../README.md) + +# **fakeOuterStringSerialize** +```swift + open class func fakeOuterStringSerialize(body: String? = nil, completion: @escaping ((_ data: String?,_ error: Error?) -> Void)) +``` + + + +Test serialization of outer string types + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = "body_example" // String | Input string as post body (optional) + +FakeAPI.fakeOuterStringSerialize(body: body) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **String**| Input string as post body | [optional] + +### Return type + +**String** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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 README]](../README.md) + +# **testBodyWithFileSchema** +```swift + open class func testBodyWithFileSchema(body: FileSchemaTestClass, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) +``` + + + +For this test, the body for this request much reference a schema named `File`. + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = FileSchemaTestClass(File("sourceURI_example"), [File("sourceURI_example")]) // FileSchemaTestClass | + +FakeAPI.testBodyWithFileSchema(body: body) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**FileSchemaTestClass**](FileSchemaTestClass.md)| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + +# **testBodyWithQueryParams** +```swift + open class func testBodyWithQueryParams(query: String, body: User, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) +``` + + + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let query = "query_example" // String | +let body = User(123, "username_example", "firstName_example", "lastName_example", "email_example", "password_example", "phone_example", 123) // User | + +FakeAPI.testBodyWithQueryParams(query: query, body: body) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **String**| | + **body** | [**User**](User.md)| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + +# **testClientModel** +```swift + open class func testClientModel(body: Client, completion: @escaping ((_ data: Client?,_ error: Error?) -> Void)) +``` + +To test \"client\" model + +To test \"client\" model + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = Client("client_example") // Client | client model + +// To test \"client\" model +FakeAPI.testClientModel(body: body) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**Client**](Client.md)| client model | + +### Return type + +[**Client**](Client.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + +# **testEndpointParameters** +```swift + open class func testEndpointParameters(number: Double, double: Double, patternWithoutDelimiter: String, byte: Data, integer: Int? = nil, int32: Int? = nil, int64: Int64? = nil, float: Float? = nil, string: String? = nil, binary: URL? = nil, date: Date? = nil, dateTime: Date? = nil, password: String? = nil, callback: String? = nil, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) +``` + +Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 + +Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let number = 987 // Double | None +let double = 987 // Double | None +let patternWithoutDelimiter = "patternWithoutDelimiter_example" // String | None +let byte = TODO // Data | None +let integer = 987 // Int | None (optional) +let int32 = 987 // Int | None (optional) +let int64 = 987 // Int64 | None (optional) +let float = 987 // Float | None (optional) +let string = "string_example" // String | None (optional) +let binary = "TODO" // URL | None (optional) +let date = TODO // Date | None (optional) +let dateTime = TODO // Date | None (optional) +let password = "password_example" // String | None (optional) +let callback = "callback_example" // String | None (optional) + +// Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 +FakeAPI.testEndpointParameters(number: number, double: double, patternWithoutDelimiter: patternWithoutDelimiter, byte: byte, integer: integer, int32: int32, int64: int64, float: float, string: string, binary: binary, date: date, dateTime: dateTime, password: password, callback: callback) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **number** | **Double**| None | + **double** | **Double**| None | + **patternWithoutDelimiter** | **String**| None | + **byte** | **Data**| None | + **integer** | **Int**| None | [optional] + **int32** | **Int**| None | [optional] + **int64** | **Int64**| None | [optional] + **float** | **Float**| None | [optional] + **string** | **String**| None | [optional] + **binary** | **URL****URL**| None | [optional] + **date** | **Date**| None | [optional] + **dateTime** | **Date**| None | [optional] + **password** | **String**| None | [optional] + **callback** | **String**| None | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[http_basic_test](../README.md#http_basic_test) + +### HTTP request headers + + - **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 README]](../README.md) + +# **testEnumParameters** +```swift + open class func testEnumParameters(enumHeaderStringArray: [String]? = nil, enumHeaderString: EnumHeaderString_testEnumParameters? = nil, enumQueryStringArray: [String]? = nil, enumQueryString: EnumQueryString_testEnumParameters? = nil, enumQueryInteger: EnumQueryInteger_testEnumParameters? = nil, enumQueryDouble: EnumQueryDouble_testEnumParameters? = nil, enumFormStringArray: [String]? = nil, enumFormString: EnumFormString_testEnumParameters? = nil, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) +``` + +To test enum parameters + +To test enum parameters + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let enumHeaderStringArray = ["enumHeaderStringArray_example"] // [String] | Header parameter enum test (string array) (optional) +let enumHeaderString = "enumHeaderString_example" // String | Header parameter enum test (string) (optional) (default to .-efg) +let enumQueryStringArray = ["enumQueryStringArray_example"] // [String] | Query parameter enum test (string array) (optional) +let enumQueryString = "enumQueryString_example" // String | Query parameter enum test (string) (optional) (default to .-efg) +let enumQueryInteger = 987 // Int | Query parameter enum test (double) (optional) +let enumQueryDouble = 987 // Double | Query parameter enum test (double) (optional) +let enumFormStringArray = ["inner_example"] // [String] | Form parameter enum test (string array) (optional) (default to .$) +let enumFormString = "enumFormString_example" // String | Form parameter enum test (string) (optional) (default to .-efg) + +// To test enum parameters +FakeAPI.testEnumParameters(enumHeaderStringArray: enumHeaderStringArray, enumHeaderString: enumHeaderString, enumQueryStringArray: enumQueryStringArray, enumQueryString: enumQueryString, enumQueryInteger: enumQueryInteger, enumQueryDouble: enumQueryDouble, enumFormStringArray: enumFormStringArray, enumFormString: enumFormString) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **enumHeaderStringArray** | [**[String]**](String.md)| Header parameter enum test (string array) | [optional] + **enumHeaderString** | **String**| Header parameter enum test (string) | [optional] [default to .-efg] + **enumQueryStringArray** | [**[String]**](String.md)| Query parameter enum test (string array) | [optional] + **enumQueryString** | **String**| Query parameter enum test (string) | [optional] [default to .-efg] + **enumQueryInteger** | **Int**| Query parameter enum test (double) | [optional] + **enumQueryDouble** | **Double**| Query parameter enum test (double) | [optional] + **enumFormStringArray** | [**[String]**](String.md)| Form parameter enum test (string array) | [optional] [default to .$] + **enumFormString** | **String**| Form parameter enum test (string) | [optional] [default to .-efg] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + +# **testGroupParameters** +```swift + open class func testGroupParameters(requiredStringGroup: Int, requiredBooleanGroup: Bool, requiredInt64Group: Int64, stringGroup: Int? = nil, booleanGroup: Bool? = nil, int64Group: Int64? = nil, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) +``` + +Fake endpoint to test group parameters (optional) + +Fake endpoint to test group parameters (optional) + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let requiredStringGroup = 987 // Int | Required String in group parameters +let requiredBooleanGroup = 987 // Bool | Required Boolean in group parameters +let requiredInt64Group = 987 // Int64 | Required Integer in group parameters +let stringGroup = 987 // Int | String in group parameters (optional) +let booleanGroup = 987 // Bool | Boolean in group parameters (optional) +let int64Group = 987 // Int64 | Integer in group parameters (optional) + +// Fake endpoint to test group parameters (optional) +FakeAPI.testGroupParameters(requiredStringGroup: requiredStringGroup, requiredBooleanGroup: requiredBooleanGroup, requiredInt64Group: requiredInt64Group, stringGroup: stringGroup, booleanGroup: booleanGroup, int64Group: int64Group) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **requiredStringGroup** | **Int**| Required String in group parameters | + **requiredBooleanGroup** | **Bool**| Required Boolean in group parameters | + **requiredInt64Group** | **Int64**| Required Integer in group parameters | + **stringGroup** | **Int**| String in group parameters | [optional] + **booleanGroup** | **Bool**| Boolean in group parameters | [optional] + **int64Group** | **Int64**| Integer in group parameters | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + +# **testInlineAdditionalProperties** +```swift + open class func testInlineAdditionalProperties(param: [String:String], completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) +``` + +test inline additionalProperties + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let param = "TODO" // [String:String] | request body + +// test inline additionalProperties +FakeAPI.testInlineAdditionalProperties(param: param) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **param** | [**[String:String]**](String.md)| request body | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + +# **testJsonFormData** +```swift + open class func testJsonFormData(param: String, param2: String, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) +``` + +test json serialization of form data + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let param = "param_example" // String | field1 +let param2 = "param2_example" // String | field2 + +// test json serialization of form data +FakeAPI.testJsonFormData(param: param, param2: param2) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **param** | **String**| field1 | + **param2** | **String**| field2 | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + diff --git a/samples/client/petstore/swift4/default/docs/FakeClassnameTags123API.md b/samples/client/petstore/swift4/default/docs/FakeClassnameTags123API.md new file mode 100644 index 000000000000..cacc84a1cf89 --- /dev/null +++ b/samples/client/petstore/swift4/default/docs/FakeClassnameTags123API.md @@ -0,0 +1,60 @@ +# FakeClassnameTags123API + +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** +```swift + open class func testClassname(body: Client, completion: @escaping ((_ data: Client?,_ error: Error?) -> Void)) +``` + +To test class name in snake case + +To test class name in snake case + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = Client("client_example") // Client | client model + +// To test class name in snake case +FakeClassnameTags123API.testClassname(body: body) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**Client**](Client.md)| client model | + +### Return type + +[**Client**](Client.md) + +### Authorization + +[api_key_query](../README.md#api_key_query) + +### HTTP request headers + + - **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 README]](../README.md) + diff --git a/samples/client/petstore/swift4/default/docs/File.md b/samples/client/petstore/swift4/default/docs/File.md new file mode 100644 index 000000000000..3edfef17b794 --- /dev/null +++ b/samples/client/petstore/swift4/default/docs/File.md @@ -0,0 +1,10 @@ +# File + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**sourceURI** | **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) + + diff --git a/samples/client/petstore/swift4/default/docs/FileSchemaTestClass.md b/samples/client/petstore/swift4/default/docs/FileSchemaTestClass.md new file mode 100644 index 000000000000..d0a8bbaaba95 --- /dev/null +++ b/samples/client/petstore/swift4/default/docs/FileSchemaTestClass.md @@ -0,0 +1,11 @@ +# FileSchemaTestClass + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**file** | [**File**](File.md) | | [optional] +**files** | [**[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) + + diff --git a/samples/client/petstore/swift4/default/docs/FormatTest.md b/samples/client/petstore/swift4/default/docs/FormatTest.md new file mode 100644 index 000000000000..547eb88754f4 --- /dev/null +++ b/samples/client/petstore/swift4/default/docs/FormatTest.md @@ -0,0 +1,22 @@ +# FormatTest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**integer** | **Int** | | [optional] +**int32** | **Int** | | [optional] +**int64** | **Int64** | | [optional] +**number** | **Double** | | +**float** | **Float** | | [optional] +**double** | **Double** | | [optional] +**string** | **String** | | [optional] +**byte** | [**Data**](Data.md) | | +**binary** | [**URL**](URL.md) | | [optional] +**date** | [**Date**](Date.md) | | +**dateTime** | [**Date**](Date.md) | | [optional] +**uuid** | [**UUID**](UUID.md) | | [optional] +**password** | **String** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/samples/client/petstore/swift4/default/docs/HasOnlyReadOnly.md b/samples/client/petstore/swift4/default/docs/HasOnlyReadOnly.md new file mode 100644 index 000000000000..45781360154c --- /dev/null +++ b/samples/client/petstore/swift4/default/docs/HasOnlyReadOnly.md @@ -0,0 +1,11 @@ +# HasOnlyReadOnly + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**bar** | **String** | | [optional] +**foo** | **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) + + diff --git a/samples/client/petstore/swift4/default/docs/List.md b/samples/client/petstore/swift4/default/docs/List.md new file mode 100644 index 000000000000..b77718302edf --- /dev/null +++ b/samples/client/petstore/swift4/default/docs/List.md @@ -0,0 +1,10 @@ +# List + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**_123list** | **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) + + diff --git a/samples/client/petstore/swift4/default/docs/MapTest.md b/samples/client/petstore/swift4/default/docs/MapTest.md new file mode 100644 index 000000000000..e910bc97518c --- /dev/null +++ b/samples/client/petstore/swift4/default/docs/MapTest.md @@ -0,0 +1,13 @@ +# MapTest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**mapMapOfString** | [**[String:[String:String]]**](Dictionary.md) | | [optional] +**mapOfEnumString** | **[String:String]** | | [optional] +**directMap** | **[String:Bool]** | | [optional] +**indirectMap** | [**StringBooleanMap**](StringBooleanMap.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) + + diff --git a/samples/client/petstore/swift4/default/docs/MixedPropertiesAndAdditionalPropertiesClass.md b/samples/client/petstore/swift4/default/docs/MixedPropertiesAndAdditionalPropertiesClass.md new file mode 100644 index 000000000000..2c502eace42c --- /dev/null +++ b/samples/client/petstore/swift4/default/docs/MixedPropertiesAndAdditionalPropertiesClass.md @@ -0,0 +1,12 @@ +# MixedPropertiesAndAdditionalPropertiesClass + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**uuid** | [**UUID**](UUID.md) | | [optional] +**dateTime** | [**Date**](Date.md) | | [optional] +**map** | [**[String: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) + + diff --git a/samples/client/petstore/swift4/default/docs/Model200Response.md b/samples/client/petstore/swift4/default/docs/Model200Response.md new file mode 100644 index 000000000000..5865ea690cc3 --- /dev/null +++ b/samples/client/petstore/swift4/default/docs/Model200Response.md @@ -0,0 +1,11 @@ +# Model200Response + +## Properties +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) + + diff --git a/samples/client/petstore/swift4/default/docs/Name.md b/samples/client/petstore/swift4/default/docs/Name.md new file mode 100644 index 000000000000..2be75d062e47 --- /dev/null +++ b/samples/client/petstore/swift4/default/docs/Name.md @@ -0,0 +1,13 @@ +# Name + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **Int** | | +**snakeCase** | **Int** | | [optional] +**property** | **String** | | [optional] +**_123number** | **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) + + diff --git a/samples/client/petstore/swift4/default/docs/NumberOnly.md b/samples/client/petstore/swift4/default/docs/NumberOnly.md new file mode 100644 index 000000000000..72bd361168b5 --- /dev/null +++ b/samples/client/petstore/swift4/default/docs/NumberOnly.md @@ -0,0 +1,10 @@ +# NumberOnly + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**justNumber** | **Double** | | [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) + + diff --git a/samples/client/petstore/swift4/default/docs/Order.md b/samples/client/petstore/swift4/default/docs/Order.md new file mode 100644 index 000000000000..9d3205c1526a --- /dev/null +++ b/samples/client/petstore/swift4/default/docs/Order.md @@ -0,0 +1,15 @@ +# Order + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **Int64** | | [optional] +**petId** | **Int64** | | [optional] +**quantity** | **Int** | | [optional] +**shipDate** | [**Date**](Date.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) + + diff --git a/samples/client/petstore/swift4/default/docs/OuterComposite.md b/samples/client/petstore/swift4/default/docs/OuterComposite.md new file mode 100644 index 000000000000..d6b3583bc3ff --- /dev/null +++ b/samples/client/petstore/swift4/default/docs/OuterComposite.md @@ -0,0 +1,12 @@ +# OuterComposite + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**myNumber** | **Double** | | [optional] +**myString** | **String** | | [optional] +**myBoolean** | **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) + + diff --git a/samples/client/petstore/swift4/default/docs/OuterEnum.md b/samples/client/petstore/swift4/default/docs/OuterEnum.md new file mode 100644 index 000000000000..06d413b01680 --- /dev/null +++ b/samples/client/petstore/swift4/default/docs/OuterEnum.md @@ -0,0 +1,9 @@ +# OuterEnum + +## Properties +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) + + diff --git a/samples/client/petstore/swift4/default/docs/Pet.md b/samples/client/petstore/swift4/default/docs/Pet.md new file mode 100644 index 000000000000..c30a5292f537 --- /dev/null +++ b/samples/client/petstore/swift4/default/docs/Pet.md @@ -0,0 +1,15 @@ +# Pet + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **Int64** | | [optional] +**category** | [**Category**](Category.md) | | [optional] +**name** | **String** | | +**photoUrls** | **[String]** | | +**tags** | [**[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) + + diff --git a/samples/client/petstore/swift4/default/docs/PetAPI.md b/samples/client/petstore/swift4/default/docs/PetAPI.md new file mode 100644 index 000000000000..bd2640ed0a8d --- /dev/null +++ b/samples/client/petstore/swift4/default/docs/PetAPI.md @@ -0,0 +1,478 @@ +# PetAPI + +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** +```swift + open class func addPet(body: Pet, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) +``` + +Add a new pet to the store + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = Pet(123, Category(123, "name_example"), "name_example", ["photoUrls_example"], [Tag(123, "name_example")], "status_example") // Pet | Pet object that needs to be added to the store + +// Add a new pet to the store +PetAPI.addPet(body: body) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | + +### Return type + +void (empty response body) + +### Authorization + +[petstore_auth](../README.md#petstore_auth) + +### HTTP request headers + + - **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 README]](../README.md) + +# **deletePet** +```swift + open class func deletePet(petId: Int64, apiKey: String? = nil, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) +``` + +Deletes a pet + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let petId = 987 // Int64 | Pet id to delete +let apiKey = "apiKey_example" // String | (optional) + +// Deletes a pet +PetAPI.deletePet(petId: petId, apiKey: apiKey) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **petId** | **Int64**| Pet id to delete | + **apiKey** | **String**| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[petstore_auth](../README.md#petstore_auth) + +### HTTP request headers + + - **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 README]](../README.md) + +# **findPetsByStatus** +```swift + open class func findPetsByStatus(status: [String], completion: @escaping ((_ data: [Pet]?,_ error: Error?) -> Void)) +``` + +Finds Pets by status + +Multiple status values can be provided with comma separated strings + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let status = ["status_example"] // [String] | Status values that need to be considered for filter + +// Finds Pets by status +PetAPI.findPetsByStatus(status: status) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **status** | [**[String]**](String.md)| Status values that need to be considered for filter | + +### Return type + +[**[Pet]**](Pet.md) + +### Authorization + +[petstore_auth](../README.md#petstore_auth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **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 README]](../README.md) + +# **findPetsByTags** +```swift + open class func findPetsByTags(tags: [String], completion: @escaping ((_ data: [Pet]?,_ error: Error?) -> Void)) +``` + +Finds Pets by tags + +Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let tags = ["inner_example"] // [String] | Tags to filter by + +// Finds Pets by tags +PetAPI.findPetsByTags(tags: tags) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **tags** | [**[String]**](String.md)| Tags to filter by | + +### Return type + +[**[Pet]**](Pet.md) + +### Authorization + +[petstore_auth](../README.md#petstore_auth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **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 README]](../README.md) + +# **getPetById** +```swift + open class func getPetById(petId: Int64, completion: @escaping ((_ data: Pet?,_ error: Error?) -> Void)) +``` + +Find pet by ID + +Returns a single pet + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let petId = 987 // Int64 | ID of pet to return + +// Find pet by ID +PetAPI.getPetById(petId: petId) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **petId** | **Int64**| ID of pet to return | + +### Return type + +[**Pet**](Pet.md) + +### Authorization + +[api_key](../README.md#api_key) + +### HTTP request headers + + - **Content-Type**: Not defined + - **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 README]](../README.md) + +# **updatePet** +```swift + open class func updatePet(body: Pet, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) +``` + +Update an existing pet + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = Pet(123, Category(123, "name_example"), "name_example", ["photoUrls_example"], [Tag(123, "name_example")], "status_example") // Pet | Pet object that needs to be added to the store + +// Update an existing pet +PetAPI.updatePet(body: body) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | + +### Return type + +void (empty response body) + +### Authorization + +[petstore_auth](../README.md#petstore_auth) + +### HTTP request headers + + - **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 README]](../README.md) + +# **updatePetWithForm** +```swift + open class func updatePetWithForm(petId: Int64, name: String? = nil, status: String? = nil, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) +``` + +Updates a pet in the store with form data + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let petId = 987 // Int64 | ID of pet that needs to be updated +let name = "name_example" // String | Updated name of the pet (optional) +let status = "status_example" // String | Updated status of the pet (optional) + +// Updates a pet in the store with form data +PetAPI.updatePetWithForm(petId: petId, name: name, status: status) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **petId** | **Int64**| ID of pet that needs to be updated | + **name** | **String**| Updated name of the pet | [optional] + **status** | **String**| Updated status of the pet | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[petstore_auth](../README.md#petstore_auth) + +### HTTP request headers + + - **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 README]](../README.md) + +# **uploadFile** +```swift + open class func uploadFile(petId: Int64, additionalMetadata: String? = nil, file: URL? = nil, completion: @escaping ((_ data: ApiResponse?,_ error: Error?) -> Void)) +``` + +uploads an image + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let petId = 987 // Int64 | ID of pet to update +let additionalMetadata = "additionalMetadata_example" // String | Additional data to pass to server (optional) +let file = "TODO" // URL | file to upload (optional) + +// uploads an image +PetAPI.uploadFile(petId: petId, additionalMetadata: additionalMetadata, file: file) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **petId** | **Int64**| ID of pet to update | + **additionalMetadata** | **String**| Additional data to pass to server | [optional] + **file** | **URL****URL**| file to upload | [optional] + +### Return type + +[**ApiResponse**](ApiResponse.md) + +### Authorization + +[petstore_auth](../README.md#petstore_auth) + +### HTTP request headers + + - **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 README]](../README.md) + +# **uploadFileWithRequiredFile** +```swift + open class func uploadFileWithRequiredFile(petId: Int64, requiredFile: URL, additionalMetadata: String? = nil, completion: @escaping ((_ data: ApiResponse?,_ error: Error?) -> Void)) +``` + +uploads an image (required) + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let petId = 987 // Int64 | ID of pet to update +let requiredFile = "TODO" // URL | file to upload +let additionalMetadata = "additionalMetadata_example" // String | Additional data to pass to server (optional) + +// uploads an image (required) +PetAPI.uploadFileWithRequiredFile(petId: petId, requiredFile: requiredFile, additionalMetadata: additionalMetadata) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **petId** | **Int64**| ID of pet to update | + **requiredFile** | **URL****URL**| file to upload | + **additionalMetadata** | **String**| Additional data to pass to server | [optional] + +### Return type + +[**ApiResponse**](ApiResponse.md) + +### Authorization + +[petstore_auth](../README.md#petstore_auth) + +### HTTP request headers + + - **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 README]](../README.md) + diff --git a/samples/client/petstore/swift4/default/docs/ReadOnlyFirst.md b/samples/client/petstore/swift4/default/docs/ReadOnlyFirst.md new file mode 100644 index 000000000000..e3f16038b970 --- /dev/null +++ b/samples/client/petstore/swift4/default/docs/ReadOnlyFirst.md @@ -0,0 +1,11 @@ +# ReadOnlyFirst + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**bar** | **String** | | [optional] +**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) + + diff --git a/samples/client/petstore/swift4/default/docs/Return.md b/samples/client/petstore/swift4/default/docs/Return.md new file mode 100644 index 000000000000..66d17c27c887 --- /dev/null +++ b/samples/client/petstore/swift4/default/docs/Return.md @@ -0,0 +1,10 @@ +# Return + +## Properties +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) + + diff --git a/samples/client/petstore/swift4/default/docs/SpecialModelName.md b/samples/client/petstore/swift4/default/docs/SpecialModelName.md new file mode 100644 index 000000000000..3ec27a38c2ac --- /dev/null +++ b/samples/client/petstore/swift4/default/docs/SpecialModelName.md @@ -0,0 +1,10 @@ +# SpecialModelName + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**specialPropertyName** | **Int64** | | [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) + + diff --git a/samples/client/petstore/swift4/default/docs/StoreAPI.md b/samples/client/petstore/swift4/default/docs/StoreAPI.md new file mode 100644 index 000000000000..45210030fae1 --- /dev/null +++ b/samples/client/petstore/swift4/default/docs/StoreAPI.md @@ -0,0 +1,210 @@ +# StoreAPI + +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** +```swift + open class func deleteOrder(orderId: String, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) +``` + +Delete purchase order by ID + +For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let orderId = "orderId_example" // String | ID of the order that needs to be deleted + +// Delete purchase order by ID +StoreAPI.deleteOrder(orderId: orderId) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **orderId** | **String**| ID of the order that needs to be deleted | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + +# **getInventory** +```swift + open class func getInventory(completion: @escaping ((_ data: [String:Int]?,_ error: Error?) -> Void)) +``` + +Returns pet inventories by status + +Returns a map of status codes to quantities + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + + +// Returns pet inventories by status +StoreAPI.getInventory() { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[String:Int]** + +### Authorization + +[api_key](../README.md#api_key) + +### HTTP request headers + + - **Content-Type**: Not defined + - **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 README]](../README.md) + +# **getOrderById** +```swift + open class func getOrderById(orderId: Int64, completion: @escaping ((_ data: Order?,_ error: Error?) -> Void)) +``` + +Find purchase order by ID + +For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let orderId = 987 // Int64 | ID of pet that needs to be fetched + +// Find purchase order by ID +StoreAPI.getOrderById(orderId: orderId) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **orderId** | **Int64**| ID of pet that needs to be fetched | + +### Return type + +[**Order**](Order.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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 README]](../README.md) + +# **placeOrder** +```swift + open class func placeOrder(body: Order, completion: @escaping ((_ data: Order?,_ error: Error?) -> Void)) +``` + +Place an order for a pet + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = Order(123, 123, 123, "TODO", "status_example", 123) // Order | order placed for purchasing the pet + +// Place an order for a pet +StoreAPI.placeOrder(body: body) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**Order**](Order.md)| order placed for purchasing the pet | + +### Return type + +[**Order**](Order.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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 README]](../README.md) + diff --git a/samples/client/petstore/swift4/default/docs/StringBooleanMap.md b/samples/client/petstore/swift4/default/docs/StringBooleanMap.md new file mode 100644 index 000000000000..7abf11ec68b1 --- /dev/null +++ b/samples/client/petstore/swift4/default/docs/StringBooleanMap.md @@ -0,0 +1,9 @@ +# StringBooleanMap + +## Properties +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) + + diff --git a/samples/client/petstore/swift4/default/docs/Tag.md b/samples/client/petstore/swift4/default/docs/Tag.md new file mode 100644 index 000000000000..ff4ac8aa4519 --- /dev/null +++ b/samples/client/petstore/swift4/default/docs/Tag.md @@ -0,0 +1,11 @@ +# Tag + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **Int64** | | [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) + + diff --git a/samples/client/petstore/swift4/default/docs/TypeHolderDefault.md b/samples/client/petstore/swift4/default/docs/TypeHolderDefault.md new file mode 100644 index 000000000000..5161394bdc3e --- /dev/null +++ b/samples/client/petstore/swift4/default/docs/TypeHolderDefault.md @@ -0,0 +1,14 @@ +# TypeHolderDefault + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**stringItem** | **String** | | [default to "what"] +**numberItem** | **Double** | | +**integerItem** | **Int** | | +**boolItem** | **Bool** | | [default to true] +**arrayItem** | **[Int]** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/samples/client/petstore/swift4/default/docs/TypeHolderExample.md b/samples/client/petstore/swift4/default/docs/TypeHolderExample.md new file mode 100644 index 000000000000..46d0471cd71a --- /dev/null +++ b/samples/client/petstore/swift4/default/docs/TypeHolderExample.md @@ -0,0 +1,14 @@ +# TypeHolderExample + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**stringItem** | **String** | | +**numberItem** | **Double** | | +**integerItem** | **Int** | | +**boolItem** | **Bool** | | +**arrayItem** | **[Int]** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/samples/client/petstore/swift4/default/docs/User.md b/samples/client/petstore/swift4/default/docs/User.md new file mode 100644 index 000000000000..5a439de0ff95 --- /dev/null +++ b/samples/client/petstore/swift4/default/docs/User.md @@ -0,0 +1,17 @@ +# User + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **Int64** | | [optional] +**username** | **String** | | [optional] +**firstName** | **String** | | [optional] +**lastName** | **String** | | [optional] +**email** | **String** | | [optional] +**password** | **String** | | [optional] +**phone** | **String** | | [optional] +**userStatus** | **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) + + diff --git a/samples/client/petstore/swift4/default/docs/UserAPI.md b/samples/client/petstore/swift4/default/docs/UserAPI.md new file mode 100644 index 000000000000..b22538654d8a --- /dev/null +++ b/samples/client/petstore/swift4/default/docs/UserAPI.md @@ -0,0 +1,414 @@ +# UserAPI + +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** +```swift + open class func createUser(body: User, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) +``` + +Create user + +This can only be done by the logged in user. + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = User(123, "username_example", "firstName_example", "lastName_example", "email_example", "password_example", "phone_example", 123) // User | Created user object + +// Create user +UserAPI.createUser(body: body) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**User**](User.md)| Created user object | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + +# **createUsersWithArrayInput** +```swift + open class func createUsersWithArrayInput(body: [User], completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) +``` + +Creates list of users with given input array + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = [User(123, "username_example", "firstName_example", "lastName_example", "email_example", "password_example", "phone_example", 123)] // [User] | List of user object + +// Creates list of users with given input array +UserAPI.createUsersWithArrayInput(body: body) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**[User]**](Array.md)| List of user object | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + +# **createUsersWithListInput** +```swift + open class func createUsersWithListInput(body: [User], completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) +``` + +Creates list of users with given input array + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = [User(123, "username_example", "firstName_example", "lastName_example", "email_example", "password_example", "phone_example", 123)] // [User] | List of user object + +// Creates list of users with given input array +UserAPI.createUsersWithListInput(body: body) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**[User]**](Array.md)| List of user object | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + +# **deleteUser** +```swift + open class func deleteUser(username: String, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) +``` + +Delete user + +This can only be done by the logged in user. + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let username = "username_example" // String | The name that needs to be deleted + +// Delete user +UserAPI.deleteUser(username: username) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **username** | **String**| The name that needs to be deleted | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + +# **getUserByName** +```swift + open class func getUserByName(username: String, completion: @escaping ((_ data: User?,_ error: Error?) -> Void)) +``` + +Get user by user name + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let username = "username_example" // String | The name that needs to be fetched. Use user1 for testing. + +// Get user by user name +UserAPI.getUserByName(username: username) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **username** | **String**| The name that needs to be fetched. Use user1 for testing. | + +### Return type + +[**User**](User.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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 README]](../README.md) + +# **loginUser** +```swift + open class func loginUser(username: String, password: String, completion: @escaping ((_ data: String?,_ error: Error?) -> Void)) +``` + +Logs user into the system + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let username = "username_example" // String | The user name for login +let password = "password_example" // String | The password for login in clear text + +// Logs user into the system +UserAPI.loginUser(username: username, password: password) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **username** | **String**| The user name for login | + **password** | **String**| The password for login in clear text | + +### Return type + +**String** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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 README]](../README.md) + +# **logoutUser** +```swift + open class func logoutUser(completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) +``` + +Logs out current logged in user session + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + + +// Logs out current logged in user session +UserAPI.logoutUser() { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + +# **updateUser** +```swift + open class func updateUser(username: String, body: User, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) +``` + +Updated user + +This can only be done by the logged in user. + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let username = "username_example" // String | name that need to be deleted +let body = User(123, "username_example", "firstName_example", "lastName_example", "email_example", "password_example", "phone_example", 123) // User | Updated user object + +// Updated user +UserAPI.updateUser(username: username, body: body) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **username** | **String**| name that need to be deleted | + **body** | [**User**](User.md)| Updated user object | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + diff --git a/samples/client/petstore/swift4/objcCompatible/README.md b/samples/client/petstore/swift4/objcCompatible/README.md new file mode 100644 index 000000000000..ac131d8fcd5e --- /dev/null +++ b/samples/client/petstore/swift4/objcCompatible/README.md @@ -0,0 +1,146 @@ +# Swift4 API client for PetstoreClient + +This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\ + +## Overview +This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [openapi-spec from a remote server, you can easily generate an API client. + +- API version: 1.0.0 +- Package version: +- Build package: org.openapitools.codegen.languages.Swift4Codegen + +## Installation + +### Carthage + +Run `carthage update` + +### CocoaPods + +Run `pod install` + +## Documentation for API Endpoints + +All URIs are relative to *http://petstore.swagger.io:80/v2* + +Class | Method | HTTP request | Description +------------ | ------------- | ------------- | ------------- +*AnotherFakeAPI* | [**call123testSpecialTags**](docs/AnotherFakeAPI.md#call123testspecialtags) | **PATCH** /another-fake/dummy | To test special tags +*FakeAPI* | [**createXmlItem**](docs/FakeAPI.md#createxmlitem) | **POST** /fake/create_xml_item | creates an XmlItem +*FakeAPI* | [**fakeOuterBooleanSerialize**](docs/FakeAPI.md#fakeouterbooleanserialize) | **POST** /fake/outer/boolean | +*FakeAPI* | [**fakeOuterCompositeSerialize**](docs/FakeAPI.md#fakeoutercompositeserialize) | **POST** /fake/outer/composite | +*FakeAPI* | [**fakeOuterNumberSerialize**](docs/FakeAPI.md#fakeouternumberserialize) | **POST** /fake/outer/number | +*FakeAPI* | [**fakeOuterStringSerialize**](docs/FakeAPI.md#fakeouterstringserialize) | **POST** /fake/outer/string | +*FakeAPI* | [**testBodyWithFileSchema**](docs/FakeAPI.md#testbodywithfileschema) | **PUT** /fake/body-with-file-schema | +*FakeAPI* | [**testBodyWithQueryParams**](docs/FakeAPI.md#testbodywithqueryparams) | **PUT** /fake/body-with-query-params | +*FakeAPI* | [**testClientModel**](docs/FakeAPI.md#testclientmodel) | **PATCH** /fake | To test \"client\" model +*FakeAPI* | [**testEndpointParameters**](docs/FakeAPI.md#testendpointparameters) | **POST** /fake | Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 +*FakeAPI* | [**testEnumParameters**](docs/FakeAPI.md#testenumparameters) | **GET** /fake | To test enum parameters +*FakeAPI* | [**testGroupParameters**](docs/FakeAPI.md#testgroupparameters) | **DELETE** /fake | Fake endpoint to test group parameters (optional) +*FakeAPI* | [**testInlineAdditionalProperties**](docs/FakeAPI.md#testinlineadditionalproperties) | **POST** /fake/inline-additionalProperties | test inline additionalProperties +*FakeAPI* | [**testJsonFormData**](docs/FakeAPI.md#testjsonformdata) | **GET** /fake/jsonFormData | test json serialization of form data +*FakeClassnameTags123API* | [**testClassname**](docs/FakeClassnameTags123API.md#testclassname) | **PATCH** /fake_classname_test | To test class name in snake case +*PetAPI* | [**addPet**](docs/PetAPI.md#addpet) | **POST** /pet | Add a new pet to the store +*PetAPI* | [**deletePet**](docs/PetAPI.md#deletepet) | **DELETE** /pet/{petId} | Deletes a pet +*PetAPI* | [**findPetsByStatus**](docs/PetAPI.md#findpetsbystatus) | **GET** /pet/findByStatus | Finds Pets by status +*PetAPI* | [**findPetsByTags**](docs/PetAPI.md#findpetsbytags) | **GET** /pet/findByTags | Finds Pets by tags +*PetAPI* | [**getPetById**](docs/PetAPI.md#getpetbyid) | **GET** /pet/{petId} | Find pet by ID +*PetAPI* | [**updatePet**](docs/PetAPI.md#updatepet) | **PUT** /pet | Update an existing pet +*PetAPI* | [**updatePetWithForm**](docs/PetAPI.md#updatepetwithform) | **POST** /pet/{petId} | Updates a pet in the store with form data +*PetAPI* | [**uploadFile**](docs/PetAPI.md#uploadfile) | **POST** /pet/{petId}/uploadImage | uploads an image +*PetAPI* | [**uploadFileWithRequiredFile**](docs/PetAPI.md#uploadfilewithrequiredfile) | **POST** /fake/{petId}/uploadImageWithRequiredFile | uploads an image (required) +*StoreAPI* | [**deleteOrder**](docs/StoreAPI.md#deleteorder) | **DELETE** /store/order/{order_id} | Delete purchase order by ID +*StoreAPI* | [**getInventory**](docs/StoreAPI.md#getinventory) | **GET** /store/inventory | Returns pet inventories by status +*StoreAPI* | [**getOrderById**](docs/StoreAPI.md#getorderbyid) | **GET** /store/order/{order_id} | Find purchase order by ID +*StoreAPI* | [**placeOrder**](docs/StoreAPI.md#placeorder) | **POST** /store/order | Place an order for a pet +*UserAPI* | [**createUser**](docs/UserAPI.md#createuser) | **POST** /user | Create user +*UserAPI* | [**createUsersWithArrayInput**](docs/UserAPI.md#createuserswitharrayinput) | **POST** /user/createWithArray | Creates list of users with given input array +*UserAPI* | [**createUsersWithListInput**](docs/UserAPI.md#createuserswithlistinput) | **POST** /user/createWithList | Creates list of users with given input array +*UserAPI* | [**deleteUser**](docs/UserAPI.md#deleteuser) | **DELETE** /user/{username} | Delete user +*UserAPI* | [**getUserByName**](docs/UserAPI.md#getuserbyname) | **GET** /user/{username} | Get user by user name +*UserAPI* | [**loginUser**](docs/UserAPI.md#loginuser) | **GET** /user/login | Logs user into the system +*UserAPI* | [**logoutUser**](docs/UserAPI.md#logoutuser) | **GET** /user/logout | Logs out current logged in user session +*UserAPI* | [**updateUser**](docs/UserAPI.md#updateuser) | **PUT** /user/{username} | Updated user + + +## Documentation For Models + + - [AdditionalPropertiesAnyType](docs/AdditionalPropertiesAnyType.md) + - [AdditionalPropertiesArray](docs/AdditionalPropertiesArray.md) + - [AdditionalPropertiesBoolean](docs/AdditionalPropertiesBoolean.md) + - [AdditionalPropertiesClass](docs/AdditionalPropertiesClass.md) + - [AdditionalPropertiesInteger](docs/AdditionalPropertiesInteger.md) + - [AdditionalPropertiesNumber](docs/AdditionalPropertiesNumber.md) + - [AdditionalPropertiesObject](docs/AdditionalPropertiesObject.md) + - [AdditionalPropertiesString](docs/AdditionalPropertiesString.md) + - [Animal](docs/Animal.md) + - [ApiResponse](docs/ApiResponse.md) + - [ArrayOfArrayOfNumberOnly](docs/ArrayOfArrayOfNumberOnly.md) + - [ArrayOfNumberOnly](docs/ArrayOfNumberOnly.md) + - [ArrayTest](docs/ArrayTest.md) + - [Capitalization](docs/Capitalization.md) + - [Cat](docs/Cat.md) + - [Category](docs/Category.md) + - [ClassModel](docs/ClassModel.md) + - [Client](docs/Client.md) + - [Dog](docs/Dog.md) + - [EnumArrays](docs/EnumArrays.md) + - [EnumClass](docs/EnumClass.md) + - [EnumTest](docs/EnumTest.md) + - [File](docs/File.md) + - [FileSchemaTestClass](docs/FileSchemaTestClass.md) + - [FormatTest](docs/FormatTest.md) + - [HasOnlyReadOnly](docs/HasOnlyReadOnly.md) + - [List](docs/List.md) + - [MapTest](docs/MapTest.md) + - [MixedPropertiesAndAdditionalPropertiesClass](docs/MixedPropertiesAndAdditionalPropertiesClass.md) + - [Model200Response](docs/Model200Response.md) + - [Name](docs/Name.md) + - [NumberOnly](docs/NumberOnly.md) + - [Order](docs/Order.md) + - [OuterComposite](docs/OuterComposite.md) + - [OuterEnum](docs/OuterEnum.md) + - [Pet](docs/Pet.md) + - [ReadOnlyFirst](docs/ReadOnlyFirst.md) + - [Return](docs/Return.md) + - [SpecialModelName](docs/SpecialModelName.md) + - [Tag](docs/Tag.md) + - [TypeHolderDefault](docs/TypeHolderDefault.md) + - [TypeHolderExample](docs/TypeHolderExample.md) + - [User](docs/User.md) + - [XmlItem](docs/XmlItem.md) + + +## Documentation For Authorization + + +## api_key + +- **Type**: API key +- **API key parameter name**: api_key +- **Location**: HTTP header + +## api_key_query + +- **Type**: API key +- **API key parameter name**: api_key_query +- **Location**: URL query string + +## http_basic_test + +- **Type**: HTTP basic authentication + +## petstore_auth + +- **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 + + +## Author + + + diff --git a/samples/client/petstore/swift4/objcCompatible/docs/AdditionalPropertiesAnyType.md b/samples/client/petstore/swift4/objcCompatible/docs/AdditionalPropertiesAnyType.md new file mode 100644 index 000000000000..bae60ab148f2 --- /dev/null +++ b/samples/client/petstore/swift4/objcCompatible/docs/AdditionalPropertiesAnyType.md @@ -0,0 +1,10 @@ +# AdditionalPropertiesAnyType + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**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) + + diff --git a/samples/client/petstore/swift4/objcCompatible/docs/AdditionalPropertiesArray.md b/samples/client/petstore/swift4/objcCompatible/docs/AdditionalPropertiesArray.md new file mode 100644 index 000000000000..a371b5e28f32 --- /dev/null +++ b/samples/client/petstore/swift4/objcCompatible/docs/AdditionalPropertiesArray.md @@ -0,0 +1,10 @@ +# AdditionalPropertiesArray + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**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) + + diff --git a/samples/client/petstore/swift4/objcCompatible/docs/AdditionalPropertiesBoolean.md b/samples/client/petstore/swift4/objcCompatible/docs/AdditionalPropertiesBoolean.md new file mode 100644 index 000000000000..d5f0d6da11ee --- /dev/null +++ b/samples/client/petstore/swift4/objcCompatible/docs/AdditionalPropertiesBoolean.md @@ -0,0 +1,10 @@ +# AdditionalPropertiesBoolean + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**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) + + diff --git a/samples/client/petstore/swift4/objcCompatible/docs/AdditionalPropertiesClass.md b/samples/client/petstore/swift4/objcCompatible/docs/AdditionalPropertiesClass.md new file mode 100644 index 000000000000..75fe1fcc137a --- /dev/null +++ b/samples/client/petstore/swift4/objcCompatible/docs/AdditionalPropertiesClass.md @@ -0,0 +1,20 @@ +# AdditionalPropertiesClass + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**mapString** | **[String:String]** | | [optional] +**mapNumber** | **[String:Double]** | | [optional] +**mapInteger** | **[String:Int]** | | [optional] +**mapBoolean** | **[String:Bool]** | | [optional] +**mapArrayInteger** | [**[String:[Int]]**](Array.md) | | [optional] +**mapArrayAnytype** | [**[String:[Any]]**](Array.md) | | [optional] +**mapMapString** | [**[String:[String:String]]**](Dictionary.md) | | [optional] +**mapMapAnytype** | [**[String:[String:Any]]**](Dictionary.md) | | [optional] +**anytype1** | [**Any**](.md) | | [optional] +**anytype2** | [**Any**](.md) | | [optional] +**anytype3** | [**Any**](.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) + + diff --git a/samples/client/petstore/swift4/objcCompatible/docs/AdditionalPropertiesInteger.md b/samples/client/petstore/swift4/objcCompatible/docs/AdditionalPropertiesInteger.md new file mode 100644 index 000000000000..629293abdfe9 --- /dev/null +++ b/samples/client/petstore/swift4/objcCompatible/docs/AdditionalPropertiesInteger.md @@ -0,0 +1,10 @@ +# AdditionalPropertiesInteger + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**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) + + diff --git a/samples/client/petstore/swift4/objcCompatible/docs/AdditionalPropertiesNumber.md b/samples/client/petstore/swift4/objcCompatible/docs/AdditionalPropertiesNumber.md new file mode 100644 index 000000000000..65adfe78137c --- /dev/null +++ b/samples/client/petstore/swift4/objcCompatible/docs/AdditionalPropertiesNumber.md @@ -0,0 +1,10 @@ +# AdditionalPropertiesNumber + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**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) + + diff --git a/samples/client/petstore/swift4/objcCompatible/docs/AdditionalPropertiesObject.md b/samples/client/petstore/swift4/objcCompatible/docs/AdditionalPropertiesObject.md new file mode 100644 index 000000000000..99d69b7aae6a --- /dev/null +++ b/samples/client/petstore/swift4/objcCompatible/docs/AdditionalPropertiesObject.md @@ -0,0 +1,10 @@ +# AdditionalPropertiesObject + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**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) + + diff --git a/samples/client/petstore/swift4/objcCompatible/docs/AdditionalPropertiesString.md b/samples/client/petstore/swift4/objcCompatible/docs/AdditionalPropertiesString.md new file mode 100644 index 000000000000..5bb8122887c4 --- /dev/null +++ b/samples/client/petstore/swift4/objcCompatible/docs/AdditionalPropertiesString.md @@ -0,0 +1,10 @@ +# AdditionalPropertiesString + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**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) + + diff --git a/samples/client/petstore/swift4/objcCompatible/docs/Animal.md b/samples/client/petstore/swift4/objcCompatible/docs/Animal.md new file mode 100644 index 000000000000..69c601455cd8 --- /dev/null +++ b/samples/client/petstore/swift4/objcCompatible/docs/Animal.md @@ -0,0 +1,11 @@ +# Animal + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**className** | **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) + + diff --git a/samples/client/petstore/swift4/objcCompatible/docs/AnotherFakeAPI.md b/samples/client/petstore/swift4/objcCompatible/docs/AnotherFakeAPI.md new file mode 100644 index 000000000000..f6fc23dd02b3 --- /dev/null +++ b/samples/client/petstore/swift4/objcCompatible/docs/AnotherFakeAPI.md @@ -0,0 +1,60 @@ +# AnotherFakeAPI + +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** +```swift + open class func call123testSpecialTags(body: Client, completion: @escaping ((_ data: Client?,_ error: Error?) -> Void)) +``` + +To test special tags + +To test special tags and operation ID starting with number + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = Client("client_example") // Client | client model + +// To test special tags +AnotherFakeAPI.call123testSpecialTags(body: body) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**Client**](Client.md)| client model | + +### Return type + +[**Client**](Client.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + diff --git a/samples/client/petstore/swift4/objcCompatible/docs/ApiResponse.md b/samples/client/petstore/swift4/objcCompatible/docs/ApiResponse.md new file mode 100644 index 000000000000..c6d9768fe9bf --- /dev/null +++ b/samples/client/petstore/swift4/objcCompatible/docs/ApiResponse.md @@ -0,0 +1,12 @@ +# ApiResponse + +## Properties +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) + + diff --git a/samples/client/petstore/swift4/objcCompatible/docs/ArrayOfArrayOfNumberOnly.md b/samples/client/petstore/swift4/objcCompatible/docs/ArrayOfArrayOfNumberOnly.md new file mode 100644 index 000000000000..3f78a9584d82 --- /dev/null +++ b/samples/client/petstore/swift4/objcCompatible/docs/ArrayOfArrayOfNumberOnly.md @@ -0,0 +1,10 @@ +# ArrayOfArrayOfNumberOnly + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**arrayArrayNumber** | [**[[Double]]**](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) + + diff --git a/samples/client/petstore/swift4/objcCompatible/docs/ArrayOfNumberOnly.md b/samples/client/petstore/swift4/objcCompatible/docs/ArrayOfNumberOnly.md new file mode 100644 index 000000000000..f09f8fa6f70f --- /dev/null +++ b/samples/client/petstore/swift4/objcCompatible/docs/ArrayOfNumberOnly.md @@ -0,0 +1,10 @@ +# ArrayOfNumberOnly + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**arrayNumber** | **[Double]** | | [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) + + diff --git a/samples/client/petstore/swift4/objcCompatible/docs/ArrayTest.md b/samples/client/petstore/swift4/objcCompatible/docs/ArrayTest.md new file mode 100644 index 000000000000..dd9be9d5876b --- /dev/null +++ b/samples/client/petstore/swift4/objcCompatible/docs/ArrayTest.md @@ -0,0 +1,12 @@ +# ArrayTest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**arrayOfString** | **[String]** | | [optional] +**arrayArrayOfInteger** | [**[[Int64]]**](Array.md) | | [optional] +**arrayArrayOfModel** | [**[[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) + + diff --git a/samples/client/petstore/swift4/objcCompatible/docs/Capitalization.md b/samples/client/petstore/swift4/objcCompatible/docs/Capitalization.md new file mode 100644 index 000000000000..95374216c773 --- /dev/null +++ b/samples/client/petstore/swift4/objcCompatible/docs/Capitalization.md @@ -0,0 +1,15 @@ +# Capitalization + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**smallCamel** | **String** | | [optional] +**capitalCamel** | **String** | | [optional] +**smallSnake** | **String** | | [optional] +**capitalSnake** | **String** | | [optional] +**sCAETHFlowPoints** | **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) + + diff --git a/samples/client/petstore/swift4/objcCompatible/docs/Cat.md b/samples/client/petstore/swift4/objcCompatible/docs/Cat.md new file mode 100644 index 000000000000..fb5949b15761 --- /dev/null +++ b/samples/client/petstore/swift4/objcCompatible/docs/Cat.md @@ -0,0 +1,10 @@ +# Cat + +## Properties +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) + + diff --git a/samples/client/petstore/swift4/objcCompatible/docs/Category.md b/samples/client/petstore/swift4/objcCompatible/docs/Category.md new file mode 100644 index 000000000000..f9bf59e4ac49 --- /dev/null +++ b/samples/client/petstore/swift4/objcCompatible/docs/Category.md @@ -0,0 +1,11 @@ +# Category + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**_id** | **Int64** | | [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) + + diff --git a/samples/client/petstore/swift4/objcCompatible/docs/ClassModel.md b/samples/client/petstore/swift4/objcCompatible/docs/ClassModel.md new file mode 100644 index 000000000000..e3912fdf0fd5 --- /dev/null +++ b/samples/client/petstore/swift4/objcCompatible/docs/ClassModel.md @@ -0,0 +1,10 @@ +# ClassModel + +## Properties +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) + + diff --git a/samples/client/petstore/swift4/objcCompatible/docs/Client.md b/samples/client/petstore/swift4/objcCompatible/docs/Client.md new file mode 100644 index 000000000000..0de1b238c36f --- /dev/null +++ b/samples/client/petstore/swift4/objcCompatible/docs/Client.md @@ -0,0 +1,10 @@ +# Client + +## Properties +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) + + diff --git a/samples/client/petstore/swift4/objcCompatible/docs/Dog.md b/samples/client/petstore/swift4/objcCompatible/docs/Dog.md new file mode 100644 index 000000000000..4824786da049 --- /dev/null +++ b/samples/client/petstore/swift4/objcCompatible/docs/Dog.md @@ -0,0 +1,10 @@ +# Dog + +## Properties +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) + + diff --git a/samples/client/petstore/swift4/objcCompatible/docs/EnumArrays.md b/samples/client/petstore/swift4/objcCompatible/docs/EnumArrays.md new file mode 100644 index 000000000000..b9a9807d3c8e --- /dev/null +++ b/samples/client/petstore/swift4/objcCompatible/docs/EnumArrays.md @@ -0,0 +1,11 @@ +# EnumArrays + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**justSymbol** | **String** | | [optional] +**arrayEnum** | **[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) + + diff --git a/samples/client/petstore/swift4/objcCompatible/docs/EnumClass.md b/samples/client/petstore/swift4/objcCompatible/docs/EnumClass.md new file mode 100644 index 000000000000..67f017becd0c --- /dev/null +++ b/samples/client/petstore/swift4/objcCompatible/docs/EnumClass.md @@ -0,0 +1,9 @@ +# EnumClass + +## Properties +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) + + diff --git a/samples/client/petstore/swift4/objcCompatible/docs/EnumTest.md b/samples/client/petstore/swift4/objcCompatible/docs/EnumTest.md new file mode 100644 index 000000000000..bc9b036dd769 --- /dev/null +++ b/samples/client/petstore/swift4/objcCompatible/docs/EnumTest.md @@ -0,0 +1,14 @@ +# EnumTest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enumString** | **String** | | [optional] +**enumStringRequired** | **String** | | +**enumInteger** | **Int** | | [optional] +**enumNumber** | **Double** | | [optional] +**outerEnum** | [**OuterEnum**](OuterEnum.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) + + diff --git a/samples/client/petstore/swift4/objcCompatible/docs/FakeAPI.md b/samples/client/petstore/swift4/objcCompatible/docs/FakeAPI.md new file mode 100644 index 000000000000..d89f9f44b0b5 --- /dev/null +++ b/samples/client/petstore/swift4/objcCompatible/docs/FakeAPI.md @@ -0,0 +1,726 @@ +# FakeAPI + +All URIs are relative to *http://petstore.swagger.io:80/v2* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createXmlItem**](FakeAPI.md#createxmlitem) | **POST** /fake/create_xml_item | creates an XmlItem +[**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 + + +# **createXmlItem** +```swift + open class func createXmlItem(xmlItem: XmlItem, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) +``` + +creates an XmlItem + +this route creates an XmlItem + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let xmlItem = XmlItem("attributeString_example", 123, 123, 123, [123], "nameString_example", 123, 123, 123, [123], [123], "prefixString_example", 123, 123, 123, [123], [123], "namespaceString_example", 123, 123, 123, [123], [123], "prefixNsString_example", 123, 123, 123, [123], [123]) // XmlItem | XmlItem Body + +// creates an XmlItem +FakeAPI.createXmlItem(xmlItem: xmlItem) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xmlItem** | [**XmlItem**](XmlItem.md)| XmlItem Body | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/xml, application/xml; charset=utf-8, application/xml; charset=utf-16, text/xml, text/xml; charset=utf-8, text/xml; charset=utf-16 + - **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 README]](../README.md) + +# **fakeOuterBooleanSerialize** +```swift + open class func fakeOuterBooleanSerialize(body: Bool? = nil, completion: @escaping ((_ data: Bool?,_ error: Error?) -> Void)) +``` + + + +Test serialization of outer boolean types + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = 987 // Bool | Input boolean as post body (optional) + +FakeAPI.fakeOuterBooleanSerialize(body: body) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **Bool**| Input boolean as post body | [optional] + +### Return type + +**Bool** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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 README]](../README.md) + +# **fakeOuterCompositeSerialize** +```swift + open class func fakeOuterCompositeSerialize(body: OuterComposite? = nil, completion: @escaping ((_ data: OuterComposite?,_ error: Error?) -> Void)) +``` + + + +Test serialization of object with outer number type + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = OuterComposite(123, "myString_example", 123) // OuterComposite | Input composite as post body (optional) + +FakeAPI.fakeOuterCompositeSerialize(body: body) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**OuterComposite**](OuterComposite.md)| Input composite as post body | [optional] + +### Return type + +[**OuterComposite**](OuterComposite.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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 README]](../README.md) + +# **fakeOuterNumberSerialize** +```swift + open class func fakeOuterNumberSerialize(body: Double? = nil, completion: @escaping ((_ data: Double?,_ error: Error?) -> Void)) +``` + + + +Test serialization of outer number types + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = 987 // Double | Input number as post body (optional) + +FakeAPI.fakeOuterNumberSerialize(body: body) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **Double**| Input number as post body | [optional] + +### Return type + +**Double** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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 README]](../README.md) + +# **fakeOuterStringSerialize** +```swift + open class func fakeOuterStringSerialize(body: String? = nil, completion: @escaping ((_ data: String?,_ error: Error?) -> Void)) +``` + + + +Test serialization of outer string types + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = "body_example" // String | Input string as post body (optional) + +FakeAPI.fakeOuterStringSerialize(body: body) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **String**| Input string as post body | [optional] + +### Return type + +**String** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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 README]](../README.md) + +# **testBodyWithFileSchema** +```swift + open class func testBodyWithFileSchema(body: FileSchemaTestClass, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) +``` + + + +For this test, the body for this request much reference a schema named `File`. + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = FileSchemaTestClass(File("sourceURI_example"), [File("sourceURI_example")]) // FileSchemaTestClass | + +FakeAPI.testBodyWithFileSchema(body: body) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**FileSchemaTestClass**](FileSchemaTestClass.md)| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + +# **testBodyWithQueryParams** +```swift + open class func testBodyWithQueryParams(query: String, body: User, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) +``` + + + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let query = "query_example" // String | +let body = User(123, "username_example", "firstName_example", "lastName_example", "email_example", "password_example", "phone_example", 123) // User | + +FakeAPI.testBodyWithQueryParams(query: query, body: body) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **String**| | + **body** | [**User**](User.md)| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + +# **testClientModel** +```swift + open class func testClientModel(body: Client, completion: @escaping ((_ data: Client?,_ error: Error?) -> Void)) +``` + +To test \"client\" model + +To test \"client\" model + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = Client("client_example") // Client | client model + +// To test \"client\" model +FakeAPI.testClientModel(body: body) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**Client**](Client.md)| client model | + +### Return type + +[**Client**](Client.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + +# **testEndpointParameters** +```swift + open class func testEndpointParameters(number: Double, double: Double, patternWithoutDelimiter: String, byte: Data, integer: Int? = nil, int32: Int? = nil, int64: Int64? = nil, float: Float? = nil, string: String? = nil, binary: URL? = nil, date: Date? = nil, dateTime: Date? = nil, password: String? = nil, callback: String? = nil, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) +``` + +Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 + +Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let number = 987 // Double | None +let double = 987 // Double | None +let patternWithoutDelimiter = "patternWithoutDelimiter_example" // String | None +let byte = TODO // Data | None +let integer = 987 // Int | None (optional) +let int32 = 987 // Int | None (optional) +let int64 = 987 // Int64 | None (optional) +let float = 987 // Float | None (optional) +let string = "string_example" // String | None (optional) +let binary = "TODO" // URL | None (optional) +let date = TODO // Date | None (optional) +let dateTime = TODO // Date | None (optional) +let password = "password_example" // String | None (optional) +let callback = "callback_example" // String | None (optional) + +// Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 +FakeAPI.testEndpointParameters(number: number, double: double, patternWithoutDelimiter: patternWithoutDelimiter, byte: byte, integer: integer, int32: int32, int64: int64, float: float, string: string, binary: binary, date: date, dateTime: dateTime, password: password, callback: callback) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **number** | **Double**| None | + **double** | **Double**| None | + **patternWithoutDelimiter** | **String**| None | + **byte** | **Data**| None | + **integer** | **Int**| None | [optional] + **int32** | **Int**| None | [optional] + **int64** | **Int64**| None | [optional] + **float** | **Float**| None | [optional] + **string** | **String**| None | [optional] + **binary** | **URL****URL**| None | [optional] + **date** | **Date**| None | [optional] + **dateTime** | **Date**| None | [optional] + **password** | **String**| None | [optional] + **callback** | **String**| None | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[http_basic_test](../README.md#http_basic_test) + +### HTTP request headers + + - **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 README]](../README.md) + +# **testEnumParameters** +```swift + open class func testEnumParameters(enumHeaderStringArray: [String]? = nil, enumHeaderString: EnumHeaderString_testEnumParameters? = nil, enumQueryStringArray: [String]? = nil, enumQueryString: EnumQueryString_testEnumParameters? = nil, enumQueryInteger: EnumQueryInteger_testEnumParameters? = nil, enumQueryDouble: EnumQueryDouble_testEnumParameters? = nil, enumFormStringArray: [String]? = nil, enumFormString: EnumFormString_testEnumParameters? = nil, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) +``` + +To test enum parameters + +To test enum parameters + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let enumHeaderStringArray = ["enumHeaderStringArray_example"] // [String] | Header parameter enum test (string array) (optional) +let enumHeaderString = "enumHeaderString_example" // String | Header parameter enum test (string) (optional) (default to .-efg) +let enumQueryStringArray = ["enumQueryStringArray_example"] // [String] | Query parameter enum test (string array) (optional) +let enumQueryString = "enumQueryString_example" // String | Query parameter enum test (string) (optional) (default to .-efg) +let enumQueryInteger = 987 // Int | Query parameter enum test (double) (optional) +let enumQueryDouble = 987 // Double | Query parameter enum test (double) (optional) +let enumFormStringArray = ["inner_example"] // [String] | Form parameter enum test (string array) (optional) (default to .$) +let enumFormString = "enumFormString_example" // String | Form parameter enum test (string) (optional) (default to .-efg) + +// To test enum parameters +FakeAPI.testEnumParameters(enumHeaderStringArray: enumHeaderStringArray, enumHeaderString: enumHeaderString, enumQueryStringArray: enumQueryStringArray, enumQueryString: enumQueryString, enumQueryInteger: enumQueryInteger, enumQueryDouble: enumQueryDouble, enumFormStringArray: enumFormStringArray, enumFormString: enumFormString) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **enumHeaderStringArray** | [**[String]**](String.md)| Header parameter enum test (string array) | [optional] + **enumHeaderString** | **String**| Header parameter enum test (string) | [optional] [default to .-efg] + **enumQueryStringArray** | [**[String]**](String.md)| Query parameter enum test (string array) | [optional] + **enumQueryString** | **String**| Query parameter enum test (string) | [optional] [default to .-efg] + **enumQueryInteger** | **Int**| Query parameter enum test (double) | [optional] + **enumQueryDouble** | **Double**| Query parameter enum test (double) | [optional] + **enumFormStringArray** | [**[String]**](String.md)| Form parameter enum test (string array) | [optional] [default to .$] + **enumFormString** | **String**| Form parameter enum test (string) | [optional] [default to .-efg] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + +# **testGroupParameters** +```swift + open class func testGroupParameters(requiredStringGroup: Int, requiredBooleanGroup: Bool, requiredInt64Group: Int64, stringGroup: Int? = nil, booleanGroup: Bool? = nil, int64Group: Int64? = nil, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) +``` + +Fake endpoint to test group parameters (optional) + +Fake endpoint to test group parameters (optional) + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let requiredStringGroup = 987 // Int | Required String in group parameters +let requiredBooleanGroup = 987 // Bool | Required Boolean in group parameters +let requiredInt64Group = 987 // Int64 | Required Integer in group parameters +let stringGroup = 987 // Int | String in group parameters (optional) +let booleanGroup = 987 // Bool | Boolean in group parameters (optional) +let int64Group = 987 // Int64 | Integer in group parameters (optional) + +// Fake endpoint to test group parameters (optional) +FakeAPI.testGroupParameters(requiredStringGroup: requiredStringGroup, requiredBooleanGroup: requiredBooleanGroup, requiredInt64Group: requiredInt64Group, stringGroup: stringGroup, booleanGroup: booleanGroup, int64Group: int64Group) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **requiredStringGroup** | **Int**| Required String in group parameters | + **requiredBooleanGroup** | **Bool**| Required Boolean in group parameters | + **requiredInt64Group** | **Int64**| Required Integer in group parameters | + **stringGroup** | **Int**| String in group parameters | [optional] + **booleanGroup** | **Bool**| Boolean in group parameters | [optional] + **int64Group** | **Int64**| Integer in group parameters | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + +# **testInlineAdditionalProperties** +```swift + open class func testInlineAdditionalProperties(param: [String:String], completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) +``` + +test inline additionalProperties + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let param = "TODO" // [String:String] | request body + +// test inline additionalProperties +FakeAPI.testInlineAdditionalProperties(param: param) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **param** | [**[String:String]**](String.md)| request body | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + +# **testJsonFormData** +```swift + open class func testJsonFormData(param: String, param2: String, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) +``` + +test json serialization of form data + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let param = "param_example" // String | field1 +let param2 = "param2_example" // String | field2 + +// test json serialization of form data +FakeAPI.testJsonFormData(param: param, param2: param2) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **param** | **String**| field1 | + **param2** | **String**| field2 | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + diff --git a/samples/client/petstore/swift4/objcCompatible/docs/FakeClassnameTags123API.md b/samples/client/petstore/swift4/objcCompatible/docs/FakeClassnameTags123API.md new file mode 100644 index 000000000000..cacc84a1cf89 --- /dev/null +++ b/samples/client/petstore/swift4/objcCompatible/docs/FakeClassnameTags123API.md @@ -0,0 +1,60 @@ +# FakeClassnameTags123API + +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** +```swift + open class func testClassname(body: Client, completion: @escaping ((_ data: Client?,_ error: Error?) -> Void)) +``` + +To test class name in snake case + +To test class name in snake case + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = Client("client_example") // Client | client model + +// To test class name in snake case +FakeClassnameTags123API.testClassname(body: body) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**Client**](Client.md)| client model | + +### Return type + +[**Client**](Client.md) + +### Authorization + +[api_key_query](../README.md#api_key_query) + +### HTTP request headers + + - **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 README]](../README.md) + diff --git a/samples/client/petstore/swift4/objcCompatible/docs/File.md b/samples/client/petstore/swift4/objcCompatible/docs/File.md new file mode 100644 index 000000000000..3edfef17b794 --- /dev/null +++ b/samples/client/petstore/swift4/objcCompatible/docs/File.md @@ -0,0 +1,10 @@ +# File + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**sourceURI** | **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) + + diff --git a/samples/client/petstore/swift4/objcCompatible/docs/FileSchemaTestClass.md b/samples/client/petstore/swift4/objcCompatible/docs/FileSchemaTestClass.md new file mode 100644 index 000000000000..d0a8bbaaba95 --- /dev/null +++ b/samples/client/petstore/swift4/objcCompatible/docs/FileSchemaTestClass.md @@ -0,0 +1,11 @@ +# FileSchemaTestClass + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**file** | [**File**](File.md) | | [optional] +**files** | [**[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) + + diff --git a/samples/client/petstore/swift4/objcCompatible/docs/FormatTest.md b/samples/client/petstore/swift4/objcCompatible/docs/FormatTest.md new file mode 100644 index 000000000000..547eb88754f4 --- /dev/null +++ b/samples/client/petstore/swift4/objcCompatible/docs/FormatTest.md @@ -0,0 +1,22 @@ +# FormatTest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**integer** | **Int** | | [optional] +**int32** | **Int** | | [optional] +**int64** | **Int64** | | [optional] +**number** | **Double** | | +**float** | **Float** | | [optional] +**double** | **Double** | | [optional] +**string** | **String** | | [optional] +**byte** | [**Data**](Data.md) | | +**binary** | [**URL**](URL.md) | | [optional] +**date** | [**Date**](Date.md) | | +**dateTime** | [**Date**](Date.md) | | [optional] +**uuid** | [**UUID**](UUID.md) | | [optional] +**password** | **String** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/samples/client/petstore/swift4/objcCompatible/docs/HasOnlyReadOnly.md b/samples/client/petstore/swift4/objcCompatible/docs/HasOnlyReadOnly.md new file mode 100644 index 000000000000..45781360154c --- /dev/null +++ b/samples/client/petstore/swift4/objcCompatible/docs/HasOnlyReadOnly.md @@ -0,0 +1,11 @@ +# HasOnlyReadOnly + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**bar** | **String** | | [optional] +**foo** | **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) + + diff --git a/samples/client/petstore/swift4/objcCompatible/docs/List.md b/samples/client/petstore/swift4/objcCompatible/docs/List.md new file mode 100644 index 000000000000..b77718302edf --- /dev/null +++ b/samples/client/petstore/swift4/objcCompatible/docs/List.md @@ -0,0 +1,10 @@ +# List + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**_123list** | **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) + + diff --git a/samples/client/petstore/swift4/objcCompatible/docs/MapTest.md b/samples/client/petstore/swift4/objcCompatible/docs/MapTest.md new file mode 100644 index 000000000000..ecd9c5f5e8b4 --- /dev/null +++ b/samples/client/petstore/swift4/objcCompatible/docs/MapTest.md @@ -0,0 +1,13 @@ +# MapTest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**mapMapOfString** | [**[String:[String:String]]**](Dictionary.md) | | [optional] +**mapOfEnumString** | **[String:String]** | | [optional] +**directMap** | **[String:Bool]** | | [optional] +**indirectMap** | **[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) + + diff --git a/samples/client/petstore/swift4/objcCompatible/docs/MixedPropertiesAndAdditionalPropertiesClass.md b/samples/client/petstore/swift4/objcCompatible/docs/MixedPropertiesAndAdditionalPropertiesClass.md new file mode 100644 index 000000000000..2c502eace42c --- /dev/null +++ b/samples/client/petstore/swift4/objcCompatible/docs/MixedPropertiesAndAdditionalPropertiesClass.md @@ -0,0 +1,12 @@ +# MixedPropertiesAndAdditionalPropertiesClass + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**uuid** | [**UUID**](UUID.md) | | [optional] +**dateTime** | [**Date**](Date.md) | | [optional] +**map** | [**[String: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) + + diff --git a/samples/client/petstore/swift4/objcCompatible/docs/Model200Response.md b/samples/client/petstore/swift4/objcCompatible/docs/Model200Response.md new file mode 100644 index 000000000000..5865ea690cc3 --- /dev/null +++ b/samples/client/petstore/swift4/objcCompatible/docs/Model200Response.md @@ -0,0 +1,11 @@ +# Model200Response + +## Properties +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) + + diff --git a/samples/client/petstore/swift4/objcCompatible/docs/Name.md b/samples/client/petstore/swift4/objcCompatible/docs/Name.md new file mode 100644 index 000000000000..2be75d062e47 --- /dev/null +++ b/samples/client/petstore/swift4/objcCompatible/docs/Name.md @@ -0,0 +1,13 @@ +# Name + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **Int** | | +**snakeCase** | **Int** | | [optional] +**property** | **String** | | [optional] +**_123number** | **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) + + diff --git a/samples/client/petstore/swift4/objcCompatible/docs/NumberOnly.md b/samples/client/petstore/swift4/objcCompatible/docs/NumberOnly.md new file mode 100644 index 000000000000..72bd361168b5 --- /dev/null +++ b/samples/client/petstore/swift4/objcCompatible/docs/NumberOnly.md @@ -0,0 +1,10 @@ +# NumberOnly + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**justNumber** | **Double** | | [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) + + diff --git a/samples/client/petstore/swift4/objcCompatible/docs/Order.md b/samples/client/petstore/swift4/objcCompatible/docs/Order.md new file mode 100644 index 000000000000..16950a5f7aed --- /dev/null +++ b/samples/client/petstore/swift4/objcCompatible/docs/Order.md @@ -0,0 +1,15 @@ +# Order + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**_id** | **Int64** | | [optional] +**petId** | **Int64** | | [optional] +**quantity** | **Int** | | [optional] +**shipDate** | [**Date**](Date.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) + + diff --git a/samples/client/petstore/swift4/objcCompatible/docs/OuterComposite.md b/samples/client/petstore/swift4/objcCompatible/docs/OuterComposite.md new file mode 100644 index 000000000000..d6b3583bc3ff --- /dev/null +++ b/samples/client/petstore/swift4/objcCompatible/docs/OuterComposite.md @@ -0,0 +1,12 @@ +# OuterComposite + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**myNumber** | **Double** | | [optional] +**myString** | **String** | | [optional] +**myBoolean** | **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) + + diff --git a/samples/client/petstore/swift4/objcCompatible/docs/OuterEnum.md b/samples/client/petstore/swift4/objcCompatible/docs/OuterEnum.md new file mode 100644 index 000000000000..06d413b01680 --- /dev/null +++ b/samples/client/petstore/swift4/objcCompatible/docs/OuterEnum.md @@ -0,0 +1,9 @@ +# OuterEnum + +## Properties +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) + + diff --git a/samples/client/petstore/swift4/objcCompatible/docs/Pet.md b/samples/client/petstore/swift4/objcCompatible/docs/Pet.md new file mode 100644 index 000000000000..916dae0d4366 --- /dev/null +++ b/samples/client/petstore/swift4/objcCompatible/docs/Pet.md @@ -0,0 +1,15 @@ +# Pet + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**_id** | **Int64** | | [optional] +**category** | [**Category**](Category.md) | | [optional] +**name** | **String** | | +**photoUrls** | **[String]** | | +**tags** | [**[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) + + diff --git a/samples/client/petstore/swift4/objcCompatible/docs/PetAPI.md b/samples/client/petstore/swift4/objcCompatible/docs/PetAPI.md new file mode 100644 index 000000000000..bd2640ed0a8d --- /dev/null +++ b/samples/client/petstore/swift4/objcCompatible/docs/PetAPI.md @@ -0,0 +1,478 @@ +# PetAPI + +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** +```swift + open class func addPet(body: Pet, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) +``` + +Add a new pet to the store + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = Pet(123, Category(123, "name_example"), "name_example", ["photoUrls_example"], [Tag(123, "name_example")], "status_example") // Pet | Pet object that needs to be added to the store + +// Add a new pet to the store +PetAPI.addPet(body: body) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | + +### Return type + +void (empty response body) + +### Authorization + +[petstore_auth](../README.md#petstore_auth) + +### HTTP request headers + + - **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 README]](../README.md) + +# **deletePet** +```swift + open class func deletePet(petId: Int64, apiKey: String? = nil, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) +``` + +Deletes a pet + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let petId = 987 // Int64 | Pet id to delete +let apiKey = "apiKey_example" // String | (optional) + +// Deletes a pet +PetAPI.deletePet(petId: petId, apiKey: apiKey) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **petId** | **Int64**| Pet id to delete | + **apiKey** | **String**| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[petstore_auth](../README.md#petstore_auth) + +### HTTP request headers + + - **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 README]](../README.md) + +# **findPetsByStatus** +```swift + open class func findPetsByStatus(status: [String], completion: @escaping ((_ data: [Pet]?,_ error: Error?) -> Void)) +``` + +Finds Pets by status + +Multiple status values can be provided with comma separated strings + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let status = ["status_example"] // [String] | Status values that need to be considered for filter + +// Finds Pets by status +PetAPI.findPetsByStatus(status: status) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **status** | [**[String]**](String.md)| Status values that need to be considered for filter | + +### Return type + +[**[Pet]**](Pet.md) + +### Authorization + +[petstore_auth](../README.md#petstore_auth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **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 README]](../README.md) + +# **findPetsByTags** +```swift + open class func findPetsByTags(tags: [String], completion: @escaping ((_ data: [Pet]?,_ error: Error?) -> Void)) +``` + +Finds Pets by tags + +Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let tags = ["inner_example"] // [String] | Tags to filter by + +// Finds Pets by tags +PetAPI.findPetsByTags(tags: tags) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **tags** | [**[String]**](String.md)| Tags to filter by | + +### Return type + +[**[Pet]**](Pet.md) + +### Authorization + +[petstore_auth](../README.md#petstore_auth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **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 README]](../README.md) + +# **getPetById** +```swift + open class func getPetById(petId: Int64, completion: @escaping ((_ data: Pet?,_ error: Error?) -> Void)) +``` + +Find pet by ID + +Returns a single pet + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let petId = 987 // Int64 | ID of pet to return + +// Find pet by ID +PetAPI.getPetById(petId: petId) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **petId** | **Int64**| ID of pet to return | + +### Return type + +[**Pet**](Pet.md) + +### Authorization + +[api_key](../README.md#api_key) + +### HTTP request headers + + - **Content-Type**: Not defined + - **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 README]](../README.md) + +# **updatePet** +```swift + open class func updatePet(body: Pet, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) +``` + +Update an existing pet + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = Pet(123, Category(123, "name_example"), "name_example", ["photoUrls_example"], [Tag(123, "name_example")], "status_example") // Pet | Pet object that needs to be added to the store + +// Update an existing pet +PetAPI.updatePet(body: body) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | + +### Return type + +void (empty response body) + +### Authorization + +[petstore_auth](../README.md#petstore_auth) + +### HTTP request headers + + - **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 README]](../README.md) + +# **updatePetWithForm** +```swift + open class func updatePetWithForm(petId: Int64, name: String? = nil, status: String? = nil, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) +``` + +Updates a pet in the store with form data + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let petId = 987 // Int64 | ID of pet that needs to be updated +let name = "name_example" // String | Updated name of the pet (optional) +let status = "status_example" // String | Updated status of the pet (optional) + +// Updates a pet in the store with form data +PetAPI.updatePetWithForm(petId: petId, name: name, status: status) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **petId** | **Int64**| ID of pet that needs to be updated | + **name** | **String**| Updated name of the pet | [optional] + **status** | **String**| Updated status of the pet | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[petstore_auth](../README.md#petstore_auth) + +### HTTP request headers + + - **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 README]](../README.md) + +# **uploadFile** +```swift + open class func uploadFile(petId: Int64, additionalMetadata: String? = nil, file: URL? = nil, completion: @escaping ((_ data: ApiResponse?,_ error: Error?) -> Void)) +``` + +uploads an image + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let petId = 987 // Int64 | ID of pet to update +let additionalMetadata = "additionalMetadata_example" // String | Additional data to pass to server (optional) +let file = "TODO" // URL | file to upload (optional) + +// uploads an image +PetAPI.uploadFile(petId: petId, additionalMetadata: additionalMetadata, file: file) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **petId** | **Int64**| ID of pet to update | + **additionalMetadata** | **String**| Additional data to pass to server | [optional] + **file** | **URL****URL**| file to upload | [optional] + +### Return type + +[**ApiResponse**](ApiResponse.md) + +### Authorization + +[petstore_auth](../README.md#petstore_auth) + +### HTTP request headers + + - **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 README]](../README.md) + +# **uploadFileWithRequiredFile** +```swift + open class func uploadFileWithRequiredFile(petId: Int64, requiredFile: URL, additionalMetadata: String? = nil, completion: @escaping ((_ data: ApiResponse?,_ error: Error?) -> Void)) +``` + +uploads an image (required) + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let petId = 987 // Int64 | ID of pet to update +let requiredFile = "TODO" // URL | file to upload +let additionalMetadata = "additionalMetadata_example" // String | Additional data to pass to server (optional) + +// uploads an image (required) +PetAPI.uploadFileWithRequiredFile(petId: petId, requiredFile: requiredFile, additionalMetadata: additionalMetadata) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **petId** | **Int64**| ID of pet to update | + **requiredFile** | **URL****URL**| file to upload | + **additionalMetadata** | **String**| Additional data to pass to server | [optional] + +### Return type + +[**ApiResponse**](ApiResponse.md) + +### Authorization + +[petstore_auth](../README.md#petstore_auth) + +### HTTP request headers + + - **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 README]](../README.md) + diff --git a/samples/client/petstore/swift4/objcCompatible/docs/ReadOnlyFirst.md b/samples/client/petstore/swift4/objcCompatible/docs/ReadOnlyFirst.md new file mode 100644 index 000000000000..e3f16038b970 --- /dev/null +++ b/samples/client/petstore/swift4/objcCompatible/docs/ReadOnlyFirst.md @@ -0,0 +1,11 @@ +# ReadOnlyFirst + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**bar** | **String** | | [optional] +**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) + + diff --git a/samples/client/petstore/swift4/objcCompatible/docs/Return.md b/samples/client/petstore/swift4/objcCompatible/docs/Return.md new file mode 100644 index 000000000000..66d17c27c887 --- /dev/null +++ b/samples/client/petstore/swift4/objcCompatible/docs/Return.md @@ -0,0 +1,10 @@ +# Return + +## Properties +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) + + diff --git a/samples/client/petstore/swift4/objcCompatible/docs/SpecialModelName.md b/samples/client/petstore/swift4/objcCompatible/docs/SpecialModelName.md new file mode 100644 index 000000000000..3ec27a38c2ac --- /dev/null +++ b/samples/client/petstore/swift4/objcCompatible/docs/SpecialModelName.md @@ -0,0 +1,10 @@ +# SpecialModelName + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**specialPropertyName** | **Int64** | | [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) + + diff --git a/samples/client/petstore/swift4/objcCompatible/docs/StoreAPI.md b/samples/client/petstore/swift4/objcCompatible/docs/StoreAPI.md new file mode 100644 index 000000000000..45210030fae1 --- /dev/null +++ b/samples/client/petstore/swift4/objcCompatible/docs/StoreAPI.md @@ -0,0 +1,210 @@ +# StoreAPI + +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** +```swift + open class func deleteOrder(orderId: String, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) +``` + +Delete purchase order by ID + +For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let orderId = "orderId_example" // String | ID of the order that needs to be deleted + +// Delete purchase order by ID +StoreAPI.deleteOrder(orderId: orderId) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **orderId** | **String**| ID of the order that needs to be deleted | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + +# **getInventory** +```swift + open class func getInventory(completion: @escaping ((_ data: [String:Int]?,_ error: Error?) -> Void)) +``` + +Returns pet inventories by status + +Returns a map of status codes to quantities + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + + +// Returns pet inventories by status +StoreAPI.getInventory() { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[String:Int]** + +### Authorization + +[api_key](../README.md#api_key) + +### HTTP request headers + + - **Content-Type**: Not defined + - **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 README]](../README.md) + +# **getOrderById** +```swift + open class func getOrderById(orderId: Int64, completion: @escaping ((_ data: Order?,_ error: Error?) -> Void)) +``` + +Find purchase order by ID + +For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let orderId = 987 // Int64 | ID of pet that needs to be fetched + +// Find purchase order by ID +StoreAPI.getOrderById(orderId: orderId) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **orderId** | **Int64**| ID of pet that needs to be fetched | + +### Return type + +[**Order**](Order.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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 README]](../README.md) + +# **placeOrder** +```swift + open class func placeOrder(body: Order, completion: @escaping ((_ data: Order?,_ error: Error?) -> Void)) +``` + +Place an order for a pet + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = Order(123, 123, 123, "TODO", "status_example", 123) // Order | order placed for purchasing the pet + +// Place an order for a pet +StoreAPI.placeOrder(body: body) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**Order**](Order.md)| order placed for purchasing the pet | + +### Return type + +[**Order**](Order.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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 README]](../README.md) + diff --git a/samples/client/petstore/swift4/objcCompatible/docs/Tag.md b/samples/client/petstore/swift4/objcCompatible/docs/Tag.md new file mode 100644 index 000000000000..24a050117abc --- /dev/null +++ b/samples/client/petstore/swift4/objcCompatible/docs/Tag.md @@ -0,0 +1,11 @@ +# Tag + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**_id** | **Int64** | | [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) + + diff --git a/samples/client/petstore/swift4/objcCompatible/docs/TypeHolderDefault.md b/samples/client/petstore/swift4/objcCompatible/docs/TypeHolderDefault.md new file mode 100644 index 000000000000..5161394bdc3e --- /dev/null +++ b/samples/client/petstore/swift4/objcCompatible/docs/TypeHolderDefault.md @@ -0,0 +1,14 @@ +# TypeHolderDefault + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**stringItem** | **String** | | [default to "what"] +**numberItem** | **Double** | | +**integerItem** | **Int** | | +**boolItem** | **Bool** | | [default to true] +**arrayItem** | **[Int]** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/samples/client/petstore/swift4/objcCompatible/docs/TypeHolderExample.md b/samples/client/petstore/swift4/objcCompatible/docs/TypeHolderExample.md new file mode 100644 index 000000000000..46d0471cd71a --- /dev/null +++ b/samples/client/petstore/swift4/objcCompatible/docs/TypeHolderExample.md @@ -0,0 +1,14 @@ +# TypeHolderExample + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**stringItem** | **String** | | +**numberItem** | **Double** | | +**integerItem** | **Int** | | +**boolItem** | **Bool** | | +**arrayItem** | **[Int]** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/samples/client/petstore/swift4/objcCompatible/docs/User.md b/samples/client/petstore/swift4/objcCompatible/docs/User.md new file mode 100644 index 000000000000..a8791643e76d --- /dev/null +++ b/samples/client/petstore/swift4/objcCompatible/docs/User.md @@ -0,0 +1,17 @@ +# User + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**_id** | **Int64** | | [optional] +**username** | **String** | | [optional] +**firstName** | **String** | | [optional] +**lastName** | **String** | | [optional] +**email** | **String** | | [optional] +**password** | **String** | | [optional] +**phone** | **String** | | [optional] +**userStatus** | **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) + + diff --git a/samples/client/petstore/swift4/objcCompatible/docs/UserAPI.md b/samples/client/petstore/swift4/objcCompatible/docs/UserAPI.md new file mode 100644 index 000000000000..b22538654d8a --- /dev/null +++ b/samples/client/petstore/swift4/objcCompatible/docs/UserAPI.md @@ -0,0 +1,414 @@ +# UserAPI + +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** +```swift + open class func createUser(body: User, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) +``` + +Create user + +This can only be done by the logged in user. + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = User(123, "username_example", "firstName_example", "lastName_example", "email_example", "password_example", "phone_example", 123) // User | Created user object + +// Create user +UserAPI.createUser(body: body) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**User**](User.md)| Created user object | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + +# **createUsersWithArrayInput** +```swift + open class func createUsersWithArrayInput(body: [User], completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) +``` + +Creates list of users with given input array + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = [User(123, "username_example", "firstName_example", "lastName_example", "email_example", "password_example", "phone_example", 123)] // [User] | List of user object + +// Creates list of users with given input array +UserAPI.createUsersWithArrayInput(body: body) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**[User]**](Array.md)| List of user object | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + +# **createUsersWithListInput** +```swift + open class func createUsersWithListInput(body: [User], completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) +``` + +Creates list of users with given input array + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = [User(123, "username_example", "firstName_example", "lastName_example", "email_example", "password_example", "phone_example", 123)] // [User] | List of user object + +// Creates list of users with given input array +UserAPI.createUsersWithListInput(body: body) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**[User]**](Array.md)| List of user object | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + +# **deleteUser** +```swift + open class func deleteUser(username: String, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) +``` + +Delete user + +This can only be done by the logged in user. + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let username = "username_example" // String | The name that needs to be deleted + +// Delete user +UserAPI.deleteUser(username: username) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **username** | **String**| The name that needs to be deleted | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + +# **getUserByName** +```swift + open class func getUserByName(username: String, completion: @escaping ((_ data: User?,_ error: Error?) -> Void)) +``` + +Get user by user name + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let username = "username_example" // String | The name that needs to be fetched. Use user1 for testing. + +// Get user by user name +UserAPI.getUserByName(username: username) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **username** | **String**| The name that needs to be fetched. Use user1 for testing. | + +### Return type + +[**User**](User.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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 README]](../README.md) + +# **loginUser** +```swift + open class func loginUser(username: String, password: String, completion: @escaping ((_ data: String?,_ error: Error?) -> Void)) +``` + +Logs user into the system + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let username = "username_example" // String | The user name for login +let password = "password_example" // String | The password for login in clear text + +// Logs user into the system +UserAPI.loginUser(username: username, password: password) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **username** | **String**| The user name for login | + **password** | **String**| The password for login in clear text | + +### Return type + +**String** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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 README]](../README.md) + +# **logoutUser** +```swift + open class func logoutUser(completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) +``` + +Logs out current logged in user session + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + + +// Logs out current logged in user session +UserAPI.logoutUser() { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + +# **updateUser** +```swift + open class func updateUser(username: String, body: User, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) +``` + +Updated user + +This can only be done by the logged in user. + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let username = "username_example" // String | name that need to be deleted +let body = User(123, "username_example", "firstName_example", "lastName_example", "email_example", "password_example", "phone_example", 123) // User | Updated user object + +// Updated user +UserAPI.updateUser(username: username, body: body) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **username** | **String**| name that need to be deleted | + **body** | [**User**](User.md)| Updated user object | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + diff --git a/samples/client/petstore/swift4/objcCompatible/docs/XmlItem.md b/samples/client/petstore/swift4/objcCompatible/docs/XmlItem.md new file mode 100644 index 000000000000..1a4eb4e9c836 --- /dev/null +++ b/samples/client/petstore/swift4/objcCompatible/docs/XmlItem.md @@ -0,0 +1,38 @@ +# XmlItem + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributeString** | **String** | | [optional] +**attributeNumber** | **Double** | | [optional] +**attributeInteger** | **Int** | | [optional] +**attributeBoolean** | **Bool** | | [optional] +**wrappedArray** | **[Int]** | | [optional] +**nameString** | **String** | | [optional] +**nameNumber** | **Double** | | [optional] +**nameInteger** | **Int** | | [optional] +**nameBoolean** | **Bool** | | [optional] +**nameArray** | **[Int]** | | [optional] +**nameWrappedArray** | **[Int]** | | [optional] +**prefixString** | **String** | | [optional] +**prefixNumber** | **Double** | | [optional] +**prefixInteger** | **Int** | | [optional] +**prefixBoolean** | **Bool** | | [optional] +**prefixArray** | **[Int]** | | [optional] +**prefixWrappedArray** | **[Int]** | | [optional] +**namespaceString** | **String** | | [optional] +**namespaceNumber** | **Double** | | [optional] +**namespaceInteger** | **Int** | | [optional] +**namespaceBoolean** | **Bool** | | [optional] +**namespaceArray** | **[Int]** | | [optional] +**namespaceWrappedArray** | **[Int]** | | [optional] +**prefixNsString** | **String** | | [optional] +**prefixNsNumber** | **Double** | | [optional] +**prefixNsInteger** | **Int** | | [optional] +**prefixNsBoolean** | **Bool** | | [optional] +**prefixNsArray** | **[Int]** | | [optional] +**prefixNsWrappedArray** | **[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) + + diff --git a/samples/client/petstore/swift4/promisekit/README.md b/samples/client/petstore/swift4/promisekit/README.md new file mode 100644 index 000000000000..1e7f0a59ea01 --- /dev/null +++ b/samples/client/petstore/swift4/promisekit/README.md @@ -0,0 +1,139 @@ +# Swift4 API client for PetstoreClient + +This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\ + +## Overview +This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [openapi-spec from a remote server, you can easily generate an API client. + +- API version: 1.0.0 +- Package version: +- Build package: org.openapitools.codegen.languages.Swift4Codegen + +## Installation + +### Carthage + +Run `carthage update` + +### CocoaPods + +Run `pod install` + +## Documentation for API Endpoints + +All URIs are relative to *http://petstore.swagger.io:80/v2* + +Class | Method | HTTP request | Description +------------ | ------------- | ------------- | ------------- +*AnotherFakeAPI* | [**call123testSpecialTags**](docs/AnotherFakeAPI.md#call123testspecialtags) | **PATCH** /another-fake/dummy | To test special tags +*FakeAPI* | [**fakeOuterBooleanSerialize**](docs/FakeAPI.md#fakeouterbooleanserialize) | **POST** /fake/outer/boolean | +*FakeAPI* | [**fakeOuterCompositeSerialize**](docs/FakeAPI.md#fakeoutercompositeserialize) | **POST** /fake/outer/composite | +*FakeAPI* | [**fakeOuterNumberSerialize**](docs/FakeAPI.md#fakeouternumberserialize) | **POST** /fake/outer/number | +*FakeAPI* | [**fakeOuterStringSerialize**](docs/FakeAPI.md#fakeouterstringserialize) | **POST** /fake/outer/string | +*FakeAPI* | [**testBodyWithFileSchema**](docs/FakeAPI.md#testbodywithfileschema) | **PUT** /fake/body-with-file-schema | +*FakeAPI* | [**testBodyWithQueryParams**](docs/FakeAPI.md#testbodywithqueryparams) | **PUT** /fake/body-with-query-params | +*FakeAPI* | [**testClientModel**](docs/FakeAPI.md#testclientmodel) | **PATCH** /fake | To test \"client\" model +*FakeAPI* | [**testEndpointParameters**](docs/FakeAPI.md#testendpointparameters) | **POST** /fake | Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 +*FakeAPI* | [**testEnumParameters**](docs/FakeAPI.md#testenumparameters) | **GET** /fake | To test enum parameters +*FakeAPI* | [**testGroupParameters**](docs/FakeAPI.md#testgroupparameters) | **DELETE** /fake | Fake endpoint to test group parameters (optional) +*FakeAPI* | [**testInlineAdditionalProperties**](docs/FakeAPI.md#testinlineadditionalproperties) | **POST** /fake/inline-additionalProperties | test inline additionalProperties +*FakeAPI* | [**testJsonFormData**](docs/FakeAPI.md#testjsonformdata) | **GET** /fake/jsonFormData | test json serialization of form data +*FakeClassnameTags123API* | [**testClassname**](docs/FakeClassnameTags123API.md#testclassname) | **PATCH** /fake_classname_test | To test class name in snake case +*PetAPI* | [**addPet**](docs/PetAPI.md#addpet) | **POST** /pet | Add a new pet to the store +*PetAPI* | [**deletePet**](docs/PetAPI.md#deletepet) | **DELETE** /pet/{petId} | Deletes a pet +*PetAPI* | [**findPetsByStatus**](docs/PetAPI.md#findpetsbystatus) | **GET** /pet/findByStatus | Finds Pets by status +*PetAPI* | [**findPetsByTags**](docs/PetAPI.md#findpetsbytags) | **GET** /pet/findByTags | Finds Pets by tags +*PetAPI* | [**getPetById**](docs/PetAPI.md#getpetbyid) | **GET** /pet/{petId} | Find pet by ID +*PetAPI* | [**updatePet**](docs/PetAPI.md#updatepet) | **PUT** /pet | Update an existing pet +*PetAPI* | [**updatePetWithForm**](docs/PetAPI.md#updatepetwithform) | **POST** /pet/{petId} | Updates a pet in the store with form data +*PetAPI* | [**uploadFile**](docs/PetAPI.md#uploadfile) | **POST** /pet/{petId}/uploadImage | uploads an image +*PetAPI* | [**uploadFileWithRequiredFile**](docs/PetAPI.md#uploadfilewithrequiredfile) | **POST** /fake/{petId}/uploadImageWithRequiredFile | uploads an image (required) +*StoreAPI* | [**deleteOrder**](docs/StoreAPI.md#deleteorder) | **DELETE** /store/order/{order_id} | Delete purchase order by ID +*StoreAPI* | [**getInventory**](docs/StoreAPI.md#getinventory) | **GET** /store/inventory | Returns pet inventories by status +*StoreAPI* | [**getOrderById**](docs/StoreAPI.md#getorderbyid) | **GET** /store/order/{order_id} | Find purchase order by ID +*StoreAPI* | [**placeOrder**](docs/StoreAPI.md#placeorder) | **POST** /store/order | Place an order for a pet +*UserAPI* | [**createUser**](docs/UserAPI.md#createuser) | **POST** /user | Create user +*UserAPI* | [**createUsersWithArrayInput**](docs/UserAPI.md#createuserswitharrayinput) | **POST** /user/createWithArray | Creates list of users with given input array +*UserAPI* | [**createUsersWithListInput**](docs/UserAPI.md#createuserswithlistinput) | **POST** /user/createWithList | Creates list of users with given input array +*UserAPI* | [**deleteUser**](docs/UserAPI.md#deleteuser) | **DELETE** /user/{username} | Delete user +*UserAPI* | [**getUserByName**](docs/UserAPI.md#getuserbyname) | **GET** /user/{username} | Get user by user name +*UserAPI* | [**loginUser**](docs/UserAPI.md#loginuser) | **GET** /user/login | Logs user into the system +*UserAPI* | [**logoutUser**](docs/UserAPI.md#logoutuser) | **GET** /user/logout | Logs out current logged in user session +*UserAPI* | [**updateUser**](docs/UserAPI.md#updateuser) | **PUT** /user/{username} | Updated user + + +## Documentation For Models + + - [AdditionalPropertiesClass](docs/AdditionalPropertiesClass.md) + - [Animal](docs/Animal.md) + - [AnimalFarm](docs/AnimalFarm.md) + - [ApiResponse](docs/ApiResponse.md) + - [ArrayOfArrayOfNumberOnly](docs/ArrayOfArrayOfNumberOnly.md) + - [ArrayOfNumberOnly](docs/ArrayOfNumberOnly.md) + - [ArrayTest](docs/ArrayTest.md) + - [Capitalization](docs/Capitalization.md) + - [Cat](docs/Cat.md) + - [Category](docs/Category.md) + - [ClassModel](docs/ClassModel.md) + - [Client](docs/Client.md) + - [Dog](docs/Dog.md) + - [EnumArrays](docs/EnumArrays.md) + - [EnumClass](docs/EnumClass.md) + - [EnumTest](docs/EnumTest.md) + - [File](docs/File.md) + - [FileSchemaTestClass](docs/FileSchemaTestClass.md) + - [FormatTest](docs/FormatTest.md) + - [HasOnlyReadOnly](docs/HasOnlyReadOnly.md) + - [List](docs/List.md) + - [MapTest](docs/MapTest.md) + - [MixedPropertiesAndAdditionalPropertiesClass](docs/MixedPropertiesAndAdditionalPropertiesClass.md) + - [Model200Response](docs/Model200Response.md) + - [Name](docs/Name.md) + - [NumberOnly](docs/NumberOnly.md) + - [Order](docs/Order.md) + - [OuterComposite](docs/OuterComposite.md) + - [OuterEnum](docs/OuterEnum.md) + - [Pet](docs/Pet.md) + - [ReadOnlyFirst](docs/ReadOnlyFirst.md) + - [Return](docs/Return.md) + - [SpecialModelName](docs/SpecialModelName.md) + - [StringBooleanMap](docs/StringBooleanMap.md) + - [Tag](docs/Tag.md) + - [TypeHolderDefault](docs/TypeHolderDefault.md) + - [TypeHolderExample](docs/TypeHolderExample.md) + - [User](docs/User.md) + + +## Documentation For Authorization + + +## api_key + +- **Type**: API key +- **API key parameter name**: api_key +- **Location**: HTTP header + +## api_key_query + +- **Type**: API key +- **API key parameter name**: api_key_query +- **Location**: URL query string + +## http_basic_test + +- **Type**: HTTP basic authentication + +## petstore_auth + +- **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 + + +## Author + + + diff --git a/samples/client/petstore/swift4/promisekit/docs/AdditionalPropertiesClass.md b/samples/client/petstore/swift4/promisekit/docs/AdditionalPropertiesClass.md new file mode 100644 index 000000000000..a524730eb652 --- /dev/null +++ b/samples/client/petstore/swift4/promisekit/docs/AdditionalPropertiesClass.md @@ -0,0 +1,11 @@ +# AdditionalPropertiesClass + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**mapString** | **[String:String]** | | [optional] +**mapMapString** | [**[String:[String:String]]**](Dictionary.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) + + diff --git a/samples/client/petstore/swift4/promisekit/docs/Animal.md b/samples/client/petstore/swift4/promisekit/docs/Animal.md new file mode 100644 index 000000000000..69c601455cd8 --- /dev/null +++ b/samples/client/petstore/swift4/promisekit/docs/Animal.md @@ -0,0 +1,11 @@ +# Animal + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**className** | **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) + + diff --git a/samples/client/petstore/swift4/promisekit/docs/AnimalFarm.md b/samples/client/petstore/swift4/promisekit/docs/AnimalFarm.md new file mode 100644 index 000000000000..df6bab21dae8 --- /dev/null +++ b/samples/client/petstore/swift4/promisekit/docs/AnimalFarm.md @@ -0,0 +1,9 @@ +# AnimalFarm + +## Properties +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) + + diff --git a/samples/client/petstore/swift4/promisekit/docs/AnotherFakeAPI.md b/samples/client/petstore/swift4/promisekit/docs/AnotherFakeAPI.md new file mode 100644 index 000000000000..85f6da956681 --- /dev/null +++ b/samples/client/petstore/swift4/promisekit/docs/AnotherFakeAPI.md @@ -0,0 +1,58 @@ +# AnotherFakeAPI + +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** +```swift + open class func call123testSpecialTags( body: Client) -> Promise +``` + +To test special tags + +To test special tags and operation ID starting with number + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = Client("client_example") // Client | client model + +// To test special tags +AnotherFakeAPI.call123testSpecialTags(body: body).then { + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**Client**](Client.md)| client model | + +### Return type + +[**Client**](Client.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + diff --git a/samples/client/petstore/swift4/promisekit/docs/ApiResponse.md b/samples/client/petstore/swift4/promisekit/docs/ApiResponse.md new file mode 100644 index 000000000000..c6d9768fe9bf --- /dev/null +++ b/samples/client/petstore/swift4/promisekit/docs/ApiResponse.md @@ -0,0 +1,12 @@ +# ApiResponse + +## Properties +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) + + diff --git a/samples/client/petstore/swift4/promisekit/docs/ArrayOfArrayOfNumberOnly.md b/samples/client/petstore/swift4/promisekit/docs/ArrayOfArrayOfNumberOnly.md new file mode 100644 index 000000000000..3f78a9584d82 --- /dev/null +++ b/samples/client/petstore/swift4/promisekit/docs/ArrayOfArrayOfNumberOnly.md @@ -0,0 +1,10 @@ +# ArrayOfArrayOfNumberOnly + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**arrayArrayNumber** | [**[[Double]]**](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) + + diff --git a/samples/client/petstore/swift4/promisekit/docs/ArrayOfNumberOnly.md b/samples/client/petstore/swift4/promisekit/docs/ArrayOfNumberOnly.md new file mode 100644 index 000000000000..f09f8fa6f70f --- /dev/null +++ b/samples/client/petstore/swift4/promisekit/docs/ArrayOfNumberOnly.md @@ -0,0 +1,10 @@ +# ArrayOfNumberOnly + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**arrayNumber** | **[Double]** | | [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) + + diff --git a/samples/client/petstore/swift4/promisekit/docs/ArrayTest.md b/samples/client/petstore/swift4/promisekit/docs/ArrayTest.md new file mode 100644 index 000000000000..dd9be9d5876b --- /dev/null +++ b/samples/client/petstore/swift4/promisekit/docs/ArrayTest.md @@ -0,0 +1,12 @@ +# ArrayTest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**arrayOfString** | **[String]** | | [optional] +**arrayArrayOfInteger** | [**[[Int64]]**](Array.md) | | [optional] +**arrayArrayOfModel** | [**[[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) + + diff --git a/samples/client/petstore/swift4/promisekit/docs/Capitalization.md b/samples/client/petstore/swift4/promisekit/docs/Capitalization.md new file mode 100644 index 000000000000..95374216c773 --- /dev/null +++ b/samples/client/petstore/swift4/promisekit/docs/Capitalization.md @@ -0,0 +1,15 @@ +# Capitalization + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**smallCamel** | **String** | | [optional] +**capitalCamel** | **String** | | [optional] +**smallSnake** | **String** | | [optional] +**capitalSnake** | **String** | | [optional] +**sCAETHFlowPoints** | **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) + + diff --git a/samples/client/petstore/swift4/promisekit/docs/Cat.md b/samples/client/petstore/swift4/promisekit/docs/Cat.md new file mode 100644 index 000000000000..fb5949b15761 --- /dev/null +++ b/samples/client/petstore/swift4/promisekit/docs/Cat.md @@ -0,0 +1,10 @@ +# Cat + +## Properties +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) + + diff --git a/samples/client/petstore/swift4/promisekit/docs/Category.md b/samples/client/petstore/swift4/promisekit/docs/Category.md new file mode 100644 index 000000000000..5ca5408c0f96 --- /dev/null +++ b/samples/client/petstore/swift4/promisekit/docs/Category.md @@ -0,0 +1,11 @@ +# Category + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **Int64** | | [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) + + diff --git a/samples/client/petstore/swift4/promisekit/docs/ClassModel.md b/samples/client/petstore/swift4/promisekit/docs/ClassModel.md new file mode 100644 index 000000000000..e3912fdf0fd5 --- /dev/null +++ b/samples/client/petstore/swift4/promisekit/docs/ClassModel.md @@ -0,0 +1,10 @@ +# ClassModel + +## Properties +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) + + diff --git a/samples/client/petstore/swift4/promisekit/docs/Client.md b/samples/client/petstore/swift4/promisekit/docs/Client.md new file mode 100644 index 000000000000..0de1b238c36f --- /dev/null +++ b/samples/client/petstore/swift4/promisekit/docs/Client.md @@ -0,0 +1,10 @@ +# Client + +## Properties +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) + + diff --git a/samples/client/petstore/swift4/promisekit/docs/Dog.md b/samples/client/petstore/swift4/promisekit/docs/Dog.md new file mode 100644 index 000000000000..4824786da049 --- /dev/null +++ b/samples/client/petstore/swift4/promisekit/docs/Dog.md @@ -0,0 +1,10 @@ +# Dog + +## Properties +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) + + diff --git a/samples/client/petstore/swift4/promisekit/docs/EnumArrays.md b/samples/client/petstore/swift4/promisekit/docs/EnumArrays.md new file mode 100644 index 000000000000..b9a9807d3c8e --- /dev/null +++ b/samples/client/petstore/swift4/promisekit/docs/EnumArrays.md @@ -0,0 +1,11 @@ +# EnumArrays + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**justSymbol** | **String** | | [optional] +**arrayEnum** | **[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) + + diff --git a/samples/client/petstore/swift4/promisekit/docs/EnumClass.md b/samples/client/petstore/swift4/promisekit/docs/EnumClass.md new file mode 100644 index 000000000000..67f017becd0c --- /dev/null +++ b/samples/client/petstore/swift4/promisekit/docs/EnumClass.md @@ -0,0 +1,9 @@ +# EnumClass + +## Properties +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) + + diff --git a/samples/client/petstore/swift4/promisekit/docs/EnumTest.md b/samples/client/petstore/swift4/promisekit/docs/EnumTest.md new file mode 100644 index 000000000000..bc9b036dd769 --- /dev/null +++ b/samples/client/petstore/swift4/promisekit/docs/EnumTest.md @@ -0,0 +1,14 @@ +# EnumTest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enumString** | **String** | | [optional] +**enumStringRequired** | **String** | | +**enumInteger** | **Int** | | [optional] +**enumNumber** | **Double** | | [optional] +**outerEnum** | [**OuterEnum**](OuterEnum.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) + + diff --git a/samples/client/petstore/swift4/promisekit/docs/FakeAPI.md b/samples/client/petstore/swift4/promisekit/docs/FakeAPI.md new file mode 100644 index 000000000000..c46d8b679f0e --- /dev/null +++ b/samples/client/petstore/swift4/promisekit/docs/FakeAPI.md @@ -0,0 +1,650 @@ +# FakeAPI + +All URIs are relative to *http://petstore.swagger.io:80/v2* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**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 + + +# **fakeOuterBooleanSerialize** +```swift + open class func fakeOuterBooleanSerialize( body: Bool? = nil) -> Promise +``` + + + +Test serialization of outer boolean types + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = 987 // Bool | Input boolean as post body (optional) + +FakeAPI.fakeOuterBooleanSerialize(body: body).then { + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **Bool**| Input boolean as post body | [optional] + +### Return type + +**Bool** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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 README]](../README.md) + +# **fakeOuterCompositeSerialize** +```swift + open class func fakeOuterCompositeSerialize( body: OuterComposite? = nil) -> Promise +``` + + + +Test serialization of object with outer number type + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = OuterComposite(123, "myString_example", 123) // OuterComposite | Input composite as post body (optional) + +FakeAPI.fakeOuterCompositeSerialize(body: body).then { + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**OuterComposite**](OuterComposite.md)| Input composite as post body | [optional] + +### Return type + +[**OuterComposite**](OuterComposite.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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 README]](../README.md) + +# **fakeOuterNumberSerialize** +```swift + open class func fakeOuterNumberSerialize( body: Double? = nil) -> Promise +``` + + + +Test serialization of outer number types + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = 987 // Double | Input number as post body (optional) + +FakeAPI.fakeOuterNumberSerialize(body: body).then { + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **Double**| Input number as post body | [optional] + +### Return type + +**Double** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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 README]](../README.md) + +# **fakeOuterStringSerialize** +```swift + open class func fakeOuterStringSerialize( body: String? = nil) -> Promise +``` + + + +Test serialization of outer string types + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = "body_example" // String | Input string as post body (optional) + +FakeAPI.fakeOuterStringSerialize(body: body).then { + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **String**| Input string as post body | [optional] + +### Return type + +**String** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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 README]](../README.md) + +# **testBodyWithFileSchema** +```swift + open class func testBodyWithFileSchema( body: FileSchemaTestClass) -> Promise +``` + + + +For this test, the body for this request much reference a schema named `File`. + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = FileSchemaTestClass(File("sourceURI_example"), [File("sourceURI_example")]) // FileSchemaTestClass | + +FakeAPI.testBodyWithFileSchema(body: body).then { + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**FileSchemaTestClass**](FileSchemaTestClass.md)| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + +# **testBodyWithQueryParams** +```swift + open class func testBodyWithQueryParams( query: String, body: User) -> Promise +``` + + + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let query = "query_example" // String | +let body = User(123, "username_example", "firstName_example", "lastName_example", "email_example", "password_example", "phone_example", 123) // User | + +FakeAPI.testBodyWithQueryParams(query: query, body: body).then { + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **String**| | + **body** | [**User**](User.md)| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + +# **testClientModel** +```swift + open class func testClientModel( body: Client) -> Promise +``` + +To test \"client\" model + +To test \"client\" model + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = Client("client_example") // Client | client model + +// To test \"client\" model +FakeAPI.testClientModel(body: body).then { + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**Client**](Client.md)| client model | + +### Return type + +[**Client**](Client.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + +# **testEndpointParameters** +```swift + open class func testEndpointParameters( number: Double, double: Double, patternWithoutDelimiter: String, byte: Data, integer: Int? = nil, int32: Int? = nil, int64: Int64? = nil, float: Float? = nil, string: String? = nil, binary: URL? = nil, date: Date? = nil, dateTime: Date? = nil, password: String? = nil, callback: String? = nil) -> Promise +``` + +Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 + +Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let number = 987 // Double | None +let double = 987 // Double | None +let patternWithoutDelimiter = "patternWithoutDelimiter_example" // String | None +let byte = TODO // Data | None +let integer = 987 // Int | None (optional) +let int32 = 987 // Int | None (optional) +let int64 = 987 // Int64 | None (optional) +let float = 987 // Float | None (optional) +let string = "string_example" // String | None (optional) +let binary = "TODO" // URL | None (optional) +let date = TODO // Date | None (optional) +let dateTime = TODO // Date | None (optional) +let password = "password_example" // String | None (optional) +let callback = "callback_example" // String | None (optional) + +// Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 +FakeAPI.testEndpointParameters(number: number, double: double, patternWithoutDelimiter: patternWithoutDelimiter, byte: byte, integer: integer, int32: int32, int64: int64, float: float, string: string, binary: binary, date: date, dateTime: dateTime, password: password, callback: callback).then { + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **number** | **Double**| None | + **double** | **Double**| None | + **patternWithoutDelimiter** | **String**| None | + **byte** | **Data**| None | + **integer** | **Int**| None | [optional] + **int32** | **Int**| None | [optional] + **int64** | **Int64**| None | [optional] + **float** | **Float**| None | [optional] + **string** | **String**| None | [optional] + **binary** | **URL****URL**| None | [optional] + **date** | **Date**| None | [optional] + **dateTime** | **Date**| None | [optional] + **password** | **String**| None | [optional] + **callback** | **String**| None | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[http_basic_test](../README.md#http_basic_test) + +### HTTP request headers + + - **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 README]](../README.md) + +# **testEnumParameters** +```swift + open class func testEnumParameters( enumHeaderStringArray: [String]? = nil, enumHeaderString: EnumHeaderString_testEnumParameters? = nil, enumQueryStringArray: [String]? = nil, enumQueryString: EnumQueryString_testEnumParameters? = nil, enumQueryInteger: EnumQueryInteger_testEnumParameters? = nil, enumQueryDouble: EnumQueryDouble_testEnumParameters? = nil, enumFormStringArray: [String]? = nil, enumFormString: EnumFormString_testEnumParameters? = nil) -> Promise +``` + +To test enum parameters + +To test enum parameters + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let enumHeaderStringArray = ["enumHeaderStringArray_example"] // [String] | Header parameter enum test (string array) (optional) +let enumHeaderString = "enumHeaderString_example" // String | Header parameter enum test (string) (optional) (default to .-efg) +let enumQueryStringArray = ["enumQueryStringArray_example"] // [String] | Query parameter enum test (string array) (optional) +let enumQueryString = "enumQueryString_example" // String | Query parameter enum test (string) (optional) (default to .-efg) +let enumQueryInteger = 987 // Int | Query parameter enum test (double) (optional) +let enumQueryDouble = 987 // Double | Query parameter enum test (double) (optional) +let enumFormStringArray = ["inner_example"] // [String] | Form parameter enum test (string array) (optional) (default to .$) +let enumFormString = "enumFormString_example" // String | Form parameter enum test (string) (optional) (default to .-efg) + +// To test enum parameters +FakeAPI.testEnumParameters(enumHeaderStringArray: enumHeaderStringArray, enumHeaderString: enumHeaderString, enumQueryStringArray: enumQueryStringArray, enumQueryString: enumQueryString, enumQueryInteger: enumQueryInteger, enumQueryDouble: enumQueryDouble, enumFormStringArray: enumFormStringArray, enumFormString: enumFormString).then { + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **enumHeaderStringArray** | [**[String]**](String.md)| Header parameter enum test (string array) | [optional] + **enumHeaderString** | **String**| Header parameter enum test (string) | [optional] [default to .-efg] + **enumQueryStringArray** | [**[String]**](String.md)| Query parameter enum test (string array) | [optional] + **enumQueryString** | **String**| Query parameter enum test (string) | [optional] [default to .-efg] + **enumQueryInteger** | **Int**| Query parameter enum test (double) | [optional] + **enumQueryDouble** | **Double**| Query parameter enum test (double) | [optional] + **enumFormStringArray** | [**[String]**](String.md)| Form parameter enum test (string array) | [optional] [default to .$] + **enumFormString** | **String**| Form parameter enum test (string) | [optional] [default to .-efg] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + +# **testGroupParameters** +```swift + open class func testGroupParameters( requiredStringGroup: Int, requiredBooleanGroup: Bool, requiredInt64Group: Int64, stringGroup: Int? = nil, booleanGroup: Bool? = nil, int64Group: Int64? = nil) -> Promise +``` + +Fake endpoint to test group parameters (optional) + +Fake endpoint to test group parameters (optional) + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let requiredStringGroup = 987 // Int | Required String in group parameters +let requiredBooleanGroup = 987 // Bool | Required Boolean in group parameters +let requiredInt64Group = 987 // Int64 | Required Integer in group parameters +let stringGroup = 987 // Int | String in group parameters (optional) +let booleanGroup = 987 // Bool | Boolean in group parameters (optional) +let int64Group = 987 // Int64 | Integer in group parameters (optional) + +// Fake endpoint to test group parameters (optional) +FakeAPI.testGroupParameters(requiredStringGroup: requiredStringGroup, requiredBooleanGroup: requiredBooleanGroup, requiredInt64Group: requiredInt64Group, stringGroup: stringGroup, booleanGroup: booleanGroup, int64Group: int64Group).then { + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **requiredStringGroup** | **Int**| Required String in group parameters | + **requiredBooleanGroup** | **Bool**| Required Boolean in group parameters | + **requiredInt64Group** | **Int64**| Required Integer in group parameters | + **stringGroup** | **Int**| String in group parameters | [optional] + **booleanGroup** | **Bool**| Boolean in group parameters | [optional] + **int64Group** | **Int64**| Integer in group parameters | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + +# **testInlineAdditionalProperties** +```swift + open class func testInlineAdditionalProperties( param: [String:String]) -> Promise +``` + +test inline additionalProperties + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let param = "TODO" // [String:String] | request body + +// test inline additionalProperties +FakeAPI.testInlineAdditionalProperties(param: param).then { + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **param** | [**[String:String]**](String.md)| request body | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + +# **testJsonFormData** +```swift + open class func testJsonFormData( param: String, param2: String) -> Promise +``` + +test json serialization of form data + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let param = "param_example" // String | field1 +let param2 = "param2_example" // String | field2 + +// test json serialization of form data +FakeAPI.testJsonFormData(param: param, param2: param2).then { + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **param** | **String**| field1 | + **param2** | **String**| field2 | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + diff --git a/samples/client/petstore/swift4/promisekit/docs/FakeClassnameTags123API.md b/samples/client/petstore/swift4/promisekit/docs/FakeClassnameTags123API.md new file mode 100644 index 000000000000..e778f7d7368b --- /dev/null +++ b/samples/client/petstore/swift4/promisekit/docs/FakeClassnameTags123API.md @@ -0,0 +1,58 @@ +# FakeClassnameTags123API + +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** +```swift + open class func testClassname( body: Client) -> Promise +``` + +To test class name in snake case + +To test class name in snake case + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = Client("client_example") // Client | client model + +// To test class name in snake case +FakeClassnameTags123API.testClassname(body: body).then { + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**Client**](Client.md)| client model | + +### Return type + +[**Client**](Client.md) + +### Authorization + +[api_key_query](../README.md#api_key_query) + +### HTTP request headers + + - **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 README]](../README.md) + diff --git a/samples/client/petstore/swift4/promisekit/docs/File.md b/samples/client/petstore/swift4/promisekit/docs/File.md new file mode 100644 index 000000000000..3edfef17b794 --- /dev/null +++ b/samples/client/petstore/swift4/promisekit/docs/File.md @@ -0,0 +1,10 @@ +# File + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**sourceURI** | **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) + + diff --git a/samples/client/petstore/swift4/promisekit/docs/FileSchemaTestClass.md b/samples/client/petstore/swift4/promisekit/docs/FileSchemaTestClass.md new file mode 100644 index 000000000000..d0a8bbaaba95 --- /dev/null +++ b/samples/client/petstore/swift4/promisekit/docs/FileSchemaTestClass.md @@ -0,0 +1,11 @@ +# FileSchemaTestClass + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**file** | [**File**](File.md) | | [optional] +**files** | [**[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) + + diff --git a/samples/client/petstore/swift4/promisekit/docs/FormatTest.md b/samples/client/petstore/swift4/promisekit/docs/FormatTest.md new file mode 100644 index 000000000000..547eb88754f4 --- /dev/null +++ b/samples/client/petstore/swift4/promisekit/docs/FormatTest.md @@ -0,0 +1,22 @@ +# FormatTest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**integer** | **Int** | | [optional] +**int32** | **Int** | | [optional] +**int64** | **Int64** | | [optional] +**number** | **Double** | | +**float** | **Float** | | [optional] +**double** | **Double** | | [optional] +**string** | **String** | | [optional] +**byte** | [**Data**](Data.md) | | +**binary** | [**URL**](URL.md) | | [optional] +**date** | [**Date**](Date.md) | | +**dateTime** | [**Date**](Date.md) | | [optional] +**uuid** | [**UUID**](UUID.md) | | [optional] +**password** | **String** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/samples/client/petstore/swift4/promisekit/docs/HasOnlyReadOnly.md b/samples/client/petstore/swift4/promisekit/docs/HasOnlyReadOnly.md new file mode 100644 index 000000000000..45781360154c --- /dev/null +++ b/samples/client/petstore/swift4/promisekit/docs/HasOnlyReadOnly.md @@ -0,0 +1,11 @@ +# HasOnlyReadOnly + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**bar** | **String** | | [optional] +**foo** | **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) + + diff --git a/samples/client/petstore/swift4/promisekit/docs/List.md b/samples/client/petstore/swift4/promisekit/docs/List.md new file mode 100644 index 000000000000..b77718302edf --- /dev/null +++ b/samples/client/petstore/swift4/promisekit/docs/List.md @@ -0,0 +1,10 @@ +# List + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**_123list** | **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) + + diff --git a/samples/client/petstore/swift4/promisekit/docs/MapTest.md b/samples/client/petstore/swift4/promisekit/docs/MapTest.md new file mode 100644 index 000000000000..e910bc97518c --- /dev/null +++ b/samples/client/petstore/swift4/promisekit/docs/MapTest.md @@ -0,0 +1,13 @@ +# MapTest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**mapMapOfString** | [**[String:[String:String]]**](Dictionary.md) | | [optional] +**mapOfEnumString** | **[String:String]** | | [optional] +**directMap** | **[String:Bool]** | | [optional] +**indirectMap** | [**StringBooleanMap**](StringBooleanMap.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) + + diff --git a/samples/client/petstore/swift4/promisekit/docs/MixedPropertiesAndAdditionalPropertiesClass.md b/samples/client/petstore/swift4/promisekit/docs/MixedPropertiesAndAdditionalPropertiesClass.md new file mode 100644 index 000000000000..2c502eace42c --- /dev/null +++ b/samples/client/petstore/swift4/promisekit/docs/MixedPropertiesAndAdditionalPropertiesClass.md @@ -0,0 +1,12 @@ +# MixedPropertiesAndAdditionalPropertiesClass + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**uuid** | [**UUID**](UUID.md) | | [optional] +**dateTime** | [**Date**](Date.md) | | [optional] +**map** | [**[String: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) + + diff --git a/samples/client/petstore/swift4/promisekit/docs/Model200Response.md b/samples/client/petstore/swift4/promisekit/docs/Model200Response.md new file mode 100644 index 000000000000..5865ea690cc3 --- /dev/null +++ b/samples/client/petstore/swift4/promisekit/docs/Model200Response.md @@ -0,0 +1,11 @@ +# Model200Response + +## Properties +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) + + diff --git a/samples/client/petstore/swift4/promisekit/docs/Name.md b/samples/client/petstore/swift4/promisekit/docs/Name.md new file mode 100644 index 000000000000..2be75d062e47 --- /dev/null +++ b/samples/client/petstore/swift4/promisekit/docs/Name.md @@ -0,0 +1,13 @@ +# Name + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **Int** | | +**snakeCase** | **Int** | | [optional] +**property** | **String** | | [optional] +**_123number** | **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) + + diff --git a/samples/client/petstore/swift4/promisekit/docs/NumberOnly.md b/samples/client/petstore/swift4/promisekit/docs/NumberOnly.md new file mode 100644 index 000000000000..72bd361168b5 --- /dev/null +++ b/samples/client/petstore/swift4/promisekit/docs/NumberOnly.md @@ -0,0 +1,10 @@ +# NumberOnly + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**justNumber** | **Double** | | [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) + + diff --git a/samples/client/petstore/swift4/promisekit/docs/Order.md b/samples/client/petstore/swift4/promisekit/docs/Order.md new file mode 100644 index 000000000000..9d3205c1526a --- /dev/null +++ b/samples/client/petstore/swift4/promisekit/docs/Order.md @@ -0,0 +1,15 @@ +# Order + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **Int64** | | [optional] +**petId** | **Int64** | | [optional] +**quantity** | **Int** | | [optional] +**shipDate** | [**Date**](Date.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) + + diff --git a/samples/client/petstore/swift4/promisekit/docs/OuterComposite.md b/samples/client/petstore/swift4/promisekit/docs/OuterComposite.md new file mode 100644 index 000000000000..d6b3583bc3ff --- /dev/null +++ b/samples/client/petstore/swift4/promisekit/docs/OuterComposite.md @@ -0,0 +1,12 @@ +# OuterComposite + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**myNumber** | **Double** | | [optional] +**myString** | **String** | | [optional] +**myBoolean** | **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) + + diff --git a/samples/client/petstore/swift4/promisekit/docs/OuterEnum.md b/samples/client/petstore/swift4/promisekit/docs/OuterEnum.md new file mode 100644 index 000000000000..06d413b01680 --- /dev/null +++ b/samples/client/petstore/swift4/promisekit/docs/OuterEnum.md @@ -0,0 +1,9 @@ +# OuterEnum + +## Properties +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) + + diff --git a/samples/client/petstore/swift4/promisekit/docs/Pet.md b/samples/client/petstore/swift4/promisekit/docs/Pet.md new file mode 100644 index 000000000000..c30a5292f537 --- /dev/null +++ b/samples/client/petstore/swift4/promisekit/docs/Pet.md @@ -0,0 +1,15 @@ +# Pet + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **Int64** | | [optional] +**category** | [**Category**](Category.md) | | [optional] +**name** | **String** | | +**photoUrls** | **[String]** | | +**tags** | [**[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) + + diff --git a/samples/client/petstore/swift4/promisekit/docs/PetAPI.md b/samples/client/petstore/swift4/promisekit/docs/PetAPI.md new file mode 100644 index 000000000000..b5a7e2ac51d9 --- /dev/null +++ b/samples/client/petstore/swift4/promisekit/docs/PetAPI.md @@ -0,0 +1,460 @@ +# PetAPI + +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** +```swift + open class func addPet( body: Pet) -> Promise +``` + +Add a new pet to the store + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = Pet(123, Category(123, "name_example"), "name_example", ["photoUrls_example"], [Tag(123, "name_example")], "status_example") // Pet | Pet object that needs to be added to the store + +// Add a new pet to the store +PetAPI.addPet(body: body).then { + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | + +### Return type + +void (empty response body) + +### Authorization + +[petstore_auth](../README.md#petstore_auth) + +### HTTP request headers + + - **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 README]](../README.md) + +# **deletePet** +```swift + open class func deletePet( petId: Int64, apiKey: String? = nil) -> Promise +``` + +Deletes a pet + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let petId = 987 // Int64 | Pet id to delete +let apiKey = "apiKey_example" // String | (optional) + +// Deletes a pet +PetAPI.deletePet(petId: petId, apiKey: apiKey).then { + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **petId** | **Int64**| Pet id to delete | + **apiKey** | **String**| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[petstore_auth](../README.md#petstore_auth) + +### HTTP request headers + + - **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 README]](../README.md) + +# **findPetsByStatus** +```swift + open class func findPetsByStatus( status: [String]) -> Promise<[Pet]> +``` + +Finds Pets by status + +Multiple status values can be provided with comma separated strings + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let status = ["status_example"] // [String] | Status values that need to be considered for filter + +// Finds Pets by status +PetAPI.findPetsByStatus(status: status).then { + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **status** | [**[String]**](String.md)| Status values that need to be considered for filter | + +### Return type + +[**[Pet]**](Pet.md) + +### Authorization + +[petstore_auth](../README.md#petstore_auth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **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 README]](../README.md) + +# **findPetsByTags** +```swift + open class func findPetsByTags( tags: [String]) -> Promise<[Pet]> +``` + +Finds Pets by tags + +Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let tags = ["inner_example"] // [String] | Tags to filter by + +// Finds Pets by tags +PetAPI.findPetsByTags(tags: tags).then { + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **tags** | [**[String]**](String.md)| Tags to filter by | + +### Return type + +[**[Pet]**](Pet.md) + +### Authorization + +[petstore_auth](../README.md#petstore_auth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **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 README]](../README.md) + +# **getPetById** +```swift + open class func getPetById( petId: Int64) -> Promise +``` + +Find pet by ID + +Returns a single pet + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let petId = 987 // Int64 | ID of pet to return + +// Find pet by ID +PetAPI.getPetById(petId: petId).then { + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **petId** | **Int64**| ID of pet to return | + +### Return type + +[**Pet**](Pet.md) + +### Authorization + +[api_key](../README.md#api_key) + +### HTTP request headers + + - **Content-Type**: Not defined + - **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 README]](../README.md) + +# **updatePet** +```swift + open class func updatePet( body: Pet) -> Promise +``` + +Update an existing pet + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = Pet(123, Category(123, "name_example"), "name_example", ["photoUrls_example"], [Tag(123, "name_example")], "status_example") // Pet | Pet object that needs to be added to the store + +// Update an existing pet +PetAPI.updatePet(body: body).then { + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | + +### Return type + +void (empty response body) + +### Authorization + +[petstore_auth](../README.md#petstore_auth) + +### HTTP request headers + + - **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 README]](../README.md) + +# **updatePetWithForm** +```swift + open class func updatePetWithForm( petId: Int64, name: String? = nil, status: String? = nil) -> Promise +``` + +Updates a pet in the store with form data + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let petId = 987 // Int64 | ID of pet that needs to be updated +let name = "name_example" // String | Updated name of the pet (optional) +let status = "status_example" // String | Updated status of the pet (optional) + +// Updates a pet in the store with form data +PetAPI.updatePetWithForm(petId: petId, name: name, status: status).then { + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **petId** | **Int64**| ID of pet that needs to be updated | + **name** | **String**| Updated name of the pet | [optional] + **status** | **String**| Updated status of the pet | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[petstore_auth](../README.md#petstore_auth) + +### HTTP request headers + + - **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 README]](../README.md) + +# **uploadFile** +```swift + open class func uploadFile( petId: Int64, additionalMetadata: String? = nil, file: URL? = nil) -> Promise +``` + +uploads an image + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let petId = 987 // Int64 | ID of pet to update +let additionalMetadata = "additionalMetadata_example" // String | Additional data to pass to server (optional) +let file = "TODO" // URL | file to upload (optional) + +// uploads an image +PetAPI.uploadFile(petId: petId, additionalMetadata: additionalMetadata, file: file).then { + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **petId** | **Int64**| ID of pet to update | + **additionalMetadata** | **String**| Additional data to pass to server | [optional] + **file** | **URL****URL**| file to upload | [optional] + +### Return type + +[**ApiResponse**](ApiResponse.md) + +### Authorization + +[petstore_auth](../README.md#petstore_auth) + +### HTTP request headers + + - **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 README]](../README.md) + +# **uploadFileWithRequiredFile** +```swift + open class func uploadFileWithRequiredFile( petId: Int64, requiredFile: URL, additionalMetadata: String? = nil) -> Promise +``` + +uploads an image (required) + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let petId = 987 // Int64 | ID of pet to update +let requiredFile = "TODO" // URL | file to upload +let additionalMetadata = "additionalMetadata_example" // String | Additional data to pass to server (optional) + +// uploads an image (required) +PetAPI.uploadFileWithRequiredFile(petId: petId, requiredFile: requiredFile, additionalMetadata: additionalMetadata).then { + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **petId** | **Int64**| ID of pet to update | + **requiredFile** | **URL****URL**| file to upload | + **additionalMetadata** | **String**| Additional data to pass to server | [optional] + +### Return type + +[**ApiResponse**](ApiResponse.md) + +### Authorization + +[petstore_auth](../README.md#petstore_auth) + +### HTTP request headers + + - **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 README]](../README.md) + diff --git a/samples/client/petstore/swift4/promisekit/docs/ReadOnlyFirst.md b/samples/client/petstore/swift4/promisekit/docs/ReadOnlyFirst.md new file mode 100644 index 000000000000..e3f16038b970 --- /dev/null +++ b/samples/client/petstore/swift4/promisekit/docs/ReadOnlyFirst.md @@ -0,0 +1,11 @@ +# ReadOnlyFirst + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**bar** | **String** | | [optional] +**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) + + diff --git a/samples/client/petstore/swift4/promisekit/docs/Return.md b/samples/client/petstore/swift4/promisekit/docs/Return.md new file mode 100644 index 000000000000..66d17c27c887 --- /dev/null +++ b/samples/client/petstore/swift4/promisekit/docs/Return.md @@ -0,0 +1,10 @@ +# Return + +## Properties +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) + + diff --git a/samples/client/petstore/swift4/promisekit/docs/SpecialModelName.md b/samples/client/petstore/swift4/promisekit/docs/SpecialModelName.md new file mode 100644 index 000000000000..3ec27a38c2ac --- /dev/null +++ b/samples/client/petstore/swift4/promisekit/docs/SpecialModelName.md @@ -0,0 +1,10 @@ +# SpecialModelName + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**specialPropertyName** | **Int64** | | [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) + + diff --git a/samples/client/petstore/swift4/promisekit/docs/StoreAPI.md b/samples/client/petstore/swift4/promisekit/docs/StoreAPI.md new file mode 100644 index 000000000000..41e4a0f23c39 --- /dev/null +++ b/samples/client/petstore/swift4/promisekit/docs/StoreAPI.md @@ -0,0 +1,202 @@ +# StoreAPI + +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** +```swift + open class func deleteOrder( orderId: String) -> Promise +``` + +Delete purchase order by ID + +For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let orderId = "orderId_example" // String | ID of the order that needs to be deleted + +// Delete purchase order by ID +StoreAPI.deleteOrder(orderId: orderId).then { + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **orderId** | **String**| ID of the order that needs to be deleted | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + +# **getInventory** +```swift + open class func getInventory() -> Promise<[String:Int]> +``` + +Returns pet inventories by status + +Returns a map of status codes to quantities + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + + +// Returns pet inventories by status +StoreAPI.getInventory().then { + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[String:Int]** + +### Authorization + +[api_key](../README.md#api_key) + +### HTTP request headers + + - **Content-Type**: Not defined + - **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 README]](../README.md) + +# **getOrderById** +```swift + open class func getOrderById( orderId: Int64) -> Promise +``` + +Find purchase order by ID + +For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let orderId = 987 // Int64 | ID of pet that needs to be fetched + +// Find purchase order by ID +StoreAPI.getOrderById(orderId: orderId).then { + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **orderId** | **Int64**| ID of pet that needs to be fetched | + +### Return type + +[**Order**](Order.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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 README]](../README.md) + +# **placeOrder** +```swift + open class func placeOrder( body: Order) -> Promise +``` + +Place an order for a pet + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = Order(123, 123, 123, "TODO", "status_example", 123) // Order | order placed for purchasing the pet + +// Place an order for a pet +StoreAPI.placeOrder(body: body).then { + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**Order**](Order.md)| order placed for purchasing the pet | + +### Return type + +[**Order**](Order.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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 README]](../README.md) + diff --git a/samples/client/petstore/swift4/promisekit/docs/StringBooleanMap.md b/samples/client/petstore/swift4/promisekit/docs/StringBooleanMap.md new file mode 100644 index 000000000000..7abf11ec68b1 --- /dev/null +++ b/samples/client/petstore/swift4/promisekit/docs/StringBooleanMap.md @@ -0,0 +1,9 @@ +# StringBooleanMap + +## Properties +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) + + diff --git a/samples/client/petstore/swift4/promisekit/docs/Tag.md b/samples/client/petstore/swift4/promisekit/docs/Tag.md new file mode 100644 index 000000000000..ff4ac8aa4519 --- /dev/null +++ b/samples/client/petstore/swift4/promisekit/docs/Tag.md @@ -0,0 +1,11 @@ +# Tag + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **Int64** | | [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) + + diff --git a/samples/client/petstore/swift4/promisekit/docs/TypeHolderDefault.md b/samples/client/petstore/swift4/promisekit/docs/TypeHolderDefault.md new file mode 100644 index 000000000000..5161394bdc3e --- /dev/null +++ b/samples/client/petstore/swift4/promisekit/docs/TypeHolderDefault.md @@ -0,0 +1,14 @@ +# TypeHolderDefault + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**stringItem** | **String** | | [default to "what"] +**numberItem** | **Double** | | +**integerItem** | **Int** | | +**boolItem** | **Bool** | | [default to true] +**arrayItem** | **[Int]** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/samples/client/petstore/swift4/promisekit/docs/TypeHolderExample.md b/samples/client/petstore/swift4/promisekit/docs/TypeHolderExample.md new file mode 100644 index 000000000000..46d0471cd71a --- /dev/null +++ b/samples/client/petstore/swift4/promisekit/docs/TypeHolderExample.md @@ -0,0 +1,14 @@ +# TypeHolderExample + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**stringItem** | **String** | | +**numberItem** | **Double** | | +**integerItem** | **Int** | | +**boolItem** | **Bool** | | +**arrayItem** | **[Int]** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/samples/client/petstore/swift4/promisekit/docs/User.md b/samples/client/petstore/swift4/promisekit/docs/User.md new file mode 100644 index 000000000000..5a439de0ff95 --- /dev/null +++ b/samples/client/petstore/swift4/promisekit/docs/User.md @@ -0,0 +1,17 @@ +# User + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **Int64** | | [optional] +**username** | **String** | | [optional] +**firstName** | **String** | | [optional] +**lastName** | **String** | | [optional] +**email** | **String** | | [optional] +**password** | **String** | | [optional] +**phone** | **String** | | [optional] +**userStatus** | **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) + + diff --git a/samples/client/petstore/swift4/promisekit/docs/UserAPI.md b/samples/client/petstore/swift4/promisekit/docs/UserAPI.md new file mode 100644 index 000000000000..d2a5b698cfeb --- /dev/null +++ b/samples/client/petstore/swift4/promisekit/docs/UserAPI.md @@ -0,0 +1,398 @@ +# UserAPI + +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** +```swift + open class func createUser( body: User) -> Promise +``` + +Create user + +This can only be done by the logged in user. + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = User(123, "username_example", "firstName_example", "lastName_example", "email_example", "password_example", "phone_example", 123) // User | Created user object + +// Create user +UserAPI.createUser(body: body).then { + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**User**](User.md)| Created user object | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + +# **createUsersWithArrayInput** +```swift + open class func createUsersWithArrayInput( body: [User]) -> Promise +``` + +Creates list of users with given input array + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = [User(123, "username_example", "firstName_example", "lastName_example", "email_example", "password_example", "phone_example", 123)] // [User] | List of user object + +// Creates list of users with given input array +UserAPI.createUsersWithArrayInput(body: body).then { + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**[User]**](Array.md)| List of user object | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + +# **createUsersWithListInput** +```swift + open class func createUsersWithListInput( body: [User]) -> Promise +``` + +Creates list of users with given input array + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = [User(123, "username_example", "firstName_example", "lastName_example", "email_example", "password_example", "phone_example", 123)] // [User] | List of user object + +// Creates list of users with given input array +UserAPI.createUsersWithListInput(body: body).then { + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**[User]**](Array.md)| List of user object | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + +# **deleteUser** +```swift + open class func deleteUser( username: String) -> Promise +``` + +Delete user + +This can only be done by the logged in user. + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let username = "username_example" // String | The name that needs to be deleted + +// Delete user +UserAPI.deleteUser(username: username).then { + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **username** | **String**| The name that needs to be deleted | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + +# **getUserByName** +```swift + open class func getUserByName( username: String) -> Promise +``` + +Get user by user name + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let username = "username_example" // String | The name that needs to be fetched. Use user1 for testing. + +// Get user by user name +UserAPI.getUserByName(username: username).then { + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **username** | **String**| The name that needs to be fetched. Use user1 for testing. | + +### Return type + +[**User**](User.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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 README]](../README.md) + +# **loginUser** +```swift + open class func loginUser( username: String, password: String) -> Promise +``` + +Logs user into the system + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let username = "username_example" // String | The user name for login +let password = "password_example" // String | The password for login in clear text + +// Logs user into the system +UserAPI.loginUser(username: username, password: password).then { + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **username** | **String**| The user name for login | + **password** | **String**| The password for login in clear text | + +### Return type + +**String** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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 README]](../README.md) + +# **logoutUser** +```swift + open class func logoutUser() -> Promise +``` + +Logs out current logged in user session + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + + +// Logs out current logged in user session +UserAPI.logoutUser().then { + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + +# **updateUser** +```swift + open class func updateUser( username: String, body: User) -> Promise +``` + +Updated user + +This can only be done by the logged in user. + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let username = "username_example" // String | name that need to be deleted +let body = User(123, "username_example", "firstName_example", "lastName_example", "email_example", "password_example", "phone_example", 123) // User | Updated user object + +// Updated user +UserAPI.updateUser(username: username, body: body).then { + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **username** | **String**| name that need to be deleted | + **body** | [**User**](User.md)| Updated user object | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + diff --git a/samples/client/petstore/swift4/rxswift/README.md b/samples/client/petstore/swift4/rxswift/README.md new file mode 100644 index 000000000000..1e7f0a59ea01 --- /dev/null +++ b/samples/client/petstore/swift4/rxswift/README.md @@ -0,0 +1,139 @@ +# Swift4 API client for PetstoreClient + +This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\ + +## Overview +This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [openapi-spec from a remote server, you can easily generate an API client. + +- API version: 1.0.0 +- Package version: +- Build package: org.openapitools.codegen.languages.Swift4Codegen + +## Installation + +### Carthage + +Run `carthage update` + +### CocoaPods + +Run `pod install` + +## Documentation for API Endpoints + +All URIs are relative to *http://petstore.swagger.io:80/v2* + +Class | Method | HTTP request | Description +------------ | ------------- | ------------- | ------------- +*AnotherFakeAPI* | [**call123testSpecialTags**](docs/AnotherFakeAPI.md#call123testspecialtags) | **PATCH** /another-fake/dummy | To test special tags +*FakeAPI* | [**fakeOuterBooleanSerialize**](docs/FakeAPI.md#fakeouterbooleanserialize) | **POST** /fake/outer/boolean | +*FakeAPI* | [**fakeOuterCompositeSerialize**](docs/FakeAPI.md#fakeoutercompositeserialize) | **POST** /fake/outer/composite | +*FakeAPI* | [**fakeOuterNumberSerialize**](docs/FakeAPI.md#fakeouternumberserialize) | **POST** /fake/outer/number | +*FakeAPI* | [**fakeOuterStringSerialize**](docs/FakeAPI.md#fakeouterstringserialize) | **POST** /fake/outer/string | +*FakeAPI* | [**testBodyWithFileSchema**](docs/FakeAPI.md#testbodywithfileschema) | **PUT** /fake/body-with-file-schema | +*FakeAPI* | [**testBodyWithQueryParams**](docs/FakeAPI.md#testbodywithqueryparams) | **PUT** /fake/body-with-query-params | +*FakeAPI* | [**testClientModel**](docs/FakeAPI.md#testclientmodel) | **PATCH** /fake | To test \"client\" model +*FakeAPI* | [**testEndpointParameters**](docs/FakeAPI.md#testendpointparameters) | **POST** /fake | Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 +*FakeAPI* | [**testEnumParameters**](docs/FakeAPI.md#testenumparameters) | **GET** /fake | To test enum parameters +*FakeAPI* | [**testGroupParameters**](docs/FakeAPI.md#testgroupparameters) | **DELETE** /fake | Fake endpoint to test group parameters (optional) +*FakeAPI* | [**testInlineAdditionalProperties**](docs/FakeAPI.md#testinlineadditionalproperties) | **POST** /fake/inline-additionalProperties | test inline additionalProperties +*FakeAPI* | [**testJsonFormData**](docs/FakeAPI.md#testjsonformdata) | **GET** /fake/jsonFormData | test json serialization of form data +*FakeClassnameTags123API* | [**testClassname**](docs/FakeClassnameTags123API.md#testclassname) | **PATCH** /fake_classname_test | To test class name in snake case +*PetAPI* | [**addPet**](docs/PetAPI.md#addpet) | **POST** /pet | Add a new pet to the store +*PetAPI* | [**deletePet**](docs/PetAPI.md#deletepet) | **DELETE** /pet/{petId} | Deletes a pet +*PetAPI* | [**findPetsByStatus**](docs/PetAPI.md#findpetsbystatus) | **GET** /pet/findByStatus | Finds Pets by status +*PetAPI* | [**findPetsByTags**](docs/PetAPI.md#findpetsbytags) | **GET** /pet/findByTags | Finds Pets by tags +*PetAPI* | [**getPetById**](docs/PetAPI.md#getpetbyid) | **GET** /pet/{petId} | Find pet by ID +*PetAPI* | [**updatePet**](docs/PetAPI.md#updatepet) | **PUT** /pet | Update an existing pet +*PetAPI* | [**updatePetWithForm**](docs/PetAPI.md#updatepetwithform) | **POST** /pet/{petId} | Updates a pet in the store with form data +*PetAPI* | [**uploadFile**](docs/PetAPI.md#uploadfile) | **POST** /pet/{petId}/uploadImage | uploads an image +*PetAPI* | [**uploadFileWithRequiredFile**](docs/PetAPI.md#uploadfilewithrequiredfile) | **POST** /fake/{petId}/uploadImageWithRequiredFile | uploads an image (required) +*StoreAPI* | [**deleteOrder**](docs/StoreAPI.md#deleteorder) | **DELETE** /store/order/{order_id} | Delete purchase order by ID +*StoreAPI* | [**getInventory**](docs/StoreAPI.md#getinventory) | **GET** /store/inventory | Returns pet inventories by status +*StoreAPI* | [**getOrderById**](docs/StoreAPI.md#getorderbyid) | **GET** /store/order/{order_id} | Find purchase order by ID +*StoreAPI* | [**placeOrder**](docs/StoreAPI.md#placeorder) | **POST** /store/order | Place an order for a pet +*UserAPI* | [**createUser**](docs/UserAPI.md#createuser) | **POST** /user | Create user +*UserAPI* | [**createUsersWithArrayInput**](docs/UserAPI.md#createuserswitharrayinput) | **POST** /user/createWithArray | Creates list of users with given input array +*UserAPI* | [**createUsersWithListInput**](docs/UserAPI.md#createuserswithlistinput) | **POST** /user/createWithList | Creates list of users with given input array +*UserAPI* | [**deleteUser**](docs/UserAPI.md#deleteuser) | **DELETE** /user/{username} | Delete user +*UserAPI* | [**getUserByName**](docs/UserAPI.md#getuserbyname) | **GET** /user/{username} | Get user by user name +*UserAPI* | [**loginUser**](docs/UserAPI.md#loginuser) | **GET** /user/login | Logs user into the system +*UserAPI* | [**logoutUser**](docs/UserAPI.md#logoutuser) | **GET** /user/logout | Logs out current logged in user session +*UserAPI* | [**updateUser**](docs/UserAPI.md#updateuser) | **PUT** /user/{username} | Updated user + + +## Documentation For Models + + - [AdditionalPropertiesClass](docs/AdditionalPropertiesClass.md) + - [Animal](docs/Animal.md) + - [AnimalFarm](docs/AnimalFarm.md) + - [ApiResponse](docs/ApiResponse.md) + - [ArrayOfArrayOfNumberOnly](docs/ArrayOfArrayOfNumberOnly.md) + - [ArrayOfNumberOnly](docs/ArrayOfNumberOnly.md) + - [ArrayTest](docs/ArrayTest.md) + - [Capitalization](docs/Capitalization.md) + - [Cat](docs/Cat.md) + - [Category](docs/Category.md) + - [ClassModel](docs/ClassModel.md) + - [Client](docs/Client.md) + - [Dog](docs/Dog.md) + - [EnumArrays](docs/EnumArrays.md) + - [EnumClass](docs/EnumClass.md) + - [EnumTest](docs/EnumTest.md) + - [File](docs/File.md) + - [FileSchemaTestClass](docs/FileSchemaTestClass.md) + - [FormatTest](docs/FormatTest.md) + - [HasOnlyReadOnly](docs/HasOnlyReadOnly.md) + - [List](docs/List.md) + - [MapTest](docs/MapTest.md) + - [MixedPropertiesAndAdditionalPropertiesClass](docs/MixedPropertiesAndAdditionalPropertiesClass.md) + - [Model200Response](docs/Model200Response.md) + - [Name](docs/Name.md) + - [NumberOnly](docs/NumberOnly.md) + - [Order](docs/Order.md) + - [OuterComposite](docs/OuterComposite.md) + - [OuterEnum](docs/OuterEnum.md) + - [Pet](docs/Pet.md) + - [ReadOnlyFirst](docs/ReadOnlyFirst.md) + - [Return](docs/Return.md) + - [SpecialModelName](docs/SpecialModelName.md) + - [StringBooleanMap](docs/StringBooleanMap.md) + - [Tag](docs/Tag.md) + - [TypeHolderDefault](docs/TypeHolderDefault.md) + - [TypeHolderExample](docs/TypeHolderExample.md) + - [User](docs/User.md) + + +## Documentation For Authorization + + +## api_key + +- **Type**: API key +- **API key parameter name**: api_key +- **Location**: HTTP header + +## api_key_query + +- **Type**: API key +- **API key parameter name**: api_key_query +- **Location**: URL query string + +## http_basic_test + +- **Type**: HTTP basic authentication + +## petstore_auth + +- **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 + + +## Author + + + diff --git a/samples/client/petstore/swift4/rxswift/docs/AdditionalPropertiesClass.md b/samples/client/petstore/swift4/rxswift/docs/AdditionalPropertiesClass.md new file mode 100644 index 000000000000..a524730eb652 --- /dev/null +++ b/samples/client/petstore/swift4/rxswift/docs/AdditionalPropertiesClass.md @@ -0,0 +1,11 @@ +# AdditionalPropertiesClass + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**mapString** | **[String:String]** | | [optional] +**mapMapString** | [**[String:[String:String]]**](Dictionary.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) + + diff --git a/samples/client/petstore/swift4/rxswift/docs/Animal.md b/samples/client/petstore/swift4/rxswift/docs/Animal.md new file mode 100644 index 000000000000..69c601455cd8 --- /dev/null +++ b/samples/client/petstore/swift4/rxswift/docs/Animal.md @@ -0,0 +1,11 @@ +# Animal + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**className** | **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) + + diff --git a/samples/client/petstore/swift4/rxswift/docs/AnimalFarm.md b/samples/client/petstore/swift4/rxswift/docs/AnimalFarm.md new file mode 100644 index 000000000000..df6bab21dae8 --- /dev/null +++ b/samples/client/petstore/swift4/rxswift/docs/AnimalFarm.md @@ -0,0 +1,9 @@ +# AnimalFarm + +## Properties +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) + + diff --git a/samples/client/petstore/swift4/rxswift/docs/AnotherFakeAPI.md b/samples/client/petstore/swift4/rxswift/docs/AnotherFakeAPI.md new file mode 100644 index 000000000000..9f9e94d1c1f2 --- /dev/null +++ b/samples/client/petstore/swift4/rxswift/docs/AnotherFakeAPI.md @@ -0,0 +1,48 @@ +# AnotherFakeAPI + +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** +```swift + open class func call123testSpecialTags(body: Client) -> Observable +``` + +To test special tags + +To test special tags and operation ID starting with number + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = Client("client_example") // Client | client model + +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**Client**](Client.md)| client model | + +### Return type + +[**Client**](Client.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + diff --git a/samples/client/petstore/swift4/rxswift/docs/ApiResponse.md b/samples/client/petstore/swift4/rxswift/docs/ApiResponse.md new file mode 100644 index 000000000000..c6d9768fe9bf --- /dev/null +++ b/samples/client/petstore/swift4/rxswift/docs/ApiResponse.md @@ -0,0 +1,12 @@ +# ApiResponse + +## Properties +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) + + diff --git a/samples/client/petstore/swift4/rxswift/docs/ArrayOfArrayOfNumberOnly.md b/samples/client/petstore/swift4/rxswift/docs/ArrayOfArrayOfNumberOnly.md new file mode 100644 index 000000000000..3f78a9584d82 --- /dev/null +++ b/samples/client/petstore/swift4/rxswift/docs/ArrayOfArrayOfNumberOnly.md @@ -0,0 +1,10 @@ +# ArrayOfArrayOfNumberOnly + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**arrayArrayNumber** | [**[[Double]]**](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) + + diff --git a/samples/client/petstore/swift4/rxswift/docs/ArrayOfNumberOnly.md b/samples/client/petstore/swift4/rxswift/docs/ArrayOfNumberOnly.md new file mode 100644 index 000000000000..f09f8fa6f70f --- /dev/null +++ b/samples/client/petstore/swift4/rxswift/docs/ArrayOfNumberOnly.md @@ -0,0 +1,10 @@ +# ArrayOfNumberOnly + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**arrayNumber** | **[Double]** | | [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) + + diff --git a/samples/client/petstore/swift4/rxswift/docs/ArrayTest.md b/samples/client/petstore/swift4/rxswift/docs/ArrayTest.md new file mode 100644 index 000000000000..dd9be9d5876b --- /dev/null +++ b/samples/client/petstore/swift4/rxswift/docs/ArrayTest.md @@ -0,0 +1,12 @@ +# ArrayTest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**arrayOfString** | **[String]** | | [optional] +**arrayArrayOfInteger** | [**[[Int64]]**](Array.md) | | [optional] +**arrayArrayOfModel** | [**[[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) + + diff --git a/samples/client/petstore/swift4/rxswift/docs/Capitalization.md b/samples/client/petstore/swift4/rxswift/docs/Capitalization.md new file mode 100644 index 000000000000..95374216c773 --- /dev/null +++ b/samples/client/petstore/swift4/rxswift/docs/Capitalization.md @@ -0,0 +1,15 @@ +# Capitalization + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**smallCamel** | **String** | | [optional] +**capitalCamel** | **String** | | [optional] +**smallSnake** | **String** | | [optional] +**capitalSnake** | **String** | | [optional] +**sCAETHFlowPoints** | **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) + + diff --git a/samples/client/petstore/swift4/rxswift/docs/Cat.md b/samples/client/petstore/swift4/rxswift/docs/Cat.md new file mode 100644 index 000000000000..fb5949b15761 --- /dev/null +++ b/samples/client/petstore/swift4/rxswift/docs/Cat.md @@ -0,0 +1,10 @@ +# Cat + +## Properties +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) + + diff --git a/samples/client/petstore/swift4/rxswift/docs/Category.md b/samples/client/petstore/swift4/rxswift/docs/Category.md new file mode 100644 index 000000000000..5ca5408c0f96 --- /dev/null +++ b/samples/client/petstore/swift4/rxswift/docs/Category.md @@ -0,0 +1,11 @@ +# Category + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **Int64** | | [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) + + diff --git a/samples/client/petstore/swift4/rxswift/docs/ClassModel.md b/samples/client/petstore/swift4/rxswift/docs/ClassModel.md new file mode 100644 index 000000000000..e3912fdf0fd5 --- /dev/null +++ b/samples/client/petstore/swift4/rxswift/docs/ClassModel.md @@ -0,0 +1,10 @@ +# ClassModel + +## Properties +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) + + diff --git a/samples/client/petstore/swift4/rxswift/docs/Client.md b/samples/client/petstore/swift4/rxswift/docs/Client.md new file mode 100644 index 000000000000..0de1b238c36f --- /dev/null +++ b/samples/client/petstore/swift4/rxswift/docs/Client.md @@ -0,0 +1,10 @@ +# Client + +## Properties +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) + + diff --git a/samples/client/petstore/swift4/rxswift/docs/Dog.md b/samples/client/petstore/swift4/rxswift/docs/Dog.md new file mode 100644 index 000000000000..4824786da049 --- /dev/null +++ b/samples/client/petstore/swift4/rxswift/docs/Dog.md @@ -0,0 +1,10 @@ +# Dog + +## Properties +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) + + diff --git a/samples/client/petstore/swift4/rxswift/docs/EnumArrays.md b/samples/client/petstore/swift4/rxswift/docs/EnumArrays.md new file mode 100644 index 000000000000..b9a9807d3c8e --- /dev/null +++ b/samples/client/petstore/swift4/rxswift/docs/EnumArrays.md @@ -0,0 +1,11 @@ +# EnumArrays + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**justSymbol** | **String** | | [optional] +**arrayEnum** | **[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) + + diff --git a/samples/client/petstore/swift4/rxswift/docs/EnumClass.md b/samples/client/petstore/swift4/rxswift/docs/EnumClass.md new file mode 100644 index 000000000000..67f017becd0c --- /dev/null +++ b/samples/client/petstore/swift4/rxswift/docs/EnumClass.md @@ -0,0 +1,9 @@ +# EnumClass + +## Properties +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) + + diff --git a/samples/client/petstore/swift4/rxswift/docs/EnumTest.md b/samples/client/petstore/swift4/rxswift/docs/EnumTest.md new file mode 100644 index 000000000000..bc9b036dd769 --- /dev/null +++ b/samples/client/petstore/swift4/rxswift/docs/EnumTest.md @@ -0,0 +1,14 @@ +# EnumTest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enumString** | **String** | | [optional] +**enumStringRequired** | **String** | | +**enumInteger** | **Int** | | [optional] +**enumNumber** | **Double** | | [optional] +**outerEnum** | [**OuterEnum**](OuterEnum.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) + + diff --git a/samples/client/petstore/swift4/rxswift/docs/FakeAPI.md b/samples/client/petstore/swift4/rxswift/docs/FakeAPI.md new file mode 100644 index 000000000000..54e9aa89a0cf --- /dev/null +++ b/samples/client/petstore/swift4/rxswift/docs/FakeAPI.md @@ -0,0 +1,536 @@ +# FakeAPI + +All URIs are relative to *http://petstore.swagger.io:80/v2* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**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 + + +# **fakeOuterBooleanSerialize** +```swift + open class func fakeOuterBooleanSerialize(body: Bool? = nil) -> Observable +``` + + + +Test serialization of outer boolean types + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = 987 // Bool | Input boolean as post body (optional) + +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **Bool**| Input boolean as post body | [optional] + +### Return type + +**Bool** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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 README]](../README.md) + +# **fakeOuterCompositeSerialize** +```swift + open class func fakeOuterCompositeSerialize(body: OuterComposite? = nil) -> Observable +``` + + + +Test serialization of object with outer number type + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = OuterComposite(123, "myString_example", 123) // OuterComposite | Input composite as post body (optional) + +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**OuterComposite**](OuterComposite.md)| Input composite as post body | [optional] + +### Return type + +[**OuterComposite**](OuterComposite.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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 README]](../README.md) + +# **fakeOuterNumberSerialize** +```swift + open class func fakeOuterNumberSerialize(body: Double? = nil) -> Observable +``` + + + +Test serialization of outer number types + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = 987 // Double | Input number as post body (optional) + +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **Double**| Input number as post body | [optional] + +### Return type + +**Double** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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 README]](../README.md) + +# **fakeOuterStringSerialize** +```swift + open class func fakeOuterStringSerialize(body: String? = nil) -> Observable +``` + + + +Test serialization of outer string types + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = "body_example" // String | Input string as post body (optional) + +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **String**| Input string as post body | [optional] + +### Return type + +**String** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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 README]](../README.md) + +# **testBodyWithFileSchema** +```swift + open class func testBodyWithFileSchema(body: FileSchemaTestClass) -> Observable +``` + + + +For this test, the body for this request much reference a schema named `File`. + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = FileSchemaTestClass(File("sourceURI_example"), [File("sourceURI_example")]) // FileSchemaTestClass | + +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**FileSchemaTestClass**](FileSchemaTestClass.md)| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + +# **testBodyWithQueryParams** +```swift + open class func testBodyWithQueryParams(query: String, body: User) -> Observable +``` + + + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let query = "query_example" // String | +let body = User(123, "username_example", "firstName_example", "lastName_example", "email_example", "password_example", "phone_example", 123) // User | + +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **String**| | + **body** | [**User**](User.md)| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + +# **testClientModel** +```swift + open class func testClientModel(body: Client) -> Observable +``` + +To test \"client\" model + +To test \"client\" model + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = Client("client_example") // Client | client model + +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**Client**](Client.md)| client model | + +### Return type + +[**Client**](Client.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + +# **testEndpointParameters** +```swift + open class func testEndpointParameters(number: Double, double: Double, patternWithoutDelimiter: String, byte: Data, integer: Int? = nil, int32: Int? = nil, int64: Int64? = nil, float: Float? = nil, string: String? = nil, binary: URL? = nil, date: Date? = nil, dateTime: Date? = nil, password: String? = nil, callback: String? = nil) -> Observable +``` + +Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 + +Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let number = 987 // Double | None +let double = 987 // Double | None +let patternWithoutDelimiter = "patternWithoutDelimiter_example" // String | None +let byte = TODO // Data | None +let integer = 987 // Int | None (optional) +let int32 = 987 // Int | None (optional) +let int64 = 987 // Int64 | None (optional) +let float = 987 // Float | None (optional) +let string = "string_example" // String | None (optional) +let binary = "TODO" // URL | None (optional) +let date = TODO // Date | None (optional) +let dateTime = TODO // Date | None (optional) +let password = "password_example" // String | None (optional) +let callback = "callback_example" // String | None (optional) + +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **number** | **Double**| None | + **double** | **Double**| None | + **patternWithoutDelimiter** | **String**| None | + **byte** | **Data**| None | + **integer** | **Int**| None | [optional] + **int32** | **Int**| None | [optional] + **int64** | **Int64**| None | [optional] + **float** | **Float**| None | [optional] + **string** | **String**| None | [optional] + **binary** | **URL****URL**| None | [optional] + **date** | **Date**| None | [optional] + **dateTime** | **Date**| None | [optional] + **password** | **String**| None | [optional] + **callback** | **String**| None | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[http_basic_test](../README.md#http_basic_test) + +### HTTP request headers + + - **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 README]](../README.md) + +# **testEnumParameters** +```swift + open class func testEnumParameters(enumHeaderStringArray: [String]? = nil, enumHeaderString: EnumHeaderString_testEnumParameters? = nil, enumQueryStringArray: [String]? = nil, enumQueryString: EnumQueryString_testEnumParameters? = nil, enumQueryInteger: EnumQueryInteger_testEnumParameters? = nil, enumQueryDouble: EnumQueryDouble_testEnumParameters? = nil, enumFormStringArray: [String]? = nil, enumFormString: EnumFormString_testEnumParameters? = nil) -> Observable +``` + +To test enum parameters + +To test enum parameters + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let enumHeaderStringArray = ["enumHeaderStringArray_example"] // [String] | Header parameter enum test (string array) (optional) +let enumHeaderString = "enumHeaderString_example" // String | Header parameter enum test (string) (optional) (default to .-efg) +let enumQueryStringArray = ["enumQueryStringArray_example"] // [String] | Query parameter enum test (string array) (optional) +let enumQueryString = "enumQueryString_example" // String | Query parameter enum test (string) (optional) (default to .-efg) +let enumQueryInteger = 987 // Int | Query parameter enum test (double) (optional) +let enumQueryDouble = 987 // Double | Query parameter enum test (double) (optional) +let enumFormStringArray = ["inner_example"] // [String] | Form parameter enum test (string array) (optional) (default to .$) +let enumFormString = "enumFormString_example" // String | Form parameter enum test (string) (optional) (default to .-efg) + +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **enumHeaderStringArray** | [**[String]**](String.md)| Header parameter enum test (string array) | [optional] + **enumHeaderString** | **String**| Header parameter enum test (string) | [optional] [default to .-efg] + **enumQueryStringArray** | [**[String]**](String.md)| Query parameter enum test (string array) | [optional] + **enumQueryString** | **String**| Query parameter enum test (string) | [optional] [default to .-efg] + **enumQueryInteger** | **Int**| Query parameter enum test (double) | [optional] + **enumQueryDouble** | **Double**| Query parameter enum test (double) | [optional] + **enumFormStringArray** | [**[String]**](String.md)| Form parameter enum test (string array) | [optional] [default to .$] + **enumFormString** | **String**| Form parameter enum test (string) | [optional] [default to .-efg] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + +# **testGroupParameters** +```swift + open class func testGroupParameters(requiredStringGroup: Int, requiredBooleanGroup: Bool, requiredInt64Group: Int64, stringGroup: Int? = nil, booleanGroup: Bool? = nil, int64Group: Int64? = nil) -> Observable +``` + +Fake endpoint to test group parameters (optional) + +Fake endpoint to test group parameters (optional) + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let requiredStringGroup = 987 // Int | Required String in group parameters +let requiredBooleanGroup = 987 // Bool | Required Boolean in group parameters +let requiredInt64Group = 987 // Int64 | Required Integer in group parameters +let stringGroup = 987 // Int | String in group parameters (optional) +let booleanGroup = 987 // Bool | Boolean in group parameters (optional) +let int64Group = 987 // Int64 | Integer in group parameters (optional) + +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **requiredStringGroup** | **Int**| Required String in group parameters | + **requiredBooleanGroup** | **Bool**| Required Boolean in group parameters | + **requiredInt64Group** | **Int64**| Required Integer in group parameters | + **stringGroup** | **Int**| String in group parameters | [optional] + **booleanGroup** | **Bool**| Boolean in group parameters | [optional] + **int64Group** | **Int64**| Integer in group parameters | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + +# **testInlineAdditionalProperties** +```swift + open class func testInlineAdditionalProperties(param: [String:String]) -> Observable +``` + +test inline additionalProperties + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let param = "TODO" // [String:String] | request body + +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **param** | [**[String:String]**](String.md)| request body | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + +# **testJsonFormData** +```swift + open class func testJsonFormData(param: String, param2: String) -> Observable +``` + +test json serialization of form data + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let param = "param_example" // String | field1 +let param2 = "param2_example" // String | field2 + +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **param** | **String**| field1 | + **param2** | **String**| field2 | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + diff --git a/samples/client/petstore/swift4/rxswift/docs/FakeClassnameTags123API.md b/samples/client/petstore/swift4/rxswift/docs/FakeClassnameTags123API.md new file mode 100644 index 000000000000..ab72d71f0218 --- /dev/null +++ b/samples/client/petstore/swift4/rxswift/docs/FakeClassnameTags123API.md @@ -0,0 +1,48 @@ +# FakeClassnameTags123API + +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** +```swift + open class func testClassname(body: Client) -> Observable +``` + +To test class name in snake case + +To test class name in snake case + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = Client("client_example") // Client | client model + +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**Client**](Client.md)| client model | + +### Return type + +[**Client**](Client.md) + +### Authorization + +[api_key_query](../README.md#api_key_query) + +### HTTP request headers + + - **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 README]](../README.md) + diff --git a/samples/client/petstore/swift4/rxswift/docs/File.md b/samples/client/petstore/swift4/rxswift/docs/File.md new file mode 100644 index 000000000000..3edfef17b794 --- /dev/null +++ b/samples/client/petstore/swift4/rxswift/docs/File.md @@ -0,0 +1,10 @@ +# File + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**sourceURI** | **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) + + diff --git a/samples/client/petstore/swift4/rxswift/docs/FileSchemaTestClass.md b/samples/client/petstore/swift4/rxswift/docs/FileSchemaTestClass.md new file mode 100644 index 000000000000..d0a8bbaaba95 --- /dev/null +++ b/samples/client/petstore/swift4/rxswift/docs/FileSchemaTestClass.md @@ -0,0 +1,11 @@ +# FileSchemaTestClass + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**file** | [**File**](File.md) | | [optional] +**files** | [**[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) + + diff --git a/samples/client/petstore/swift4/rxswift/docs/FormatTest.md b/samples/client/petstore/swift4/rxswift/docs/FormatTest.md new file mode 100644 index 000000000000..547eb88754f4 --- /dev/null +++ b/samples/client/petstore/swift4/rxswift/docs/FormatTest.md @@ -0,0 +1,22 @@ +# FormatTest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**integer** | **Int** | | [optional] +**int32** | **Int** | | [optional] +**int64** | **Int64** | | [optional] +**number** | **Double** | | +**float** | **Float** | | [optional] +**double** | **Double** | | [optional] +**string** | **String** | | [optional] +**byte** | [**Data**](Data.md) | | +**binary** | [**URL**](URL.md) | | [optional] +**date** | [**Date**](Date.md) | | +**dateTime** | [**Date**](Date.md) | | [optional] +**uuid** | [**UUID**](UUID.md) | | [optional] +**password** | **String** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/samples/client/petstore/swift4/rxswift/docs/HasOnlyReadOnly.md b/samples/client/petstore/swift4/rxswift/docs/HasOnlyReadOnly.md new file mode 100644 index 000000000000..45781360154c --- /dev/null +++ b/samples/client/petstore/swift4/rxswift/docs/HasOnlyReadOnly.md @@ -0,0 +1,11 @@ +# HasOnlyReadOnly + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**bar** | **String** | | [optional] +**foo** | **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) + + diff --git a/samples/client/petstore/swift4/rxswift/docs/List.md b/samples/client/petstore/swift4/rxswift/docs/List.md new file mode 100644 index 000000000000..b77718302edf --- /dev/null +++ b/samples/client/petstore/swift4/rxswift/docs/List.md @@ -0,0 +1,10 @@ +# List + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**_123list** | **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) + + diff --git a/samples/client/petstore/swift4/rxswift/docs/MapTest.md b/samples/client/petstore/swift4/rxswift/docs/MapTest.md new file mode 100644 index 000000000000..e910bc97518c --- /dev/null +++ b/samples/client/petstore/swift4/rxswift/docs/MapTest.md @@ -0,0 +1,13 @@ +# MapTest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**mapMapOfString** | [**[String:[String:String]]**](Dictionary.md) | | [optional] +**mapOfEnumString** | **[String:String]** | | [optional] +**directMap** | **[String:Bool]** | | [optional] +**indirectMap** | [**StringBooleanMap**](StringBooleanMap.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) + + diff --git a/samples/client/petstore/swift4/rxswift/docs/MixedPropertiesAndAdditionalPropertiesClass.md b/samples/client/petstore/swift4/rxswift/docs/MixedPropertiesAndAdditionalPropertiesClass.md new file mode 100644 index 000000000000..2c502eace42c --- /dev/null +++ b/samples/client/petstore/swift4/rxswift/docs/MixedPropertiesAndAdditionalPropertiesClass.md @@ -0,0 +1,12 @@ +# MixedPropertiesAndAdditionalPropertiesClass + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**uuid** | [**UUID**](UUID.md) | | [optional] +**dateTime** | [**Date**](Date.md) | | [optional] +**map** | [**[String: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) + + diff --git a/samples/client/petstore/swift4/rxswift/docs/Model200Response.md b/samples/client/petstore/swift4/rxswift/docs/Model200Response.md new file mode 100644 index 000000000000..5865ea690cc3 --- /dev/null +++ b/samples/client/petstore/swift4/rxswift/docs/Model200Response.md @@ -0,0 +1,11 @@ +# Model200Response + +## Properties +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) + + diff --git a/samples/client/petstore/swift4/rxswift/docs/Name.md b/samples/client/petstore/swift4/rxswift/docs/Name.md new file mode 100644 index 000000000000..2be75d062e47 --- /dev/null +++ b/samples/client/petstore/swift4/rxswift/docs/Name.md @@ -0,0 +1,13 @@ +# Name + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **Int** | | +**snakeCase** | **Int** | | [optional] +**property** | **String** | | [optional] +**_123number** | **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) + + diff --git a/samples/client/petstore/swift4/rxswift/docs/NumberOnly.md b/samples/client/petstore/swift4/rxswift/docs/NumberOnly.md new file mode 100644 index 000000000000..72bd361168b5 --- /dev/null +++ b/samples/client/petstore/swift4/rxswift/docs/NumberOnly.md @@ -0,0 +1,10 @@ +# NumberOnly + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**justNumber** | **Double** | | [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) + + diff --git a/samples/client/petstore/swift4/rxswift/docs/Order.md b/samples/client/petstore/swift4/rxswift/docs/Order.md new file mode 100644 index 000000000000..9d3205c1526a --- /dev/null +++ b/samples/client/petstore/swift4/rxswift/docs/Order.md @@ -0,0 +1,15 @@ +# Order + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **Int64** | | [optional] +**petId** | **Int64** | | [optional] +**quantity** | **Int** | | [optional] +**shipDate** | [**Date**](Date.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) + + diff --git a/samples/client/petstore/swift4/rxswift/docs/OuterComposite.md b/samples/client/petstore/swift4/rxswift/docs/OuterComposite.md new file mode 100644 index 000000000000..d6b3583bc3ff --- /dev/null +++ b/samples/client/petstore/swift4/rxswift/docs/OuterComposite.md @@ -0,0 +1,12 @@ +# OuterComposite + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**myNumber** | **Double** | | [optional] +**myString** | **String** | | [optional] +**myBoolean** | **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) + + diff --git a/samples/client/petstore/swift4/rxswift/docs/OuterEnum.md b/samples/client/petstore/swift4/rxswift/docs/OuterEnum.md new file mode 100644 index 000000000000..06d413b01680 --- /dev/null +++ b/samples/client/petstore/swift4/rxswift/docs/OuterEnum.md @@ -0,0 +1,9 @@ +# OuterEnum + +## Properties +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) + + diff --git a/samples/client/petstore/swift4/rxswift/docs/Pet.md b/samples/client/petstore/swift4/rxswift/docs/Pet.md new file mode 100644 index 000000000000..c30a5292f537 --- /dev/null +++ b/samples/client/petstore/swift4/rxswift/docs/Pet.md @@ -0,0 +1,15 @@ +# Pet + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **Int64** | | [optional] +**category** | [**Category**](Category.md) | | [optional] +**name** | **String** | | +**photoUrls** | **[String]** | | +**tags** | [**[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) + + diff --git a/samples/client/petstore/swift4/rxswift/docs/PetAPI.md b/samples/client/petstore/swift4/rxswift/docs/PetAPI.md new file mode 100644 index 000000000000..036f5dcb7dbb --- /dev/null +++ b/samples/client/petstore/swift4/rxswift/docs/PetAPI.md @@ -0,0 +1,370 @@ +# PetAPI + +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** +```swift + open class func addPet(body: Pet) -> Observable +``` + +Add a new pet to the store + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = Pet(123, Category(123, "name_example"), "name_example", ["photoUrls_example"], [Tag(123, "name_example")], "status_example") // Pet | Pet object that needs to be added to the store + +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | + +### Return type + +void (empty response body) + +### Authorization + +[petstore_auth](../README.md#petstore_auth) + +### HTTP request headers + + - **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 README]](../README.md) + +# **deletePet** +```swift + open class func deletePet(petId: Int64, apiKey: String? = nil) -> Observable +``` + +Deletes a pet + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let petId = 987 // Int64 | Pet id to delete +let apiKey = "apiKey_example" // String | (optional) + +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **petId** | **Int64**| Pet id to delete | + **apiKey** | **String**| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[petstore_auth](../README.md#petstore_auth) + +### HTTP request headers + + - **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 README]](../README.md) + +# **findPetsByStatus** +```swift + open class func findPetsByStatus(status: [String]) -> Observable<[Pet]> +``` + +Finds Pets by status + +Multiple status values can be provided with comma separated strings + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let status = ["status_example"] // [String] | Status values that need to be considered for filter + +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **status** | [**[String]**](String.md)| Status values that need to be considered for filter | + +### Return type + +[**[Pet]**](Pet.md) + +### Authorization + +[petstore_auth](../README.md#petstore_auth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **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 README]](../README.md) + +# **findPetsByTags** +```swift + open class func findPetsByTags(tags: [String]) -> Observable<[Pet]> +``` + +Finds Pets by tags + +Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let tags = ["inner_example"] // [String] | Tags to filter by + +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **tags** | [**[String]**](String.md)| Tags to filter by | + +### Return type + +[**[Pet]**](Pet.md) + +### Authorization + +[petstore_auth](../README.md#petstore_auth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **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 README]](../README.md) + +# **getPetById** +```swift + open class func getPetById(petId: Int64) -> Observable +``` + +Find pet by ID + +Returns a single pet + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let petId = 987 // Int64 | ID of pet to return + +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **petId** | **Int64**| ID of pet to return | + +### Return type + +[**Pet**](Pet.md) + +### Authorization + +[api_key](../README.md#api_key) + +### HTTP request headers + + - **Content-Type**: Not defined + - **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 README]](../README.md) + +# **updatePet** +```swift + open class func updatePet(body: Pet) -> Observable +``` + +Update an existing pet + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = Pet(123, Category(123, "name_example"), "name_example", ["photoUrls_example"], [Tag(123, "name_example")], "status_example") // Pet | Pet object that needs to be added to the store + +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | + +### Return type + +void (empty response body) + +### Authorization + +[petstore_auth](../README.md#petstore_auth) + +### HTTP request headers + + - **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 README]](../README.md) + +# **updatePetWithForm** +```swift + open class func updatePetWithForm(petId: Int64, name: String? = nil, status: String? = nil) -> Observable +``` + +Updates a pet in the store with form data + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let petId = 987 // Int64 | ID of pet that needs to be updated +let name = "name_example" // String | Updated name of the pet (optional) +let status = "status_example" // String | Updated status of the pet (optional) + +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **petId** | **Int64**| ID of pet that needs to be updated | + **name** | **String**| Updated name of the pet | [optional] + **status** | **String**| Updated status of the pet | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[petstore_auth](../README.md#petstore_auth) + +### HTTP request headers + + - **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 README]](../README.md) + +# **uploadFile** +```swift + open class func uploadFile(petId: Int64, additionalMetadata: String? = nil, file: URL? = nil) -> Observable +``` + +uploads an image + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let petId = 987 // Int64 | ID of pet to update +let additionalMetadata = "additionalMetadata_example" // String | Additional data to pass to server (optional) +let file = "TODO" // URL | file to upload (optional) + +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **petId** | **Int64**| ID of pet to update | + **additionalMetadata** | **String**| Additional data to pass to server | [optional] + **file** | **URL****URL**| file to upload | [optional] + +### Return type + +[**ApiResponse**](ApiResponse.md) + +### Authorization + +[petstore_auth](../README.md#petstore_auth) + +### HTTP request headers + + - **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 README]](../README.md) + +# **uploadFileWithRequiredFile** +```swift + open class func uploadFileWithRequiredFile(petId: Int64, requiredFile: URL, additionalMetadata: String? = nil) -> Observable +``` + +uploads an image (required) + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let petId = 987 // Int64 | ID of pet to update +let requiredFile = "TODO" // URL | file to upload +let additionalMetadata = "additionalMetadata_example" // String | Additional data to pass to server (optional) + +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **petId** | **Int64**| ID of pet to update | + **requiredFile** | **URL****URL**| file to upload | + **additionalMetadata** | **String**| Additional data to pass to server | [optional] + +### Return type + +[**ApiResponse**](ApiResponse.md) + +### Authorization + +[petstore_auth](../README.md#petstore_auth) + +### HTTP request headers + + - **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 README]](../README.md) + diff --git a/samples/client/petstore/swift4/rxswift/docs/ReadOnlyFirst.md b/samples/client/petstore/swift4/rxswift/docs/ReadOnlyFirst.md new file mode 100644 index 000000000000..e3f16038b970 --- /dev/null +++ b/samples/client/petstore/swift4/rxswift/docs/ReadOnlyFirst.md @@ -0,0 +1,11 @@ +# ReadOnlyFirst + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**bar** | **String** | | [optional] +**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) + + diff --git a/samples/client/petstore/swift4/rxswift/docs/Return.md b/samples/client/petstore/swift4/rxswift/docs/Return.md new file mode 100644 index 000000000000..66d17c27c887 --- /dev/null +++ b/samples/client/petstore/swift4/rxswift/docs/Return.md @@ -0,0 +1,10 @@ +# Return + +## Properties +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) + + diff --git a/samples/client/petstore/swift4/rxswift/docs/SpecialModelName.md b/samples/client/petstore/swift4/rxswift/docs/SpecialModelName.md new file mode 100644 index 000000000000..3ec27a38c2ac --- /dev/null +++ b/samples/client/petstore/swift4/rxswift/docs/SpecialModelName.md @@ -0,0 +1,10 @@ +# SpecialModelName + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**specialPropertyName** | **Int64** | | [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) + + diff --git a/samples/client/petstore/swift4/rxswift/docs/StoreAPI.md b/samples/client/petstore/swift4/rxswift/docs/StoreAPI.md new file mode 100644 index 000000000000..f95177acb7bb --- /dev/null +++ b/samples/client/petstore/swift4/rxswift/docs/StoreAPI.md @@ -0,0 +1,162 @@ +# StoreAPI + +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** +```swift + open class func deleteOrder(orderId: String) -> Observable +``` + +Delete purchase order by ID + +For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let orderId = "orderId_example" // String | ID of the order that needs to be deleted + +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **orderId** | **String**| ID of the order that needs to be deleted | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + +# **getInventory** +```swift + open class func getInventory() -> Observable<[String:Int]> +``` + +Returns pet inventories by status + +Returns a map of status codes to quantities + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + + +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[String:Int]** + +### Authorization + +[api_key](../README.md#api_key) + +### HTTP request headers + + - **Content-Type**: Not defined + - **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 README]](../README.md) + +# **getOrderById** +```swift + open class func getOrderById(orderId: Int64) -> Observable +``` + +Find purchase order by ID + +For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let orderId = 987 // Int64 | ID of pet that needs to be fetched + +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **orderId** | **Int64**| ID of pet that needs to be fetched | + +### Return type + +[**Order**](Order.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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 README]](../README.md) + +# **placeOrder** +```swift + open class func placeOrder(body: Order) -> Observable +``` + +Place an order for a pet + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = Order(123, 123, 123, "TODO", "status_example", 123) // Order | order placed for purchasing the pet + +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**Order**](Order.md)| order placed for purchasing the pet | + +### Return type + +[**Order**](Order.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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 README]](../README.md) + diff --git a/samples/client/petstore/swift4/rxswift/docs/StringBooleanMap.md b/samples/client/petstore/swift4/rxswift/docs/StringBooleanMap.md new file mode 100644 index 000000000000..7abf11ec68b1 --- /dev/null +++ b/samples/client/petstore/swift4/rxswift/docs/StringBooleanMap.md @@ -0,0 +1,9 @@ +# StringBooleanMap + +## Properties +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) + + diff --git a/samples/client/petstore/swift4/rxswift/docs/Tag.md b/samples/client/petstore/swift4/rxswift/docs/Tag.md new file mode 100644 index 000000000000..ff4ac8aa4519 --- /dev/null +++ b/samples/client/petstore/swift4/rxswift/docs/Tag.md @@ -0,0 +1,11 @@ +# Tag + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **Int64** | | [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) + + diff --git a/samples/client/petstore/swift4/rxswift/docs/TypeHolderDefault.md b/samples/client/petstore/swift4/rxswift/docs/TypeHolderDefault.md new file mode 100644 index 000000000000..5161394bdc3e --- /dev/null +++ b/samples/client/petstore/swift4/rxswift/docs/TypeHolderDefault.md @@ -0,0 +1,14 @@ +# TypeHolderDefault + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**stringItem** | **String** | | [default to "what"] +**numberItem** | **Double** | | +**integerItem** | **Int** | | +**boolItem** | **Bool** | | [default to true] +**arrayItem** | **[Int]** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/samples/client/petstore/swift4/rxswift/docs/TypeHolderExample.md b/samples/client/petstore/swift4/rxswift/docs/TypeHolderExample.md new file mode 100644 index 000000000000..46d0471cd71a --- /dev/null +++ b/samples/client/petstore/swift4/rxswift/docs/TypeHolderExample.md @@ -0,0 +1,14 @@ +# TypeHolderExample + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**stringItem** | **String** | | +**numberItem** | **Double** | | +**integerItem** | **Int** | | +**boolItem** | **Bool** | | +**arrayItem** | **[Int]** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/samples/client/petstore/swift4/rxswift/docs/User.md b/samples/client/petstore/swift4/rxswift/docs/User.md new file mode 100644 index 000000000000..5a439de0ff95 --- /dev/null +++ b/samples/client/petstore/swift4/rxswift/docs/User.md @@ -0,0 +1,17 @@ +# User + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **Int64** | | [optional] +**username** | **String** | | [optional] +**firstName** | **String** | | [optional] +**lastName** | **String** | | [optional] +**email** | **String** | | [optional] +**password** | **String** | | [optional] +**phone** | **String** | | [optional] +**userStatus** | **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) + + diff --git a/samples/client/petstore/swift4/rxswift/docs/UserAPI.md b/samples/client/petstore/swift4/rxswift/docs/UserAPI.md new file mode 100644 index 000000000000..094d1b409e6a --- /dev/null +++ b/samples/client/petstore/swift4/rxswift/docs/UserAPI.md @@ -0,0 +1,318 @@ +# UserAPI + +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** +```swift + open class func createUser(body: User) -> Observable +``` + +Create user + +This can only be done by the logged in user. + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = User(123, "username_example", "firstName_example", "lastName_example", "email_example", "password_example", "phone_example", 123) // User | Created user object + +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**User**](User.md)| Created user object | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + +# **createUsersWithArrayInput** +```swift + open class func createUsersWithArrayInput(body: [User]) -> Observable +``` + +Creates list of users with given input array + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = [User(123, "username_example", "firstName_example", "lastName_example", "email_example", "password_example", "phone_example", 123)] // [User] | List of user object + +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**[User]**](Array.md)| List of user object | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + +# **createUsersWithListInput** +```swift + open class func createUsersWithListInput(body: [User]) -> Observable +``` + +Creates list of users with given input array + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = [User(123, "username_example", "firstName_example", "lastName_example", "email_example", "password_example", "phone_example", 123)] // [User] | List of user object + +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**[User]**](Array.md)| List of user object | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + +# **deleteUser** +```swift + open class func deleteUser(username: String) -> Observable +``` + +Delete user + +This can only be done by the logged in user. + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let username = "username_example" // String | The name that needs to be deleted + +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **username** | **String**| The name that needs to be deleted | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + +# **getUserByName** +```swift + open class func getUserByName(username: String) -> Observable +``` + +Get user by user name + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let username = "username_example" // String | The name that needs to be fetched. Use user1 for testing. + +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **username** | **String**| The name that needs to be fetched. Use user1 for testing. | + +### Return type + +[**User**](User.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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 README]](../README.md) + +# **loginUser** +```swift + open class func loginUser(username: String, password: String) -> Observable +``` + +Logs user into the system + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let username = "username_example" // String | The user name for login +let password = "password_example" // String | The password for login in clear text + +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **username** | **String**| The user name for login | + **password** | **String**| The password for login in clear text | + +### Return type + +**String** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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 README]](../README.md) + +# **logoutUser** +```swift + open class func logoutUser() -> Observable +``` + +Logs out current logged in user session + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + + +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + +# **updateUser** +```swift + open class func updateUser(username: String, body: User) -> Observable +``` + +Updated user + +This can only be done by the logged in user. + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let username = "username_example" // String | name that need to be deleted +let body = User(123, "username_example", "firstName_example", "lastName_example", "email_example", "password_example", "phone_example", 123) // User | Updated user object + +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **username** | **String**| name that need to be deleted | + **body** | [**User**](User.md)| Updated user object | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + diff --git a/samples/client/petstore/swift4/unwrapRequired/README.md b/samples/client/petstore/swift4/unwrapRequired/README.md new file mode 100644 index 000000000000..1e7f0a59ea01 --- /dev/null +++ b/samples/client/petstore/swift4/unwrapRequired/README.md @@ -0,0 +1,139 @@ +# Swift4 API client for PetstoreClient + +This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\ + +## Overview +This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [openapi-spec from a remote server, you can easily generate an API client. + +- API version: 1.0.0 +- Package version: +- Build package: org.openapitools.codegen.languages.Swift4Codegen + +## Installation + +### Carthage + +Run `carthage update` + +### CocoaPods + +Run `pod install` + +## Documentation for API Endpoints + +All URIs are relative to *http://petstore.swagger.io:80/v2* + +Class | Method | HTTP request | Description +------------ | ------------- | ------------- | ------------- +*AnotherFakeAPI* | [**call123testSpecialTags**](docs/AnotherFakeAPI.md#call123testspecialtags) | **PATCH** /another-fake/dummy | To test special tags +*FakeAPI* | [**fakeOuterBooleanSerialize**](docs/FakeAPI.md#fakeouterbooleanserialize) | **POST** /fake/outer/boolean | +*FakeAPI* | [**fakeOuterCompositeSerialize**](docs/FakeAPI.md#fakeoutercompositeserialize) | **POST** /fake/outer/composite | +*FakeAPI* | [**fakeOuterNumberSerialize**](docs/FakeAPI.md#fakeouternumberserialize) | **POST** /fake/outer/number | +*FakeAPI* | [**fakeOuterStringSerialize**](docs/FakeAPI.md#fakeouterstringserialize) | **POST** /fake/outer/string | +*FakeAPI* | [**testBodyWithFileSchema**](docs/FakeAPI.md#testbodywithfileschema) | **PUT** /fake/body-with-file-schema | +*FakeAPI* | [**testBodyWithQueryParams**](docs/FakeAPI.md#testbodywithqueryparams) | **PUT** /fake/body-with-query-params | +*FakeAPI* | [**testClientModel**](docs/FakeAPI.md#testclientmodel) | **PATCH** /fake | To test \"client\" model +*FakeAPI* | [**testEndpointParameters**](docs/FakeAPI.md#testendpointparameters) | **POST** /fake | Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 +*FakeAPI* | [**testEnumParameters**](docs/FakeAPI.md#testenumparameters) | **GET** /fake | To test enum parameters +*FakeAPI* | [**testGroupParameters**](docs/FakeAPI.md#testgroupparameters) | **DELETE** /fake | Fake endpoint to test group parameters (optional) +*FakeAPI* | [**testInlineAdditionalProperties**](docs/FakeAPI.md#testinlineadditionalproperties) | **POST** /fake/inline-additionalProperties | test inline additionalProperties +*FakeAPI* | [**testJsonFormData**](docs/FakeAPI.md#testjsonformdata) | **GET** /fake/jsonFormData | test json serialization of form data +*FakeClassnameTags123API* | [**testClassname**](docs/FakeClassnameTags123API.md#testclassname) | **PATCH** /fake_classname_test | To test class name in snake case +*PetAPI* | [**addPet**](docs/PetAPI.md#addpet) | **POST** /pet | Add a new pet to the store +*PetAPI* | [**deletePet**](docs/PetAPI.md#deletepet) | **DELETE** /pet/{petId} | Deletes a pet +*PetAPI* | [**findPetsByStatus**](docs/PetAPI.md#findpetsbystatus) | **GET** /pet/findByStatus | Finds Pets by status +*PetAPI* | [**findPetsByTags**](docs/PetAPI.md#findpetsbytags) | **GET** /pet/findByTags | Finds Pets by tags +*PetAPI* | [**getPetById**](docs/PetAPI.md#getpetbyid) | **GET** /pet/{petId} | Find pet by ID +*PetAPI* | [**updatePet**](docs/PetAPI.md#updatepet) | **PUT** /pet | Update an existing pet +*PetAPI* | [**updatePetWithForm**](docs/PetAPI.md#updatepetwithform) | **POST** /pet/{petId} | Updates a pet in the store with form data +*PetAPI* | [**uploadFile**](docs/PetAPI.md#uploadfile) | **POST** /pet/{petId}/uploadImage | uploads an image +*PetAPI* | [**uploadFileWithRequiredFile**](docs/PetAPI.md#uploadfilewithrequiredfile) | **POST** /fake/{petId}/uploadImageWithRequiredFile | uploads an image (required) +*StoreAPI* | [**deleteOrder**](docs/StoreAPI.md#deleteorder) | **DELETE** /store/order/{order_id} | Delete purchase order by ID +*StoreAPI* | [**getInventory**](docs/StoreAPI.md#getinventory) | **GET** /store/inventory | Returns pet inventories by status +*StoreAPI* | [**getOrderById**](docs/StoreAPI.md#getorderbyid) | **GET** /store/order/{order_id} | Find purchase order by ID +*StoreAPI* | [**placeOrder**](docs/StoreAPI.md#placeorder) | **POST** /store/order | Place an order for a pet +*UserAPI* | [**createUser**](docs/UserAPI.md#createuser) | **POST** /user | Create user +*UserAPI* | [**createUsersWithArrayInput**](docs/UserAPI.md#createuserswitharrayinput) | **POST** /user/createWithArray | Creates list of users with given input array +*UserAPI* | [**createUsersWithListInput**](docs/UserAPI.md#createuserswithlistinput) | **POST** /user/createWithList | Creates list of users with given input array +*UserAPI* | [**deleteUser**](docs/UserAPI.md#deleteuser) | **DELETE** /user/{username} | Delete user +*UserAPI* | [**getUserByName**](docs/UserAPI.md#getuserbyname) | **GET** /user/{username} | Get user by user name +*UserAPI* | [**loginUser**](docs/UserAPI.md#loginuser) | **GET** /user/login | Logs user into the system +*UserAPI* | [**logoutUser**](docs/UserAPI.md#logoutuser) | **GET** /user/logout | Logs out current logged in user session +*UserAPI* | [**updateUser**](docs/UserAPI.md#updateuser) | **PUT** /user/{username} | Updated user + + +## Documentation For Models + + - [AdditionalPropertiesClass](docs/AdditionalPropertiesClass.md) + - [Animal](docs/Animal.md) + - [AnimalFarm](docs/AnimalFarm.md) + - [ApiResponse](docs/ApiResponse.md) + - [ArrayOfArrayOfNumberOnly](docs/ArrayOfArrayOfNumberOnly.md) + - [ArrayOfNumberOnly](docs/ArrayOfNumberOnly.md) + - [ArrayTest](docs/ArrayTest.md) + - [Capitalization](docs/Capitalization.md) + - [Cat](docs/Cat.md) + - [Category](docs/Category.md) + - [ClassModel](docs/ClassModel.md) + - [Client](docs/Client.md) + - [Dog](docs/Dog.md) + - [EnumArrays](docs/EnumArrays.md) + - [EnumClass](docs/EnumClass.md) + - [EnumTest](docs/EnumTest.md) + - [File](docs/File.md) + - [FileSchemaTestClass](docs/FileSchemaTestClass.md) + - [FormatTest](docs/FormatTest.md) + - [HasOnlyReadOnly](docs/HasOnlyReadOnly.md) + - [List](docs/List.md) + - [MapTest](docs/MapTest.md) + - [MixedPropertiesAndAdditionalPropertiesClass](docs/MixedPropertiesAndAdditionalPropertiesClass.md) + - [Model200Response](docs/Model200Response.md) + - [Name](docs/Name.md) + - [NumberOnly](docs/NumberOnly.md) + - [Order](docs/Order.md) + - [OuterComposite](docs/OuterComposite.md) + - [OuterEnum](docs/OuterEnum.md) + - [Pet](docs/Pet.md) + - [ReadOnlyFirst](docs/ReadOnlyFirst.md) + - [Return](docs/Return.md) + - [SpecialModelName](docs/SpecialModelName.md) + - [StringBooleanMap](docs/StringBooleanMap.md) + - [Tag](docs/Tag.md) + - [TypeHolderDefault](docs/TypeHolderDefault.md) + - [TypeHolderExample](docs/TypeHolderExample.md) + - [User](docs/User.md) + + +## Documentation For Authorization + + +## api_key + +- **Type**: API key +- **API key parameter name**: api_key +- **Location**: HTTP header + +## api_key_query + +- **Type**: API key +- **API key parameter name**: api_key_query +- **Location**: URL query string + +## http_basic_test + +- **Type**: HTTP basic authentication + +## petstore_auth + +- **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 + + +## Author + + + diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/AdditionalPropertiesClass.md b/samples/client/petstore/swift4/unwrapRequired/docs/AdditionalPropertiesClass.md new file mode 100644 index 000000000000..a524730eb652 --- /dev/null +++ b/samples/client/petstore/swift4/unwrapRequired/docs/AdditionalPropertiesClass.md @@ -0,0 +1,11 @@ +# AdditionalPropertiesClass + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**mapString** | **[String:String]** | | [optional] +**mapMapString** | [**[String:[String:String]]**](Dictionary.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) + + diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/Animal.md b/samples/client/petstore/swift4/unwrapRequired/docs/Animal.md new file mode 100644 index 000000000000..69c601455cd8 --- /dev/null +++ b/samples/client/petstore/swift4/unwrapRequired/docs/Animal.md @@ -0,0 +1,11 @@ +# Animal + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**className** | **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) + + diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/AnimalFarm.md b/samples/client/petstore/swift4/unwrapRequired/docs/AnimalFarm.md new file mode 100644 index 000000000000..df6bab21dae8 --- /dev/null +++ b/samples/client/petstore/swift4/unwrapRequired/docs/AnimalFarm.md @@ -0,0 +1,9 @@ +# AnimalFarm + +## Properties +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) + + diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/AnotherFakeAPI.md b/samples/client/petstore/swift4/unwrapRequired/docs/AnotherFakeAPI.md new file mode 100644 index 000000000000..f6fc23dd02b3 --- /dev/null +++ b/samples/client/petstore/swift4/unwrapRequired/docs/AnotherFakeAPI.md @@ -0,0 +1,60 @@ +# AnotherFakeAPI + +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** +```swift + open class func call123testSpecialTags(body: Client, completion: @escaping ((_ data: Client?,_ error: Error?) -> Void)) +``` + +To test special tags + +To test special tags and operation ID starting with number + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = Client("client_example") // Client | client model + +// To test special tags +AnotherFakeAPI.call123testSpecialTags(body: body) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**Client**](Client.md)| client model | + +### Return type + +[**Client**](Client.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/ApiResponse.md b/samples/client/petstore/swift4/unwrapRequired/docs/ApiResponse.md new file mode 100644 index 000000000000..c6d9768fe9bf --- /dev/null +++ b/samples/client/petstore/swift4/unwrapRequired/docs/ApiResponse.md @@ -0,0 +1,12 @@ +# ApiResponse + +## Properties +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) + + diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/ArrayOfArrayOfNumberOnly.md b/samples/client/petstore/swift4/unwrapRequired/docs/ArrayOfArrayOfNumberOnly.md new file mode 100644 index 000000000000..3f78a9584d82 --- /dev/null +++ b/samples/client/petstore/swift4/unwrapRequired/docs/ArrayOfArrayOfNumberOnly.md @@ -0,0 +1,10 @@ +# ArrayOfArrayOfNumberOnly + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**arrayArrayNumber** | [**[[Double]]**](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) + + diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/ArrayOfNumberOnly.md b/samples/client/petstore/swift4/unwrapRequired/docs/ArrayOfNumberOnly.md new file mode 100644 index 000000000000..f09f8fa6f70f --- /dev/null +++ b/samples/client/petstore/swift4/unwrapRequired/docs/ArrayOfNumberOnly.md @@ -0,0 +1,10 @@ +# ArrayOfNumberOnly + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**arrayNumber** | **[Double]** | | [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) + + diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/ArrayTest.md b/samples/client/petstore/swift4/unwrapRequired/docs/ArrayTest.md new file mode 100644 index 000000000000..dd9be9d5876b --- /dev/null +++ b/samples/client/petstore/swift4/unwrapRequired/docs/ArrayTest.md @@ -0,0 +1,12 @@ +# ArrayTest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**arrayOfString** | **[String]** | | [optional] +**arrayArrayOfInteger** | [**[[Int64]]**](Array.md) | | [optional] +**arrayArrayOfModel** | [**[[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) + + diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/Capitalization.md b/samples/client/petstore/swift4/unwrapRequired/docs/Capitalization.md new file mode 100644 index 000000000000..95374216c773 --- /dev/null +++ b/samples/client/petstore/swift4/unwrapRequired/docs/Capitalization.md @@ -0,0 +1,15 @@ +# Capitalization + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**smallCamel** | **String** | | [optional] +**capitalCamel** | **String** | | [optional] +**smallSnake** | **String** | | [optional] +**capitalSnake** | **String** | | [optional] +**sCAETHFlowPoints** | **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) + + diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/Cat.md b/samples/client/petstore/swift4/unwrapRequired/docs/Cat.md new file mode 100644 index 000000000000..fb5949b15761 --- /dev/null +++ b/samples/client/petstore/swift4/unwrapRequired/docs/Cat.md @@ -0,0 +1,10 @@ +# Cat + +## Properties +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) + + diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/Category.md b/samples/client/petstore/swift4/unwrapRequired/docs/Category.md new file mode 100644 index 000000000000..5ca5408c0f96 --- /dev/null +++ b/samples/client/petstore/swift4/unwrapRequired/docs/Category.md @@ -0,0 +1,11 @@ +# Category + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **Int64** | | [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) + + diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/ClassModel.md b/samples/client/petstore/swift4/unwrapRequired/docs/ClassModel.md new file mode 100644 index 000000000000..e3912fdf0fd5 --- /dev/null +++ b/samples/client/petstore/swift4/unwrapRequired/docs/ClassModel.md @@ -0,0 +1,10 @@ +# ClassModel + +## Properties +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) + + diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/Client.md b/samples/client/petstore/swift4/unwrapRequired/docs/Client.md new file mode 100644 index 000000000000..0de1b238c36f --- /dev/null +++ b/samples/client/petstore/swift4/unwrapRequired/docs/Client.md @@ -0,0 +1,10 @@ +# Client + +## Properties +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) + + diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/Dog.md b/samples/client/petstore/swift4/unwrapRequired/docs/Dog.md new file mode 100644 index 000000000000..4824786da049 --- /dev/null +++ b/samples/client/petstore/swift4/unwrapRequired/docs/Dog.md @@ -0,0 +1,10 @@ +# Dog + +## Properties +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) + + diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/EnumArrays.md b/samples/client/petstore/swift4/unwrapRequired/docs/EnumArrays.md new file mode 100644 index 000000000000..b9a9807d3c8e --- /dev/null +++ b/samples/client/petstore/swift4/unwrapRequired/docs/EnumArrays.md @@ -0,0 +1,11 @@ +# EnumArrays + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**justSymbol** | **String** | | [optional] +**arrayEnum** | **[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) + + diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/EnumClass.md b/samples/client/petstore/swift4/unwrapRequired/docs/EnumClass.md new file mode 100644 index 000000000000..67f017becd0c --- /dev/null +++ b/samples/client/petstore/swift4/unwrapRequired/docs/EnumClass.md @@ -0,0 +1,9 @@ +# EnumClass + +## Properties +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) + + diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/EnumTest.md b/samples/client/petstore/swift4/unwrapRequired/docs/EnumTest.md new file mode 100644 index 000000000000..bc9b036dd769 --- /dev/null +++ b/samples/client/petstore/swift4/unwrapRequired/docs/EnumTest.md @@ -0,0 +1,14 @@ +# EnumTest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enumString** | **String** | | [optional] +**enumStringRequired** | **String** | | +**enumInteger** | **Int** | | [optional] +**enumNumber** | **Double** | | [optional] +**outerEnum** | [**OuterEnum**](OuterEnum.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) + + diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/FakeAPI.md b/samples/client/petstore/swift4/unwrapRequired/docs/FakeAPI.md new file mode 100644 index 000000000000..5a6edfb6a6e9 --- /dev/null +++ b/samples/client/petstore/swift4/unwrapRequired/docs/FakeAPI.md @@ -0,0 +1,674 @@ +# FakeAPI + +All URIs are relative to *http://petstore.swagger.io:80/v2* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**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 + + +# **fakeOuterBooleanSerialize** +```swift + open class func fakeOuterBooleanSerialize(body: Bool? = nil, completion: @escaping ((_ data: Bool?,_ error: Error?) -> Void)) +``` + + + +Test serialization of outer boolean types + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = 987 // Bool | Input boolean as post body (optional) + +FakeAPI.fakeOuterBooleanSerialize(body: body) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **Bool**| Input boolean as post body | [optional] + +### Return type + +**Bool** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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 README]](../README.md) + +# **fakeOuterCompositeSerialize** +```swift + open class func fakeOuterCompositeSerialize(body: OuterComposite? = nil, completion: @escaping ((_ data: OuterComposite?,_ error: Error?) -> Void)) +``` + + + +Test serialization of object with outer number type + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = OuterComposite(123, "myString_example", 123) // OuterComposite | Input composite as post body (optional) + +FakeAPI.fakeOuterCompositeSerialize(body: body) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**OuterComposite**](OuterComposite.md)| Input composite as post body | [optional] + +### Return type + +[**OuterComposite**](OuterComposite.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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 README]](../README.md) + +# **fakeOuterNumberSerialize** +```swift + open class func fakeOuterNumberSerialize(body: Double? = nil, completion: @escaping ((_ data: Double?,_ error: Error?) -> Void)) +``` + + + +Test serialization of outer number types + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = 987 // Double | Input number as post body (optional) + +FakeAPI.fakeOuterNumberSerialize(body: body) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **Double**| Input number as post body | [optional] + +### Return type + +**Double** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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 README]](../README.md) + +# **fakeOuterStringSerialize** +```swift + open class func fakeOuterStringSerialize(body: String? = nil, completion: @escaping ((_ data: String?,_ error: Error?) -> Void)) +``` + + + +Test serialization of outer string types + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = "body_example" // String | Input string as post body (optional) + +FakeAPI.fakeOuterStringSerialize(body: body) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **String**| Input string as post body | [optional] + +### Return type + +**String** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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 README]](../README.md) + +# **testBodyWithFileSchema** +```swift + open class func testBodyWithFileSchema(body: FileSchemaTestClass, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) +``` + + + +For this test, the body for this request much reference a schema named `File`. + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = FileSchemaTestClass(File("sourceURI_example"), [File("sourceURI_example")]) // FileSchemaTestClass | + +FakeAPI.testBodyWithFileSchema(body: body) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**FileSchemaTestClass**](FileSchemaTestClass.md)| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + +# **testBodyWithQueryParams** +```swift + open class func testBodyWithQueryParams(query: String, body: User, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) +``` + + + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let query = "query_example" // String | +let body = User(123, "username_example", "firstName_example", "lastName_example", "email_example", "password_example", "phone_example", 123) // User | + +FakeAPI.testBodyWithQueryParams(query: query, body: body) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **String**| | + **body** | [**User**](User.md)| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + +# **testClientModel** +```swift + open class func testClientModel(body: Client, completion: @escaping ((_ data: Client?,_ error: Error?) -> Void)) +``` + +To test \"client\" model + +To test \"client\" model + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = Client("client_example") // Client | client model + +// To test \"client\" model +FakeAPI.testClientModel(body: body) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**Client**](Client.md)| client model | + +### Return type + +[**Client**](Client.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + +# **testEndpointParameters** +```swift + open class func testEndpointParameters(number: Double, double: Double, patternWithoutDelimiter: String, byte: Data, integer: Int? = nil, int32: Int? = nil, int64: Int64? = nil, float: Float? = nil, string: String? = nil, binary: URL? = nil, date: Date? = nil, dateTime: Date? = nil, password: String? = nil, callback: String? = nil, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) +``` + +Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 + +Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let number = 987 // Double | None +let double = 987 // Double | None +let patternWithoutDelimiter = "patternWithoutDelimiter_example" // String | None +let byte = TODO // Data | None +let integer = 987 // Int | None (optional) +let int32 = 987 // Int | None (optional) +let int64 = 987 // Int64 | None (optional) +let float = 987 // Float | None (optional) +let string = "string_example" // String | None (optional) +let binary = "TODO" // URL | None (optional) +let date = TODO // Date | None (optional) +let dateTime = TODO // Date | None (optional) +let password = "password_example" // String | None (optional) +let callback = "callback_example" // String | None (optional) + +// Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 +FakeAPI.testEndpointParameters(number: number, double: double, patternWithoutDelimiter: patternWithoutDelimiter, byte: byte, integer: integer, int32: int32, int64: int64, float: float, string: string, binary: binary, date: date, dateTime: dateTime, password: password, callback: callback) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **number** | **Double**| None | + **double** | **Double**| None | + **patternWithoutDelimiter** | **String**| None | + **byte** | **Data**| None | + **integer** | **Int**| None | [optional] + **int32** | **Int**| None | [optional] + **int64** | **Int64**| None | [optional] + **float** | **Float**| None | [optional] + **string** | **String**| None | [optional] + **binary** | **URL****URL**| None | [optional] + **date** | **Date**| None | [optional] + **dateTime** | **Date**| None | [optional] + **password** | **String**| None | [optional] + **callback** | **String**| None | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[http_basic_test](../README.md#http_basic_test) + +### HTTP request headers + + - **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 README]](../README.md) + +# **testEnumParameters** +```swift + open class func testEnumParameters(enumHeaderStringArray: [String]? = nil, enumHeaderString: EnumHeaderString_testEnumParameters? = nil, enumQueryStringArray: [String]? = nil, enumQueryString: EnumQueryString_testEnumParameters? = nil, enumQueryInteger: EnumQueryInteger_testEnumParameters? = nil, enumQueryDouble: EnumQueryDouble_testEnumParameters? = nil, enumFormStringArray: [String]? = nil, enumFormString: EnumFormString_testEnumParameters? = nil, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) +``` + +To test enum parameters + +To test enum parameters + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let enumHeaderStringArray = ["enumHeaderStringArray_example"] // [String] | Header parameter enum test (string array) (optional) +let enumHeaderString = "enumHeaderString_example" // String | Header parameter enum test (string) (optional) (default to .-efg) +let enumQueryStringArray = ["enumQueryStringArray_example"] // [String] | Query parameter enum test (string array) (optional) +let enumQueryString = "enumQueryString_example" // String | Query parameter enum test (string) (optional) (default to .-efg) +let enumQueryInteger = 987 // Int | Query parameter enum test (double) (optional) +let enumQueryDouble = 987 // Double | Query parameter enum test (double) (optional) +let enumFormStringArray = ["inner_example"] // [String] | Form parameter enum test (string array) (optional) (default to .$) +let enumFormString = "enumFormString_example" // String | Form parameter enum test (string) (optional) (default to .-efg) + +// To test enum parameters +FakeAPI.testEnumParameters(enumHeaderStringArray: enumHeaderStringArray, enumHeaderString: enumHeaderString, enumQueryStringArray: enumQueryStringArray, enumQueryString: enumQueryString, enumQueryInteger: enumQueryInteger, enumQueryDouble: enumQueryDouble, enumFormStringArray: enumFormStringArray, enumFormString: enumFormString) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **enumHeaderStringArray** | [**[String]**](String.md)| Header parameter enum test (string array) | [optional] + **enumHeaderString** | **String**| Header parameter enum test (string) | [optional] [default to .-efg] + **enumQueryStringArray** | [**[String]**](String.md)| Query parameter enum test (string array) | [optional] + **enumQueryString** | **String**| Query parameter enum test (string) | [optional] [default to .-efg] + **enumQueryInteger** | **Int**| Query parameter enum test (double) | [optional] + **enumQueryDouble** | **Double**| Query parameter enum test (double) | [optional] + **enumFormStringArray** | [**[String]**](String.md)| Form parameter enum test (string array) | [optional] [default to .$] + **enumFormString** | **String**| Form parameter enum test (string) | [optional] [default to .-efg] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + +# **testGroupParameters** +```swift + open class func testGroupParameters(requiredStringGroup: Int, requiredBooleanGroup: Bool, requiredInt64Group: Int64, stringGroup: Int? = nil, booleanGroup: Bool? = nil, int64Group: Int64? = nil, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) +``` + +Fake endpoint to test group parameters (optional) + +Fake endpoint to test group parameters (optional) + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let requiredStringGroup = 987 // Int | Required String in group parameters +let requiredBooleanGroup = 987 // Bool | Required Boolean in group parameters +let requiredInt64Group = 987 // Int64 | Required Integer in group parameters +let stringGroup = 987 // Int | String in group parameters (optional) +let booleanGroup = 987 // Bool | Boolean in group parameters (optional) +let int64Group = 987 // Int64 | Integer in group parameters (optional) + +// Fake endpoint to test group parameters (optional) +FakeAPI.testGroupParameters(requiredStringGroup: requiredStringGroup, requiredBooleanGroup: requiredBooleanGroup, requiredInt64Group: requiredInt64Group, stringGroup: stringGroup, booleanGroup: booleanGroup, int64Group: int64Group) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **requiredStringGroup** | **Int**| Required String in group parameters | + **requiredBooleanGroup** | **Bool**| Required Boolean in group parameters | + **requiredInt64Group** | **Int64**| Required Integer in group parameters | + **stringGroup** | **Int**| String in group parameters | [optional] + **booleanGroup** | **Bool**| Boolean in group parameters | [optional] + **int64Group** | **Int64**| Integer in group parameters | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + +# **testInlineAdditionalProperties** +```swift + open class func testInlineAdditionalProperties(param: [String:String], completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) +``` + +test inline additionalProperties + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let param = "TODO" // [String:String] | request body + +// test inline additionalProperties +FakeAPI.testInlineAdditionalProperties(param: param) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **param** | [**[String:String]**](String.md)| request body | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + +# **testJsonFormData** +```swift + open class func testJsonFormData(param: String, param2: String, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) +``` + +test json serialization of form data + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let param = "param_example" // String | field1 +let param2 = "param2_example" // String | field2 + +// test json serialization of form data +FakeAPI.testJsonFormData(param: param, param2: param2) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **param** | **String**| field1 | + **param2** | **String**| field2 | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/FakeClassnameTags123API.md b/samples/client/petstore/swift4/unwrapRequired/docs/FakeClassnameTags123API.md new file mode 100644 index 000000000000..cacc84a1cf89 --- /dev/null +++ b/samples/client/petstore/swift4/unwrapRequired/docs/FakeClassnameTags123API.md @@ -0,0 +1,60 @@ +# FakeClassnameTags123API + +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** +```swift + open class func testClassname(body: Client, completion: @escaping ((_ data: Client?,_ error: Error?) -> Void)) +``` + +To test class name in snake case + +To test class name in snake case + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = Client("client_example") // Client | client model + +// To test class name in snake case +FakeClassnameTags123API.testClassname(body: body) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**Client**](Client.md)| client model | + +### Return type + +[**Client**](Client.md) + +### Authorization + +[api_key_query](../README.md#api_key_query) + +### HTTP request headers + + - **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 README]](../README.md) + diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/File.md b/samples/client/petstore/swift4/unwrapRequired/docs/File.md new file mode 100644 index 000000000000..3edfef17b794 --- /dev/null +++ b/samples/client/petstore/swift4/unwrapRequired/docs/File.md @@ -0,0 +1,10 @@ +# File + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**sourceURI** | **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) + + diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/FileSchemaTestClass.md b/samples/client/petstore/swift4/unwrapRequired/docs/FileSchemaTestClass.md new file mode 100644 index 000000000000..d0a8bbaaba95 --- /dev/null +++ b/samples/client/petstore/swift4/unwrapRequired/docs/FileSchemaTestClass.md @@ -0,0 +1,11 @@ +# FileSchemaTestClass + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**file** | [**File**](File.md) | | [optional] +**files** | [**[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) + + diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/FormatTest.md b/samples/client/petstore/swift4/unwrapRequired/docs/FormatTest.md new file mode 100644 index 000000000000..547eb88754f4 --- /dev/null +++ b/samples/client/petstore/swift4/unwrapRequired/docs/FormatTest.md @@ -0,0 +1,22 @@ +# FormatTest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**integer** | **Int** | | [optional] +**int32** | **Int** | | [optional] +**int64** | **Int64** | | [optional] +**number** | **Double** | | +**float** | **Float** | | [optional] +**double** | **Double** | | [optional] +**string** | **String** | | [optional] +**byte** | [**Data**](Data.md) | | +**binary** | [**URL**](URL.md) | | [optional] +**date** | [**Date**](Date.md) | | +**dateTime** | [**Date**](Date.md) | | [optional] +**uuid** | [**UUID**](UUID.md) | | [optional] +**password** | **String** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/HasOnlyReadOnly.md b/samples/client/petstore/swift4/unwrapRequired/docs/HasOnlyReadOnly.md new file mode 100644 index 000000000000..45781360154c --- /dev/null +++ b/samples/client/petstore/swift4/unwrapRequired/docs/HasOnlyReadOnly.md @@ -0,0 +1,11 @@ +# HasOnlyReadOnly + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**bar** | **String** | | [optional] +**foo** | **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) + + diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/List.md b/samples/client/petstore/swift4/unwrapRequired/docs/List.md new file mode 100644 index 000000000000..b77718302edf --- /dev/null +++ b/samples/client/petstore/swift4/unwrapRequired/docs/List.md @@ -0,0 +1,10 @@ +# List + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**_123list** | **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) + + diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/MapTest.md b/samples/client/petstore/swift4/unwrapRequired/docs/MapTest.md new file mode 100644 index 000000000000..e910bc97518c --- /dev/null +++ b/samples/client/petstore/swift4/unwrapRequired/docs/MapTest.md @@ -0,0 +1,13 @@ +# MapTest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**mapMapOfString** | [**[String:[String:String]]**](Dictionary.md) | | [optional] +**mapOfEnumString** | **[String:String]** | | [optional] +**directMap** | **[String:Bool]** | | [optional] +**indirectMap** | [**StringBooleanMap**](StringBooleanMap.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) + + diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/MixedPropertiesAndAdditionalPropertiesClass.md b/samples/client/petstore/swift4/unwrapRequired/docs/MixedPropertiesAndAdditionalPropertiesClass.md new file mode 100644 index 000000000000..2c502eace42c --- /dev/null +++ b/samples/client/petstore/swift4/unwrapRequired/docs/MixedPropertiesAndAdditionalPropertiesClass.md @@ -0,0 +1,12 @@ +# MixedPropertiesAndAdditionalPropertiesClass + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**uuid** | [**UUID**](UUID.md) | | [optional] +**dateTime** | [**Date**](Date.md) | | [optional] +**map** | [**[String: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) + + diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/Model200Response.md b/samples/client/petstore/swift4/unwrapRequired/docs/Model200Response.md new file mode 100644 index 000000000000..5865ea690cc3 --- /dev/null +++ b/samples/client/petstore/swift4/unwrapRequired/docs/Model200Response.md @@ -0,0 +1,11 @@ +# Model200Response + +## Properties +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) + + diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/Name.md b/samples/client/petstore/swift4/unwrapRequired/docs/Name.md new file mode 100644 index 000000000000..2be75d062e47 --- /dev/null +++ b/samples/client/petstore/swift4/unwrapRequired/docs/Name.md @@ -0,0 +1,13 @@ +# Name + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **Int** | | +**snakeCase** | **Int** | | [optional] +**property** | **String** | | [optional] +**_123number** | **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) + + diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/NumberOnly.md b/samples/client/petstore/swift4/unwrapRequired/docs/NumberOnly.md new file mode 100644 index 000000000000..72bd361168b5 --- /dev/null +++ b/samples/client/petstore/swift4/unwrapRequired/docs/NumberOnly.md @@ -0,0 +1,10 @@ +# NumberOnly + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**justNumber** | **Double** | | [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) + + diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/Order.md b/samples/client/petstore/swift4/unwrapRequired/docs/Order.md new file mode 100644 index 000000000000..9d3205c1526a --- /dev/null +++ b/samples/client/petstore/swift4/unwrapRequired/docs/Order.md @@ -0,0 +1,15 @@ +# Order + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **Int64** | | [optional] +**petId** | **Int64** | | [optional] +**quantity** | **Int** | | [optional] +**shipDate** | [**Date**](Date.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) + + diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/OuterComposite.md b/samples/client/petstore/swift4/unwrapRequired/docs/OuterComposite.md new file mode 100644 index 000000000000..d6b3583bc3ff --- /dev/null +++ b/samples/client/petstore/swift4/unwrapRequired/docs/OuterComposite.md @@ -0,0 +1,12 @@ +# OuterComposite + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**myNumber** | **Double** | | [optional] +**myString** | **String** | | [optional] +**myBoolean** | **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) + + diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/OuterEnum.md b/samples/client/petstore/swift4/unwrapRequired/docs/OuterEnum.md new file mode 100644 index 000000000000..06d413b01680 --- /dev/null +++ b/samples/client/petstore/swift4/unwrapRequired/docs/OuterEnum.md @@ -0,0 +1,9 @@ +# OuterEnum + +## Properties +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) + + diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/Pet.md b/samples/client/petstore/swift4/unwrapRequired/docs/Pet.md new file mode 100644 index 000000000000..c30a5292f537 --- /dev/null +++ b/samples/client/petstore/swift4/unwrapRequired/docs/Pet.md @@ -0,0 +1,15 @@ +# Pet + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **Int64** | | [optional] +**category** | [**Category**](Category.md) | | [optional] +**name** | **String** | | +**photoUrls** | **[String]** | | +**tags** | [**[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) + + diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/PetAPI.md b/samples/client/petstore/swift4/unwrapRequired/docs/PetAPI.md new file mode 100644 index 000000000000..bd2640ed0a8d --- /dev/null +++ b/samples/client/petstore/swift4/unwrapRequired/docs/PetAPI.md @@ -0,0 +1,478 @@ +# PetAPI + +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** +```swift + open class func addPet(body: Pet, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) +``` + +Add a new pet to the store + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = Pet(123, Category(123, "name_example"), "name_example", ["photoUrls_example"], [Tag(123, "name_example")], "status_example") // Pet | Pet object that needs to be added to the store + +// Add a new pet to the store +PetAPI.addPet(body: body) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | + +### Return type + +void (empty response body) + +### Authorization + +[petstore_auth](../README.md#petstore_auth) + +### HTTP request headers + + - **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 README]](../README.md) + +# **deletePet** +```swift + open class func deletePet(petId: Int64, apiKey: String? = nil, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) +``` + +Deletes a pet + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let petId = 987 // Int64 | Pet id to delete +let apiKey = "apiKey_example" // String | (optional) + +// Deletes a pet +PetAPI.deletePet(petId: petId, apiKey: apiKey) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **petId** | **Int64**| Pet id to delete | + **apiKey** | **String**| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[petstore_auth](../README.md#petstore_auth) + +### HTTP request headers + + - **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 README]](../README.md) + +# **findPetsByStatus** +```swift + open class func findPetsByStatus(status: [String], completion: @escaping ((_ data: [Pet]?,_ error: Error?) -> Void)) +``` + +Finds Pets by status + +Multiple status values can be provided with comma separated strings + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let status = ["status_example"] // [String] | Status values that need to be considered for filter + +// Finds Pets by status +PetAPI.findPetsByStatus(status: status) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **status** | [**[String]**](String.md)| Status values that need to be considered for filter | + +### Return type + +[**[Pet]**](Pet.md) + +### Authorization + +[petstore_auth](../README.md#petstore_auth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **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 README]](../README.md) + +# **findPetsByTags** +```swift + open class func findPetsByTags(tags: [String], completion: @escaping ((_ data: [Pet]?,_ error: Error?) -> Void)) +``` + +Finds Pets by tags + +Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let tags = ["inner_example"] // [String] | Tags to filter by + +// Finds Pets by tags +PetAPI.findPetsByTags(tags: tags) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **tags** | [**[String]**](String.md)| Tags to filter by | + +### Return type + +[**[Pet]**](Pet.md) + +### Authorization + +[petstore_auth](../README.md#petstore_auth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **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 README]](../README.md) + +# **getPetById** +```swift + open class func getPetById(petId: Int64, completion: @escaping ((_ data: Pet?,_ error: Error?) -> Void)) +``` + +Find pet by ID + +Returns a single pet + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let petId = 987 // Int64 | ID of pet to return + +// Find pet by ID +PetAPI.getPetById(petId: petId) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **petId** | **Int64**| ID of pet to return | + +### Return type + +[**Pet**](Pet.md) + +### Authorization + +[api_key](../README.md#api_key) + +### HTTP request headers + + - **Content-Type**: Not defined + - **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 README]](../README.md) + +# **updatePet** +```swift + open class func updatePet(body: Pet, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) +``` + +Update an existing pet + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = Pet(123, Category(123, "name_example"), "name_example", ["photoUrls_example"], [Tag(123, "name_example")], "status_example") // Pet | Pet object that needs to be added to the store + +// Update an existing pet +PetAPI.updatePet(body: body) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | + +### Return type + +void (empty response body) + +### Authorization + +[petstore_auth](../README.md#petstore_auth) + +### HTTP request headers + + - **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 README]](../README.md) + +# **updatePetWithForm** +```swift + open class func updatePetWithForm(petId: Int64, name: String? = nil, status: String? = nil, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) +``` + +Updates a pet in the store with form data + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let petId = 987 // Int64 | ID of pet that needs to be updated +let name = "name_example" // String | Updated name of the pet (optional) +let status = "status_example" // String | Updated status of the pet (optional) + +// Updates a pet in the store with form data +PetAPI.updatePetWithForm(petId: petId, name: name, status: status) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **petId** | **Int64**| ID of pet that needs to be updated | + **name** | **String**| Updated name of the pet | [optional] + **status** | **String**| Updated status of the pet | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[petstore_auth](../README.md#petstore_auth) + +### HTTP request headers + + - **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 README]](../README.md) + +# **uploadFile** +```swift + open class func uploadFile(petId: Int64, additionalMetadata: String? = nil, file: URL? = nil, completion: @escaping ((_ data: ApiResponse?,_ error: Error?) -> Void)) +``` + +uploads an image + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let petId = 987 // Int64 | ID of pet to update +let additionalMetadata = "additionalMetadata_example" // String | Additional data to pass to server (optional) +let file = "TODO" // URL | file to upload (optional) + +// uploads an image +PetAPI.uploadFile(petId: petId, additionalMetadata: additionalMetadata, file: file) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **petId** | **Int64**| ID of pet to update | + **additionalMetadata** | **String**| Additional data to pass to server | [optional] + **file** | **URL****URL**| file to upload | [optional] + +### Return type + +[**ApiResponse**](ApiResponse.md) + +### Authorization + +[petstore_auth](../README.md#petstore_auth) + +### HTTP request headers + + - **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 README]](../README.md) + +# **uploadFileWithRequiredFile** +```swift + open class func uploadFileWithRequiredFile(petId: Int64, requiredFile: URL, additionalMetadata: String? = nil, completion: @escaping ((_ data: ApiResponse?,_ error: Error?) -> Void)) +``` + +uploads an image (required) + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let petId = 987 // Int64 | ID of pet to update +let requiredFile = "TODO" // URL | file to upload +let additionalMetadata = "additionalMetadata_example" // String | Additional data to pass to server (optional) + +// uploads an image (required) +PetAPI.uploadFileWithRequiredFile(petId: petId, requiredFile: requiredFile, additionalMetadata: additionalMetadata) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **petId** | **Int64**| ID of pet to update | + **requiredFile** | **URL****URL**| file to upload | + **additionalMetadata** | **String**| Additional data to pass to server | [optional] + +### Return type + +[**ApiResponse**](ApiResponse.md) + +### Authorization + +[petstore_auth](../README.md#petstore_auth) + +### HTTP request headers + + - **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 README]](../README.md) + diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/ReadOnlyFirst.md b/samples/client/petstore/swift4/unwrapRequired/docs/ReadOnlyFirst.md new file mode 100644 index 000000000000..e3f16038b970 --- /dev/null +++ b/samples/client/petstore/swift4/unwrapRequired/docs/ReadOnlyFirst.md @@ -0,0 +1,11 @@ +# ReadOnlyFirst + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**bar** | **String** | | [optional] +**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) + + diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/Return.md b/samples/client/petstore/swift4/unwrapRequired/docs/Return.md new file mode 100644 index 000000000000..66d17c27c887 --- /dev/null +++ b/samples/client/petstore/swift4/unwrapRequired/docs/Return.md @@ -0,0 +1,10 @@ +# Return + +## Properties +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) + + diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/SpecialModelName.md b/samples/client/petstore/swift4/unwrapRequired/docs/SpecialModelName.md new file mode 100644 index 000000000000..3ec27a38c2ac --- /dev/null +++ b/samples/client/petstore/swift4/unwrapRequired/docs/SpecialModelName.md @@ -0,0 +1,10 @@ +# SpecialModelName + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**specialPropertyName** | **Int64** | | [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) + + diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/StoreAPI.md b/samples/client/petstore/swift4/unwrapRequired/docs/StoreAPI.md new file mode 100644 index 000000000000..45210030fae1 --- /dev/null +++ b/samples/client/petstore/swift4/unwrapRequired/docs/StoreAPI.md @@ -0,0 +1,210 @@ +# StoreAPI + +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** +```swift + open class func deleteOrder(orderId: String, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) +``` + +Delete purchase order by ID + +For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let orderId = "orderId_example" // String | ID of the order that needs to be deleted + +// Delete purchase order by ID +StoreAPI.deleteOrder(orderId: orderId) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **orderId** | **String**| ID of the order that needs to be deleted | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + +# **getInventory** +```swift + open class func getInventory(completion: @escaping ((_ data: [String:Int]?,_ error: Error?) -> Void)) +``` + +Returns pet inventories by status + +Returns a map of status codes to quantities + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + + +// Returns pet inventories by status +StoreAPI.getInventory() { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**[String:Int]** + +### Authorization + +[api_key](../README.md#api_key) + +### HTTP request headers + + - **Content-Type**: Not defined + - **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 README]](../README.md) + +# **getOrderById** +```swift + open class func getOrderById(orderId: Int64, completion: @escaping ((_ data: Order?,_ error: Error?) -> Void)) +``` + +Find purchase order by ID + +For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let orderId = 987 // Int64 | ID of pet that needs to be fetched + +// Find purchase order by ID +StoreAPI.getOrderById(orderId: orderId) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **orderId** | **Int64**| ID of pet that needs to be fetched | + +### Return type + +[**Order**](Order.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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 README]](../README.md) + +# **placeOrder** +```swift + open class func placeOrder(body: Order, completion: @escaping ((_ data: Order?,_ error: Error?) -> Void)) +``` + +Place an order for a pet + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = Order(123, 123, 123, "TODO", "status_example", 123) // Order | order placed for purchasing the pet + +// Place an order for a pet +StoreAPI.placeOrder(body: body) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**Order**](Order.md)| order placed for purchasing the pet | + +### Return type + +[**Order**](Order.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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 README]](../README.md) + diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/StringBooleanMap.md b/samples/client/petstore/swift4/unwrapRequired/docs/StringBooleanMap.md new file mode 100644 index 000000000000..7abf11ec68b1 --- /dev/null +++ b/samples/client/petstore/swift4/unwrapRequired/docs/StringBooleanMap.md @@ -0,0 +1,9 @@ +# StringBooleanMap + +## Properties +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) + + diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/Tag.md b/samples/client/petstore/swift4/unwrapRequired/docs/Tag.md new file mode 100644 index 000000000000..ff4ac8aa4519 --- /dev/null +++ b/samples/client/petstore/swift4/unwrapRequired/docs/Tag.md @@ -0,0 +1,11 @@ +# Tag + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **Int64** | | [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) + + diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/TypeHolderDefault.md b/samples/client/petstore/swift4/unwrapRequired/docs/TypeHolderDefault.md new file mode 100644 index 000000000000..5161394bdc3e --- /dev/null +++ b/samples/client/petstore/swift4/unwrapRequired/docs/TypeHolderDefault.md @@ -0,0 +1,14 @@ +# TypeHolderDefault + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**stringItem** | **String** | | [default to "what"] +**numberItem** | **Double** | | +**integerItem** | **Int** | | +**boolItem** | **Bool** | | [default to true] +**arrayItem** | **[Int]** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/TypeHolderExample.md b/samples/client/petstore/swift4/unwrapRequired/docs/TypeHolderExample.md new file mode 100644 index 000000000000..46d0471cd71a --- /dev/null +++ b/samples/client/petstore/swift4/unwrapRequired/docs/TypeHolderExample.md @@ -0,0 +1,14 @@ +# TypeHolderExample + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**stringItem** | **String** | | +**numberItem** | **Double** | | +**integerItem** | **Int** | | +**boolItem** | **Bool** | | +**arrayItem** | **[Int]** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/User.md b/samples/client/petstore/swift4/unwrapRequired/docs/User.md new file mode 100644 index 000000000000..5a439de0ff95 --- /dev/null +++ b/samples/client/petstore/swift4/unwrapRequired/docs/User.md @@ -0,0 +1,17 @@ +# User + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **Int64** | | [optional] +**username** | **String** | | [optional] +**firstName** | **String** | | [optional] +**lastName** | **String** | | [optional] +**email** | **String** | | [optional] +**password** | **String** | | [optional] +**phone** | **String** | | [optional] +**userStatus** | **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) + + diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/UserAPI.md b/samples/client/petstore/swift4/unwrapRequired/docs/UserAPI.md new file mode 100644 index 000000000000..b22538654d8a --- /dev/null +++ b/samples/client/petstore/swift4/unwrapRequired/docs/UserAPI.md @@ -0,0 +1,414 @@ +# UserAPI + +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** +```swift + open class func createUser(body: User, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) +``` + +Create user + +This can only be done by the logged in user. + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = User(123, "username_example", "firstName_example", "lastName_example", "email_example", "password_example", "phone_example", 123) // User | Created user object + +// Create user +UserAPI.createUser(body: body) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**User**](User.md)| Created user object | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + +# **createUsersWithArrayInput** +```swift + open class func createUsersWithArrayInput(body: [User], completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) +``` + +Creates list of users with given input array + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = [User(123, "username_example", "firstName_example", "lastName_example", "email_example", "password_example", "phone_example", 123)] // [User] | List of user object + +// Creates list of users with given input array +UserAPI.createUsersWithArrayInput(body: body) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**[User]**](Array.md)| List of user object | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + +# **createUsersWithListInput** +```swift + open class func createUsersWithListInput(body: [User], completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) +``` + +Creates list of users with given input array + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let body = [User(123, "username_example", "firstName_example", "lastName_example", "email_example", "password_example", "phone_example", 123)] // [User] | List of user object + +// Creates list of users with given input array +UserAPI.createUsersWithListInput(body: body) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**[User]**](Array.md)| List of user object | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + +# **deleteUser** +```swift + open class func deleteUser(username: String, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) +``` + +Delete user + +This can only be done by the logged in user. + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let username = "username_example" // String | The name that needs to be deleted + +// Delete user +UserAPI.deleteUser(username: username) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **username** | **String**| The name that needs to be deleted | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + +# **getUserByName** +```swift + open class func getUserByName(username: String, completion: @escaping ((_ data: User?,_ error: Error?) -> Void)) +``` + +Get user by user name + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let username = "username_example" // String | The name that needs to be fetched. Use user1 for testing. + +// Get user by user name +UserAPI.getUserByName(username: username) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **username** | **String**| The name that needs to be fetched. Use user1 for testing. | + +### Return type + +[**User**](User.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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 README]](../README.md) + +# **loginUser** +```swift + open class func loginUser(username: String, password: String, completion: @escaping ((_ data: String?,_ error: Error?) -> Void)) +``` + +Logs user into the system + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let username = "username_example" // String | The user name for login +let password = "password_example" // String | The password for login in clear text + +// Logs user into the system +UserAPI.loginUser(username: username, password: password) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **username** | **String**| The user name for login | + **password** | **String**| The password for login in clear text | + +### Return type + +**String** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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 README]](../README.md) + +# **logoutUser** +```swift + open class func logoutUser(completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) +``` + +Logs out current logged in user session + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + + +// Logs out current logged in user session +UserAPI.logoutUser() { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + +# **updateUser** +```swift + open class func updateUser(username: String, body: User, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) +``` + +Updated user + +This can only be done by the logged in user. + +### Example +```swift +// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +import PetstoreClient + +let username = "username_example" // String | name that need to be deleted +let body = User(123, "username_example", "firstName_example", "lastName_example", "email_example", "password_example", "phone_example", 123) // User | Updated user object + +// Updated user +UserAPI.updateUser(username: username, body: body) { (response, error) in + guard error == nil else { + print(error) + return + } + + if (response) { + dump(response) + } +} +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **username** | **String**| name that need to be deleted | + **body** | [**User**](User.md)| Updated user object | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **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 README]](../README.md) + From 906bdb6aacc4acb73072a50af83ba61b8360d8ff Mon Sep 17 00:00:00 2001 From: William Cheng Date: Mon, 15 Apr 2019 22:18:54 +0800 Subject: [PATCH 2/9] fix rxswift sample code --- .../src/main/resources/swift4/api_doc.mustache | 2 +- .../petstore/swift4/default/docs/AnotherFakeAPI.md | 1 - .../client/petstore/swift4/default/docs/FakeAPI.md | 12 ------------ .../swift4/default/docs/FakeClassnameTags123API.md | 1 - .../client/petstore/swift4/default/docs/PetAPI.md | 9 --------- .../client/petstore/swift4/default/docs/StoreAPI.md | 4 ---- .../client/petstore/swift4/default/docs/UserAPI.md | 8 -------- .../swift4/objcCompatible/docs/AnotherFakeAPI.md | 1 - .../petstore/swift4/objcCompatible/docs/FakeAPI.md | 13 ------------- .../objcCompatible/docs/FakeClassnameTags123API.md | 1 - .../petstore/swift4/objcCompatible/docs/PetAPI.md | 9 --------- .../petstore/swift4/objcCompatible/docs/StoreAPI.md | 4 ---- .../petstore/swift4/objcCompatible/docs/UserAPI.md | 8 -------- .../swift4/promisekit/docs/AnotherFakeAPI.md | 1 - .../petstore/swift4/promisekit/docs/FakeAPI.md | 12 ------------ .../promisekit/docs/FakeClassnameTags123API.md | 1 - .../petstore/swift4/promisekit/docs/PetAPI.md | 9 --------- .../petstore/swift4/promisekit/docs/StoreAPI.md | 4 ---- .../petstore/swift4/promisekit/docs/UserAPI.md | 8 -------- .../petstore/swift4/rxswift/docs/AnotherFakeAPI.md | 1 + .../client/petstore/swift4/rxswift/docs/FakeAPI.md | 12 ++++++++++++ .../swift4/rxswift/docs/FakeClassnameTags123API.md | 1 + .../client/petstore/swift4/rxswift/docs/PetAPI.md | 9 +++++++++ .../client/petstore/swift4/rxswift/docs/StoreAPI.md | 4 ++++ .../client/petstore/swift4/rxswift/docs/UserAPI.md | 8 ++++++++ .../swift4/unwrapRequired/docs/AnotherFakeAPI.md | 1 - .../petstore/swift4/unwrapRequired/docs/FakeAPI.md | 12 ------------ .../unwrapRequired/docs/FakeClassnameTags123API.md | 1 - .../petstore/swift4/unwrapRequired/docs/PetAPI.md | 9 --------- .../petstore/swift4/unwrapRequired/docs/StoreAPI.md | 4 ---- .../petstore/swift4/unwrapRequired/docs/UserAPI.md | 8 -------- 31 files changed, 36 insertions(+), 142 deletions(-) diff --git a/modules/openapi-generator/src/main/resources/swift4/api_doc.mustache b/modules/openapi-generator/src/main/resources/swift4/api_doc.mustache index 2a0092db9d32..748c3e63b450 100644 --- a/modules/openapi-generator/src/main/resources/swift4/api_doc.mustache +++ b/modules/openapi-generator/src/main/resources/swift4/api_doc.mustache @@ -63,7 +63,7 @@ import {{{projectName}}} } } {{/usePromiseKit}} -{{^useRxSwift}} +{{#useRxSwift}} // TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new {{/useRxSwift}} ``` diff --git a/samples/client/petstore/swift4/default/docs/AnotherFakeAPI.md b/samples/client/petstore/swift4/default/docs/AnotherFakeAPI.md index f6fc23dd02b3..3afdcfe0e38b 100644 --- a/samples/client/petstore/swift4/default/docs/AnotherFakeAPI.md +++ b/samples/client/petstore/swift4/default/docs/AnotherFakeAPI.md @@ -34,7 +34,6 @@ AnotherFakeAPI.call123testSpecialTags(body: body) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters diff --git a/samples/client/petstore/swift4/default/docs/FakeAPI.md b/samples/client/petstore/swift4/default/docs/FakeAPI.md index 5a6edfb6a6e9..6931e9c43fe5 100644 --- a/samples/client/petstore/swift4/default/docs/FakeAPI.md +++ b/samples/client/petstore/swift4/default/docs/FakeAPI.md @@ -44,7 +44,6 @@ FakeAPI.fakeOuterBooleanSerialize(body: body) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -94,7 +93,6 @@ FakeAPI.fakeOuterCompositeSerialize(body: body) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -144,7 +142,6 @@ FakeAPI.fakeOuterNumberSerialize(body: body) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -194,7 +191,6 @@ FakeAPI.fakeOuterStringSerialize(body: body) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -244,7 +240,6 @@ FakeAPI.testBodyWithFileSchema(body: body) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -293,7 +288,6 @@ FakeAPI.testBodyWithQueryParams(query: query, body: body) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -345,7 +339,6 @@ FakeAPI.testClientModel(body: body) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -409,7 +402,6 @@ FakeAPI.testEndpointParameters(number: number, double: double, patternWithoutDel dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -480,7 +472,6 @@ FakeAPI.testEnumParameters(enumHeaderStringArray: enumHeaderStringArray, enumHea dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -543,7 +534,6 @@ FakeAPI.testGroupParameters(requiredStringGroup: requiredStringGroup, requiredBo dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -597,7 +587,6 @@ FakeAPI.testInlineAdditionalProperties(param: param) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -647,7 +636,6 @@ FakeAPI.testJsonFormData(param: param, param2: param2) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters diff --git a/samples/client/petstore/swift4/default/docs/FakeClassnameTags123API.md b/samples/client/petstore/swift4/default/docs/FakeClassnameTags123API.md index cacc84a1cf89..aa989675233a 100644 --- a/samples/client/petstore/swift4/default/docs/FakeClassnameTags123API.md +++ b/samples/client/petstore/swift4/default/docs/FakeClassnameTags123API.md @@ -34,7 +34,6 @@ FakeClassnameTags123API.testClassname(body: body) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters diff --git a/samples/client/petstore/swift4/default/docs/PetAPI.md b/samples/client/petstore/swift4/default/docs/PetAPI.md index bd2640ed0a8d..09ac95e5823a 100644 --- a/samples/client/petstore/swift4/default/docs/PetAPI.md +++ b/samples/client/petstore/swift4/default/docs/PetAPI.md @@ -40,7 +40,6 @@ PetAPI.addPet(body: body) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -90,7 +89,6 @@ PetAPI.deletePet(petId: petId, apiKey: apiKey) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -142,7 +140,6 @@ PetAPI.findPetsByStatus(status: status) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -193,7 +190,6 @@ PetAPI.findPetsByTags(tags: tags) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -244,7 +240,6 @@ PetAPI.getPetById(petId: petId) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -293,7 +288,6 @@ PetAPI.updatePet(body: body) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -344,7 +338,6 @@ PetAPI.updatePetWithForm(petId: petId, name: name, status: status) { (response, dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -397,7 +390,6 @@ PetAPI.uploadFile(petId: petId, additionalMetadata: additionalMetadata, file: fi dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -450,7 +442,6 @@ PetAPI.uploadFileWithRequiredFile(petId: petId, requiredFile: requiredFile, addi dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters diff --git a/samples/client/petstore/swift4/default/docs/StoreAPI.md b/samples/client/petstore/swift4/default/docs/StoreAPI.md index 45210030fae1..6ee50196a32b 100644 --- a/samples/client/petstore/swift4/default/docs/StoreAPI.md +++ b/samples/client/petstore/swift4/default/docs/StoreAPI.md @@ -37,7 +37,6 @@ StoreAPI.deleteOrder(orderId: orderId) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -87,7 +86,6 @@ StoreAPI.getInventory() { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -135,7 +133,6 @@ StoreAPI.getOrderById(orderId: orderId) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -184,7 +181,6 @@ StoreAPI.placeOrder(body: body) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters diff --git a/samples/client/petstore/swift4/default/docs/UserAPI.md b/samples/client/petstore/swift4/default/docs/UserAPI.md index b22538654d8a..4cf669fc2d82 100644 --- a/samples/client/petstore/swift4/default/docs/UserAPI.md +++ b/samples/client/petstore/swift4/default/docs/UserAPI.md @@ -41,7 +41,6 @@ UserAPI.createUser(body: body) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -90,7 +89,6 @@ UserAPI.createUsersWithArrayInput(body: body) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -139,7 +137,6 @@ UserAPI.createUsersWithListInput(body: body) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -190,7 +187,6 @@ UserAPI.deleteUser(username: username) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -239,7 +235,6 @@ UserAPI.getUserByName(username: username) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -289,7 +284,6 @@ UserAPI.loginUser(username: username, password: password) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -338,7 +332,6 @@ UserAPI.logoutUser() { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -387,7 +380,6 @@ UserAPI.updateUser(username: username, body: body) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters diff --git a/samples/client/petstore/swift4/objcCompatible/docs/AnotherFakeAPI.md b/samples/client/petstore/swift4/objcCompatible/docs/AnotherFakeAPI.md index f6fc23dd02b3..3afdcfe0e38b 100644 --- a/samples/client/petstore/swift4/objcCompatible/docs/AnotherFakeAPI.md +++ b/samples/client/petstore/swift4/objcCompatible/docs/AnotherFakeAPI.md @@ -34,7 +34,6 @@ AnotherFakeAPI.call123testSpecialTags(body: body) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters diff --git a/samples/client/petstore/swift4/objcCompatible/docs/FakeAPI.md b/samples/client/petstore/swift4/objcCompatible/docs/FakeAPI.md index d89f9f44b0b5..f3eeeaa7aa53 100644 --- a/samples/client/petstore/swift4/objcCompatible/docs/FakeAPI.md +++ b/samples/client/petstore/swift4/objcCompatible/docs/FakeAPI.md @@ -46,7 +46,6 @@ FakeAPI.createXmlItem(xmlItem: xmlItem) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -96,7 +95,6 @@ FakeAPI.fakeOuterBooleanSerialize(body: body) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -146,7 +144,6 @@ FakeAPI.fakeOuterCompositeSerialize(body: body) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -196,7 +193,6 @@ FakeAPI.fakeOuterNumberSerialize(body: body) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -246,7 +242,6 @@ FakeAPI.fakeOuterStringSerialize(body: body) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -296,7 +291,6 @@ FakeAPI.testBodyWithFileSchema(body: body) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -345,7 +339,6 @@ FakeAPI.testBodyWithQueryParams(query: query, body: body) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -397,7 +390,6 @@ FakeAPI.testClientModel(body: body) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -461,7 +453,6 @@ FakeAPI.testEndpointParameters(number: number, double: double, patternWithoutDel dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -532,7 +523,6 @@ FakeAPI.testEnumParameters(enumHeaderStringArray: enumHeaderStringArray, enumHea dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -595,7 +585,6 @@ FakeAPI.testGroupParameters(requiredStringGroup: requiredStringGroup, requiredBo dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -649,7 +638,6 @@ FakeAPI.testInlineAdditionalProperties(param: param) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -699,7 +687,6 @@ FakeAPI.testJsonFormData(param: param, param2: param2) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters diff --git a/samples/client/petstore/swift4/objcCompatible/docs/FakeClassnameTags123API.md b/samples/client/petstore/swift4/objcCompatible/docs/FakeClassnameTags123API.md index cacc84a1cf89..aa989675233a 100644 --- a/samples/client/petstore/swift4/objcCompatible/docs/FakeClassnameTags123API.md +++ b/samples/client/petstore/swift4/objcCompatible/docs/FakeClassnameTags123API.md @@ -34,7 +34,6 @@ FakeClassnameTags123API.testClassname(body: body) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters diff --git a/samples/client/petstore/swift4/objcCompatible/docs/PetAPI.md b/samples/client/petstore/swift4/objcCompatible/docs/PetAPI.md index bd2640ed0a8d..09ac95e5823a 100644 --- a/samples/client/petstore/swift4/objcCompatible/docs/PetAPI.md +++ b/samples/client/petstore/swift4/objcCompatible/docs/PetAPI.md @@ -40,7 +40,6 @@ PetAPI.addPet(body: body) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -90,7 +89,6 @@ PetAPI.deletePet(petId: petId, apiKey: apiKey) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -142,7 +140,6 @@ PetAPI.findPetsByStatus(status: status) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -193,7 +190,6 @@ PetAPI.findPetsByTags(tags: tags) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -244,7 +240,6 @@ PetAPI.getPetById(petId: petId) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -293,7 +288,6 @@ PetAPI.updatePet(body: body) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -344,7 +338,6 @@ PetAPI.updatePetWithForm(petId: petId, name: name, status: status) { (response, dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -397,7 +390,6 @@ PetAPI.uploadFile(petId: petId, additionalMetadata: additionalMetadata, file: fi dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -450,7 +442,6 @@ PetAPI.uploadFileWithRequiredFile(petId: petId, requiredFile: requiredFile, addi dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters diff --git a/samples/client/petstore/swift4/objcCompatible/docs/StoreAPI.md b/samples/client/petstore/swift4/objcCompatible/docs/StoreAPI.md index 45210030fae1..6ee50196a32b 100644 --- a/samples/client/petstore/swift4/objcCompatible/docs/StoreAPI.md +++ b/samples/client/petstore/swift4/objcCompatible/docs/StoreAPI.md @@ -37,7 +37,6 @@ StoreAPI.deleteOrder(orderId: orderId) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -87,7 +86,6 @@ StoreAPI.getInventory() { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -135,7 +133,6 @@ StoreAPI.getOrderById(orderId: orderId) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -184,7 +181,6 @@ StoreAPI.placeOrder(body: body) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters diff --git a/samples/client/petstore/swift4/objcCompatible/docs/UserAPI.md b/samples/client/petstore/swift4/objcCompatible/docs/UserAPI.md index b22538654d8a..4cf669fc2d82 100644 --- a/samples/client/petstore/swift4/objcCompatible/docs/UserAPI.md +++ b/samples/client/petstore/swift4/objcCompatible/docs/UserAPI.md @@ -41,7 +41,6 @@ UserAPI.createUser(body: body) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -90,7 +89,6 @@ UserAPI.createUsersWithArrayInput(body: body) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -139,7 +137,6 @@ UserAPI.createUsersWithListInput(body: body) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -190,7 +187,6 @@ UserAPI.deleteUser(username: username) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -239,7 +235,6 @@ UserAPI.getUserByName(username: username) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -289,7 +284,6 @@ UserAPI.loginUser(username: username, password: password) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -338,7 +332,6 @@ UserAPI.logoutUser() { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -387,7 +380,6 @@ UserAPI.updateUser(username: username, body: body) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters diff --git a/samples/client/petstore/swift4/promisekit/docs/AnotherFakeAPI.md b/samples/client/petstore/swift4/promisekit/docs/AnotherFakeAPI.md index 85f6da956681..199d571dcc13 100644 --- a/samples/client/petstore/swift4/promisekit/docs/AnotherFakeAPI.md +++ b/samples/client/petstore/swift4/promisekit/docs/AnotherFakeAPI.md @@ -32,7 +32,6 @@ AnotherFakeAPI.call123testSpecialTags(body: body).then { // when the promise is rejected } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters diff --git a/samples/client/petstore/swift4/promisekit/docs/FakeAPI.md b/samples/client/petstore/swift4/promisekit/docs/FakeAPI.md index c46d8b679f0e..9e0eaef2b568 100644 --- a/samples/client/petstore/swift4/promisekit/docs/FakeAPI.md +++ b/samples/client/petstore/swift4/promisekit/docs/FakeAPI.md @@ -42,7 +42,6 @@ FakeAPI.fakeOuterBooleanSerialize(body: body).then { // when the promise is rejected } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -90,7 +89,6 @@ FakeAPI.fakeOuterCompositeSerialize(body: body).then { // when the promise is rejected } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -138,7 +136,6 @@ FakeAPI.fakeOuterNumberSerialize(body: body).then { // when the promise is rejected } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -186,7 +183,6 @@ FakeAPI.fakeOuterStringSerialize(body: body).then { // when the promise is rejected } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -234,7 +230,6 @@ FakeAPI.testBodyWithFileSchema(body: body).then { // when the promise is rejected } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -281,7 +276,6 @@ FakeAPI.testBodyWithQueryParams(query: query, body: body).then { // when the promise is rejected } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -331,7 +325,6 @@ FakeAPI.testClientModel(body: body).then { // when the promise is rejected } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -393,7 +386,6 @@ FakeAPI.testEndpointParameters(number: number, double: double, patternWithoutDel // when the promise is rejected } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -462,7 +454,6 @@ FakeAPI.testEnumParameters(enumHeaderStringArray: enumHeaderStringArray, enumHea // when the promise is rejected } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -523,7 +514,6 @@ FakeAPI.testGroupParameters(requiredStringGroup: requiredStringGroup, requiredBo // when the promise is rejected } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -575,7 +565,6 @@ FakeAPI.testInlineAdditionalProperties(param: param).then { // when the promise is rejected } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -623,7 +612,6 @@ FakeAPI.testJsonFormData(param: param, param2: param2).then { // when the promise is rejected } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters diff --git a/samples/client/petstore/swift4/promisekit/docs/FakeClassnameTags123API.md b/samples/client/petstore/swift4/promisekit/docs/FakeClassnameTags123API.md index e778f7d7368b..684309d2f56b 100644 --- a/samples/client/petstore/swift4/promisekit/docs/FakeClassnameTags123API.md +++ b/samples/client/petstore/swift4/promisekit/docs/FakeClassnameTags123API.md @@ -32,7 +32,6 @@ FakeClassnameTags123API.testClassname(body: body).then { // when the promise is rejected } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters diff --git a/samples/client/petstore/swift4/promisekit/docs/PetAPI.md b/samples/client/petstore/swift4/promisekit/docs/PetAPI.md index b5a7e2ac51d9..5f05b4bad446 100644 --- a/samples/client/petstore/swift4/promisekit/docs/PetAPI.md +++ b/samples/client/petstore/swift4/promisekit/docs/PetAPI.md @@ -38,7 +38,6 @@ PetAPI.addPet(body: body).then { // when the promise is rejected } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -86,7 +85,6 @@ PetAPI.deletePet(petId: petId, apiKey: apiKey).then { // when the promise is rejected } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -136,7 +134,6 @@ PetAPI.findPetsByStatus(status: status).then { // when the promise is rejected } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -185,7 +182,6 @@ PetAPI.findPetsByTags(tags: tags).then { // when the promise is rejected } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -234,7 +230,6 @@ PetAPI.getPetById(petId: petId).then { // when the promise is rejected } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -281,7 +276,6 @@ PetAPI.updatePet(body: body).then { // when the promise is rejected } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -330,7 +324,6 @@ PetAPI.updatePetWithForm(petId: petId, name: name, status: status).then { // when the promise is rejected } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -381,7 +374,6 @@ PetAPI.uploadFile(petId: petId, additionalMetadata: additionalMetadata, file: fi // when the promise is rejected } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -432,7 +424,6 @@ PetAPI.uploadFileWithRequiredFile(petId: petId, requiredFile: requiredFile, addi // when the promise is rejected } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters diff --git a/samples/client/petstore/swift4/promisekit/docs/StoreAPI.md b/samples/client/petstore/swift4/promisekit/docs/StoreAPI.md index 41e4a0f23c39..df5479f37114 100644 --- a/samples/client/petstore/swift4/promisekit/docs/StoreAPI.md +++ b/samples/client/petstore/swift4/promisekit/docs/StoreAPI.md @@ -35,7 +35,6 @@ StoreAPI.deleteOrder(orderId: orderId).then { // when the promise is rejected } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -83,7 +82,6 @@ StoreAPI.getInventory().then { // when the promise is rejected } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -129,7 +127,6 @@ StoreAPI.getOrderById(orderId: orderId).then { // when the promise is rejected } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -176,7 +173,6 @@ StoreAPI.placeOrder(body: body).then { // when the promise is rejected } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters diff --git a/samples/client/petstore/swift4/promisekit/docs/UserAPI.md b/samples/client/petstore/swift4/promisekit/docs/UserAPI.md index d2a5b698cfeb..50f1461dfac1 100644 --- a/samples/client/petstore/swift4/promisekit/docs/UserAPI.md +++ b/samples/client/petstore/swift4/promisekit/docs/UserAPI.md @@ -39,7 +39,6 @@ UserAPI.createUser(body: body).then { // when the promise is rejected } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -86,7 +85,6 @@ UserAPI.createUsersWithArrayInput(body: body).then { // when the promise is rejected } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -133,7 +131,6 @@ UserAPI.createUsersWithListInput(body: body).then { // when the promise is rejected } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -182,7 +179,6 @@ UserAPI.deleteUser(username: username).then { // when the promise is rejected } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -229,7 +225,6 @@ UserAPI.getUserByName(username: username).then { // when the promise is rejected } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -277,7 +272,6 @@ UserAPI.loginUser(username: username, password: password).then { // when the promise is rejected } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -324,7 +318,6 @@ UserAPI.logoutUser().then { // when the promise is rejected } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -371,7 +364,6 @@ UserAPI.updateUser(username: username, body: body).then { // when the promise is rejected } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters diff --git a/samples/client/petstore/swift4/rxswift/docs/AnotherFakeAPI.md b/samples/client/petstore/swift4/rxswift/docs/AnotherFakeAPI.md index 9f9e94d1c1f2..5a360571fccc 100644 --- a/samples/client/petstore/swift4/rxswift/docs/AnotherFakeAPI.md +++ b/samples/client/petstore/swift4/rxswift/docs/AnotherFakeAPI.md @@ -23,6 +23,7 @@ import PetstoreClient let body = Client("client_example") // Client | client model +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters diff --git a/samples/client/petstore/swift4/rxswift/docs/FakeAPI.md b/samples/client/petstore/swift4/rxswift/docs/FakeAPI.md index 54e9aa89a0cf..24fe37bb70a5 100644 --- a/samples/client/petstore/swift4/rxswift/docs/FakeAPI.md +++ b/samples/client/petstore/swift4/rxswift/docs/FakeAPI.md @@ -34,6 +34,7 @@ import PetstoreClient let body = 987 // Bool | Input boolean as post body (optional) +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -73,6 +74,7 @@ import PetstoreClient let body = OuterComposite(123, "myString_example", 123) // OuterComposite | Input composite as post body (optional) +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -112,6 +114,7 @@ import PetstoreClient let body = 987 // Double | Input number as post body (optional) +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -151,6 +154,7 @@ import PetstoreClient let body = "body_example" // String | Input string as post body (optional) +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -190,6 +194,7 @@ import PetstoreClient let body = FileSchemaTestClass(File("sourceURI_example"), [File("sourceURI_example")]) // FileSchemaTestClass | +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -228,6 +233,7 @@ import PetstoreClient let query = "query_example" // String | let body = User(123, "username_example", "firstName_example", "lastName_example", "email_example", "password_example", "phone_example", 123) // User | +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -268,6 +274,7 @@ import PetstoreClient let body = Client("client_example") // Client | client model +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -320,6 +327,7 @@ let dateTime = TODO // Date | None (optional) let password = "password_example" // String | None (optional) let callback = "callback_example" // String | None (optional) +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -379,6 +387,7 @@ let enumQueryDouble = 987 // Double | Query parameter enum test (double) (option let enumFormStringArray = ["inner_example"] // [String] | Form parameter enum test (string array) (optional) (default to .$) let enumFormString = "enumFormString_example" // String | Form parameter enum test (string) (optional) (default to .-efg) +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -430,6 +439,7 @@ let stringGroup = 987 // Int | String in group parameters (optional) let booleanGroup = 987 // Bool | Boolean in group parameters (optional) let int64Group = 987 // Int64 | Integer in group parameters (optional) +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -472,6 +482,7 @@ import PetstoreClient let param = "TODO" // [String:String] | request body +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -510,6 +521,7 @@ import PetstoreClient let param = "param_example" // String | field1 let param2 = "param2_example" // String | field2 +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters diff --git a/samples/client/petstore/swift4/rxswift/docs/FakeClassnameTags123API.md b/samples/client/petstore/swift4/rxswift/docs/FakeClassnameTags123API.md index ab72d71f0218..d05a02ec051f 100644 --- a/samples/client/petstore/swift4/rxswift/docs/FakeClassnameTags123API.md +++ b/samples/client/petstore/swift4/rxswift/docs/FakeClassnameTags123API.md @@ -23,6 +23,7 @@ import PetstoreClient let body = Client("client_example") // Client | client model +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters diff --git a/samples/client/petstore/swift4/rxswift/docs/PetAPI.md b/samples/client/petstore/swift4/rxswift/docs/PetAPI.md index 036f5dcb7dbb..82bd1c5837ac 100644 --- a/samples/client/petstore/swift4/rxswift/docs/PetAPI.md +++ b/samples/client/petstore/swift4/rxswift/docs/PetAPI.md @@ -29,6 +29,7 @@ import PetstoreClient let body = Pet(123, Category(123, "name_example"), "name_example", ["photoUrls_example"], [Tag(123, "name_example")], "status_example") // Pet | Pet object that needs to be added to the store +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -67,6 +68,7 @@ import PetstoreClient let petId = 987 // Int64 | Pet id to delete let apiKey = "apiKey_example" // String | (optional) +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -107,6 +109,7 @@ import PetstoreClient let status = ["status_example"] // [String] | Status values that need to be considered for filter +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -146,6 +149,7 @@ import PetstoreClient let tags = ["inner_example"] // [String] | Tags to filter by +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -185,6 +189,7 @@ import PetstoreClient let petId = 987 // Int64 | ID of pet to return +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -222,6 +227,7 @@ import PetstoreClient let body = Pet(123, Category(123, "name_example"), "name_example", ["photoUrls_example"], [Tag(123, "name_example")], "status_example") // Pet | Pet object that needs to be added to the store +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -261,6 +267,7 @@ let petId = 987 // Int64 | ID of pet that needs to be updated let name = "name_example" // String | Updated name of the pet (optional) let status = "status_example" // String | Updated status of the pet (optional) +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -302,6 +309,7 @@ let petId = 987 // Int64 | ID of pet to update let additionalMetadata = "additionalMetadata_example" // String | Additional data to pass to server (optional) let file = "TODO" // URL | file to upload (optional) +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -343,6 +351,7 @@ let petId = 987 // Int64 | ID of pet to update let requiredFile = "TODO" // URL | file to upload let additionalMetadata = "additionalMetadata_example" // String | Additional data to pass to server (optional) +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters diff --git a/samples/client/petstore/swift4/rxswift/docs/StoreAPI.md b/samples/client/petstore/swift4/rxswift/docs/StoreAPI.md index f95177acb7bb..ba133ff7d7ad 100644 --- a/samples/client/petstore/swift4/rxswift/docs/StoreAPI.md +++ b/samples/client/petstore/swift4/rxswift/docs/StoreAPI.md @@ -26,6 +26,7 @@ import PetstoreClient let orderId = "orderId_example" // String | ID of the order that needs to be deleted +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -64,6 +65,7 @@ Returns a map of status codes to quantities import PetstoreClient +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -100,6 +102,7 @@ import PetstoreClient let orderId = 987 // Int64 | ID of pet that needs to be fetched +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -137,6 +140,7 @@ import PetstoreClient let body = Order(123, 123, 123, "TODO", "status_example", 123) // Order | order placed for purchasing the pet +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters diff --git a/samples/client/petstore/swift4/rxswift/docs/UserAPI.md b/samples/client/petstore/swift4/rxswift/docs/UserAPI.md index 094d1b409e6a..fb7d2fa628bb 100644 --- a/samples/client/petstore/swift4/rxswift/docs/UserAPI.md +++ b/samples/client/petstore/swift4/rxswift/docs/UserAPI.md @@ -30,6 +30,7 @@ import PetstoreClient let body = User(123, "username_example", "firstName_example", "lastName_example", "email_example", "password_example", "phone_example", 123) // User | Created user object +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -67,6 +68,7 @@ import PetstoreClient let body = [User(123, "username_example", "firstName_example", "lastName_example", "email_example", "password_example", "phone_example", 123)] // [User] | List of user object +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -104,6 +106,7 @@ import PetstoreClient let body = [User(123, "username_example", "firstName_example", "lastName_example", "email_example", "password_example", "phone_example", 123)] // [User] | List of user object +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -143,6 +146,7 @@ import PetstoreClient let username = "username_example" // String | The name that needs to be deleted +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -180,6 +184,7 @@ import PetstoreClient let username = "username_example" // String | The name that needs to be fetched. Use user1 for testing. +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -218,6 +223,7 @@ import PetstoreClient let username = "username_example" // String | The user name for login let password = "password_example" // String | The password for login in clear text +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -255,6 +261,7 @@ Logs out current logged in user session import PetstoreClient +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -292,6 +299,7 @@ import PetstoreClient let username = "username_example" // String | name that need to be deleted let body = User(123, "username_example", "firstName_example", "lastName_example", "email_example", "password_example", "phone_example", 123) // User | Updated user object +// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/AnotherFakeAPI.md b/samples/client/petstore/swift4/unwrapRequired/docs/AnotherFakeAPI.md index f6fc23dd02b3..3afdcfe0e38b 100644 --- a/samples/client/petstore/swift4/unwrapRequired/docs/AnotherFakeAPI.md +++ b/samples/client/petstore/swift4/unwrapRequired/docs/AnotherFakeAPI.md @@ -34,7 +34,6 @@ AnotherFakeAPI.call123testSpecialTags(body: body) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/FakeAPI.md b/samples/client/petstore/swift4/unwrapRequired/docs/FakeAPI.md index 5a6edfb6a6e9..6931e9c43fe5 100644 --- a/samples/client/petstore/swift4/unwrapRequired/docs/FakeAPI.md +++ b/samples/client/petstore/swift4/unwrapRequired/docs/FakeAPI.md @@ -44,7 +44,6 @@ FakeAPI.fakeOuterBooleanSerialize(body: body) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -94,7 +93,6 @@ FakeAPI.fakeOuterCompositeSerialize(body: body) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -144,7 +142,6 @@ FakeAPI.fakeOuterNumberSerialize(body: body) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -194,7 +191,6 @@ FakeAPI.fakeOuterStringSerialize(body: body) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -244,7 +240,6 @@ FakeAPI.testBodyWithFileSchema(body: body) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -293,7 +288,6 @@ FakeAPI.testBodyWithQueryParams(query: query, body: body) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -345,7 +339,6 @@ FakeAPI.testClientModel(body: body) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -409,7 +402,6 @@ FakeAPI.testEndpointParameters(number: number, double: double, patternWithoutDel dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -480,7 +472,6 @@ FakeAPI.testEnumParameters(enumHeaderStringArray: enumHeaderStringArray, enumHea dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -543,7 +534,6 @@ FakeAPI.testGroupParameters(requiredStringGroup: requiredStringGroup, requiredBo dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -597,7 +587,6 @@ FakeAPI.testInlineAdditionalProperties(param: param) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -647,7 +636,6 @@ FakeAPI.testJsonFormData(param: param, param2: param2) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/FakeClassnameTags123API.md b/samples/client/petstore/swift4/unwrapRequired/docs/FakeClassnameTags123API.md index cacc84a1cf89..aa989675233a 100644 --- a/samples/client/petstore/swift4/unwrapRequired/docs/FakeClassnameTags123API.md +++ b/samples/client/petstore/swift4/unwrapRequired/docs/FakeClassnameTags123API.md @@ -34,7 +34,6 @@ FakeClassnameTags123API.testClassname(body: body) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/PetAPI.md b/samples/client/petstore/swift4/unwrapRequired/docs/PetAPI.md index bd2640ed0a8d..09ac95e5823a 100644 --- a/samples/client/petstore/swift4/unwrapRequired/docs/PetAPI.md +++ b/samples/client/petstore/swift4/unwrapRequired/docs/PetAPI.md @@ -40,7 +40,6 @@ PetAPI.addPet(body: body) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -90,7 +89,6 @@ PetAPI.deletePet(petId: petId, apiKey: apiKey) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -142,7 +140,6 @@ PetAPI.findPetsByStatus(status: status) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -193,7 +190,6 @@ PetAPI.findPetsByTags(tags: tags) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -244,7 +240,6 @@ PetAPI.getPetById(petId: petId) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -293,7 +288,6 @@ PetAPI.updatePet(body: body) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -344,7 +338,6 @@ PetAPI.updatePetWithForm(petId: petId, name: name, status: status) { (response, dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -397,7 +390,6 @@ PetAPI.uploadFile(petId: petId, additionalMetadata: additionalMetadata, file: fi dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -450,7 +442,6 @@ PetAPI.uploadFileWithRequiredFile(petId: petId, requiredFile: requiredFile, addi dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/StoreAPI.md b/samples/client/petstore/swift4/unwrapRequired/docs/StoreAPI.md index 45210030fae1..6ee50196a32b 100644 --- a/samples/client/petstore/swift4/unwrapRequired/docs/StoreAPI.md +++ b/samples/client/petstore/swift4/unwrapRequired/docs/StoreAPI.md @@ -37,7 +37,6 @@ StoreAPI.deleteOrder(orderId: orderId) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -87,7 +86,6 @@ StoreAPI.getInventory() { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -135,7 +133,6 @@ StoreAPI.getOrderById(orderId: orderId) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -184,7 +181,6 @@ StoreAPI.placeOrder(body: body) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/UserAPI.md b/samples/client/petstore/swift4/unwrapRequired/docs/UserAPI.md index b22538654d8a..4cf669fc2d82 100644 --- a/samples/client/petstore/swift4/unwrapRequired/docs/UserAPI.md +++ b/samples/client/petstore/swift4/unwrapRequired/docs/UserAPI.md @@ -41,7 +41,6 @@ UserAPI.createUser(body: body) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -90,7 +89,6 @@ UserAPI.createUsersWithArrayInput(body: body) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -139,7 +137,6 @@ UserAPI.createUsersWithListInput(body: body) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -190,7 +187,6 @@ UserAPI.deleteUser(username: username) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -239,7 +235,6 @@ UserAPI.getUserByName(username: username) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -289,7 +284,6 @@ UserAPI.loginUser(username: username, password: password) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -338,7 +332,6 @@ UserAPI.logoutUser() { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -387,7 +380,6 @@ UserAPI.updateUser(username: username, body: body) { (response, error) in dump(response) } } -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters From 05f86bc8fa0c91f61707901f1ffe112ecf0315aa Mon Sep 17 00:00:00 2001 From: William Cheng Date: Tue, 16 Apr 2019 11:53:15 +0800 Subject: [PATCH 3/9] fix object initialize --- .../openapitools/codegen/languages/Swift4Codegen.java | 2 +- .../petstore/swift4/default/docs/AnotherFakeAPI.md | 2 +- samples/client/petstore/swift4/default/docs/FakeAPI.md | 8 ++++---- .../swift4/default/docs/FakeClassnameTags123API.md | 2 +- samples/client/petstore/swift4/default/docs/PetAPI.md | 4 ++-- .../client/petstore/swift4/default/docs/StoreAPI.md | 2 +- samples/client/petstore/swift4/default/docs/UserAPI.md | 8 ++++---- .../swift4/objcCompatible/docs/AnotherFakeAPI.md | 2 +- .../petstore/swift4/objcCompatible/docs/FakeAPI.md | 10 +++++----- .../objcCompatible/docs/FakeClassnameTags123API.md | 2 +- .../petstore/swift4/objcCompatible/docs/PetAPI.md | 4 ++-- .../petstore/swift4/objcCompatible/docs/StoreAPI.md | 2 +- .../petstore/swift4/objcCompatible/docs/UserAPI.md | 8 ++++---- .../petstore/swift4/promisekit/docs/AnotherFakeAPI.md | 2 +- .../client/petstore/swift4/promisekit/docs/FakeAPI.md | 8 ++++---- .../swift4/promisekit/docs/FakeClassnameTags123API.md | 2 +- .../client/petstore/swift4/promisekit/docs/PetAPI.md | 4 ++-- .../client/petstore/swift4/promisekit/docs/StoreAPI.md | 2 +- .../client/petstore/swift4/promisekit/docs/UserAPI.md | 8 ++++---- .../petstore/swift4/rxswift/docs/AnotherFakeAPI.md | 2 +- samples/client/petstore/swift4/rxswift/docs/FakeAPI.md | 8 ++++---- .../swift4/rxswift/docs/FakeClassnameTags123API.md | 2 +- samples/client/petstore/swift4/rxswift/docs/PetAPI.md | 4 ++-- .../client/petstore/swift4/rxswift/docs/StoreAPI.md | 2 +- samples/client/petstore/swift4/rxswift/docs/UserAPI.md | 8 ++++---- .../swift4/unwrapRequired/docs/AnotherFakeAPI.md | 2 +- .../petstore/swift4/unwrapRequired/docs/FakeAPI.md | 8 ++++---- .../unwrapRequired/docs/FakeClassnameTags123API.md | 2 +- .../petstore/swift4/unwrapRequired/docs/PetAPI.md | 4 ++-- .../petstore/swift4/unwrapRequired/docs/StoreAPI.md | 2 +- .../petstore/swift4/unwrapRequired/docs/UserAPI.md | 8 ++++---- 31 files changed, 67 insertions(+), 67 deletions(-) diff --git a/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/Swift4Codegen.java b/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/Swift4Codegen.java index 0f5c4c3ab0d8..a2fef52a8193 100644 --- a/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/Swift4Codegen.java +++ b/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/Swift4Codegen.java @@ -997,7 +997,7 @@ public String constructExampleCode(CodegenModel codegenModel, HashMap propertyExamples = new ArrayList<>(); for (CodegenProperty codegenProperty : codegenModel.vars) { - propertyExamples.add(constructExampleCode(codegenProperty, modelMaps)); + propertyExamples.add(codegenProperty.name + ": " + constructExampleCode(codegenProperty, modelMaps)); } example += StringUtils.join(propertyExamples, ", "); example += ")"; diff --git a/samples/client/petstore/swift4/default/docs/AnotherFakeAPI.md b/samples/client/petstore/swift4/default/docs/AnotherFakeAPI.md index 3afdcfe0e38b..e6a8f62dfa75 100644 --- a/samples/client/petstore/swift4/default/docs/AnotherFakeAPI.md +++ b/samples/client/petstore/swift4/default/docs/AnotherFakeAPI.md @@ -21,7 +21,7 @@ To test special tags and operation ID starting with number // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = Client("client_example") // Client | client model +let body = Client(client: "client_example") // Client | client model // To test special tags AnotherFakeAPI.call123testSpecialTags(body: body) { (response, error) in diff --git a/samples/client/petstore/swift4/default/docs/FakeAPI.md b/samples/client/petstore/swift4/default/docs/FakeAPI.md index 6931e9c43fe5..e0c5434ee605 100644 --- a/samples/client/petstore/swift4/default/docs/FakeAPI.md +++ b/samples/client/petstore/swift4/default/docs/FakeAPI.md @@ -81,7 +81,7 @@ Test serialization of object with outer number type // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = OuterComposite(123, "myString_example", 123) // OuterComposite | Input composite as post body (optional) +let body = OuterComposite(myNumber: 123, myString: "myString_example", myBoolean: 123) // OuterComposite | Input composite as post body (optional) FakeAPI.fakeOuterCompositeSerialize(body: body) { (response, error) in guard error == nil else { @@ -228,7 +228,7 @@ For this test, the body for this request much reference a schema named `File`. // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = FileSchemaTestClass(File("sourceURI_example"), [File("sourceURI_example")]) // FileSchemaTestClass | +let body = FileSchemaTestClass(file: File(sourceURI: "sourceURI_example"), files: [File(sourceURI: "sourceURI_example")]) // FileSchemaTestClass | FakeAPI.testBodyWithFileSchema(body: body) { (response, error) in guard error == nil else { @@ -276,7 +276,7 @@ No authorization required import PetstoreClient let query = "query_example" // String | -let body = User(123, "username_example", "firstName_example", "lastName_example", "email_example", "password_example", "phone_example", 123) // User | +let body = User(id: 123, username: "username_example", firstName: "firstName_example", lastName: "lastName_example", email: "email_example", password: "password_example", phone: "phone_example", userStatus: 123) // User | FakeAPI.testBodyWithQueryParams(query: query, body: body) { (response, error) in guard error == nil else { @@ -326,7 +326,7 @@ To test \"client\" model // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = Client("client_example") // Client | client model +let body = Client(client: "client_example") // Client | client model // To test \"client\" model FakeAPI.testClientModel(body: body) { (response, error) in diff --git a/samples/client/petstore/swift4/default/docs/FakeClassnameTags123API.md b/samples/client/petstore/swift4/default/docs/FakeClassnameTags123API.md index aa989675233a..704dacda40de 100644 --- a/samples/client/petstore/swift4/default/docs/FakeClassnameTags123API.md +++ b/samples/client/petstore/swift4/default/docs/FakeClassnameTags123API.md @@ -21,7 +21,7 @@ To test class name in snake case // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = Client("client_example") // Client | client model +let body = Client(client: "client_example") // Client | client model // To test class name in snake case FakeClassnameTags123API.testClassname(body: body) { (response, error) in diff --git a/samples/client/petstore/swift4/default/docs/PetAPI.md b/samples/client/petstore/swift4/default/docs/PetAPI.md index 09ac95e5823a..3d57572d9498 100644 --- a/samples/client/petstore/swift4/default/docs/PetAPI.md +++ b/samples/client/petstore/swift4/default/docs/PetAPI.md @@ -27,7 +27,7 @@ Add a new pet to the store // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = Pet(123, Category(123, "name_example"), "name_example", ["photoUrls_example"], [Tag(123, "name_example")], "status_example") // Pet | Pet object that needs to be added to the store +let body = Pet(id: 123, category: Category(id: 123, name: "name_example"), name: "name_example", photoUrls: ["photoUrls_example"], tags: [Tag(id: 123, name: "name_example")], status: "status_example") // Pet | Pet object that needs to be added to the store // Add a new pet to the store PetAPI.addPet(body: body) { (response, error) in @@ -275,7 +275,7 @@ Update an existing pet // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = Pet(123, Category(123, "name_example"), "name_example", ["photoUrls_example"], [Tag(123, "name_example")], "status_example") // Pet | Pet object that needs to be added to the store +let body = Pet(id: 123, category: Category(id: 123, name: "name_example"), name: "name_example", photoUrls: ["photoUrls_example"], tags: [Tag(id: 123, name: "name_example")], status: "status_example") // Pet | Pet object that needs to be added to the store // Update an existing pet PetAPI.updatePet(body: body) { (response, error) in diff --git a/samples/client/petstore/swift4/default/docs/StoreAPI.md b/samples/client/petstore/swift4/default/docs/StoreAPI.md index 6ee50196a32b..995b9cdea9ff 100644 --- a/samples/client/petstore/swift4/default/docs/StoreAPI.md +++ b/samples/client/petstore/swift4/default/docs/StoreAPI.md @@ -168,7 +168,7 @@ Place an order for a pet // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = Order(123, 123, 123, "TODO", "status_example", 123) // Order | order placed for purchasing the pet +let body = Order(id: 123, petId: 123, quantity: 123, shipDate: "TODO", status: "status_example", complete: 123) // Order | order placed for purchasing the pet // Place an order for a pet StoreAPI.placeOrder(body: body) { (response, error) in diff --git a/samples/client/petstore/swift4/default/docs/UserAPI.md b/samples/client/petstore/swift4/default/docs/UserAPI.md index 4cf669fc2d82..9c1b0500075a 100644 --- a/samples/client/petstore/swift4/default/docs/UserAPI.md +++ b/samples/client/petstore/swift4/default/docs/UserAPI.md @@ -28,7 +28,7 @@ This can only be done by the logged in user. // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = User(123, "username_example", "firstName_example", "lastName_example", "email_example", "password_example", "phone_example", 123) // User | Created user object +let body = User(id: 123, username: "username_example", firstName: "firstName_example", lastName: "lastName_example", email: "email_example", password: "password_example", phone: "phone_example", userStatus: 123) // User | Created user object // Create user UserAPI.createUser(body: body) { (response, error) in @@ -76,7 +76,7 @@ Creates list of users with given input array // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = [User(123, "username_example", "firstName_example", "lastName_example", "email_example", "password_example", "phone_example", 123)] // [User] | List of user object +let body = [User(id: 123, username: "username_example", firstName: "firstName_example", lastName: "lastName_example", email: "email_example", password: "password_example", phone: "phone_example", userStatus: 123)] // [User] | List of user object // Creates list of users with given input array UserAPI.createUsersWithArrayInput(body: body) { (response, error) in @@ -124,7 +124,7 @@ Creates list of users with given input array // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = [User(123, "username_example", "firstName_example", "lastName_example", "email_example", "password_example", "phone_example", 123)] // [User] | List of user object +let body = [User(id: 123, username: "username_example", firstName: "firstName_example", lastName: "lastName_example", email: "email_example", password: "password_example", phone: "phone_example", userStatus: 123)] // [User] | List of user object // Creates list of users with given input array UserAPI.createUsersWithListInput(body: body) { (response, error) in @@ -367,7 +367,7 @@ This can only be done by the logged in user. import PetstoreClient let username = "username_example" // String | name that need to be deleted -let body = User(123, "username_example", "firstName_example", "lastName_example", "email_example", "password_example", "phone_example", 123) // User | Updated user object +let body = User(id: 123, username: "username_example", firstName: "firstName_example", lastName: "lastName_example", email: "email_example", password: "password_example", phone: "phone_example", userStatus: 123) // User | Updated user object // Updated user UserAPI.updateUser(username: username, body: body) { (response, error) in diff --git a/samples/client/petstore/swift4/objcCompatible/docs/AnotherFakeAPI.md b/samples/client/petstore/swift4/objcCompatible/docs/AnotherFakeAPI.md index 3afdcfe0e38b..e6a8f62dfa75 100644 --- a/samples/client/petstore/swift4/objcCompatible/docs/AnotherFakeAPI.md +++ b/samples/client/petstore/swift4/objcCompatible/docs/AnotherFakeAPI.md @@ -21,7 +21,7 @@ To test special tags and operation ID starting with number // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = Client("client_example") // Client | client model +let body = Client(client: "client_example") // Client | client model // To test special tags AnotherFakeAPI.call123testSpecialTags(body: body) { (response, error) in diff --git a/samples/client/petstore/swift4/objcCompatible/docs/FakeAPI.md b/samples/client/petstore/swift4/objcCompatible/docs/FakeAPI.md index f3eeeaa7aa53..b14e935c0ea7 100644 --- a/samples/client/petstore/swift4/objcCompatible/docs/FakeAPI.md +++ b/samples/client/petstore/swift4/objcCompatible/docs/FakeAPI.md @@ -33,7 +33,7 @@ this route creates an XmlItem // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let xmlItem = XmlItem("attributeString_example", 123, 123, 123, [123], "nameString_example", 123, 123, 123, [123], [123], "prefixString_example", 123, 123, 123, [123], [123], "namespaceString_example", 123, 123, 123, [123], [123], "prefixNsString_example", 123, 123, 123, [123], [123]) // XmlItem | XmlItem Body +let xmlItem = XmlItem(attributeString: "attributeString_example", attributeNumber: 123, attributeInteger: 123, attributeBoolean: 123, wrappedArray: [123], nameString: "nameString_example", nameNumber: 123, nameInteger: 123, nameBoolean: 123, nameArray: [123], nameWrappedArray: [123], prefixString: "prefixString_example", prefixNumber: 123, prefixInteger: 123, prefixBoolean: 123, prefixArray: [123], prefixWrappedArray: [123], namespaceString: "namespaceString_example", namespaceNumber: 123, namespaceInteger: 123, namespaceBoolean: 123, namespaceArray: [123], namespaceWrappedArray: [123], prefixNsString: "prefixNsString_example", prefixNsNumber: 123, prefixNsInteger: 123, prefixNsBoolean: 123, prefixNsArray: [123], prefixNsWrappedArray: [123]) // XmlItem | XmlItem Body // creates an XmlItem FakeAPI.createXmlItem(xmlItem: xmlItem) { (response, error) in @@ -132,7 +132,7 @@ Test serialization of object with outer number type // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = OuterComposite(123, "myString_example", 123) // OuterComposite | Input composite as post body (optional) +let body = OuterComposite(myNumber: 123, myString: "myString_example", myBoolean: 123) // OuterComposite | Input composite as post body (optional) FakeAPI.fakeOuterCompositeSerialize(body: body) { (response, error) in guard error == nil else { @@ -279,7 +279,7 @@ For this test, the body for this request much reference a schema named `File`. // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = FileSchemaTestClass(File("sourceURI_example"), [File("sourceURI_example")]) // FileSchemaTestClass | +let body = FileSchemaTestClass(file: File(sourceURI: "sourceURI_example"), files: [File(sourceURI: "sourceURI_example")]) // FileSchemaTestClass | FakeAPI.testBodyWithFileSchema(body: body) { (response, error) in guard error == nil else { @@ -327,7 +327,7 @@ No authorization required import PetstoreClient let query = "query_example" // String | -let body = User(123, "username_example", "firstName_example", "lastName_example", "email_example", "password_example", "phone_example", 123) // User | +let body = User(_id: 123, username: "username_example", firstName: "firstName_example", lastName: "lastName_example", email: "email_example", password: "password_example", phone: "phone_example", userStatus: 123) // User | FakeAPI.testBodyWithQueryParams(query: query, body: body) { (response, error) in guard error == nil else { @@ -377,7 +377,7 @@ To test \"client\" model // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = Client("client_example") // Client | client model +let body = Client(client: "client_example") // Client | client model // To test \"client\" model FakeAPI.testClientModel(body: body) { (response, error) in diff --git a/samples/client/petstore/swift4/objcCompatible/docs/FakeClassnameTags123API.md b/samples/client/petstore/swift4/objcCompatible/docs/FakeClassnameTags123API.md index aa989675233a..704dacda40de 100644 --- a/samples/client/petstore/swift4/objcCompatible/docs/FakeClassnameTags123API.md +++ b/samples/client/petstore/swift4/objcCompatible/docs/FakeClassnameTags123API.md @@ -21,7 +21,7 @@ To test class name in snake case // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = Client("client_example") // Client | client model +let body = Client(client: "client_example") // Client | client model // To test class name in snake case FakeClassnameTags123API.testClassname(body: body) { (response, error) in diff --git a/samples/client/petstore/swift4/objcCompatible/docs/PetAPI.md b/samples/client/petstore/swift4/objcCompatible/docs/PetAPI.md index 09ac95e5823a..39413b693254 100644 --- a/samples/client/petstore/swift4/objcCompatible/docs/PetAPI.md +++ b/samples/client/petstore/swift4/objcCompatible/docs/PetAPI.md @@ -27,7 +27,7 @@ Add a new pet to the store // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = Pet(123, Category(123, "name_example"), "name_example", ["photoUrls_example"], [Tag(123, "name_example")], "status_example") // Pet | Pet object that needs to be added to the store +let body = Pet(_id: 123, category: Category(_id: 123, name: "name_example"), name: "name_example", photoUrls: ["photoUrls_example"], tags: [Tag(_id: 123, name: "name_example")], status: "status_example") // Pet | Pet object that needs to be added to the store // Add a new pet to the store PetAPI.addPet(body: body) { (response, error) in @@ -275,7 +275,7 @@ Update an existing pet // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = Pet(123, Category(123, "name_example"), "name_example", ["photoUrls_example"], [Tag(123, "name_example")], "status_example") // Pet | Pet object that needs to be added to the store +let body = Pet(_id: 123, category: Category(_id: 123, name: "name_example"), name: "name_example", photoUrls: ["photoUrls_example"], tags: [Tag(_id: 123, name: "name_example")], status: "status_example") // Pet | Pet object that needs to be added to the store // Update an existing pet PetAPI.updatePet(body: body) { (response, error) in diff --git a/samples/client/petstore/swift4/objcCompatible/docs/StoreAPI.md b/samples/client/petstore/swift4/objcCompatible/docs/StoreAPI.md index 6ee50196a32b..9be40bfcacd9 100644 --- a/samples/client/petstore/swift4/objcCompatible/docs/StoreAPI.md +++ b/samples/client/petstore/swift4/objcCompatible/docs/StoreAPI.md @@ -168,7 +168,7 @@ Place an order for a pet // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = Order(123, 123, 123, "TODO", "status_example", 123) // Order | order placed for purchasing the pet +let body = Order(_id: 123, petId: 123, quantity: 123, shipDate: "TODO", status: "status_example", complete: 123) // Order | order placed for purchasing the pet // Place an order for a pet StoreAPI.placeOrder(body: body) { (response, error) in diff --git a/samples/client/petstore/swift4/objcCompatible/docs/UserAPI.md b/samples/client/petstore/swift4/objcCompatible/docs/UserAPI.md index 4cf669fc2d82..e33bb4300e6e 100644 --- a/samples/client/petstore/swift4/objcCompatible/docs/UserAPI.md +++ b/samples/client/petstore/swift4/objcCompatible/docs/UserAPI.md @@ -28,7 +28,7 @@ This can only be done by the logged in user. // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = User(123, "username_example", "firstName_example", "lastName_example", "email_example", "password_example", "phone_example", 123) // User | Created user object +let body = User(_id: 123, username: "username_example", firstName: "firstName_example", lastName: "lastName_example", email: "email_example", password: "password_example", phone: "phone_example", userStatus: 123) // User | Created user object // Create user UserAPI.createUser(body: body) { (response, error) in @@ -76,7 +76,7 @@ Creates list of users with given input array // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = [User(123, "username_example", "firstName_example", "lastName_example", "email_example", "password_example", "phone_example", 123)] // [User] | List of user object +let body = [User(_id: 123, username: "username_example", firstName: "firstName_example", lastName: "lastName_example", email: "email_example", password: "password_example", phone: "phone_example", userStatus: 123)] // [User] | List of user object // Creates list of users with given input array UserAPI.createUsersWithArrayInput(body: body) { (response, error) in @@ -124,7 +124,7 @@ Creates list of users with given input array // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = [User(123, "username_example", "firstName_example", "lastName_example", "email_example", "password_example", "phone_example", 123)] // [User] | List of user object +let body = [User(_id: 123, username: "username_example", firstName: "firstName_example", lastName: "lastName_example", email: "email_example", password: "password_example", phone: "phone_example", userStatus: 123)] // [User] | List of user object // Creates list of users with given input array UserAPI.createUsersWithListInput(body: body) { (response, error) in @@ -367,7 +367,7 @@ This can only be done by the logged in user. import PetstoreClient let username = "username_example" // String | name that need to be deleted -let body = User(123, "username_example", "firstName_example", "lastName_example", "email_example", "password_example", "phone_example", 123) // User | Updated user object +let body = User(_id: 123, username: "username_example", firstName: "firstName_example", lastName: "lastName_example", email: "email_example", password: "password_example", phone: "phone_example", userStatus: 123) // User | Updated user object // Updated user UserAPI.updateUser(username: username, body: body) { (response, error) in diff --git a/samples/client/petstore/swift4/promisekit/docs/AnotherFakeAPI.md b/samples/client/petstore/swift4/promisekit/docs/AnotherFakeAPI.md index 199d571dcc13..c25854f64a06 100644 --- a/samples/client/petstore/swift4/promisekit/docs/AnotherFakeAPI.md +++ b/samples/client/petstore/swift4/promisekit/docs/AnotherFakeAPI.md @@ -21,7 +21,7 @@ To test special tags and operation ID starting with number // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = Client("client_example") // Client | client model +let body = Client(client: "client_example") // Client | client model // To test special tags AnotherFakeAPI.call123testSpecialTags(body: body).then { diff --git a/samples/client/petstore/swift4/promisekit/docs/FakeAPI.md b/samples/client/petstore/swift4/promisekit/docs/FakeAPI.md index 9e0eaef2b568..20880dd38338 100644 --- a/samples/client/petstore/swift4/promisekit/docs/FakeAPI.md +++ b/samples/client/petstore/swift4/promisekit/docs/FakeAPI.md @@ -79,7 +79,7 @@ Test serialization of object with outer number type // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = OuterComposite(123, "myString_example", 123) // OuterComposite | Input composite as post body (optional) +let body = OuterComposite(myNumber: 123, myString: "myString_example", myBoolean: 123) // OuterComposite | Input composite as post body (optional) FakeAPI.fakeOuterCompositeSerialize(body: body).then { // when the promise is fulfilled @@ -220,7 +220,7 @@ For this test, the body for this request much reference a schema named `File`. // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = FileSchemaTestClass(File("sourceURI_example"), [File("sourceURI_example")]) // FileSchemaTestClass | +let body = FileSchemaTestClass(file: File(sourceURI: "sourceURI_example"), files: [File(sourceURI: "sourceURI_example")]) // FileSchemaTestClass | FakeAPI.testBodyWithFileSchema(body: body).then { // when the promise is fulfilled @@ -266,7 +266,7 @@ No authorization required import PetstoreClient let query = "query_example" // String | -let body = User(123, "username_example", "firstName_example", "lastName_example", "email_example", "password_example", "phone_example", 123) // User | +let body = User(id: 123, username: "username_example", firstName: "firstName_example", lastName: "lastName_example", email: "email_example", password: "password_example", phone: "phone_example", userStatus: 123) // User | FakeAPI.testBodyWithQueryParams(query: query, body: body).then { // when the promise is fulfilled @@ -314,7 +314,7 @@ To test \"client\" model // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = Client("client_example") // Client | client model +let body = Client(client: "client_example") // Client | client model // To test \"client\" model FakeAPI.testClientModel(body: body).then { diff --git a/samples/client/petstore/swift4/promisekit/docs/FakeClassnameTags123API.md b/samples/client/petstore/swift4/promisekit/docs/FakeClassnameTags123API.md index 684309d2f56b..6a47a25d84c0 100644 --- a/samples/client/petstore/swift4/promisekit/docs/FakeClassnameTags123API.md +++ b/samples/client/petstore/swift4/promisekit/docs/FakeClassnameTags123API.md @@ -21,7 +21,7 @@ To test class name in snake case // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = Client("client_example") // Client | client model +let body = Client(client: "client_example") // Client | client model // To test class name in snake case FakeClassnameTags123API.testClassname(body: body).then { diff --git a/samples/client/petstore/swift4/promisekit/docs/PetAPI.md b/samples/client/petstore/swift4/promisekit/docs/PetAPI.md index 5f05b4bad446..7e5cc6c1ff9e 100644 --- a/samples/client/petstore/swift4/promisekit/docs/PetAPI.md +++ b/samples/client/petstore/swift4/promisekit/docs/PetAPI.md @@ -27,7 +27,7 @@ Add a new pet to the store // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = Pet(123, Category(123, "name_example"), "name_example", ["photoUrls_example"], [Tag(123, "name_example")], "status_example") // Pet | Pet object that needs to be added to the store +let body = Pet(id: 123, category: Category(id: 123, name: "name_example"), name: "name_example", photoUrls: ["photoUrls_example"], tags: [Tag(id: 123, name: "name_example")], status: "status_example") // Pet | Pet object that needs to be added to the store // Add a new pet to the store PetAPI.addPet(body: body).then { @@ -265,7 +265,7 @@ Update an existing pet // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = Pet(123, Category(123, "name_example"), "name_example", ["photoUrls_example"], [Tag(123, "name_example")], "status_example") // Pet | Pet object that needs to be added to the store +let body = Pet(id: 123, category: Category(id: 123, name: "name_example"), name: "name_example", photoUrls: ["photoUrls_example"], tags: [Tag(id: 123, name: "name_example")], status: "status_example") // Pet | Pet object that needs to be added to the store // Update an existing pet PetAPI.updatePet(body: body).then { diff --git a/samples/client/petstore/swift4/promisekit/docs/StoreAPI.md b/samples/client/petstore/swift4/promisekit/docs/StoreAPI.md index df5479f37114..01c8ec70f067 100644 --- a/samples/client/petstore/swift4/promisekit/docs/StoreAPI.md +++ b/samples/client/petstore/swift4/promisekit/docs/StoreAPI.md @@ -162,7 +162,7 @@ Place an order for a pet // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = Order(123, 123, 123, "TODO", "status_example", 123) // Order | order placed for purchasing the pet +let body = Order(id: 123, petId: 123, quantity: 123, shipDate: "TODO", status: "status_example", complete: 123) // Order | order placed for purchasing the pet // Place an order for a pet StoreAPI.placeOrder(body: body).then { diff --git a/samples/client/petstore/swift4/promisekit/docs/UserAPI.md b/samples/client/petstore/swift4/promisekit/docs/UserAPI.md index 50f1461dfac1..b0b1787f70d5 100644 --- a/samples/client/petstore/swift4/promisekit/docs/UserAPI.md +++ b/samples/client/petstore/swift4/promisekit/docs/UserAPI.md @@ -28,7 +28,7 @@ This can only be done by the logged in user. // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = User(123, "username_example", "firstName_example", "lastName_example", "email_example", "password_example", "phone_example", 123) // User | Created user object +let body = User(id: 123, username: "username_example", firstName: "firstName_example", lastName: "lastName_example", email: "email_example", password: "password_example", phone: "phone_example", userStatus: 123) // User | Created user object // Create user UserAPI.createUser(body: body).then { @@ -74,7 +74,7 @@ Creates list of users with given input array // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = [User(123, "username_example", "firstName_example", "lastName_example", "email_example", "password_example", "phone_example", 123)] // [User] | List of user object +let body = [User(id: 123, username: "username_example", firstName: "firstName_example", lastName: "lastName_example", email: "email_example", password: "password_example", phone: "phone_example", userStatus: 123)] // [User] | List of user object // Creates list of users with given input array UserAPI.createUsersWithArrayInput(body: body).then { @@ -120,7 +120,7 @@ Creates list of users with given input array // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = [User(123, "username_example", "firstName_example", "lastName_example", "email_example", "password_example", "phone_example", 123)] // [User] | List of user object +let body = [User(id: 123, username: "username_example", firstName: "firstName_example", lastName: "lastName_example", email: "email_example", password: "password_example", phone: "phone_example", userStatus: 123)] // [User] | List of user object // Creates list of users with given input array UserAPI.createUsersWithListInput(body: body).then { @@ -353,7 +353,7 @@ This can only be done by the logged in user. import PetstoreClient let username = "username_example" // String | name that need to be deleted -let body = User(123, "username_example", "firstName_example", "lastName_example", "email_example", "password_example", "phone_example", 123) // User | Updated user object +let body = User(id: 123, username: "username_example", firstName: "firstName_example", lastName: "lastName_example", email: "email_example", password: "password_example", phone: "phone_example", userStatus: 123) // User | Updated user object // Updated user UserAPI.updateUser(username: username, body: body).then { diff --git a/samples/client/petstore/swift4/rxswift/docs/AnotherFakeAPI.md b/samples/client/petstore/swift4/rxswift/docs/AnotherFakeAPI.md index 5a360571fccc..e061b9b905bb 100644 --- a/samples/client/petstore/swift4/rxswift/docs/AnotherFakeAPI.md +++ b/samples/client/petstore/swift4/rxswift/docs/AnotherFakeAPI.md @@ -21,7 +21,7 @@ To test special tags and operation ID starting with number // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = Client("client_example") // Client | client model +let body = Client(client: "client_example") // Client | client model // TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` diff --git a/samples/client/petstore/swift4/rxswift/docs/FakeAPI.md b/samples/client/petstore/swift4/rxswift/docs/FakeAPI.md index 24fe37bb70a5..edc7fce5eb54 100644 --- a/samples/client/petstore/swift4/rxswift/docs/FakeAPI.md +++ b/samples/client/petstore/swift4/rxswift/docs/FakeAPI.md @@ -72,7 +72,7 @@ Test serialization of object with outer number type // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = OuterComposite(123, "myString_example", 123) // OuterComposite | Input composite as post body (optional) +let body = OuterComposite(myNumber: 123, myString: "myString_example", myBoolean: 123) // OuterComposite | Input composite as post body (optional) // TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` @@ -192,7 +192,7 @@ For this test, the body for this request much reference a schema named `File`. // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = FileSchemaTestClass(File("sourceURI_example"), [File("sourceURI_example")]) // FileSchemaTestClass | +let body = FileSchemaTestClass(file: File(sourceURI: "sourceURI_example"), files: [File(sourceURI: "sourceURI_example")]) // FileSchemaTestClass | // TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` @@ -231,7 +231,7 @@ No authorization required import PetstoreClient let query = "query_example" // String | -let body = User(123, "username_example", "firstName_example", "lastName_example", "email_example", "password_example", "phone_example", 123) // User | +let body = User(id: 123, username: "username_example", firstName: "firstName_example", lastName: "lastName_example", email: "email_example", password: "password_example", phone: "phone_example", userStatus: 123) // User | // TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` @@ -272,7 +272,7 @@ To test \"client\" model // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = Client("client_example") // Client | client model +let body = Client(client: "client_example") // Client | client model // TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` diff --git a/samples/client/petstore/swift4/rxswift/docs/FakeClassnameTags123API.md b/samples/client/petstore/swift4/rxswift/docs/FakeClassnameTags123API.md index d05a02ec051f..058955a8e1c1 100644 --- a/samples/client/petstore/swift4/rxswift/docs/FakeClassnameTags123API.md +++ b/samples/client/petstore/swift4/rxswift/docs/FakeClassnameTags123API.md @@ -21,7 +21,7 @@ To test class name in snake case // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = Client("client_example") // Client | client model +let body = Client(client: "client_example") // Client | client model // TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` diff --git a/samples/client/petstore/swift4/rxswift/docs/PetAPI.md b/samples/client/petstore/swift4/rxswift/docs/PetAPI.md index 82bd1c5837ac..e1e1aa43d3fe 100644 --- a/samples/client/petstore/swift4/rxswift/docs/PetAPI.md +++ b/samples/client/petstore/swift4/rxswift/docs/PetAPI.md @@ -27,7 +27,7 @@ Add a new pet to the store // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = Pet(123, Category(123, "name_example"), "name_example", ["photoUrls_example"], [Tag(123, "name_example")], "status_example") // Pet | Pet object that needs to be added to the store +let body = Pet(id: 123, category: Category(id: 123, name: "name_example"), name: "name_example", photoUrls: ["photoUrls_example"], tags: [Tag(id: 123, name: "name_example")], status: "status_example") // Pet | Pet object that needs to be added to the store // TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` @@ -225,7 +225,7 @@ Update an existing pet // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = Pet(123, Category(123, "name_example"), "name_example", ["photoUrls_example"], [Tag(123, "name_example")], "status_example") // Pet | Pet object that needs to be added to the store +let body = Pet(id: 123, category: Category(id: 123, name: "name_example"), name: "name_example", photoUrls: ["photoUrls_example"], tags: [Tag(id: 123, name: "name_example")], status: "status_example") // Pet | Pet object that needs to be added to the store // TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` diff --git a/samples/client/petstore/swift4/rxswift/docs/StoreAPI.md b/samples/client/petstore/swift4/rxswift/docs/StoreAPI.md index ba133ff7d7ad..e18e960ff55b 100644 --- a/samples/client/petstore/swift4/rxswift/docs/StoreAPI.md +++ b/samples/client/petstore/swift4/rxswift/docs/StoreAPI.md @@ -138,7 +138,7 @@ Place an order for a pet // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = Order(123, 123, 123, "TODO", "status_example", 123) // Order | order placed for purchasing the pet +let body = Order(id: 123, petId: 123, quantity: 123, shipDate: "TODO", status: "status_example", complete: 123) // Order | order placed for purchasing the pet // TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` diff --git a/samples/client/petstore/swift4/rxswift/docs/UserAPI.md b/samples/client/petstore/swift4/rxswift/docs/UserAPI.md index fb7d2fa628bb..d76d0ca82467 100644 --- a/samples/client/petstore/swift4/rxswift/docs/UserAPI.md +++ b/samples/client/petstore/swift4/rxswift/docs/UserAPI.md @@ -28,7 +28,7 @@ This can only be done by the logged in user. // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = User(123, "username_example", "firstName_example", "lastName_example", "email_example", "password_example", "phone_example", 123) // User | Created user object +let body = User(id: 123, username: "username_example", firstName: "firstName_example", lastName: "lastName_example", email: "email_example", password: "password_example", phone: "phone_example", userStatus: 123) // User | Created user object // TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` @@ -66,7 +66,7 @@ Creates list of users with given input array // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = [User(123, "username_example", "firstName_example", "lastName_example", "email_example", "password_example", "phone_example", 123)] // [User] | List of user object +let body = [User(id: 123, username: "username_example", firstName: "firstName_example", lastName: "lastName_example", email: "email_example", password: "password_example", phone: "phone_example", userStatus: 123)] // [User] | List of user object // TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` @@ -104,7 +104,7 @@ Creates list of users with given input array // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = [User(123, "username_example", "firstName_example", "lastName_example", "email_example", "password_example", "phone_example", 123)] // [User] | List of user object +let body = [User(id: 123, username: "username_example", firstName: "firstName_example", lastName: "lastName_example", email: "email_example", password: "password_example", phone: "phone_example", userStatus: 123)] // [User] | List of user object // TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` @@ -297,7 +297,7 @@ This can only be done by the logged in user. import PetstoreClient let username = "username_example" // String | name that need to be deleted -let body = User(123, "username_example", "firstName_example", "lastName_example", "email_example", "password_example", "phone_example", 123) // User | Updated user object +let body = User(id: 123, username: "username_example", firstName: "firstName_example", lastName: "lastName_example", email: "email_example", password: "password_example", phone: "phone_example", userStatus: 123) // User | Updated user object // TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/AnotherFakeAPI.md b/samples/client/petstore/swift4/unwrapRequired/docs/AnotherFakeAPI.md index 3afdcfe0e38b..e6a8f62dfa75 100644 --- a/samples/client/petstore/swift4/unwrapRequired/docs/AnotherFakeAPI.md +++ b/samples/client/petstore/swift4/unwrapRequired/docs/AnotherFakeAPI.md @@ -21,7 +21,7 @@ To test special tags and operation ID starting with number // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = Client("client_example") // Client | client model +let body = Client(client: "client_example") // Client | client model // To test special tags AnotherFakeAPI.call123testSpecialTags(body: body) { (response, error) in diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/FakeAPI.md b/samples/client/petstore/swift4/unwrapRequired/docs/FakeAPI.md index 6931e9c43fe5..e0c5434ee605 100644 --- a/samples/client/petstore/swift4/unwrapRequired/docs/FakeAPI.md +++ b/samples/client/petstore/swift4/unwrapRequired/docs/FakeAPI.md @@ -81,7 +81,7 @@ Test serialization of object with outer number type // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = OuterComposite(123, "myString_example", 123) // OuterComposite | Input composite as post body (optional) +let body = OuterComposite(myNumber: 123, myString: "myString_example", myBoolean: 123) // OuterComposite | Input composite as post body (optional) FakeAPI.fakeOuterCompositeSerialize(body: body) { (response, error) in guard error == nil else { @@ -228,7 +228,7 @@ For this test, the body for this request much reference a schema named `File`. // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = FileSchemaTestClass(File("sourceURI_example"), [File("sourceURI_example")]) // FileSchemaTestClass | +let body = FileSchemaTestClass(file: File(sourceURI: "sourceURI_example"), files: [File(sourceURI: "sourceURI_example")]) // FileSchemaTestClass | FakeAPI.testBodyWithFileSchema(body: body) { (response, error) in guard error == nil else { @@ -276,7 +276,7 @@ No authorization required import PetstoreClient let query = "query_example" // String | -let body = User(123, "username_example", "firstName_example", "lastName_example", "email_example", "password_example", "phone_example", 123) // User | +let body = User(id: 123, username: "username_example", firstName: "firstName_example", lastName: "lastName_example", email: "email_example", password: "password_example", phone: "phone_example", userStatus: 123) // User | FakeAPI.testBodyWithQueryParams(query: query, body: body) { (response, error) in guard error == nil else { @@ -326,7 +326,7 @@ To test \"client\" model // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = Client("client_example") // Client | client model +let body = Client(client: "client_example") // Client | client model // To test \"client\" model FakeAPI.testClientModel(body: body) { (response, error) in diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/FakeClassnameTags123API.md b/samples/client/petstore/swift4/unwrapRequired/docs/FakeClassnameTags123API.md index aa989675233a..704dacda40de 100644 --- a/samples/client/petstore/swift4/unwrapRequired/docs/FakeClassnameTags123API.md +++ b/samples/client/petstore/swift4/unwrapRequired/docs/FakeClassnameTags123API.md @@ -21,7 +21,7 @@ To test class name in snake case // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = Client("client_example") // Client | client model +let body = Client(client: "client_example") // Client | client model // To test class name in snake case FakeClassnameTags123API.testClassname(body: body) { (response, error) in diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/PetAPI.md b/samples/client/petstore/swift4/unwrapRequired/docs/PetAPI.md index 09ac95e5823a..3d57572d9498 100644 --- a/samples/client/petstore/swift4/unwrapRequired/docs/PetAPI.md +++ b/samples/client/petstore/swift4/unwrapRequired/docs/PetAPI.md @@ -27,7 +27,7 @@ Add a new pet to the store // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = Pet(123, Category(123, "name_example"), "name_example", ["photoUrls_example"], [Tag(123, "name_example")], "status_example") // Pet | Pet object that needs to be added to the store +let body = Pet(id: 123, category: Category(id: 123, name: "name_example"), name: "name_example", photoUrls: ["photoUrls_example"], tags: [Tag(id: 123, name: "name_example")], status: "status_example") // Pet | Pet object that needs to be added to the store // Add a new pet to the store PetAPI.addPet(body: body) { (response, error) in @@ -275,7 +275,7 @@ Update an existing pet // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = Pet(123, Category(123, "name_example"), "name_example", ["photoUrls_example"], [Tag(123, "name_example")], "status_example") // Pet | Pet object that needs to be added to the store +let body = Pet(id: 123, category: Category(id: 123, name: "name_example"), name: "name_example", photoUrls: ["photoUrls_example"], tags: [Tag(id: 123, name: "name_example")], status: "status_example") // Pet | Pet object that needs to be added to the store // Update an existing pet PetAPI.updatePet(body: body) { (response, error) in diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/StoreAPI.md b/samples/client/petstore/swift4/unwrapRequired/docs/StoreAPI.md index 6ee50196a32b..995b9cdea9ff 100644 --- a/samples/client/petstore/swift4/unwrapRequired/docs/StoreAPI.md +++ b/samples/client/petstore/swift4/unwrapRequired/docs/StoreAPI.md @@ -168,7 +168,7 @@ Place an order for a pet // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = Order(123, 123, 123, "TODO", "status_example", 123) // Order | order placed for purchasing the pet +let body = Order(id: 123, petId: 123, quantity: 123, shipDate: "TODO", status: "status_example", complete: 123) // Order | order placed for purchasing the pet // Place an order for a pet StoreAPI.placeOrder(body: body) { (response, error) in diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/UserAPI.md b/samples/client/petstore/swift4/unwrapRequired/docs/UserAPI.md index 4cf669fc2d82..9c1b0500075a 100644 --- a/samples/client/petstore/swift4/unwrapRequired/docs/UserAPI.md +++ b/samples/client/petstore/swift4/unwrapRequired/docs/UserAPI.md @@ -28,7 +28,7 @@ This can only be done by the logged in user. // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = User(123, "username_example", "firstName_example", "lastName_example", "email_example", "password_example", "phone_example", 123) // User | Created user object +let body = User(id: 123, username: "username_example", firstName: "firstName_example", lastName: "lastName_example", email: "email_example", password: "password_example", phone: "phone_example", userStatus: 123) // User | Created user object // Create user UserAPI.createUser(body: body) { (response, error) in @@ -76,7 +76,7 @@ Creates list of users with given input array // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = [User(123, "username_example", "firstName_example", "lastName_example", "email_example", "password_example", "phone_example", 123)] // [User] | List of user object +let body = [User(id: 123, username: "username_example", firstName: "firstName_example", lastName: "lastName_example", email: "email_example", password: "password_example", phone: "phone_example", userStatus: 123)] // [User] | List of user object // Creates list of users with given input array UserAPI.createUsersWithArrayInput(body: body) { (response, error) in @@ -124,7 +124,7 @@ Creates list of users with given input array // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = [User(123, "username_example", "firstName_example", "lastName_example", "email_example", "password_example", "phone_example", 123)] // [User] | List of user object +let body = [User(id: 123, username: "username_example", firstName: "firstName_example", lastName: "lastName_example", email: "email_example", password: "password_example", phone: "phone_example", userStatus: 123)] // [User] | List of user object // Creates list of users with given input array UserAPI.createUsersWithListInput(body: body) { (response, error) in @@ -367,7 +367,7 @@ This can only be done by the logged in user. import PetstoreClient let username = "username_example" // String | name that need to be deleted -let body = User(123, "username_example", "firstName_example", "lastName_example", "email_example", "password_example", "phone_example", 123) // User | Updated user object +let body = User(id: 123, username: "username_example", firstName: "firstName_example", lastName: "lastName_example", email: "email_example", password: "password_example", phone: "phone_example", userStatus: 123) // User | Updated user object // Updated user UserAPI.updateUser(username: username, body: body) { (response, error) in From 1a0b5bbfa4b7c29c2a622d17c222d7c0b356ef9f Mon Sep 17 00:00:00 2001 From: William Cheng Date: Tue, 16 Apr 2019 12:01:56 +0800 Subject: [PATCH 4/9] fix boolean value --- .../codegen/languages/Swift4Codegen.java | 12 ++++++++++++ .../client/petstore/swift4/default/docs/FakeAPI.md | 8 ++++---- .../client/petstore/swift4/default/docs/StoreAPI.md | 2 +- 3 files changed, 17 insertions(+), 5 deletions(-) diff --git a/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/Swift4Codegen.java b/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/Swift4Codegen.java index a2fef52a8193..f21c9c9ee391 100644 --- a/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/Swift4Codegen.java +++ b/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/Swift4Codegen.java @@ -944,6 +944,12 @@ public String constructExampleCode(CodegenParameter codegenParameter, HashMap Date: Tue, 16 Apr 2019 12:15:57 +0800 Subject: [PATCH 5/9] fix link to object --- .../codegen/languages/Swift4Codegen.java | 8 ++ .../main/resources/swift4/api_doc.mustache | 14 ++-- .../swift4/default/docs/AnotherFakeAPI.md | 2 +- .../petstore/swift4/default/docs/FakeAPI.md | 84 +++++++++---------- .../default/docs/FakeClassnameTags123API.md | 2 +- .../swift4/default/docs/FormatTest.md | 10 +-- ...dPropertiesAndAdditionalPropertiesClass.md | 4 +- .../petstore/swift4/default/docs/Order.md | 2 +- .../petstore/swift4/default/docs/PetAPI.md | 32 +++---- .../petstore/swift4/default/docs/StoreAPI.md | 8 +- .../petstore/swift4/default/docs/UserAPI.md | 18 ++-- 11 files changed, 98 insertions(+), 86 deletions(-) diff --git a/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/Swift4Codegen.java b/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/Swift4Codegen.java index f21c9c9ee391..165ab86f5e58 100644 --- a/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/Swift4Codegen.java +++ b/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/Swift4Codegen.java @@ -94,7 +94,11 @@ public Swift4Codegen() { "Bool", "Void", "String", + "URL", + "Data", + "Date", "Character", + "UUID", "AnyObject", "Any") ); @@ -950,6 +954,8 @@ public String constructExampleCode(CodegenParameter codegenParameter, HashMap Date: Tue, 16 Apr 2019 12:32:16 +0800 Subject: [PATCH 6/9] fix void --- .../codegen/languages/Swift4Codegen.java | 4 ++++ .../src/main/resources/swift4/api_doc.mustache | 2 +- .../src/main/resources/swift4/model_doc.mustache | 2 +- .../default/docs/AdditionalPropertiesClass.md | 2 +- .../default/docs/ArrayOfArrayOfNumberOnly.md | 2 +- .../petstore/swift4/default/docs/ArrayTest.md | 4 ++-- .../client/petstore/swift4/default/docs/FakeAPI.md | 14 +++++++------- .../swift4/default/docs/FileSchemaTestClass.md | 2 +- .../client/petstore/swift4/default/docs/MapTest.md | 2 +- .../MixedPropertiesAndAdditionalPropertiesClass.md | 2 +- samples/client/petstore/swift4/default/docs/Pet.md | 2 +- .../client/petstore/swift4/default/docs/PetAPI.md | 8 ++++---- .../petstore/swift4/default/docs/StoreAPI.md | 2 +- .../client/petstore/swift4/default/docs/UserAPI.md | 12 ++++++------ 14 files changed, 32 insertions(+), 28 deletions(-) diff --git a/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/Swift4Codegen.java b/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/Swift4Codegen.java index 165ab86f5e58..06eaa6f8e716 100644 --- a/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/Swift4Codegen.java +++ b/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/Swift4Codegen.java @@ -954,6 +954,8 @@ public String constructExampleCode(CodegenParameter codegenParameter, HashMap Date: Tue, 16 Apr 2019 12:46:21 +0800 Subject: [PATCH 7/9] fix url initialize --- .../codegen/languages/Swift4Codegen.java | 7 ++--- .../main/resources/swift4/api_doc.mustache | 2 +- .../swift4/default/docs/AnotherFakeAPI.md | 2 +- .../petstore/swift4/default/docs/FakeAPI.md | 26 +++++++++---------- .../default/docs/FakeClassnameTags123API.md | 2 +- .../petstore/swift4/default/docs/PetAPI.md | 22 ++++++++-------- .../petstore/swift4/default/docs/StoreAPI.md | 8 +++--- .../petstore/swift4/default/docs/UserAPI.md | 16 ++++++------ 8 files changed, 43 insertions(+), 42 deletions(-) diff --git a/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/Swift4Codegen.java b/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/Swift4Codegen.java index 06eaa6f8e716..c5b5b97a3659 100644 --- a/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/Swift4Codegen.java +++ b/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/Swift4Codegen.java @@ -99,6 +99,7 @@ public Swift4Codegen() { "Date", "Character", "UUID", + "URL", "AnyObject", "Any") ); @@ -939,7 +940,7 @@ public Map postProcessOperationsWithModels(Map o public String constructExampleCode(CodegenParameter codegenParameter, HashMap modelMaps) { if (codegenParameter.isListContainer) { // array return "[" + constructExampleCode(codegenParameter.items, modelMaps) + "]"; - } else if (codegenParameter.isMapContainer || codegenParameter.isFile) { // TODO: map, file type + } else if (codegenParameter.isMapContainer) { // TODO: map, file type return "\"TODO\""; } else if (languageSpecificPrimitives.contains(codegenParameter.dataType)) { // primitive type if ("String".equals(codegenParameter.dataType) || "Character".equals(codegenParameter.dataType)) { @@ -954,7 +955,7 @@ public String constructExampleCode(CodegenParameter codegenParameter, HashMap modelMaps) { if (codegenProperty.isListContainer) { // array return "[" + constructExampleCode(codegenProperty.items, modelMaps) + "]"; - } else if (codegenProperty.isMapContainer || codegenProperty.isFile) { // TODO: map, file type + } else if (codegenProperty.isMapContainer) { // TODO: map, file type return "\"TODO\""; } else if (languageSpecificPrimitives.contains(codegenProperty.dataType)) { // primitive type if ("String".equals(codegenProperty.dataType) || "Character".equals(codegenProperty.dataType)) { diff --git a/modules/openapi-generator/src/main/resources/swift4/api_doc.mustache b/modules/openapi-generator/src/main/resources/swift4/api_doc.mustache index ac3f8ae056ae..b392c9cf44eb 100644 --- a/modules/openapi-generator/src/main/resources/swift4/api_doc.mustache +++ b/modules/openapi-generator/src/main/resources/swift4/api_doc.mustache @@ -14,7 +14,7 @@ Method | HTTP request | Description ```swift {{^usePromiseKit}} {{^useRxSwift}} - open class func {{operationId}}({{#allParams}}{{paramName}}: {{#isEnum}}{{#isContainer}}{{{dataType}}}{{/isContainer}}{{^isContainer}}{{{datatypeWithEnum}}}_{{operationId}}{{/isContainer}}{{/isEnum}}{{^isEnum}}{{{dataType}}}{{/isEnum}}{{^required}}? = nil{{/required}}{{#hasMore}}, {{/hasMore}}{{/allParams}}{{#hasParams}}, {{/hasParams}}completion: @escaping ((_ data: {{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}Void{{/returnType}}?,_ error: Error?) -> Void)) + open class func {{operationId}}({{#allParams}}{{paramName}}: {{#isEnum}}{{#isContainer}}{{{dataType}}}{{/isContainer}}{{^isContainer}}{{{datatypeWithEnum}}}_{{operationId}}{{/isContainer}}{{/isEnum}}{{^isEnum}}{{{dataType}}}{{/isEnum}}{{^required}}? = nil{{/required}}{{#hasMore}}, {{/hasMore}}{{/allParams}}{{#hasParams}}, {{/hasParams}}completion: @escaping (_ data: {{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}Void{{/returnType}}?, _ error: Error?) -> Void) {{/useRxSwift}} {{/usePromiseKit}} {{#usePromiseKit}} diff --git a/samples/client/petstore/swift4/default/docs/AnotherFakeAPI.md b/samples/client/petstore/swift4/default/docs/AnotherFakeAPI.md index 42987e65b11d..e4228cb018b6 100644 --- a/samples/client/petstore/swift4/default/docs/AnotherFakeAPI.md +++ b/samples/client/petstore/swift4/default/docs/AnotherFakeAPI.md @@ -9,7 +9,7 @@ Method | HTTP request | Description # **call123testSpecialTags** ```swift - open class func call123testSpecialTags(body: Client, completion: @escaping ((_ data: Client?,_ error: Error?) -> Void)) + open class func call123testSpecialTags(body: Client, completion: @escaping (_ data: Client?, _ error: Error?) -> Void) ``` To test special tags diff --git a/samples/client/petstore/swift4/default/docs/FakeAPI.md b/samples/client/petstore/swift4/default/docs/FakeAPI.md index 53d9588d448d..3e96e7830c26 100644 --- a/samples/client/petstore/swift4/default/docs/FakeAPI.md +++ b/samples/client/petstore/swift4/default/docs/FakeAPI.md @@ -20,7 +20,7 @@ Method | HTTP request | Description # **fakeOuterBooleanSerialize** ```swift - open class func fakeOuterBooleanSerialize(body: Bool? = nil, completion: @escaping ((_ data: Bool?,_ error: Error?) -> Void)) + open class func fakeOuterBooleanSerialize(body: Bool? = nil, completion: @escaping (_ data: Bool?, _ error: Error?) -> Void) ``` @@ -69,7 +69,7 @@ No authorization required # **fakeOuterCompositeSerialize** ```swift - open class func fakeOuterCompositeSerialize(body: OuterComposite? = nil, completion: @escaping ((_ data: OuterComposite?,_ error: Error?) -> Void)) + open class func fakeOuterCompositeSerialize(body: OuterComposite? = nil, completion: @escaping (_ data: OuterComposite?, _ error: Error?) -> Void) ``` @@ -118,7 +118,7 @@ No authorization required # **fakeOuterNumberSerialize** ```swift - open class func fakeOuterNumberSerialize(body: Double? = nil, completion: @escaping ((_ data: Double?,_ error: Error?) -> Void)) + open class func fakeOuterNumberSerialize(body: Double? = nil, completion: @escaping (_ data: Double?, _ error: Error?) -> Void) ``` @@ -167,7 +167,7 @@ No authorization required # **fakeOuterStringSerialize** ```swift - open class func fakeOuterStringSerialize(body: String? = nil, completion: @escaping ((_ data: String?,_ error: Error?) -> Void)) + open class func fakeOuterStringSerialize(body: String? = nil, completion: @escaping (_ data: String?, _ error: Error?) -> Void) ``` @@ -216,7 +216,7 @@ No authorization required # **testBodyWithFileSchema** ```swift - open class func testBodyWithFileSchema(body: FileSchemaTestClass, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) + open class func testBodyWithFileSchema(body: FileSchemaTestClass, completion: @escaping (_ data: Void?, _ error: Error?) -> Void) ``` @@ -265,7 +265,7 @@ No authorization required # **testBodyWithQueryParams** ```swift - open class func testBodyWithQueryParams(query: String, body: User, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) + open class func testBodyWithQueryParams(query: String, body: User, completion: @escaping (_ data: Void?, _ error: Error?) -> Void) ``` @@ -314,7 +314,7 @@ No authorization required # **testClientModel** ```swift - open class func testClientModel(body: Client, completion: @escaping ((_ data: Client?,_ error: Error?) -> Void)) + open class func testClientModel(body: Client, completion: @escaping (_ data: Client?, _ error: Error?) -> Void) ``` To test \"client\" model @@ -364,7 +364,7 @@ No authorization required # **testEndpointParameters** ```swift - open class func testEndpointParameters(number: Double, double: Double, patternWithoutDelimiter: String, byte: Data, integer: Int? = nil, int32: Int? = nil, int64: Int64? = nil, float: Float? = nil, string: String? = nil, binary: URL? = nil, date: Date? = nil, dateTime: Date? = nil, password: String? = nil, callback: String? = nil, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) + open class func testEndpointParameters(number: Double, double: Double, patternWithoutDelimiter: String, byte: Data, integer: Int? = nil, int32: Int? = nil, int64: Int64? = nil, float: Float? = nil, string: String? = nil, binary: URL? = nil, date: Date? = nil, dateTime: Date? = nil, password: String? = nil, callback: String? = nil, completion: @escaping (_ data: Void?, _ error: Error?) -> Void) ``` Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 @@ -385,7 +385,7 @@ let int32 = 987 // Int | None (optional) let int64 = 987 // Int64 | None (optional) let float = 987 // Float | None (optional) let string = "string_example" // String | None (optional) -let binary = "TODO" // URL | None (optional) +let binary = URL(string: "https://example.com")! // URL | None (optional) let date = Date() // Date | None (optional) let dateTime = Date() // Date | None (optional) let password = "password_example" // String | None (optional) @@ -440,7 +440,7 @@ Void (empty response body) # **testEnumParameters** ```swift - open class func testEnumParameters(enumHeaderStringArray: [String]? = nil, enumHeaderString: EnumHeaderString_testEnumParameters? = nil, enumQueryStringArray: [String]? = nil, enumQueryString: EnumQueryString_testEnumParameters? = nil, enumQueryInteger: EnumQueryInteger_testEnumParameters? = nil, enumQueryDouble: EnumQueryDouble_testEnumParameters? = nil, enumFormStringArray: [String]? = nil, enumFormString: EnumFormString_testEnumParameters? = nil, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) + open class func testEnumParameters(enumHeaderStringArray: [String]? = nil, enumHeaderString: EnumHeaderString_testEnumParameters? = nil, enumQueryStringArray: [String]? = nil, enumQueryString: EnumQueryString_testEnumParameters? = nil, enumQueryInteger: EnumQueryInteger_testEnumParameters? = nil, enumQueryDouble: EnumQueryDouble_testEnumParameters? = nil, enumFormStringArray: [String]? = nil, enumFormString: EnumFormString_testEnumParameters? = nil, completion: @escaping (_ data: Void?, _ error: Error?) -> Void) ``` To test enum parameters @@ -504,7 +504,7 @@ No authorization required # **testGroupParameters** ```swift - open class func testGroupParameters(requiredStringGroup: Int, requiredBooleanGroup: Bool, requiredInt64Group: Int64, stringGroup: Int? = nil, booleanGroup: Bool? = nil, int64Group: Int64? = nil, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) + open class func testGroupParameters(requiredStringGroup: Int, requiredBooleanGroup: Bool, requiredInt64Group: Int64, stringGroup: Int? = nil, booleanGroup: Bool? = nil, int64Group: Int64? = nil, completion: @escaping (_ data: Void?, _ error: Error?) -> Void) ``` Fake endpoint to test group parameters (optional) @@ -564,7 +564,7 @@ No authorization required # **testInlineAdditionalProperties** ```swift - open class func testInlineAdditionalProperties(param: [String:String], completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) + open class func testInlineAdditionalProperties(param: [String:String], completion: @escaping (_ data: Void?, _ error: Error?) -> Void) ``` test inline additionalProperties @@ -612,7 +612,7 @@ No authorization required # **testJsonFormData** ```swift - open class func testJsonFormData(param: String, param2: String, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) + open class func testJsonFormData(param: String, param2: String, completion: @escaping (_ data: Void?, _ error: Error?) -> Void) ``` test json serialization of form data diff --git a/samples/client/petstore/swift4/default/docs/FakeClassnameTags123API.md b/samples/client/petstore/swift4/default/docs/FakeClassnameTags123API.md index f70565858526..e46333f3454b 100644 --- a/samples/client/petstore/swift4/default/docs/FakeClassnameTags123API.md +++ b/samples/client/petstore/swift4/default/docs/FakeClassnameTags123API.md @@ -9,7 +9,7 @@ Method | HTTP request | Description # **testClassname** ```swift - open class func testClassname(body: Client, completion: @escaping ((_ data: Client?,_ error: Error?) -> Void)) + open class func testClassname(body: Client, completion: @escaping (_ data: Client?, _ error: Error?) -> Void) ``` To test class name in snake case diff --git a/samples/client/petstore/swift4/default/docs/PetAPI.md b/samples/client/petstore/swift4/default/docs/PetAPI.md index 0d8c5a521491..02cb51983a82 100644 --- a/samples/client/petstore/swift4/default/docs/PetAPI.md +++ b/samples/client/petstore/swift4/default/docs/PetAPI.md @@ -17,7 +17,7 @@ Method | HTTP request | Description # **addPet** ```swift - open class func addPet(body: Pet, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) + open class func addPet(body: Pet, completion: @escaping (_ data: Void?, _ error: Error?) -> Void) ``` Add a new pet to the store @@ -65,7 +65,7 @@ Void (empty response body) # **deletePet** ```swift - open class func deletePet(petId: Int64, apiKey: String? = nil, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) + open class func deletePet(petId: Int64, apiKey: String? = nil, completion: @escaping (_ data: Void?, _ error: Error?) -> Void) ``` Deletes a pet @@ -115,7 +115,7 @@ Void (empty response body) # **findPetsByStatus** ```swift - open class func findPetsByStatus(status: [String], completion: @escaping ((_ data: [Pet]?,_ error: Error?) -> Void)) + open class func findPetsByStatus(status: [String], completion: @escaping (_ data: [Pet]?, _ error: Error?) -> Void) ``` Finds Pets by status @@ -165,7 +165,7 @@ Name | Type | Description | Notes # **findPetsByTags** ```swift - open class func findPetsByTags(tags: [String], completion: @escaping ((_ data: [Pet]?,_ error: Error?) -> Void)) + open class func findPetsByTags(tags: [String], completion: @escaping (_ data: [Pet]?, _ error: Error?) -> Void) ``` Finds Pets by tags @@ -215,7 +215,7 @@ Name | Type | Description | Notes # **getPetById** ```swift - open class func getPetById(petId: Int64, completion: @escaping ((_ data: Pet?,_ error: Error?) -> Void)) + open class func getPetById(petId: Int64, completion: @escaping (_ data: Pet?, _ error: Error?) -> Void) ``` Find pet by ID @@ -265,7 +265,7 @@ Name | Type | Description | Notes # **updatePet** ```swift - open class func updatePet(body: Pet, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) + open class func updatePet(body: Pet, completion: @escaping (_ data: Void?, _ error: Error?) -> Void) ``` Update an existing pet @@ -313,7 +313,7 @@ Void (empty response body) # **updatePetWithForm** ```swift - open class func updatePetWithForm(petId: Int64, name: String? = nil, status: String? = nil, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) + open class func updatePetWithForm(petId: Int64, name: String? = nil, status: String? = nil, completion: @escaping (_ data: Void?, _ error: Error?) -> Void) ``` Updates a pet in the store with form data @@ -365,7 +365,7 @@ Void (empty response body) # **uploadFile** ```swift - open class func uploadFile(petId: Int64, additionalMetadata: String? = nil, file: URL? = nil, completion: @escaping ((_ data: ApiResponse?,_ error: Error?) -> Void)) + open class func uploadFile(petId: Int64, additionalMetadata: String? = nil, file: URL? = nil, completion: @escaping (_ data: ApiResponse?, _ error: Error?) -> Void) ``` uploads an image @@ -377,7 +377,7 @@ import PetstoreClient let petId = 987 // Int64 | ID of pet to update let additionalMetadata = "additionalMetadata_example" // String | Additional data to pass to server (optional) -let file = "TODO" // URL | file to upload (optional) +let file = URL(string: "https://example.com")! // URL | file to upload (optional) // uploads an image PetAPI.uploadFile(petId: petId, additionalMetadata: additionalMetadata, file: file) { (response, error) in @@ -417,7 +417,7 @@ Name | Type | Description | Notes # **uploadFileWithRequiredFile** ```swift - open class func uploadFileWithRequiredFile(petId: Int64, requiredFile: URL, additionalMetadata: String? = nil, completion: @escaping ((_ data: ApiResponse?,_ error: Error?) -> Void)) + open class func uploadFileWithRequiredFile(petId: Int64, requiredFile: URL, additionalMetadata: String? = nil, completion: @escaping (_ data: ApiResponse?, _ error: Error?) -> Void) ``` uploads an image (required) @@ -428,7 +428,7 @@ uploads an image (required) import PetstoreClient let petId = 987 // Int64 | ID of pet to update -let requiredFile = "TODO" // URL | file to upload +let requiredFile = URL(string: "https://example.com")! // URL | file to upload let additionalMetadata = "additionalMetadata_example" // String | Additional data to pass to server (optional) // uploads an image (required) diff --git a/samples/client/petstore/swift4/default/docs/StoreAPI.md b/samples/client/petstore/swift4/default/docs/StoreAPI.md index 2eca9ae1bcc1..da5100bbab40 100644 --- a/samples/client/petstore/swift4/default/docs/StoreAPI.md +++ b/samples/client/petstore/swift4/default/docs/StoreAPI.md @@ -12,7 +12,7 @@ Method | HTTP request | Description # **deleteOrder** ```swift - open class func deleteOrder(orderId: String, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) + open class func deleteOrder(orderId: String, completion: @escaping (_ data: Void?, _ error: Error?) -> Void) ``` Delete purchase order by ID @@ -62,7 +62,7 @@ No authorization required # **getInventory** ```swift - open class func getInventory(completion: @escaping ((_ data: [String:Int]?,_ error: Error?) -> Void)) + open class func getInventory(completion: @escaping (_ data: [String:Int]?, _ error: Error?) -> Void) ``` Returns pet inventories by status @@ -108,7 +108,7 @@ This endpoint does not need any parameter. # **getOrderById** ```swift - open class func getOrderById(orderId: Int64, completion: @escaping ((_ data: Order?,_ error: Error?) -> Void)) + open class func getOrderById(orderId: Int64, completion: @escaping (_ data: Order?, _ error: Error?) -> Void) ``` Find purchase order by ID @@ -158,7 +158,7 @@ No authorization required # **placeOrder** ```swift - open class func placeOrder(body: Order, completion: @escaping ((_ data: Order?,_ error: Error?) -> Void)) + open class func placeOrder(body: Order, completion: @escaping (_ data: Order?, _ error: Error?) -> Void) ``` Place an order for a pet diff --git a/samples/client/petstore/swift4/default/docs/UserAPI.md b/samples/client/petstore/swift4/default/docs/UserAPI.md index f7654767afb1..b89e05125571 100644 --- a/samples/client/petstore/swift4/default/docs/UserAPI.md +++ b/samples/client/petstore/swift4/default/docs/UserAPI.md @@ -16,7 +16,7 @@ Method | HTTP request | Description # **createUser** ```swift - open class func createUser(body: User, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) + open class func createUser(body: User, completion: @escaping (_ data: Void?, _ error: Error?) -> Void) ``` Create user @@ -66,7 +66,7 @@ No authorization required # **createUsersWithArrayInput** ```swift - open class func createUsersWithArrayInput(body: [User], completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) + open class func createUsersWithArrayInput(body: [User], completion: @escaping (_ data: Void?, _ error: Error?) -> Void) ``` Creates list of users with given input array @@ -114,7 +114,7 @@ No authorization required # **createUsersWithListInput** ```swift - open class func createUsersWithListInput(body: [User], completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) + open class func createUsersWithListInput(body: [User], completion: @escaping (_ data: Void?, _ error: Error?) -> Void) ``` Creates list of users with given input array @@ -162,7 +162,7 @@ No authorization required # **deleteUser** ```swift - open class func deleteUser(username: String, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) + open class func deleteUser(username: String, completion: @escaping (_ data: Void?, _ error: Error?) -> Void) ``` Delete user @@ -212,7 +212,7 @@ No authorization required # **getUserByName** ```swift - open class func getUserByName(username: String, completion: @escaping ((_ data: User?,_ error: Error?) -> Void)) + open class func getUserByName(username: String, completion: @escaping (_ data: User?, _ error: Error?) -> Void) ``` Get user by user name @@ -260,7 +260,7 @@ No authorization required # **loginUser** ```swift - open class func loginUser(username: String, password: String, completion: @escaping ((_ data: String?,_ error: Error?) -> Void)) + open class func loginUser(username: String, password: String, completion: @escaping (_ data: String?, _ error: Error?) -> Void) ``` Logs user into the system @@ -310,7 +310,7 @@ No authorization required # **logoutUser** ```swift - open class func logoutUser(completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) + open class func logoutUser(completion: @escaping (_ data: Void?, _ error: Error?) -> Void) ``` Logs out current logged in user session @@ -354,7 +354,7 @@ No authorization required # **updateUser** ```swift - open class func updateUser(username: String, body: User, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) + open class func updateUser(username: String, body: User, completion: @escaping (_ data: Void?, _ error: Error?) -> Void) ``` Updated user From 718b729488dbf22215b56195e3e7acf0e0cdf5f5 Mon Sep 17 00:00:00 2001 From: William Cheng Date: Tue, 16 Apr 2019 12:46:58 +0800 Subject: [PATCH 8/9] update all swift samples --- .../docs/AdditionalPropertiesClass.md | 8 +- .../objcCompatible/docs/AnotherFakeAPI.md | 4 +- .../docs/ArrayOfArrayOfNumberOnly.md | 2 +- .../swift4/objcCompatible/docs/ArrayTest.md | 4 +- .../swift4/objcCompatible/docs/FakeAPI.md | 140 +++++++++--------- .../docs/FakeClassnameTags123API.md | 4 +- .../docs/FileSchemaTestClass.md | 2 +- .../swift4/objcCompatible/docs/FormatTest.md | 10 +- .../swift4/objcCompatible/docs/MapTest.md | 2 +- ...dPropertiesAndAdditionalPropertiesClass.md | 6 +- .../swift4/objcCompatible/docs/Order.md | 2 +- .../swift4/objcCompatible/docs/Pet.md | 2 +- .../swift4/objcCompatible/docs/PetAPI.md | 62 ++++---- .../swift4/objcCompatible/docs/StoreAPI.md | 18 +-- .../swift4/objcCompatible/docs/UserAPI.md | 46 +++--- .../docs/AdditionalPropertiesClass.md | 2 +- .../swift4/promisekit/docs/AnotherFakeAPI.md | 2 +- .../docs/ArrayOfArrayOfNumberOnly.md | 2 +- .../swift4/promisekit/docs/ArrayTest.md | 4 +- .../swift4/promisekit/docs/FakeAPI.md | 108 +++++++------- .../docs/FakeClassnameTags123API.md | 2 +- .../promisekit/docs/FileSchemaTestClass.md | 2 +- .../swift4/promisekit/docs/FormatTest.md | 10 +- .../swift4/promisekit/docs/MapTest.md | 2 +- ...dPropertiesAndAdditionalPropertiesClass.md | 6 +- .../petstore/swift4/promisekit/docs/Order.md | 2 +- .../petstore/swift4/promisekit/docs/Pet.md | 2 +- .../petstore/swift4/promisekit/docs/PetAPI.md | 44 +++--- .../swift4/promisekit/docs/StoreAPI.md | 10 +- .../swift4/promisekit/docs/UserAPI.md | 30 ++-- .../rxswift/docs/AdditionalPropertiesClass.md | 2 +- .../swift4/rxswift/docs/AnotherFakeAPI.md | 2 +- .../rxswift/docs/ArrayOfArrayOfNumberOnly.md | 2 +- .../petstore/swift4/rxswift/docs/ArrayTest.md | 4 +- .../petstore/swift4/rxswift/docs/FakeAPI.md | 108 +++++++------- .../rxswift/docs/FakeClassnameTags123API.md | 2 +- .../rxswift/docs/FileSchemaTestClass.md | 2 +- .../swift4/rxswift/docs/FormatTest.md | 10 +- .../petstore/swift4/rxswift/docs/MapTest.md | 2 +- ...dPropertiesAndAdditionalPropertiesClass.md | 6 +- .../petstore/swift4/rxswift/docs/Order.md | 2 +- .../petstore/swift4/rxswift/docs/Pet.md | 2 +- .../petstore/swift4/rxswift/docs/PetAPI.md | 44 +++--- .../petstore/swift4/rxswift/docs/StoreAPI.md | 10 +- .../petstore/swift4/rxswift/docs/UserAPI.md | 30 ++-- .../docs/AdditionalPropertiesClass.md | 2 +- .../unwrapRequired/docs/AnotherFakeAPI.md | 4 +- .../docs/ArrayOfArrayOfNumberOnly.md | 2 +- .../swift4/unwrapRequired/docs/ArrayTest.md | 4 +- .../swift4/unwrapRequired/docs/FakeAPI.md | 132 ++++++++--------- .../docs/FakeClassnameTags123API.md | 4 +- .../docs/FileSchemaTestClass.md | 2 +- .../swift4/unwrapRequired/docs/FormatTest.md | 10 +- .../swift4/unwrapRequired/docs/MapTest.md | 2 +- ...dPropertiesAndAdditionalPropertiesClass.md | 6 +- .../swift4/unwrapRequired/docs/Order.md | 2 +- .../swift4/unwrapRequired/docs/Pet.md | 2 +- .../swift4/unwrapRequired/docs/PetAPI.md | 62 ++++---- .../swift4/unwrapRequired/docs/StoreAPI.md | 18 +-- .../swift4/unwrapRequired/docs/UserAPI.md | 46 +++--- 60 files changed, 533 insertions(+), 533 deletions(-) diff --git a/samples/client/petstore/swift4/objcCompatible/docs/AdditionalPropertiesClass.md b/samples/client/petstore/swift4/objcCompatible/docs/AdditionalPropertiesClass.md index 75fe1fcc137a..f7fbe1ab7969 100644 --- a/samples/client/petstore/swift4/objcCompatible/docs/AdditionalPropertiesClass.md +++ b/samples/client/petstore/swift4/objcCompatible/docs/AdditionalPropertiesClass.md @@ -7,10 +7,10 @@ Name | Type | Description | Notes **mapNumber** | **[String:Double]** | | [optional] **mapInteger** | **[String:Int]** | | [optional] **mapBoolean** | **[String:Bool]** | | [optional] -**mapArrayInteger** | [**[String:[Int]]**](Array.md) | | [optional] -**mapArrayAnytype** | [**[String:[Any]]**](Array.md) | | [optional] -**mapMapString** | [**[String:[String:String]]**](Dictionary.md) | | [optional] -**mapMapAnytype** | [**[String:[String:Any]]**](Dictionary.md) | | [optional] +**mapArrayInteger** | [String:[Int]] | | [optional] +**mapArrayAnytype** | [String:[Any]] | | [optional] +**mapMapString** | [String:[String:String]] | | [optional] +**mapMapAnytype** | [String:[String:Any]] | | [optional] **anytype1** | [**Any**](.md) | | [optional] **anytype2** | [**Any**](.md) | | [optional] **anytype3** | [**Any**](.md) | | [optional] diff --git a/samples/client/petstore/swift4/objcCompatible/docs/AnotherFakeAPI.md b/samples/client/petstore/swift4/objcCompatible/docs/AnotherFakeAPI.md index e6a8f62dfa75..e4228cb018b6 100644 --- a/samples/client/petstore/swift4/objcCompatible/docs/AnotherFakeAPI.md +++ b/samples/client/petstore/swift4/objcCompatible/docs/AnotherFakeAPI.md @@ -9,7 +9,7 @@ Method | HTTP request | Description # **call123testSpecialTags** ```swift - open class func call123testSpecialTags(body: Client, completion: @escaping ((_ data: Client?,_ error: Error?) -> Void)) + open class func call123testSpecialTags(body: Client, completion: @escaping (_ data: Client?, _ error: Error?) -> Void) ``` To test special tags @@ -40,7 +40,7 @@ AnotherFakeAPI.call123testSpecialTags(body: body) { (response, error) in Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**Client**](Client.md)| client model | + **body** | [**Client**](Client.md) | client model | ### Return type diff --git a/samples/client/petstore/swift4/objcCompatible/docs/ArrayOfArrayOfNumberOnly.md b/samples/client/petstore/swift4/objcCompatible/docs/ArrayOfArrayOfNumberOnly.md index 3f78a9584d82..c6fceff5e08d 100644 --- a/samples/client/petstore/swift4/objcCompatible/docs/ArrayOfArrayOfNumberOnly.md +++ b/samples/client/petstore/swift4/objcCompatible/docs/ArrayOfArrayOfNumberOnly.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**arrayArrayNumber** | [**[[Double]]**](Array.md) | | [optional] +**arrayArrayNumber** | [[Double]] | | [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) diff --git a/samples/client/petstore/swift4/objcCompatible/docs/ArrayTest.md b/samples/client/petstore/swift4/objcCompatible/docs/ArrayTest.md index dd9be9d5876b..bf416b8330cc 100644 --- a/samples/client/petstore/swift4/objcCompatible/docs/ArrayTest.md +++ b/samples/client/petstore/swift4/objcCompatible/docs/ArrayTest.md @@ -4,8 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayOfString** | **[String]** | | [optional] -**arrayArrayOfInteger** | [**[[Int64]]**](Array.md) | | [optional] -**arrayArrayOfModel** | [**[[ReadOnlyFirst]]**](Array.md) | | [optional] +**arrayArrayOfInteger** | [[Int64]] | | [optional] +**arrayArrayOfModel** | [[ReadOnlyFirst]] | | [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) diff --git a/samples/client/petstore/swift4/objcCompatible/docs/FakeAPI.md b/samples/client/petstore/swift4/objcCompatible/docs/FakeAPI.md index b14e935c0ea7..7bc4275361b5 100644 --- a/samples/client/petstore/swift4/objcCompatible/docs/FakeAPI.md +++ b/samples/client/petstore/swift4/objcCompatible/docs/FakeAPI.md @@ -21,7 +21,7 @@ Method | HTTP request | Description # **createXmlItem** ```swift - open class func createXmlItem(xmlItem: XmlItem, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) + open class func createXmlItem(xmlItem: XmlItem, completion: @escaping (_ data: Void?, _ error: Error?) -> Void) ``` creates an XmlItem @@ -33,7 +33,7 @@ this route creates an XmlItem // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let xmlItem = XmlItem(attributeString: "attributeString_example", attributeNumber: 123, attributeInteger: 123, attributeBoolean: 123, wrappedArray: [123], nameString: "nameString_example", nameNumber: 123, nameInteger: 123, nameBoolean: 123, nameArray: [123], nameWrappedArray: [123], prefixString: "prefixString_example", prefixNumber: 123, prefixInteger: 123, prefixBoolean: 123, prefixArray: [123], prefixWrappedArray: [123], namespaceString: "namespaceString_example", namespaceNumber: 123, namespaceInteger: 123, namespaceBoolean: 123, namespaceArray: [123], namespaceWrappedArray: [123], prefixNsString: "prefixNsString_example", prefixNsNumber: 123, prefixNsInteger: 123, prefixNsBoolean: 123, prefixNsArray: [123], prefixNsWrappedArray: [123]) // XmlItem | XmlItem Body +let xmlItem = XmlItem(attributeString: "attributeString_example", attributeNumber: 123, attributeInteger: 123, attributeBoolean: false, wrappedArray: [123], nameString: "nameString_example", nameNumber: 123, nameInteger: 123, nameBoolean: false, nameArray: [123], nameWrappedArray: [123], prefixString: "prefixString_example", prefixNumber: 123, prefixInteger: 123, prefixBoolean: false, prefixArray: [123], prefixWrappedArray: [123], namespaceString: "namespaceString_example", namespaceNumber: 123, namespaceInteger: 123, namespaceBoolean: false, namespaceArray: [123], namespaceWrappedArray: [123], prefixNsString: "prefixNsString_example", prefixNsNumber: 123, prefixNsInteger: 123, prefixNsBoolean: false, prefixNsArray: [123], prefixNsWrappedArray: [123]) // XmlItem | XmlItem Body // creates an XmlItem FakeAPI.createXmlItem(xmlItem: xmlItem) { (response, error) in @@ -52,11 +52,11 @@ FakeAPI.createXmlItem(xmlItem: xmlItem) { (response, error) in Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **xmlItem** | [**XmlItem**](XmlItem.md)| XmlItem Body | + **xmlItem** | [**XmlItem**](XmlItem.md) | XmlItem Body | ### Return type -void (empty response body) +Void (empty response body) ### Authorization @@ -71,7 +71,7 @@ No authorization required # **fakeOuterBooleanSerialize** ```swift - open class func fakeOuterBooleanSerialize(body: Bool? = nil, completion: @escaping ((_ data: Bool?,_ error: Error?) -> Void)) + open class func fakeOuterBooleanSerialize(body: Bool? = nil, completion: @escaping (_ data: Bool?, _ error: Error?) -> Void) ``` @@ -83,7 +83,7 @@ Test serialization of outer boolean types // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = 987 // Bool | Input boolean as post body (optional) +let body = false // Bool | Input boolean as post body (optional) FakeAPI.fakeOuterBooleanSerialize(body: body) { (response, error) in guard error == nil else { @@ -101,7 +101,7 @@ FakeAPI.fakeOuterBooleanSerialize(body: body) { (response, error) in Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | **Bool**| Input boolean as post body | [optional] + **body** | **Bool** | Input boolean as post body | [optional] ### Return type @@ -120,7 +120,7 @@ No authorization required # **fakeOuterCompositeSerialize** ```swift - open class func fakeOuterCompositeSerialize(body: OuterComposite? = nil, completion: @escaping ((_ data: OuterComposite?,_ error: Error?) -> Void)) + open class func fakeOuterCompositeSerialize(body: OuterComposite? = nil, completion: @escaping (_ data: OuterComposite?, _ error: Error?) -> Void) ``` @@ -132,7 +132,7 @@ Test serialization of object with outer number type // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = OuterComposite(myNumber: 123, myString: "myString_example", myBoolean: 123) // OuterComposite | Input composite as post body (optional) +let body = OuterComposite(myNumber: 123, myString: "myString_example", myBoolean: false) // OuterComposite | Input composite as post body (optional) FakeAPI.fakeOuterCompositeSerialize(body: body) { (response, error) in guard error == nil else { @@ -150,7 +150,7 @@ FakeAPI.fakeOuterCompositeSerialize(body: body) { (response, error) in Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**OuterComposite**](OuterComposite.md)| Input composite as post body | [optional] + **body** | [**OuterComposite**](OuterComposite.md) | Input composite as post body | [optional] ### Return type @@ -169,7 +169,7 @@ No authorization required # **fakeOuterNumberSerialize** ```swift - open class func fakeOuterNumberSerialize(body: Double? = nil, completion: @escaping ((_ data: Double?,_ error: Error?) -> Void)) + open class func fakeOuterNumberSerialize(body: Double? = nil, completion: @escaping (_ data: Double?, _ error: Error?) -> Void) ``` @@ -199,7 +199,7 @@ FakeAPI.fakeOuterNumberSerialize(body: body) { (response, error) in Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | **Double**| Input number as post body | [optional] + **body** | **Double** | Input number as post body | [optional] ### Return type @@ -218,7 +218,7 @@ No authorization required # **fakeOuterStringSerialize** ```swift - open class func fakeOuterStringSerialize(body: String? = nil, completion: @escaping ((_ data: String?,_ error: Error?) -> Void)) + open class func fakeOuterStringSerialize(body: String? = nil, completion: @escaping (_ data: String?, _ error: Error?) -> Void) ``` @@ -248,7 +248,7 @@ FakeAPI.fakeOuterStringSerialize(body: body) { (response, error) in Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | **String**| Input string as post body | [optional] + **body** | **String** | Input string as post body | [optional] ### Return type @@ -267,7 +267,7 @@ No authorization required # **testBodyWithFileSchema** ```swift - open class func testBodyWithFileSchema(body: FileSchemaTestClass, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) + open class func testBodyWithFileSchema(body: FileSchemaTestClass, completion: @escaping (_ data: Void?, _ error: Error?) -> Void) ``` @@ -297,11 +297,11 @@ FakeAPI.testBodyWithFileSchema(body: body) { (response, error) in Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**FileSchemaTestClass**](FileSchemaTestClass.md)| | + **body** | [**FileSchemaTestClass**](FileSchemaTestClass.md) | | ### Return type -void (empty response body) +Void (empty response body) ### Authorization @@ -316,7 +316,7 @@ No authorization required # **testBodyWithQueryParams** ```swift - open class func testBodyWithQueryParams(query: String, body: User, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) + open class func testBodyWithQueryParams(query: String, body: User, completion: @escaping (_ data: Void?, _ error: Error?) -> Void) ``` @@ -345,12 +345,12 @@ FakeAPI.testBodyWithQueryParams(query: query, body: body) { (response, error) in Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **query** | **String**| | - **body** | [**User**](User.md)| | + **query** | **String** | | + **body** | [**User**](User.md) | | ### Return type -void (empty response body) +Void (empty response body) ### Authorization @@ -365,7 +365,7 @@ No authorization required # **testClientModel** ```swift - open class func testClientModel(body: Client, completion: @escaping ((_ data: Client?,_ error: Error?) -> Void)) + open class func testClientModel(body: Client, completion: @escaping (_ data: Client?, _ error: Error?) -> Void) ``` To test \"client\" model @@ -396,7 +396,7 @@ FakeAPI.testClientModel(body: body) { (response, error) in Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**Client**](Client.md)| client model | + **body** | [**Client**](Client.md) | client model | ### Return type @@ -415,7 +415,7 @@ No authorization required # **testEndpointParameters** ```swift - open class func testEndpointParameters(number: Double, double: Double, patternWithoutDelimiter: String, byte: Data, integer: Int? = nil, int32: Int? = nil, int64: Int64? = nil, float: Float? = nil, string: String? = nil, binary: URL? = nil, date: Date? = nil, dateTime: Date? = nil, password: String? = nil, callback: String? = nil, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) + open class func testEndpointParameters(number: Double, double: Double, patternWithoutDelimiter: String, byte: Data, integer: Int? = nil, int32: Int? = nil, int64: Int64? = nil, float: Float? = nil, string: String? = nil, binary: URL? = nil, date: Date? = nil, dateTime: Date? = nil, password: String? = nil, callback: String? = nil, completion: @escaping (_ data: Void?, _ error: Error?) -> Void) ``` Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 @@ -430,15 +430,15 @@ import PetstoreClient let number = 987 // Double | None let double = 987 // Double | None let patternWithoutDelimiter = "patternWithoutDelimiter_example" // String | None -let byte = TODO // Data | None +let byte = 987 // Data | None let integer = 987 // Int | None (optional) let int32 = 987 // Int | None (optional) let int64 = 987 // Int64 | None (optional) let float = 987 // Float | None (optional) let string = "string_example" // String | None (optional) -let binary = "TODO" // URL | None (optional) -let date = TODO // Date | None (optional) -let dateTime = TODO // Date | None (optional) +let binary = URL(string: "https://example.com")! // URL | None (optional) +let date = Date() // Date | None (optional) +let dateTime = Date() // Date | None (optional) let password = "password_example" // String | None (optional) let callback = "callback_example" // String | None (optional) @@ -459,24 +459,24 @@ FakeAPI.testEndpointParameters(number: number, double: double, patternWithoutDel Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **number** | **Double**| None | - **double** | **Double**| None | - **patternWithoutDelimiter** | **String**| None | - **byte** | **Data**| None | - **integer** | **Int**| None | [optional] - **int32** | **Int**| None | [optional] - **int64** | **Int64**| None | [optional] - **float** | **Float**| None | [optional] - **string** | **String**| None | [optional] - **binary** | **URL****URL**| None | [optional] - **date** | **Date**| None | [optional] - **dateTime** | **Date**| None | [optional] - **password** | **String**| None | [optional] - **callback** | **String**| None | [optional] + **number** | **Double** | None | + **double** | **Double** | None | + **patternWithoutDelimiter** | **String** | None | + **byte** | **Data** | None | + **integer** | **Int** | None | [optional] + **int32** | **Int** | None | [optional] + **int64** | **Int64** | None | [optional] + **float** | **Float** | None | [optional] + **string** | **String** | None | [optional] + **binary** | **URL** | None | [optional] + **date** | **Date** | None | [optional] + **dateTime** | **Date** | None | [optional] + **password** | **String** | None | [optional] + **callback** | **String** | None | [optional] ### Return type -void (empty response body) +Void (empty response body) ### Authorization @@ -491,7 +491,7 @@ void (empty response body) # **testEnumParameters** ```swift - open class func testEnumParameters(enumHeaderStringArray: [String]? = nil, enumHeaderString: EnumHeaderString_testEnumParameters? = nil, enumQueryStringArray: [String]? = nil, enumQueryString: EnumQueryString_testEnumParameters? = nil, enumQueryInteger: EnumQueryInteger_testEnumParameters? = nil, enumQueryDouble: EnumQueryDouble_testEnumParameters? = nil, enumFormStringArray: [String]? = nil, enumFormString: EnumFormString_testEnumParameters? = nil, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) + open class func testEnumParameters(enumHeaderStringArray: [String]? = nil, enumHeaderString: EnumHeaderString_testEnumParameters? = nil, enumQueryStringArray: [String]? = nil, enumQueryString: EnumQueryString_testEnumParameters? = nil, enumQueryInteger: EnumQueryInteger_testEnumParameters? = nil, enumQueryDouble: EnumQueryDouble_testEnumParameters? = nil, enumFormStringArray: [String]? = nil, enumFormString: EnumFormString_testEnumParameters? = nil, completion: @escaping (_ data: Void?, _ error: Error?) -> Void) ``` To test enum parameters @@ -529,18 +529,18 @@ FakeAPI.testEnumParameters(enumHeaderStringArray: enumHeaderStringArray, enumHea Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **enumHeaderStringArray** | [**[String]**](String.md)| Header parameter enum test (string array) | [optional] - **enumHeaderString** | **String**| Header parameter enum test (string) | [optional] [default to .-efg] - **enumQueryStringArray** | [**[String]**](String.md)| Query parameter enum test (string array) | [optional] - **enumQueryString** | **String**| Query parameter enum test (string) | [optional] [default to .-efg] - **enumQueryInteger** | **Int**| Query parameter enum test (double) | [optional] - **enumQueryDouble** | **Double**| Query parameter enum test (double) | [optional] - **enumFormStringArray** | [**[String]**](String.md)| Form parameter enum test (string array) | [optional] [default to .$] - **enumFormString** | **String**| Form parameter enum test (string) | [optional] [default to .-efg] + **enumHeaderStringArray** | [**[String]**](String.md) | Header parameter enum test (string array) | [optional] + **enumHeaderString** | **String** | Header parameter enum test (string) | [optional] [default to .-efg] + **enumQueryStringArray** | [**[String]**](String.md) | Query parameter enum test (string array) | [optional] + **enumQueryString** | **String** | Query parameter enum test (string) | [optional] [default to .-efg] + **enumQueryInteger** | **Int** | Query parameter enum test (double) | [optional] + **enumQueryDouble** | **Double** | Query parameter enum test (double) | [optional] + **enumFormStringArray** | [**[String]**](String.md) | Form parameter enum test (string array) | [optional] [default to .$] + **enumFormString** | **String** | Form parameter enum test (string) | [optional] [default to .-efg] ### Return type -void (empty response body) +Void (empty response body) ### Authorization @@ -555,7 +555,7 @@ No authorization required # **testGroupParameters** ```swift - open class func testGroupParameters(requiredStringGroup: Int, requiredBooleanGroup: Bool, requiredInt64Group: Int64, stringGroup: Int? = nil, booleanGroup: Bool? = nil, int64Group: Int64? = nil, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) + open class func testGroupParameters(requiredStringGroup: Int, requiredBooleanGroup: Bool, requiredInt64Group: Int64, stringGroup: Int? = nil, booleanGroup: Bool? = nil, int64Group: Int64? = nil, completion: @escaping (_ data: Void?, _ error: Error?) -> Void) ``` Fake endpoint to test group parameters (optional) @@ -568,10 +568,10 @@ Fake endpoint to test group parameters (optional) import PetstoreClient let requiredStringGroup = 987 // Int | Required String in group parameters -let requiredBooleanGroup = 987 // Bool | Required Boolean in group parameters +let requiredBooleanGroup = false // Bool | Required Boolean in group parameters let requiredInt64Group = 987 // Int64 | Required Integer in group parameters let stringGroup = 987 // Int | String in group parameters (optional) -let booleanGroup = 987 // Bool | Boolean in group parameters (optional) +let booleanGroup = false // Bool | Boolean in group parameters (optional) let int64Group = 987 // Int64 | Integer in group parameters (optional) // Fake endpoint to test group parameters (optional) @@ -591,16 +591,16 @@ FakeAPI.testGroupParameters(requiredStringGroup: requiredStringGroup, requiredBo Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **requiredStringGroup** | **Int**| Required String in group parameters | - **requiredBooleanGroup** | **Bool**| Required Boolean in group parameters | - **requiredInt64Group** | **Int64**| Required Integer in group parameters | - **stringGroup** | **Int**| String in group parameters | [optional] - **booleanGroup** | **Bool**| Boolean in group parameters | [optional] - **int64Group** | **Int64**| Integer in group parameters | [optional] + **requiredStringGroup** | **Int** | Required String in group parameters | + **requiredBooleanGroup** | **Bool** | Required Boolean in group parameters | + **requiredInt64Group** | **Int64** | Required Integer in group parameters | + **stringGroup** | **Int** | String in group parameters | [optional] + **booleanGroup** | **Bool** | Boolean in group parameters | [optional] + **int64Group** | **Int64** | Integer in group parameters | [optional] ### Return type -void (empty response body) +Void (empty response body) ### Authorization @@ -615,7 +615,7 @@ No authorization required # **testInlineAdditionalProperties** ```swift - open class func testInlineAdditionalProperties(param: [String:String], completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) + open class func testInlineAdditionalProperties(param: [String:String], completion: @escaping (_ data: Void?, _ error: Error?) -> Void) ``` test inline additionalProperties @@ -644,11 +644,11 @@ FakeAPI.testInlineAdditionalProperties(param: param) { (response, error) in Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **param** | [**[String:String]**](String.md)| request body | + **param** | [**[String:String]**](String.md) | request body | ### Return type -void (empty response body) +Void (empty response body) ### Authorization @@ -663,7 +663,7 @@ No authorization required # **testJsonFormData** ```swift - open class func testJsonFormData(param: String, param2: String, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) + open class func testJsonFormData(param: String, param2: String, completion: @escaping (_ data: Void?, _ error: Error?) -> Void) ``` test json serialization of form data @@ -693,12 +693,12 @@ FakeAPI.testJsonFormData(param: param, param2: param2) { (response, error) in Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **param** | **String**| field1 | - **param2** | **String**| field2 | + **param** | **String** | field1 | + **param2** | **String** | field2 | ### Return type -void (empty response body) +Void (empty response body) ### Authorization diff --git a/samples/client/petstore/swift4/objcCompatible/docs/FakeClassnameTags123API.md b/samples/client/petstore/swift4/objcCompatible/docs/FakeClassnameTags123API.md index 704dacda40de..e46333f3454b 100644 --- a/samples/client/petstore/swift4/objcCompatible/docs/FakeClassnameTags123API.md +++ b/samples/client/petstore/swift4/objcCompatible/docs/FakeClassnameTags123API.md @@ -9,7 +9,7 @@ Method | HTTP request | Description # **testClassname** ```swift - open class func testClassname(body: Client, completion: @escaping ((_ data: Client?,_ error: Error?) -> Void)) + open class func testClassname(body: Client, completion: @escaping (_ data: Client?, _ error: Error?) -> Void) ``` To test class name in snake case @@ -40,7 +40,7 @@ FakeClassnameTags123API.testClassname(body: body) { (response, error) in Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**Client**](Client.md)| client model | + **body** | [**Client**](Client.md) | client model | ### Return type diff --git a/samples/client/petstore/swift4/objcCompatible/docs/FileSchemaTestClass.md b/samples/client/petstore/swift4/objcCompatible/docs/FileSchemaTestClass.md index d0a8bbaaba95..afdacc60b2c3 100644 --- a/samples/client/petstore/swift4/objcCompatible/docs/FileSchemaTestClass.md +++ b/samples/client/petstore/swift4/objcCompatible/docs/FileSchemaTestClass.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **file** | [**File**](File.md) | | [optional] -**files** | [**[File]**](File.md) | | [optional] +**files** | [File] | | [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) diff --git a/samples/client/petstore/swift4/objcCompatible/docs/FormatTest.md b/samples/client/petstore/swift4/objcCompatible/docs/FormatTest.md index 547eb88754f4..f74d94f6c46a 100644 --- a/samples/client/petstore/swift4/objcCompatible/docs/FormatTest.md +++ b/samples/client/petstore/swift4/objcCompatible/docs/FormatTest.md @@ -10,11 +10,11 @@ Name | Type | Description | Notes **float** | **Float** | | [optional] **double** | **Double** | | [optional] **string** | **String** | | [optional] -**byte** | [**Data**](Data.md) | | -**binary** | [**URL**](URL.md) | | [optional] -**date** | [**Date**](Date.md) | | -**dateTime** | [**Date**](Date.md) | | [optional] -**uuid** | [**UUID**](UUID.md) | | [optional] +**byte** | **Data** | | +**binary** | **URL** | | [optional] +**date** | **Date** | | +**dateTime** | **Date** | | [optional] +**uuid** | **UUID** | | [optional] **password** | **String** | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/samples/client/petstore/swift4/objcCompatible/docs/MapTest.md b/samples/client/petstore/swift4/objcCompatible/docs/MapTest.md index ecd9c5f5e8b4..664861c03fd8 100644 --- a/samples/client/petstore/swift4/objcCompatible/docs/MapTest.md +++ b/samples/client/petstore/swift4/objcCompatible/docs/MapTest.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**mapMapOfString** | [**[String:[String:String]]**](Dictionary.md) | | [optional] +**mapMapOfString** | [String:[String:String]] | | [optional] **mapOfEnumString** | **[String:String]** | | [optional] **directMap** | **[String:Bool]** | | [optional] **indirectMap** | **[String:Bool]** | | [optional] diff --git a/samples/client/petstore/swift4/objcCompatible/docs/MixedPropertiesAndAdditionalPropertiesClass.md b/samples/client/petstore/swift4/objcCompatible/docs/MixedPropertiesAndAdditionalPropertiesClass.md index 2c502eace42c..fcffb8ecdbf3 100644 --- a/samples/client/petstore/swift4/objcCompatible/docs/MixedPropertiesAndAdditionalPropertiesClass.md +++ b/samples/client/petstore/swift4/objcCompatible/docs/MixedPropertiesAndAdditionalPropertiesClass.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**uuid** | [**UUID**](UUID.md) | | [optional] -**dateTime** | [**Date**](Date.md) | | [optional] -**map** | [**[String:Animal]**](Animal.md) | | [optional] +**uuid** | **UUID** | | [optional] +**dateTime** | **Date** | | [optional] +**map** | [String:Animal] | | [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) diff --git a/samples/client/petstore/swift4/objcCompatible/docs/Order.md b/samples/client/petstore/swift4/objcCompatible/docs/Order.md index 16950a5f7aed..006916ec7411 100644 --- a/samples/client/petstore/swift4/objcCompatible/docs/Order.md +++ b/samples/client/petstore/swift4/objcCompatible/docs/Order.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes **_id** | **Int64** | | [optional] **petId** | **Int64** | | [optional] **quantity** | **Int** | | [optional] -**shipDate** | [**Date**](Date.md) | | [optional] +**shipDate** | **Date** | | [optional] **status** | **String** | Order Status | [optional] **complete** | **Bool** | | [optional] [default to false] diff --git a/samples/client/petstore/swift4/objcCompatible/docs/Pet.md b/samples/client/petstore/swift4/objcCompatible/docs/Pet.md index 916dae0d4366..26c07cc4ba73 100644 --- a/samples/client/petstore/swift4/objcCompatible/docs/Pet.md +++ b/samples/client/petstore/swift4/objcCompatible/docs/Pet.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes **category** | [**Category**](Category.md) | | [optional] **name** | **String** | | **photoUrls** | **[String]** | | -**tags** | [**[Tag]**](Tag.md) | | [optional] +**tags** | [Tag] | | [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) diff --git a/samples/client/petstore/swift4/objcCompatible/docs/PetAPI.md b/samples/client/petstore/swift4/objcCompatible/docs/PetAPI.md index 39413b693254..dcdb2886ccfb 100644 --- a/samples/client/petstore/swift4/objcCompatible/docs/PetAPI.md +++ b/samples/client/petstore/swift4/objcCompatible/docs/PetAPI.md @@ -17,7 +17,7 @@ Method | HTTP request | Description # **addPet** ```swift - open class func addPet(body: Pet, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) + open class func addPet(body: Pet, completion: @escaping (_ data: Void?, _ error: Error?) -> Void) ``` Add a new pet to the store @@ -46,11 +46,11 @@ PetAPI.addPet(body: body) { (response, error) in Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | + **body** | [**Pet**](Pet.md) | Pet object that needs to be added to the store | ### Return type -void (empty response body) +Void (empty response body) ### Authorization @@ -65,7 +65,7 @@ void (empty response body) # **deletePet** ```swift - open class func deletePet(petId: Int64, apiKey: String? = nil, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) + open class func deletePet(petId: Int64, apiKey: String? = nil, completion: @escaping (_ data: Void?, _ error: Error?) -> Void) ``` Deletes a pet @@ -95,12 +95,12 @@ PetAPI.deletePet(petId: petId, apiKey: apiKey) { (response, error) in Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **petId** | **Int64**| Pet id to delete | - **apiKey** | **String**| | [optional] + **petId** | **Int64** | Pet id to delete | + **apiKey** | **String** | | [optional] ### Return type -void (empty response body) +Void (empty response body) ### Authorization @@ -115,7 +115,7 @@ void (empty response body) # **findPetsByStatus** ```swift - open class func findPetsByStatus(status: [String], completion: @escaping ((_ data: [Pet]?,_ error: Error?) -> Void)) + open class func findPetsByStatus(status: [String], completion: @escaping (_ data: [Pet]?, _ error: Error?) -> Void) ``` Finds Pets by status @@ -146,7 +146,7 @@ PetAPI.findPetsByStatus(status: status) { (response, error) in Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **status** | [**[String]**](String.md)| Status values that need to be considered for filter | + **status** | [**[String]**](String.md) | Status values that need to be considered for filter | ### Return type @@ -165,7 +165,7 @@ Name | Type | Description | Notes # **findPetsByTags** ```swift - open class func findPetsByTags(tags: [String], completion: @escaping ((_ data: [Pet]?,_ error: Error?) -> Void)) + open class func findPetsByTags(tags: [String], completion: @escaping (_ data: [Pet]?, _ error: Error?) -> Void) ``` Finds Pets by tags @@ -196,7 +196,7 @@ PetAPI.findPetsByTags(tags: tags) { (response, error) in Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **tags** | [**[String]**](String.md)| Tags to filter by | + **tags** | [**[String]**](String.md) | Tags to filter by | ### Return type @@ -215,7 +215,7 @@ Name | Type | Description | Notes # **getPetById** ```swift - open class func getPetById(petId: Int64, completion: @escaping ((_ data: Pet?,_ error: Error?) -> Void)) + open class func getPetById(petId: Int64, completion: @escaping (_ data: Pet?, _ error: Error?) -> Void) ``` Find pet by ID @@ -246,7 +246,7 @@ PetAPI.getPetById(petId: petId) { (response, error) in Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **petId** | **Int64**| ID of pet to return | + **petId** | **Int64** | ID of pet to return | ### Return type @@ -265,7 +265,7 @@ Name | Type | Description | Notes # **updatePet** ```swift - open class func updatePet(body: Pet, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) + open class func updatePet(body: Pet, completion: @escaping (_ data: Void?, _ error: Error?) -> Void) ``` Update an existing pet @@ -294,11 +294,11 @@ PetAPI.updatePet(body: body) { (response, error) in Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | + **body** | [**Pet**](Pet.md) | Pet object that needs to be added to the store | ### Return type -void (empty response body) +Void (empty response body) ### Authorization @@ -313,7 +313,7 @@ void (empty response body) # **updatePetWithForm** ```swift - open class func updatePetWithForm(petId: Int64, name: String? = nil, status: String? = nil, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) + open class func updatePetWithForm(petId: Int64, name: String? = nil, status: String? = nil, completion: @escaping (_ data: Void?, _ error: Error?) -> Void) ``` Updates a pet in the store with form data @@ -344,13 +344,13 @@ PetAPI.updatePetWithForm(petId: petId, name: name, status: status) { (response, Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **petId** | **Int64**| ID of pet that needs to be updated | - **name** | **String**| Updated name of the pet | [optional] - **status** | **String**| Updated status of the pet | [optional] + **petId** | **Int64** | ID of pet that needs to be updated | + **name** | **String** | Updated name of the pet | [optional] + **status** | **String** | Updated status of the pet | [optional] ### Return type -void (empty response body) +Void (empty response body) ### Authorization @@ -365,7 +365,7 @@ void (empty response body) # **uploadFile** ```swift - open class func uploadFile(petId: Int64, additionalMetadata: String? = nil, file: URL? = nil, completion: @escaping ((_ data: ApiResponse?,_ error: Error?) -> Void)) + open class func uploadFile(petId: Int64, additionalMetadata: String? = nil, file: URL? = nil, completion: @escaping (_ data: ApiResponse?, _ error: Error?) -> Void) ``` uploads an image @@ -377,7 +377,7 @@ import PetstoreClient let petId = 987 // Int64 | ID of pet to update let additionalMetadata = "additionalMetadata_example" // String | Additional data to pass to server (optional) -let file = "TODO" // URL | file to upload (optional) +let file = URL(string: "https://example.com")! // URL | file to upload (optional) // uploads an image PetAPI.uploadFile(petId: petId, additionalMetadata: additionalMetadata, file: file) { (response, error) in @@ -396,9 +396,9 @@ PetAPI.uploadFile(petId: petId, additionalMetadata: additionalMetadata, file: fi Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **petId** | **Int64**| ID of pet to update | - **additionalMetadata** | **String**| Additional data to pass to server | [optional] - **file** | **URL****URL**| file to upload | [optional] + **petId** | **Int64** | ID of pet to update | + **additionalMetadata** | **String** | Additional data to pass to server | [optional] + **file** | **URL** | file to upload | [optional] ### Return type @@ -417,7 +417,7 @@ Name | Type | Description | Notes # **uploadFileWithRequiredFile** ```swift - open class func uploadFileWithRequiredFile(petId: Int64, requiredFile: URL, additionalMetadata: String? = nil, completion: @escaping ((_ data: ApiResponse?,_ error: Error?) -> Void)) + open class func uploadFileWithRequiredFile(petId: Int64, requiredFile: URL, additionalMetadata: String? = nil, completion: @escaping (_ data: ApiResponse?, _ error: Error?) -> Void) ``` uploads an image (required) @@ -428,7 +428,7 @@ uploads an image (required) import PetstoreClient let petId = 987 // Int64 | ID of pet to update -let requiredFile = "TODO" // URL | file to upload +let requiredFile = URL(string: "https://example.com")! // URL | file to upload let additionalMetadata = "additionalMetadata_example" // String | Additional data to pass to server (optional) // uploads an image (required) @@ -448,9 +448,9 @@ PetAPI.uploadFileWithRequiredFile(petId: petId, requiredFile: requiredFile, addi Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **petId** | **Int64**| ID of pet to update | - **requiredFile** | **URL****URL**| file to upload | - **additionalMetadata** | **String**| Additional data to pass to server | [optional] + **petId** | **Int64** | ID of pet to update | + **requiredFile** | **URL** | file to upload | + **additionalMetadata** | **String** | Additional data to pass to server | [optional] ### Return type diff --git a/samples/client/petstore/swift4/objcCompatible/docs/StoreAPI.md b/samples/client/petstore/swift4/objcCompatible/docs/StoreAPI.md index 9be40bfcacd9..86c8f84e7b56 100644 --- a/samples/client/petstore/swift4/objcCompatible/docs/StoreAPI.md +++ b/samples/client/petstore/swift4/objcCompatible/docs/StoreAPI.md @@ -12,7 +12,7 @@ Method | HTTP request | Description # **deleteOrder** ```swift - open class func deleteOrder(orderId: String, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) + open class func deleteOrder(orderId: String, completion: @escaping (_ data: Void?, _ error: Error?) -> Void) ``` Delete purchase order by ID @@ -43,11 +43,11 @@ StoreAPI.deleteOrder(orderId: orderId) { (response, error) in Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **orderId** | **String**| ID of the order that needs to be deleted | + **orderId** | **String** | ID of the order that needs to be deleted | ### Return type -void (empty response body) +Void (empty response body) ### Authorization @@ -62,7 +62,7 @@ No authorization required # **getInventory** ```swift - open class func getInventory(completion: @escaping ((_ data: [String:Int]?,_ error: Error?) -> Void)) + open class func getInventory(completion: @escaping (_ data: [String:Int]?, _ error: Error?) -> Void) ``` Returns pet inventories by status @@ -108,7 +108,7 @@ This endpoint does not need any parameter. # **getOrderById** ```swift - open class func getOrderById(orderId: Int64, completion: @escaping ((_ data: Order?,_ error: Error?) -> Void)) + open class func getOrderById(orderId: Int64, completion: @escaping (_ data: Order?, _ error: Error?) -> Void) ``` Find purchase order by ID @@ -139,7 +139,7 @@ StoreAPI.getOrderById(orderId: orderId) { (response, error) in Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **orderId** | **Int64**| ID of pet that needs to be fetched | + **orderId** | **Int64** | ID of pet that needs to be fetched | ### Return type @@ -158,7 +158,7 @@ No authorization required # **placeOrder** ```swift - open class func placeOrder(body: Order, completion: @escaping ((_ data: Order?,_ error: Error?) -> Void)) + open class func placeOrder(body: Order, completion: @escaping (_ data: Order?, _ error: Error?) -> Void) ``` Place an order for a pet @@ -168,7 +168,7 @@ Place an order for a pet // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = Order(_id: 123, petId: 123, quantity: 123, shipDate: "TODO", status: "status_example", complete: 123) // Order | order placed for purchasing the pet +let body = Order(_id: 123, petId: 123, quantity: 123, shipDate: Date(), status: "status_example", complete: false) // Order | order placed for purchasing the pet // Place an order for a pet StoreAPI.placeOrder(body: body) { (response, error) in @@ -187,7 +187,7 @@ StoreAPI.placeOrder(body: body) { (response, error) in Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**Order**](Order.md)| order placed for purchasing the pet | + **body** | [**Order**](Order.md) | order placed for purchasing the pet | ### Return type diff --git a/samples/client/petstore/swift4/objcCompatible/docs/UserAPI.md b/samples/client/petstore/swift4/objcCompatible/docs/UserAPI.md index e33bb4300e6e..a1b5cfaada5d 100644 --- a/samples/client/petstore/swift4/objcCompatible/docs/UserAPI.md +++ b/samples/client/petstore/swift4/objcCompatible/docs/UserAPI.md @@ -16,7 +16,7 @@ Method | HTTP request | Description # **createUser** ```swift - open class func createUser(body: User, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) + open class func createUser(body: User, completion: @escaping (_ data: Void?, _ error: Error?) -> Void) ``` Create user @@ -47,11 +47,11 @@ UserAPI.createUser(body: body) { (response, error) in Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**User**](User.md)| Created user object | + **body** | [**User**](User.md) | Created user object | ### Return type -void (empty response body) +Void (empty response body) ### Authorization @@ -66,7 +66,7 @@ No authorization required # **createUsersWithArrayInput** ```swift - open class func createUsersWithArrayInput(body: [User], completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) + open class func createUsersWithArrayInput(body: [User], completion: @escaping (_ data: Void?, _ error: Error?) -> Void) ``` Creates list of users with given input array @@ -95,11 +95,11 @@ UserAPI.createUsersWithArrayInput(body: body) { (response, error) in Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**[User]**](Array.md)| List of user object | + **body** | [**[User]**](Array.md) | List of user object | ### Return type -void (empty response body) +Void (empty response body) ### Authorization @@ -114,7 +114,7 @@ No authorization required # **createUsersWithListInput** ```swift - open class func createUsersWithListInput(body: [User], completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) + open class func createUsersWithListInput(body: [User], completion: @escaping (_ data: Void?, _ error: Error?) -> Void) ``` Creates list of users with given input array @@ -143,11 +143,11 @@ UserAPI.createUsersWithListInput(body: body) { (response, error) in Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**[User]**](Array.md)| List of user object | + **body** | [**[User]**](Array.md) | List of user object | ### Return type -void (empty response body) +Void (empty response body) ### Authorization @@ -162,7 +162,7 @@ No authorization required # **deleteUser** ```swift - open class func deleteUser(username: String, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) + open class func deleteUser(username: String, completion: @escaping (_ data: Void?, _ error: Error?) -> Void) ``` Delete user @@ -193,11 +193,11 @@ UserAPI.deleteUser(username: username) { (response, error) in Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **username** | **String**| The name that needs to be deleted | + **username** | **String** | The name that needs to be deleted | ### Return type -void (empty response body) +Void (empty response body) ### Authorization @@ -212,7 +212,7 @@ No authorization required # **getUserByName** ```swift - open class func getUserByName(username: String, completion: @escaping ((_ data: User?,_ error: Error?) -> Void)) + open class func getUserByName(username: String, completion: @escaping (_ data: User?, _ error: Error?) -> Void) ``` Get user by user name @@ -241,7 +241,7 @@ UserAPI.getUserByName(username: username) { (response, error) in Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **username** | **String**| The name that needs to be fetched. Use user1 for testing. | + **username** | **String** | The name that needs to be fetched. Use user1 for testing. | ### Return type @@ -260,7 +260,7 @@ No authorization required # **loginUser** ```swift - open class func loginUser(username: String, password: String, completion: @escaping ((_ data: String?,_ error: Error?) -> Void)) + open class func loginUser(username: String, password: String, completion: @escaping (_ data: String?, _ error: Error?) -> Void) ``` Logs user into the system @@ -290,8 +290,8 @@ UserAPI.loginUser(username: username, password: password) { (response, error) in Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **username** | **String**| The user name for login | - **password** | **String**| The password for login in clear text | + **username** | **String** | The user name for login | + **password** | **String** | The password for login in clear text | ### Return type @@ -310,7 +310,7 @@ No authorization required # **logoutUser** ```swift - open class func logoutUser(completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) + open class func logoutUser(completion: @escaping (_ data: Void?, _ error: Error?) -> Void) ``` Logs out current logged in user session @@ -339,7 +339,7 @@ This endpoint does not need any parameter. ### Return type -void (empty response body) +Void (empty response body) ### Authorization @@ -354,7 +354,7 @@ No authorization required # **updateUser** ```swift - open class func updateUser(username: String, body: User, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) + open class func updateUser(username: String, body: User, completion: @escaping (_ data: Void?, _ error: Error?) -> Void) ``` Updated user @@ -386,12 +386,12 @@ UserAPI.updateUser(username: username, body: body) { (response, error) in Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **username** | **String**| name that need to be deleted | - **body** | [**User**](User.md)| Updated user object | + **username** | **String** | name that need to be deleted | + **body** | [**User**](User.md) | Updated user object | ### Return type -void (empty response body) +Void (empty response body) ### Authorization diff --git a/samples/client/petstore/swift4/promisekit/docs/AdditionalPropertiesClass.md b/samples/client/petstore/swift4/promisekit/docs/AdditionalPropertiesClass.md index a524730eb652..e22d28be1de6 100644 --- a/samples/client/petstore/swift4/promisekit/docs/AdditionalPropertiesClass.md +++ b/samples/client/petstore/swift4/promisekit/docs/AdditionalPropertiesClass.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **mapString** | **[String:String]** | | [optional] -**mapMapString** | [**[String:[String:String]]**](Dictionary.md) | | [optional] +**mapMapString** | [String:[String: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) diff --git a/samples/client/petstore/swift4/promisekit/docs/AnotherFakeAPI.md b/samples/client/petstore/swift4/promisekit/docs/AnotherFakeAPI.md index c25854f64a06..00b343464f8f 100644 --- a/samples/client/petstore/swift4/promisekit/docs/AnotherFakeAPI.md +++ b/samples/client/petstore/swift4/promisekit/docs/AnotherFakeAPI.md @@ -38,7 +38,7 @@ AnotherFakeAPI.call123testSpecialTags(body: body).then { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**Client**](Client.md)| client model | + **body** | [**Client**](Client.md) | client model | ### Return type diff --git a/samples/client/petstore/swift4/promisekit/docs/ArrayOfArrayOfNumberOnly.md b/samples/client/petstore/swift4/promisekit/docs/ArrayOfArrayOfNumberOnly.md index 3f78a9584d82..c6fceff5e08d 100644 --- a/samples/client/petstore/swift4/promisekit/docs/ArrayOfArrayOfNumberOnly.md +++ b/samples/client/petstore/swift4/promisekit/docs/ArrayOfArrayOfNumberOnly.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**arrayArrayNumber** | [**[[Double]]**](Array.md) | | [optional] +**arrayArrayNumber** | [[Double]] | | [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) diff --git a/samples/client/petstore/swift4/promisekit/docs/ArrayTest.md b/samples/client/petstore/swift4/promisekit/docs/ArrayTest.md index dd9be9d5876b..bf416b8330cc 100644 --- a/samples/client/petstore/swift4/promisekit/docs/ArrayTest.md +++ b/samples/client/petstore/swift4/promisekit/docs/ArrayTest.md @@ -4,8 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayOfString** | **[String]** | | [optional] -**arrayArrayOfInteger** | [**[[Int64]]**](Array.md) | | [optional] -**arrayArrayOfModel** | [**[[ReadOnlyFirst]]**](Array.md) | | [optional] +**arrayArrayOfInteger** | [[Int64]] | | [optional] +**arrayArrayOfModel** | [[ReadOnlyFirst]] | | [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) diff --git a/samples/client/petstore/swift4/promisekit/docs/FakeAPI.md b/samples/client/petstore/swift4/promisekit/docs/FakeAPI.md index 20880dd38338..eb46c5616a55 100644 --- a/samples/client/petstore/swift4/promisekit/docs/FakeAPI.md +++ b/samples/client/petstore/swift4/promisekit/docs/FakeAPI.md @@ -32,7 +32,7 @@ Test serialization of outer boolean types // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = 987 // Bool | Input boolean as post body (optional) +let body = false // Bool | Input boolean as post body (optional) FakeAPI.fakeOuterBooleanSerialize(body: body).then { // when the promise is fulfilled @@ -48,7 +48,7 @@ FakeAPI.fakeOuterBooleanSerialize(body: body).then { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | **Bool**| Input boolean as post body | [optional] + **body** | **Bool** | Input boolean as post body | [optional] ### Return type @@ -79,7 +79,7 @@ Test serialization of object with outer number type // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = OuterComposite(myNumber: 123, myString: "myString_example", myBoolean: 123) // OuterComposite | Input composite as post body (optional) +let body = OuterComposite(myNumber: 123, myString: "myString_example", myBoolean: false) // OuterComposite | Input composite as post body (optional) FakeAPI.fakeOuterCompositeSerialize(body: body).then { // when the promise is fulfilled @@ -95,7 +95,7 @@ FakeAPI.fakeOuterCompositeSerialize(body: body).then { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**OuterComposite**](OuterComposite.md)| Input composite as post body | [optional] + **body** | [**OuterComposite**](OuterComposite.md) | Input composite as post body | [optional] ### Return type @@ -142,7 +142,7 @@ FakeAPI.fakeOuterNumberSerialize(body: body).then { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | **Double**| Input number as post body | [optional] + **body** | **Double** | Input number as post body | [optional] ### Return type @@ -189,7 +189,7 @@ FakeAPI.fakeOuterStringSerialize(body: body).then { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | **String**| Input string as post body | [optional] + **body** | **String** | Input string as post body | [optional] ### Return type @@ -236,11 +236,11 @@ FakeAPI.testBodyWithFileSchema(body: body).then { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**FileSchemaTestClass**](FileSchemaTestClass.md)| | + **body** | [**FileSchemaTestClass**](FileSchemaTestClass.md) | | ### Return type -void (empty response body) +Void (empty response body) ### Authorization @@ -282,12 +282,12 @@ FakeAPI.testBodyWithQueryParams(query: query, body: body).then { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **query** | **String**| | - **body** | [**User**](User.md)| | + **query** | **String** | | + **body** | [**User**](User.md) | | ### Return type -void (empty response body) +Void (empty response body) ### Authorization @@ -331,7 +331,7 @@ FakeAPI.testClientModel(body: body).then { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**Client**](Client.md)| client model | + **body** | [**Client**](Client.md) | client model | ### Return type @@ -365,15 +365,15 @@ import PetstoreClient let number = 987 // Double | None let double = 987 // Double | None let patternWithoutDelimiter = "patternWithoutDelimiter_example" // String | None -let byte = TODO // Data | None +let byte = 987 // Data | None let integer = 987 // Int | None (optional) let int32 = 987 // Int | None (optional) let int64 = 987 // Int64 | None (optional) let float = 987 // Float | None (optional) let string = "string_example" // String | None (optional) -let binary = "TODO" // URL | None (optional) -let date = TODO // Date | None (optional) -let dateTime = TODO // Date | None (optional) +let binary = URL(string: "https://example.com")! // URL | None (optional) +let date = Date() // Date | None (optional) +let dateTime = Date() // Date | None (optional) let password = "password_example" // String | None (optional) let callback = "callback_example" // String | None (optional) @@ -392,24 +392,24 @@ FakeAPI.testEndpointParameters(number: number, double: double, patternWithoutDel Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **number** | **Double**| None | - **double** | **Double**| None | - **patternWithoutDelimiter** | **String**| None | - **byte** | **Data**| None | - **integer** | **Int**| None | [optional] - **int32** | **Int**| None | [optional] - **int64** | **Int64**| None | [optional] - **float** | **Float**| None | [optional] - **string** | **String**| None | [optional] - **binary** | **URL****URL**| None | [optional] - **date** | **Date**| None | [optional] - **dateTime** | **Date**| None | [optional] - **password** | **String**| None | [optional] - **callback** | **String**| None | [optional] + **number** | **Double** | None | + **double** | **Double** | None | + **patternWithoutDelimiter** | **String** | None | + **byte** | **Data** | None | + **integer** | **Int** | None | [optional] + **int32** | **Int** | None | [optional] + **int64** | **Int64** | None | [optional] + **float** | **Float** | None | [optional] + **string** | **String** | None | [optional] + **binary** | **URL** | None | [optional] + **date** | **Date** | None | [optional] + **dateTime** | **Date** | None | [optional] + **password** | **String** | None | [optional] + **callback** | **String** | None | [optional] ### Return type -void (empty response body) +Void (empty response body) ### Authorization @@ -460,18 +460,18 @@ FakeAPI.testEnumParameters(enumHeaderStringArray: enumHeaderStringArray, enumHea Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **enumHeaderStringArray** | [**[String]**](String.md)| Header parameter enum test (string array) | [optional] - **enumHeaderString** | **String**| Header parameter enum test (string) | [optional] [default to .-efg] - **enumQueryStringArray** | [**[String]**](String.md)| Query parameter enum test (string array) | [optional] - **enumQueryString** | **String**| Query parameter enum test (string) | [optional] [default to .-efg] - **enumQueryInteger** | **Int**| Query parameter enum test (double) | [optional] - **enumQueryDouble** | **Double**| Query parameter enum test (double) | [optional] - **enumFormStringArray** | [**[String]**](String.md)| Form parameter enum test (string array) | [optional] [default to .$] - **enumFormString** | **String**| Form parameter enum test (string) | [optional] [default to .-efg] + **enumHeaderStringArray** | [**[String]**](String.md) | Header parameter enum test (string array) | [optional] + **enumHeaderString** | **String** | Header parameter enum test (string) | [optional] [default to .-efg] + **enumQueryStringArray** | [**[String]**](String.md) | Query parameter enum test (string array) | [optional] + **enumQueryString** | **String** | Query parameter enum test (string) | [optional] [default to .-efg] + **enumQueryInteger** | **Int** | Query parameter enum test (double) | [optional] + **enumQueryDouble** | **Double** | Query parameter enum test (double) | [optional] + **enumFormStringArray** | [**[String]**](String.md) | Form parameter enum test (string array) | [optional] [default to .$] + **enumFormString** | **String** | Form parameter enum test (string) | [optional] [default to .-efg] ### Return type -void (empty response body) +Void (empty response body) ### Authorization @@ -499,10 +499,10 @@ Fake endpoint to test group parameters (optional) import PetstoreClient let requiredStringGroup = 987 // Int | Required String in group parameters -let requiredBooleanGroup = 987 // Bool | Required Boolean in group parameters +let requiredBooleanGroup = false // Bool | Required Boolean in group parameters let requiredInt64Group = 987 // Int64 | Required Integer in group parameters let stringGroup = 987 // Int | String in group parameters (optional) -let booleanGroup = 987 // Bool | Boolean in group parameters (optional) +let booleanGroup = false // Bool | Boolean in group parameters (optional) let int64Group = 987 // Int64 | Integer in group parameters (optional) // Fake endpoint to test group parameters (optional) @@ -520,16 +520,16 @@ FakeAPI.testGroupParameters(requiredStringGroup: requiredStringGroup, requiredBo Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **requiredStringGroup** | **Int**| Required String in group parameters | - **requiredBooleanGroup** | **Bool**| Required Boolean in group parameters | - **requiredInt64Group** | **Int64**| Required Integer in group parameters | - **stringGroup** | **Int**| String in group parameters | [optional] - **booleanGroup** | **Bool**| Boolean in group parameters | [optional] - **int64Group** | **Int64**| Integer in group parameters | [optional] + **requiredStringGroup** | **Int** | Required String in group parameters | + **requiredBooleanGroup** | **Bool** | Required Boolean in group parameters | + **requiredInt64Group** | **Int64** | Required Integer in group parameters | + **stringGroup** | **Int** | String in group parameters | [optional] + **booleanGroup** | **Bool** | Boolean in group parameters | [optional] + **int64Group** | **Int64** | Integer in group parameters | [optional] ### Return type -void (empty response body) +Void (empty response body) ### Authorization @@ -571,11 +571,11 @@ FakeAPI.testInlineAdditionalProperties(param: param).then { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **param** | [**[String:String]**](String.md)| request body | + **param** | [**[String:String]**](String.md) | request body | ### Return type -void (empty response body) +Void (empty response body) ### Authorization @@ -618,12 +618,12 @@ FakeAPI.testJsonFormData(param: param, param2: param2).then { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **param** | **String**| field1 | - **param2** | **String**| field2 | + **param** | **String** | field1 | + **param2** | **String** | field2 | ### Return type -void (empty response body) +Void (empty response body) ### Authorization diff --git a/samples/client/petstore/swift4/promisekit/docs/FakeClassnameTags123API.md b/samples/client/petstore/swift4/promisekit/docs/FakeClassnameTags123API.md index 6a47a25d84c0..9db73c90c0ed 100644 --- a/samples/client/petstore/swift4/promisekit/docs/FakeClassnameTags123API.md +++ b/samples/client/petstore/swift4/promisekit/docs/FakeClassnameTags123API.md @@ -38,7 +38,7 @@ FakeClassnameTags123API.testClassname(body: body).then { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**Client**](Client.md)| client model | + **body** | [**Client**](Client.md) | client model | ### Return type diff --git a/samples/client/petstore/swift4/promisekit/docs/FileSchemaTestClass.md b/samples/client/petstore/swift4/promisekit/docs/FileSchemaTestClass.md index d0a8bbaaba95..afdacc60b2c3 100644 --- a/samples/client/petstore/swift4/promisekit/docs/FileSchemaTestClass.md +++ b/samples/client/petstore/swift4/promisekit/docs/FileSchemaTestClass.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **file** | [**File**](File.md) | | [optional] -**files** | [**[File]**](File.md) | | [optional] +**files** | [File] | | [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) diff --git a/samples/client/petstore/swift4/promisekit/docs/FormatTest.md b/samples/client/petstore/swift4/promisekit/docs/FormatTest.md index 547eb88754f4..f74d94f6c46a 100644 --- a/samples/client/petstore/swift4/promisekit/docs/FormatTest.md +++ b/samples/client/petstore/swift4/promisekit/docs/FormatTest.md @@ -10,11 +10,11 @@ Name | Type | Description | Notes **float** | **Float** | | [optional] **double** | **Double** | | [optional] **string** | **String** | | [optional] -**byte** | [**Data**](Data.md) | | -**binary** | [**URL**](URL.md) | | [optional] -**date** | [**Date**](Date.md) | | -**dateTime** | [**Date**](Date.md) | | [optional] -**uuid** | [**UUID**](UUID.md) | | [optional] +**byte** | **Data** | | +**binary** | **URL** | | [optional] +**date** | **Date** | | +**dateTime** | **Date** | | [optional] +**uuid** | **UUID** | | [optional] **password** | **String** | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/samples/client/petstore/swift4/promisekit/docs/MapTest.md b/samples/client/petstore/swift4/promisekit/docs/MapTest.md index e910bc97518c..56213c4113f6 100644 --- a/samples/client/petstore/swift4/promisekit/docs/MapTest.md +++ b/samples/client/petstore/swift4/promisekit/docs/MapTest.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**mapMapOfString** | [**[String:[String:String]]**](Dictionary.md) | | [optional] +**mapMapOfString** | [String:[String:String]] | | [optional] **mapOfEnumString** | **[String:String]** | | [optional] **directMap** | **[String:Bool]** | | [optional] **indirectMap** | [**StringBooleanMap**](StringBooleanMap.md) | | [optional] diff --git a/samples/client/petstore/swift4/promisekit/docs/MixedPropertiesAndAdditionalPropertiesClass.md b/samples/client/petstore/swift4/promisekit/docs/MixedPropertiesAndAdditionalPropertiesClass.md index 2c502eace42c..fcffb8ecdbf3 100644 --- a/samples/client/petstore/swift4/promisekit/docs/MixedPropertiesAndAdditionalPropertiesClass.md +++ b/samples/client/petstore/swift4/promisekit/docs/MixedPropertiesAndAdditionalPropertiesClass.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**uuid** | [**UUID**](UUID.md) | | [optional] -**dateTime** | [**Date**](Date.md) | | [optional] -**map** | [**[String:Animal]**](Animal.md) | | [optional] +**uuid** | **UUID** | | [optional] +**dateTime** | **Date** | | [optional] +**map** | [String:Animal] | | [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) diff --git a/samples/client/petstore/swift4/promisekit/docs/Order.md b/samples/client/petstore/swift4/promisekit/docs/Order.md index 9d3205c1526a..15487f01175c 100644 --- a/samples/client/petstore/swift4/promisekit/docs/Order.md +++ b/samples/client/petstore/swift4/promisekit/docs/Order.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes **id** | **Int64** | | [optional] **petId** | **Int64** | | [optional] **quantity** | **Int** | | [optional] -**shipDate** | [**Date**](Date.md) | | [optional] +**shipDate** | **Date** | | [optional] **status** | **String** | Order Status | [optional] **complete** | **Bool** | | [optional] [default to false] diff --git a/samples/client/petstore/swift4/promisekit/docs/Pet.md b/samples/client/petstore/swift4/promisekit/docs/Pet.md index c30a5292f537..5c05f98fad4a 100644 --- a/samples/client/petstore/swift4/promisekit/docs/Pet.md +++ b/samples/client/petstore/swift4/promisekit/docs/Pet.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes **category** | [**Category**](Category.md) | | [optional] **name** | **String** | | **photoUrls** | **[String]** | | -**tags** | [**[Tag]**](Tag.md) | | [optional] +**tags** | [Tag] | | [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) diff --git a/samples/client/petstore/swift4/promisekit/docs/PetAPI.md b/samples/client/petstore/swift4/promisekit/docs/PetAPI.md index 7e5cc6c1ff9e..aa889a07b895 100644 --- a/samples/client/petstore/swift4/promisekit/docs/PetAPI.md +++ b/samples/client/petstore/swift4/promisekit/docs/PetAPI.md @@ -44,11 +44,11 @@ PetAPI.addPet(body: body).then { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | + **body** | [**Pet**](Pet.md) | Pet object that needs to be added to the store | ### Return type -void (empty response body) +Void (empty response body) ### Authorization @@ -91,12 +91,12 @@ PetAPI.deletePet(petId: petId, apiKey: apiKey).then { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **petId** | **Int64**| Pet id to delete | - **apiKey** | **String**| | [optional] + **petId** | **Int64** | Pet id to delete | + **apiKey** | **String** | | [optional] ### Return type -void (empty response body) +Void (empty response body) ### Authorization @@ -140,7 +140,7 @@ PetAPI.findPetsByStatus(status: status).then { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **status** | [**[String]**](String.md)| Status values that need to be considered for filter | + **status** | [**[String]**](String.md) | Status values that need to be considered for filter | ### Return type @@ -188,7 +188,7 @@ PetAPI.findPetsByTags(tags: tags).then { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **tags** | [**[String]**](String.md)| Tags to filter by | + **tags** | [**[String]**](String.md) | Tags to filter by | ### Return type @@ -236,7 +236,7 @@ PetAPI.getPetById(petId: petId).then { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **petId** | **Int64**| ID of pet to return | + **petId** | **Int64** | ID of pet to return | ### Return type @@ -282,11 +282,11 @@ PetAPI.updatePet(body: body).then { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | + **body** | [**Pet**](Pet.md) | Pet object that needs to be added to the store | ### Return type -void (empty response body) +Void (empty response body) ### Authorization @@ -330,13 +330,13 @@ PetAPI.updatePetWithForm(petId: petId, name: name, status: status).then { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **petId** | **Int64**| ID of pet that needs to be updated | - **name** | **String**| Updated name of the pet | [optional] - **status** | **String**| Updated status of the pet | [optional] + **petId** | **Int64** | ID of pet that needs to be updated | + **name** | **String** | Updated name of the pet | [optional] + **status** | **String** | Updated status of the pet | [optional] ### Return type -void (empty response body) +Void (empty response body) ### Authorization @@ -363,7 +363,7 @@ import PetstoreClient let petId = 987 // Int64 | ID of pet to update let additionalMetadata = "additionalMetadata_example" // String | Additional data to pass to server (optional) -let file = "TODO" // URL | file to upload (optional) +let file = URL(string: "https://example.com")! // URL | file to upload (optional) // uploads an image PetAPI.uploadFile(petId: petId, additionalMetadata: additionalMetadata, file: file).then { @@ -380,9 +380,9 @@ PetAPI.uploadFile(petId: petId, additionalMetadata: additionalMetadata, file: fi Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **petId** | **Int64**| ID of pet to update | - **additionalMetadata** | **String**| Additional data to pass to server | [optional] - **file** | **URL****URL**| file to upload | [optional] + **petId** | **Int64** | ID of pet to update | + **additionalMetadata** | **String** | Additional data to pass to server | [optional] + **file** | **URL** | file to upload | [optional] ### Return type @@ -412,7 +412,7 @@ uploads an image (required) import PetstoreClient let petId = 987 // Int64 | ID of pet to update -let requiredFile = "TODO" // URL | file to upload +let requiredFile = URL(string: "https://example.com")! // URL | file to upload let additionalMetadata = "additionalMetadata_example" // String | Additional data to pass to server (optional) // uploads an image (required) @@ -430,9 +430,9 @@ PetAPI.uploadFileWithRequiredFile(petId: petId, requiredFile: requiredFile, addi Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **petId** | **Int64**| ID of pet to update | - **requiredFile** | **URL****URL**| file to upload | - **additionalMetadata** | **String**| Additional data to pass to server | [optional] + **petId** | **Int64** | ID of pet to update | + **requiredFile** | **URL** | file to upload | + **additionalMetadata** | **String** | Additional data to pass to server | [optional] ### Return type diff --git a/samples/client/petstore/swift4/promisekit/docs/StoreAPI.md b/samples/client/petstore/swift4/promisekit/docs/StoreAPI.md index 01c8ec70f067..7c421fed76e6 100644 --- a/samples/client/petstore/swift4/promisekit/docs/StoreAPI.md +++ b/samples/client/petstore/swift4/promisekit/docs/StoreAPI.md @@ -41,11 +41,11 @@ StoreAPI.deleteOrder(orderId: orderId).then { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **orderId** | **String**| ID of the order that needs to be deleted | + **orderId** | **String** | ID of the order that needs to be deleted | ### Return type -void (empty response body) +Void (empty response body) ### Authorization @@ -133,7 +133,7 @@ StoreAPI.getOrderById(orderId: orderId).then { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **orderId** | **Int64**| ID of pet that needs to be fetched | + **orderId** | **Int64** | ID of pet that needs to be fetched | ### Return type @@ -162,7 +162,7 @@ Place an order for a pet // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = Order(id: 123, petId: 123, quantity: 123, shipDate: "TODO", status: "status_example", complete: 123) // Order | order placed for purchasing the pet +let body = Order(id: 123, petId: 123, quantity: 123, shipDate: Date(), status: "status_example", complete: false) // Order | order placed for purchasing the pet // Place an order for a pet StoreAPI.placeOrder(body: body).then { @@ -179,7 +179,7 @@ StoreAPI.placeOrder(body: body).then { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**Order**](Order.md)| order placed for purchasing the pet | + **body** | [**Order**](Order.md) | order placed for purchasing the pet | ### Return type diff --git a/samples/client/petstore/swift4/promisekit/docs/UserAPI.md b/samples/client/petstore/swift4/promisekit/docs/UserAPI.md index b0b1787f70d5..f435388588df 100644 --- a/samples/client/petstore/swift4/promisekit/docs/UserAPI.md +++ b/samples/client/petstore/swift4/promisekit/docs/UserAPI.md @@ -45,11 +45,11 @@ UserAPI.createUser(body: body).then { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**User**](User.md)| Created user object | + **body** | [**User**](User.md) | Created user object | ### Return type -void (empty response body) +Void (empty response body) ### Authorization @@ -91,11 +91,11 @@ UserAPI.createUsersWithArrayInput(body: body).then { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**[User]**](Array.md)| List of user object | + **body** | [**[User]**](Array.md) | List of user object | ### Return type -void (empty response body) +Void (empty response body) ### Authorization @@ -137,11 +137,11 @@ UserAPI.createUsersWithListInput(body: body).then { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**[User]**](Array.md)| List of user object | + **body** | [**[User]**](Array.md) | List of user object | ### Return type -void (empty response body) +Void (empty response body) ### Authorization @@ -185,11 +185,11 @@ UserAPI.deleteUser(username: username).then { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **username** | **String**| The name that needs to be deleted | + **username** | **String** | The name that needs to be deleted | ### Return type -void (empty response body) +Void (empty response body) ### Authorization @@ -231,7 +231,7 @@ UserAPI.getUserByName(username: username).then { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **username** | **String**| The name that needs to be fetched. Use user1 for testing. | + **username** | **String** | The name that needs to be fetched. Use user1 for testing. | ### Return type @@ -278,8 +278,8 @@ UserAPI.loginUser(username: username, password: password).then { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **username** | **String**| The user name for login | - **password** | **String**| The password for login in clear text | + **username** | **String** | The user name for login | + **password** | **String** | The password for login in clear text | ### Return type @@ -325,7 +325,7 @@ This endpoint does not need any parameter. ### Return type -void (empty response body) +Void (empty response body) ### Authorization @@ -370,12 +370,12 @@ UserAPI.updateUser(username: username, body: body).then { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **username** | **String**| name that need to be deleted | - **body** | [**User**](User.md)| Updated user object | + **username** | **String** | name that need to be deleted | + **body** | [**User**](User.md) | Updated user object | ### Return type -void (empty response body) +Void (empty response body) ### Authorization diff --git a/samples/client/petstore/swift4/rxswift/docs/AdditionalPropertiesClass.md b/samples/client/petstore/swift4/rxswift/docs/AdditionalPropertiesClass.md index a524730eb652..e22d28be1de6 100644 --- a/samples/client/petstore/swift4/rxswift/docs/AdditionalPropertiesClass.md +++ b/samples/client/petstore/swift4/rxswift/docs/AdditionalPropertiesClass.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **mapString** | **[String:String]** | | [optional] -**mapMapString** | [**[String:[String:String]]**](Dictionary.md) | | [optional] +**mapMapString** | [String:[String: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) diff --git a/samples/client/petstore/swift4/rxswift/docs/AnotherFakeAPI.md b/samples/client/petstore/swift4/rxswift/docs/AnotherFakeAPI.md index e061b9b905bb..2c5fc8f401cb 100644 --- a/samples/client/petstore/swift4/rxswift/docs/AnotherFakeAPI.md +++ b/samples/client/petstore/swift4/rxswift/docs/AnotherFakeAPI.md @@ -30,7 +30,7 @@ let body = Client(client: "client_example") // Client | client model Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**Client**](Client.md)| client model | + **body** | [**Client**](Client.md) | client model | ### Return type diff --git a/samples/client/petstore/swift4/rxswift/docs/ArrayOfArrayOfNumberOnly.md b/samples/client/petstore/swift4/rxswift/docs/ArrayOfArrayOfNumberOnly.md index 3f78a9584d82..c6fceff5e08d 100644 --- a/samples/client/petstore/swift4/rxswift/docs/ArrayOfArrayOfNumberOnly.md +++ b/samples/client/petstore/swift4/rxswift/docs/ArrayOfArrayOfNumberOnly.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**arrayArrayNumber** | [**[[Double]]**](Array.md) | | [optional] +**arrayArrayNumber** | [[Double]] | | [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) diff --git a/samples/client/petstore/swift4/rxswift/docs/ArrayTest.md b/samples/client/petstore/swift4/rxswift/docs/ArrayTest.md index dd9be9d5876b..bf416b8330cc 100644 --- a/samples/client/petstore/swift4/rxswift/docs/ArrayTest.md +++ b/samples/client/petstore/swift4/rxswift/docs/ArrayTest.md @@ -4,8 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayOfString** | **[String]** | | [optional] -**arrayArrayOfInteger** | [**[[Int64]]**](Array.md) | | [optional] -**arrayArrayOfModel** | [**[[ReadOnlyFirst]]**](Array.md) | | [optional] +**arrayArrayOfInteger** | [[Int64]] | | [optional] +**arrayArrayOfModel** | [[ReadOnlyFirst]] | | [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) diff --git a/samples/client/petstore/swift4/rxswift/docs/FakeAPI.md b/samples/client/petstore/swift4/rxswift/docs/FakeAPI.md index edc7fce5eb54..f0b3787008c6 100644 --- a/samples/client/petstore/swift4/rxswift/docs/FakeAPI.md +++ b/samples/client/petstore/swift4/rxswift/docs/FakeAPI.md @@ -32,7 +32,7 @@ Test serialization of outer boolean types // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = 987 // Bool | Input boolean as post body (optional) +let body = false // Bool | Input boolean as post body (optional) // TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` @@ -41,7 +41,7 @@ let body = 987 // Bool | Input boolean as post body (optional) Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | **Bool**| Input boolean as post body | [optional] + **body** | **Bool** | Input boolean as post body | [optional] ### Return type @@ -72,7 +72,7 @@ Test serialization of object with outer number type // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = OuterComposite(myNumber: 123, myString: "myString_example", myBoolean: 123) // OuterComposite | Input composite as post body (optional) +let body = OuterComposite(myNumber: 123, myString: "myString_example", myBoolean: false) // OuterComposite | Input composite as post body (optional) // TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` @@ -81,7 +81,7 @@ let body = OuterComposite(myNumber: 123, myString: "myString_example", myBoolean Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**OuterComposite**](OuterComposite.md)| Input composite as post body | [optional] + **body** | [**OuterComposite**](OuterComposite.md) | Input composite as post body | [optional] ### Return type @@ -121,7 +121,7 @@ let body = 987 // Double | Input number as post body (optional) Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | **Double**| Input number as post body | [optional] + **body** | **Double** | Input number as post body | [optional] ### Return type @@ -161,7 +161,7 @@ let body = "body_example" // String | Input string as post body (optional) Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | **String**| Input string as post body | [optional] + **body** | **String** | Input string as post body | [optional] ### Return type @@ -201,11 +201,11 @@ let body = FileSchemaTestClass(file: File(sourceURI: "sourceURI_example"), files Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**FileSchemaTestClass**](FileSchemaTestClass.md)| | + **body** | [**FileSchemaTestClass**](FileSchemaTestClass.md) | | ### Return type -void (empty response body) +Void (empty response body) ### Authorization @@ -240,12 +240,12 @@ let body = User(id: 123, username: "username_example", firstName: "firstName_exa Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **query** | **String**| | - **body** | [**User**](User.md)| | + **query** | **String** | | + **body** | [**User**](User.md) | | ### Return type -void (empty response body) +Void (empty response body) ### Authorization @@ -281,7 +281,7 @@ let body = Client(client: "client_example") // Client | client model Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**Client**](Client.md)| client model | + **body** | [**Client**](Client.md) | client model | ### Return type @@ -315,15 +315,15 @@ import PetstoreClient let number = 987 // Double | None let double = 987 // Double | None let patternWithoutDelimiter = "patternWithoutDelimiter_example" // String | None -let byte = TODO // Data | None +let byte = 987 // Data | None let integer = 987 // Int | None (optional) let int32 = 987 // Int | None (optional) let int64 = 987 // Int64 | None (optional) let float = 987 // Float | None (optional) let string = "string_example" // String | None (optional) -let binary = "TODO" // URL | None (optional) -let date = TODO // Date | None (optional) -let dateTime = TODO // Date | None (optional) +let binary = URL(string: "https://example.com")! // URL | None (optional) +let date = Date() // Date | None (optional) +let dateTime = Date() // Date | None (optional) let password = "password_example" // String | None (optional) let callback = "callback_example" // String | None (optional) @@ -334,24 +334,24 @@ let callback = "callback_example" // String | None (optional) Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **number** | **Double**| None | - **double** | **Double**| None | - **patternWithoutDelimiter** | **String**| None | - **byte** | **Data**| None | - **integer** | **Int**| None | [optional] - **int32** | **Int**| None | [optional] - **int64** | **Int64**| None | [optional] - **float** | **Float**| None | [optional] - **string** | **String**| None | [optional] - **binary** | **URL****URL**| None | [optional] - **date** | **Date**| None | [optional] - **dateTime** | **Date**| None | [optional] - **password** | **String**| None | [optional] - **callback** | **String**| None | [optional] + **number** | **Double** | None | + **double** | **Double** | None | + **patternWithoutDelimiter** | **String** | None | + **byte** | **Data** | None | + **integer** | **Int** | None | [optional] + **int32** | **Int** | None | [optional] + **int64** | **Int64** | None | [optional] + **float** | **Float** | None | [optional] + **string** | **String** | None | [optional] + **binary** | **URL** | None | [optional] + **date** | **Date** | None | [optional] + **dateTime** | **Date** | None | [optional] + **password** | **String** | None | [optional] + **callback** | **String** | None | [optional] ### Return type -void (empty response body) +Void (empty response body) ### Authorization @@ -394,18 +394,18 @@ let enumFormString = "enumFormString_example" // String | Form parameter enum te Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **enumHeaderStringArray** | [**[String]**](String.md)| Header parameter enum test (string array) | [optional] - **enumHeaderString** | **String**| Header parameter enum test (string) | [optional] [default to .-efg] - **enumQueryStringArray** | [**[String]**](String.md)| Query parameter enum test (string array) | [optional] - **enumQueryString** | **String**| Query parameter enum test (string) | [optional] [default to .-efg] - **enumQueryInteger** | **Int**| Query parameter enum test (double) | [optional] - **enumQueryDouble** | **Double**| Query parameter enum test (double) | [optional] - **enumFormStringArray** | [**[String]**](String.md)| Form parameter enum test (string array) | [optional] [default to .$] - **enumFormString** | **String**| Form parameter enum test (string) | [optional] [default to .-efg] + **enumHeaderStringArray** | [**[String]**](String.md) | Header parameter enum test (string array) | [optional] + **enumHeaderString** | **String** | Header parameter enum test (string) | [optional] [default to .-efg] + **enumQueryStringArray** | [**[String]**](String.md) | Query parameter enum test (string array) | [optional] + **enumQueryString** | **String** | Query parameter enum test (string) | [optional] [default to .-efg] + **enumQueryInteger** | **Int** | Query parameter enum test (double) | [optional] + **enumQueryDouble** | **Double** | Query parameter enum test (double) | [optional] + **enumFormStringArray** | [**[String]**](String.md) | Form parameter enum test (string array) | [optional] [default to .$] + **enumFormString** | **String** | Form parameter enum test (string) | [optional] [default to .-efg] ### Return type -void (empty response body) +Void (empty response body) ### Authorization @@ -433,10 +433,10 @@ Fake endpoint to test group parameters (optional) import PetstoreClient let requiredStringGroup = 987 // Int | Required String in group parameters -let requiredBooleanGroup = 987 // Bool | Required Boolean in group parameters +let requiredBooleanGroup = false // Bool | Required Boolean in group parameters let requiredInt64Group = 987 // Int64 | Required Integer in group parameters let stringGroup = 987 // Int | String in group parameters (optional) -let booleanGroup = 987 // Bool | Boolean in group parameters (optional) +let booleanGroup = false // Bool | Boolean in group parameters (optional) let int64Group = 987 // Int64 | Integer in group parameters (optional) // TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new @@ -446,16 +446,16 @@ let int64Group = 987 // Int64 | Integer in group parameters (optional) Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **requiredStringGroup** | **Int**| Required String in group parameters | - **requiredBooleanGroup** | **Bool**| Required Boolean in group parameters | - **requiredInt64Group** | **Int64**| Required Integer in group parameters | - **stringGroup** | **Int**| String in group parameters | [optional] - **booleanGroup** | **Bool**| Boolean in group parameters | [optional] - **int64Group** | **Int64**| Integer in group parameters | [optional] + **requiredStringGroup** | **Int** | Required String in group parameters | + **requiredBooleanGroup** | **Bool** | Required Boolean in group parameters | + **requiredInt64Group** | **Int64** | Required Integer in group parameters | + **stringGroup** | **Int** | String in group parameters | [optional] + **booleanGroup** | **Bool** | Boolean in group parameters | [optional] + **int64Group** | **Int64** | Integer in group parameters | [optional] ### Return type -void (empty response body) +Void (empty response body) ### Authorization @@ -489,11 +489,11 @@ let param = "TODO" // [String:String] | request body Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **param** | [**[String:String]**](String.md)| request body | + **param** | [**[String:String]**](String.md) | request body | ### Return type -void (empty response body) +Void (empty response body) ### Authorization @@ -528,12 +528,12 @@ let param2 = "param2_example" // String | field2 Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **param** | **String**| field1 | - **param2** | **String**| field2 | + **param** | **String** | field1 | + **param2** | **String** | field2 | ### Return type -void (empty response body) +Void (empty response body) ### Authorization diff --git a/samples/client/petstore/swift4/rxswift/docs/FakeClassnameTags123API.md b/samples/client/petstore/swift4/rxswift/docs/FakeClassnameTags123API.md index 058955a8e1c1..deeddb761639 100644 --- a/samples/client/petstore/swift4/rxswift/docs/FakeClassnameTags123API.md +++ b/samples/client/petstore/swift4/rxswift/docs/FakeClassnameTags123API.md @@ -30,7 +30,7 @@ let body = Client(client: "client_example") // Client | client model Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**Client**](Client.md)| client model | + **body** | [**Client**](Client.md) | client model | ### Return type diff --git a/samples/client/petstore/swift4/rxswift/docs/FileSchemaTestClass.md b/samples/client/petstore/swift4/rxswift/docs/FileSchemaTestClass.md index d0a8bbaaba95..afdacc60b2c3 100644 --- a/samples/client/petstore/swift4/rxswift/docs/FileSchemaTestClass.md +++ b/samples/client/petstore/swift4/rxswift/docs/FileSchemaTestClass.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **file** | [**File**](File.md) | | [optional] -**files** | [**[File]**](File.md) | | [optional] +**files** | [File] | | [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) diff --git a/samples/client/petstore/swift4/rxswift/docs/FormatTest.md b/samples/client/petstore/swift4/rxswift/docs/FormatTest.md index 547eb88754f4..f74d94f6c46a 100644 --- a/samples/client/petstore/swift4/rxswift/docs/FormatTest.md +++ b/samples/client/petstore/swift4/rxswift/docs/FormatTest.md @@ -10,11 +10,11 @@ Name | Type | Description | Notes **float** | **Float** | | [optional] **double** | **Double** | | [optional] **string** | **String** | | [optional] -**byte** | [**Data**](Data.md) | | -**binary** | [**URL**](URL.md) | | [optional] -**date** | [**Date**](Date.md) | | -**dateTime** | [**Date**](Date.md) | | [optional] -**uuid** | [**UUID**](UUID.md) | | [optional] +**byte** | **Data** | | +**binary** | **URL** | | [optional] +**date** | **Date** | | +**dateTime** | **Date** | | [optional] +**uuid** | **UUID** | | [optional] **password** | **String** | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/samples/client/petstore/swift4/rxswift/docs/MapTest.md b/samples/client/petstore/swift4/rxswift/docs/MapTest.md index e910bc97518c..56213c4113f6 100644 --- a/samples/client/petstore/swift4/rxswift/docs/MapTest.md +++ b/samples/client/petstore/swift4/rxswift/docs/MapTest.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**mapMapOfString** | [**[String:[String:String]]**](Dictionary.md) | | [optional] +**mapMapOfString** | [String:[String:String]] | | [optional] **mapOfEnumString** | **[String:String]** | | [optional] **directMap** | **[String:Bool]** | | [optional] **indirectMap** | [**StringBooleanMap**](StringBooleanMap.md) | | [optional] diff --git a/samples/client/petstore/swift4/rxswift/docs/MixedPropertiesAndAdditionalPropertiesClass.md b/samples/client/petstore/swift4/rxswift/docs/MixedPropertiesAndAdditionalPropertiesClass.md index 2c502eace42c..fcffb8ecdbf3 100644 --- a/samples/client/petstore/swift4/rxswift/docs/MixedPropertiesAndAdditionalPropertiesClass.md +++ b/samples/client/petstore/swift4/rxswift/docs/MixedPropertiesAndAdditionalPropertiesClass.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**uuid** | [**UUID**](UUID.md) | | [optional] -**dateTime** | [**Date**](Date.md) | | [optional] -**map** | [**[String:Animal]**](Animal.md) | | [optional] +**uuid** | **UUID** | | [optional] +**dateTime** | **Date** | | [optional] +**map** | [String:Animal] | | [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) diff --git a/samples/client/petstore/swift4/rxswift/docs/Order.md b/samples/client/petstore/swift4/rxswift/docs/Order.md index 9d3205c1526a..15487f01175c 100644 --- a/samples/client/petstore/swift4/rxswift/docs/Order.md +++ b/samples/client/petstore/swift4/rxswift/docs/Order.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes **id** | **Int64** | | [optional] **petId** | **Int64** | | [optional] **quantity** | **Int** | | [optional] -**shipDate** | [**Date**](Date.md) | | [optional] +**shipDate** | **Date** | | [optional] **status** | **String** | Order Status | [optional] **complete** | **Bool** | | [optional] [default to false] diff --git a/samples/client/petstore/swift4/rxswift/docs/Pet.md b/samples/client/petstore/swift4/rxswift/docs/Pet.md index c30a5292f537..5c05f98fad4a 100644 --- a/samples/client/petstore/swift4/rxswift/docs/Pet.md +++ b/samples/client/petstore/swift4/rxswift/docs/Pet.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes **category** | [**Category**](Category.md) | | [optional] **name** | **String** | | **photoUrls** | **[String]** | | -**tags** | [**[Tag]**](Tag.md) | | [optional] +**tags** | [Tag] | | [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) diff --git a/samples/client/petstore/swift4/rxswift/docs/PetAPI.md b/samples/client/petstore/swift4/rxswift/docs/PetAPI.md index e1e1aa43d3fe..0c33b8450eb3 100644 --- a/samples/client/petstore/swift4/rxswift/docs/PetAPI.md +++ b/samples/client/petstore/swift4/rxswift/docs/PetAPI.md @@ -36,11 +36,11 @@ let body = Pet(id: 123, category: Category(id: 123, name: "name_example"), name: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | + **body** | [**Pet**](Pet.md) | Pet object that needs to be added to the store | ### Return type -void (empty response body) +Void (empty response body) ### Authorization @@ -75,12 +75,12 @@ let apiKey = "apiKey_example" // String | (optional) Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **petId** | **Int64**| Pet id to delete | - **apiKey** | **String**| | [optional] + **petId** | **Int64** | Pet id to delete | + **apiKey** | **String** | | [optional] ### Return type -void (empty response body) +Void (empty response body) ### Authorization @@ -116,7 +116,7 @@ let status = ["status_example"] // [String] | Status values that need to be cons Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **status** | [**[String]**](String.md)| Status values that need to be considered for filter | + **status** | [**[String]**](String.md) | Status values that need to be considered for filter | ### Return type @@ -156,7 +156,7 @@ let tags = ["inner_example"] // [String] | Tags to filter by Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **tags** | [**[String]**](String.md)| Tags to filter by | + **tags** | [**[String]**](String.md) | Tags to filter by | ### Return type @@ -196,7 +196,7 @@ let petId = 987 // Int64 | ID of pet to return Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **petId** | **Int64**| ID of pet to return | + **petId** | **Int64** | ID of pet to return | ### Return type @@ -234,11 +234,11 @@ let body = Pet(id: 123, category: Category(id: 123, name: "name_example"), name: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | + **body** | [**Pet**](Pet.md) | Pet object that needs to be added to the store | ### Return type -void (empty response body) +Void (empty response body) ### Authorization @@ -274,13 +274,13 @@ let status = "status_example" // String | Updated status of the pet (optional) Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **petId** | **Int64**| ID of pet that needs to be updated | - **name** | **String**| Updated name of the pet | [optional] - **status** | **String**| Updated status of the pet | [optional] + **petId** | **Int64** | ID of pet that needs to be updated | + **name** | **String** | Updated name of the pet | [optional] + **status** | **String** | Updated status of the pet | [optional] ### Return type -void (empty response body) +Void (empty response body) ### Authorization @@ -307,7 +307,7 @@ import PetstoreClient let petId = 987 // Int64 | ID of pet to update let additionalMetadata = "additionalMetadata_example" // String | Additional data to pass to server (optional) -let file = "TODO" // URL | file to upload (optional) +let file = URL(string: "https://example.com")! // URL | file to upload (optional) // TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` @@ -316,9 +316,9 @@ let file = "TODO" // URL | file to upload (optional) Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **petId** | **Int64**| ID of pet to update | - **additionalMetadata** | **String**| Additional data to pass to server | [optional] - **file** | **URL****URL**| file to upload | [optional] + **petId** | **Int64** | ID of pet to update | + **additionalMetadata** | **String** | Additional data to pass to server | [optional] + **file** | **URL** | file to upload | [optional] ### Return type @@ -348,7 +348,7 @@ uploads an image (required) import PetstoreClient let petId = 987 // Int64 | ID of pet to update -let requiredFile = "TODO" // URL | file to upload +let requiredFile = URL(string: "https://example.com")! // URL | file to upload let additionalMetadata = "additionalMetadata_example" // String | Additional data to pass to server (optional) // TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new @@ -358,9 +358,9 @@ let additionalMetadata = "additionalMetadata_example" // String | Additional dat Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **petId** | **Int64**| ID of pet to update | - **requiredFile** | **URL****URL**| file to upload | - **additionalMetadata** | **String**| Additional data to pass to server | [optional] + **petId** | **Int64** | ID of pet to update | + **requiredFile** | **URL** | file to upload | + **additionalMetadata** | **String** | Additional data to pass to server | [optional] ### Return type diff --git a/samples/client/petstore/swift4/rxswift/docs/StoreAPI.md b/samples/client/petstore/swift4/rxswift/docs/StoreAPI.md index e18e960ff55b..35512242fa78 100644 --- a/samples/client/petstore/swift4/rxswift/docs/StoreAPI.md +++ b/samples/client/petstore/swift4/rxswift/docs/StoreAPI.md @@ -33,11 +33,11 @@ let orderId = "orderId_example" // String | ID of the order that needs to be del Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **orderId** | **String**| ID of the order that needs to be deleted | + **orderId** | **String** | ID of the order that needs to be deleted | ### Return type -void (empty response body) +Void (empty response body) ### Authorization @@ -109,7 +109,7 @@ let orderId = 987 // Int64 | ID of pet that needs to be fetched Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **orderId** | **Int64**| ID of pet that needs to be fetched | + **orderId** | **Int64** | ID of pet that needs to be fetched | ### Return type @@ -138,7 +138,7 @@ Place an order for a pet // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = Order(id: 123, petId: 123, quantity: 123, shipDate: "TODO", status: "status_example", complete: 123) // Order | order placed for purchasing the pet +let body = Order(id: 123, petId: 123, quantity: 123, shipDate: Date(), status: "status_example", complete: false) // Order | order placed for purchasing the pet // TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` @@ -147,7 +147,7 @@ let body = Order(id: 123, petId: 123, quantity: 123, shipDate: "TODO", status: " Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**Order**](Order.md)| order placed for purchasing the pet | + **body** | [**Order**](Order.md) | order placed for purchasing the pet | ### Return type diff --git a/samples/client/petstore/swift4/rxswift/docs/UserAPI.md b/samples/client/petstore/swift4/rxswift/docs/UserAPI.md index d76d0ca82467..8e4cdcb38088 100644 --- a/samples/client/petstore/swift4/rxswift/docs/UserAPI.md +++ b/samples/client/petstore/swift4/rxswift/docs/UserAPI.md @@ -37,11 +37,11 @@ let body = User(id: 123, username: "username_example", firstName: "firstName_exa Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**User**](User.md)| Created user object | + **body** | [**User**](User.md) | Created user object | ### Return type -void (empty response body) +Void (empty response body) ### Authorization @@ -75,11 +75,11 @@ let body = [User(id: 123, username: "username_example", firstName: "firstName_ex Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**[User]**](Array.md)| List of user object | + **body** | [**[User]**](Array.md) | List of user object | ### Return type -void (empty response body) +Void (empty response body) ### Authorization @@ -113,11 +113,11 @@ let body = [User(id: 123, username: "username_example", firstName: "firstName_ex Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**[User]**](Array.md)| List of user object | + **body** | [**[User]**](Array.md) | List of user object | ### Return type -void (empty response body) +Void (empty response body) ### Authorization @@ -153,11 +153,11 @@ let username = "username_example" // String | The name that needs to be deleted Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **username** | **String**| The name that needs to be deleted | + **username** | **String** | The name that needs to be deleted | ### Return type -void (empty response body) +Void (empty response body) ### Authorization @@ -191,7 +191,7 @@ let username = "username_example" // String | The name that needs to be fetched. Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **username** | **String**| The name that needs to be fetched. Use user1 for testing. | + **username** | **String** | The name that needs to be fetched. Use user1 for testing. | ### Return type @@ -230,8 +230,8 @@ let password = "password_example" // String | The password for login in clear te Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **username** | **String**| The user name for login | - **password** | **String**| The password for login in clear text | + **username** | **String** | The user name for login | + **password** | **String** | The password for login in clear text | ### Return type @@ -269,7 +269,7 @@ This endpoint does not need any parameter. ### Return type -void (empty response body) +Void (empty response body) ### Authorization @@ -306,12 +306,12 @@ let body = User(id: 123, username: "username_example", firstName: "firstName_exa Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **username** | **String**| name that need to be deleted | - **body** | [**User**](User.md)| Updated user object | + **username** | **String** | name that need to be deleted | + **body** | [**User**](User.md) | Updated user object | ### Return type -void (empty response body) +Void (empty response body) ### Authorization diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/AdditionalPropertiesClass.md b/samples/client/petstore/swift4/unwrapRequired/docs/AdditionalPropertiesClass.md index a524730eb652..e22d28be1de6 100644 --- a/samples/client/petstore/swift4/unwrapRequired/docs/AdditionalPropertiesClass.md +++ b/samples/client/petstore/swift4/unwrapRequired/docs/AdditionalPropertiesClass.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **mapString** | **[String:String]** | | [optional] -**mapMapString** | [**[String:[String:String]]**](Dictionary.md) | | [optional] +**mapMapString** | [String:[String: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) diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/AnotherFakeAPI.md b/samples/client/petstore/swift4/unwrapRequired/docs/AnotherFakeAPI.md index e6a8f62dfa75..e4228cb018b6 100644 --- a/samples/client/petstore/swift4/unwrapRequired/docs/AnotherFakeAPI.md +++ b/samples/client/petstore/swift4/unwrapRequired/docs/AnotherFakeAPI.md @@ -9,7 +9,7 @@ Method | HTTP request | Description # **call123testSpecialTags** ```swift - open class func call123testSpecialTags(body: Client, completion: @escaping ((_ data: Client?,_ error: Error?) -> Void)) + open class func call123testSpecialTags(body: Client, completion: @escaping (_ data: Client?, _ error: Error?) -> Void) ``` To test special tags @@ -40,7 +40,7 @@ AnotherFakeAPI.call123testSpecialTags(body: body) { (response, error) in Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**Client**](Client.md)| client model | + **body** | [**Client**](Client.md) | client model | ### Return type diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/ArrayOfArrayOfNumberOnly.md b/samples/client/petstore/swift4/unwrapRequired/docs/ArrayOfArrayOfNumberOnly.md index 3f78a9584d82..c6fceff5e08d 100644 --- a/samples/client/petstore/swift4/unwrapRequired/docs/ArrayOfArrayOfNumberOnly.md +++ b/samples/client/petstore/swift4/unwrapRequired/docs/ArrayOfArrayOfNumberOnly.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**arrayArrayNumber** | [**[[Double]]**](Array.md) | | [optional] +**arrayArrayNumber** | [[Double]] | | [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) diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/ArrayTest.md b/samples/client/petstore/swift4/unwrapRequired/docs/ArrayTest.md index dd9be9d5876b..bf416b8330cc 100644 --- a/samples/client/petstore/swift4/unwrapRequired/docs/ArrayTest.md +++ b/samples/client/petstore/swift4/unwrapRequired/docs/ArrayTest.md @@ -4,8 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayOfString** | **[String]** | | [optional] -**arrayArrayOfInteger** | [**[[Int64]]**](Array.md) | | [optional] -**arrayArrayOfModel** | [**[[ReadOnlyFirst]]**](Array.md) | | [optional] +**arrayArrayOfInteger** | [[Int64]] | | [optional] +**arrayArrayOfModel** | [[ReadOnlyFirst]] | | [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) diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/FakeAPI.md b/samples/client/petstore/swift4/unwrapRequired/docs/FakeAPI.md index e0c5434ee605..3e96e7830c26 100644 --- a/samples/client/petstore/swift4/unwrapRequired/docs/FakeAPI.md +++ b/samples/client/petstore/swift4/unwrapRequired/docs/FakeAPI.md @@ -20,7 +20,7 @@ Method | HTTP request | Description # **fakeOuterBooleanSerialize** ```swift - open class func fakeOuterBooleanSerialize(body: Bool? = nil, completion: @escaping ((_ data: Bool?,_ error: Error?) -> Void)) + open class func fakeOuterBooleanSerialize(body: Bool? = nil, completion: @escaping (_ data: Bool?, _ error: Error?) -> Void) ``` @@ -32,7 +32,7 @@ Test serialization of outer boolean types // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = 987 // Bool | Input boolean as post body (optional) +let body = false // Bool | Input boolean as post body (optional) FakeAPI.fakeOuterBooleanSerialize(body: body) { (response, error) in guard error == nil else { @@ -50,7 +50,7 @@ FakeAPI.fakeOuterBooleanSerialize(body: body) { (response, error) in Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | **Bool**| Input boolean as post body | [optional] + **body** | **Bool** | Input boolean as post body | [optional] ### Return type @@ -69,7 +69,7 @@ No authorization required # **fakeOuterCompositeSerialize** ```swift - open class func fakeOuterCompositeSerialize(body: OuterComposite? = nil, completion: @escaping ((_ data: OuterComposite?,_ error: Error?) -> Void)) + open class func fakeOuterCompositeSerialize(body: OuterComposite? = nil, completion: @escaping (_ data: OuterComposite?, _ error: Error?) -> Void) ``` @@ -81,7 +81,7 @@ Test serialization of object with outer number type // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = OuterComposite(myNumber: 123, myString: "myString_example", myBoolean: 123) // OuterComposite | Input composite as post body (optional) +let body = OuterComposite(myNumber: 123, myString: "myString_example", myBoolean: false) // OuterComposite | Input composite as post body (optional) FakeAPI.fakeOuterCompositeSerialize(body: body) { (response, error) in guard error == nil else { @@ -99,7 +99,7 @@ FakeAPI.fakeOuterCompositeSerialize(body: body) { (response, error) in Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**OuterComposite**](OuterComposite.md)| Input composite as post body | [optional] + **body** | [**OuterComposite**](OuterComposite.md) | Input composite as post body | [optional] ### Return type @@ -118,7 +118,7 @@ No authorization required # **fakeOuterNumberSerialize** ```swift - open class func fakeOuterNumberSerialize(body: Double? = nil, completion: @escaping ((_ data: Double?,_ error: Error?) -> Void)) + open class func fakeOuterNumberSerialize(body: Double? = nil, completion: @escaping (_ data: Double?, _ error: Error?) -> Void) ``` @@ -148,7 +148,7 @@ FakeAPI.fakeOuterNumberSerialize(body: body) { (response, error) in Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | **Double**| Input number as post body | [optional] + **body** | **Double** | Input number as post body | [optional] ### Return type @@ -167,7 +167,7 @@ No authorization required # **fakeOuterStringSerialize** ```swift - open class func fakeOuterStringSerialize(body: String? = nil, completion: @escaping ((_ data: String?,_ error: Error?) -> Void)) + open class func fakeOuterStringSerialize(body: String? = nil, completion: @escaping (_ data: String?, _ error: Error?) -> Void) ``` @@ -197,7 +197,7 @@ FakeAPI.fakeOuterStringSerialize(body: body) { (response, error) in Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | **String**| Input string as post body | [optional] + **body** | **String** | Input string as post body | [optional] ### Return type @@ -216,7 +216,7 @@ No authorization required # **testBodyWithFileSchema** ```swift - open class func testBodyWithFileSchema(body: FileSchemaTestClass, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) + open class func testBodyWithFileSchema(body: FileSchemaTestClass, completion: @escaping (_ data: Void?, _ error: Error?) -> Void) ``` @@ -246,11 +246,11 @@ FakeAPI.testBodyWithFileSchema(body: body) { (response, error) in Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**FileSchemaTestClass**](FileSchemaTestClass.md)| | + **body** | [**FileSchemaTestClass**](FileSchemaTestClass.md) | | ### Return type -void (empty response body) +Void (empty response body) ### Authorization @@ -265,7 +265,7 @@ No authorization required # **testBodyWithQueryParams** ```swift - open class func testBodyWithQueryParams(query: String, body: User, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) + open class func testBodyWithQueryParams(query: String, body: User, completion: @escaping (_ data: Void?, _ error: Error?) -> Void) ``` @@ -294,12 +294,12 @@ FakeAPI.testBodyWithQueryParams(query: query, body: body) { (response, error) in Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **query** | **String**| | - **body** | [**User**](User.md)| | + **query** | **String** | | + **body** | [**User**](User.md) | | ### Return type -void (empty response body) +Void (empty response body) ### Authorization @@ -314,7 +314,7 @@ No authorization required # **testClientModel** ```swift - open class func testClientModel(body: Client, completion: @escaping ((_ data: Client?,_ error: Error?) -> Void)) + open class func testClientModel(body: Client, completion: @escaping (_ data: Client?, _ error: Error?) -> Void) ``` To test \"client\" model @@ -345,7 +345,7 @@ FakeAPI.testClientModel(body: body) { (response, error) in Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**Client**](Client.md)| client model | + **body** | [**Client**](Client.md) | client model | ### Return type @@ -364,7 +364,7 @@ No authorization required # **testEndpointParameters** ```swift - open class func testEndpointParameters(number: Double, double: Double, patternWithoutDelimiter: String, byte: Data, integer: Int? = nil, int32: Int? = nil, int64: Int64? = nil, float: Float? = nil, string: String? = nil, binary: URL? = nil, date: Date? = nil, dateTime: Date? = nil, password: String? = nil, callback: String? = nil, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) + open class func testEndpointParameters(number: Double, double: Double, patternWithoutDelimiter: String, byte: Data, integer: Int? = nil, int32: Int? = nil, int64: Int64? = nil, float: Float? = nil, string: String? = nil, binary: URL? = nil, date: Date? = nil, dateTime: Date? = nil, password: String? = nil, callback: String? = nil, completion: @escaping (_ data: Void?, _ error: Error?) -> Void) ``` Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 @@ -379,15 +379,15 @@ import PetstoreClient let number = 987 // Double | None let double = 987 // Double | None let patternWithoutDelimiter = "patternWithoutDelimiter_example" // String | None -let byte = TODO // Data | None +let byte = 987 // Data | None let integer = 987 // Int | None (optional) let int32 = 987 // Int | None (optional) let int64 = 987 // Int64 | None (optional) let float = 987 // Float | None (optional) let string = "string_example" // String | None (optional) -let binary = "TODO" // URL | None (optional) -let date = TODO // Date | None (optional) -let dateTime = TODO // Date | None (optional) +let binary = URL(string: "https://example.com")! // URL | None (optional) +let date = Date() // Date | None (optional) +let dateTime = Date() // Date | None (optional) let password = "password_example" // String | None (optional) let callback = "callback_example" // String | None (optional) @@ -408,24 +408,24 @@ FakeAPI.testEndpointParameters(number: number, double: double, patternWithoutDel Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **number** | **Double**| None | - **double** | **Double**| None | - **patternWithoutDelimiter** | **String**| None | - **byte** | **Data**| None | - **integer** | **Int**| None | [optional] - **int32** | **Int**| None | [optional] - **int64** | **Int64**| None | [optional] - **float** | **Float**| None | [optional] - **string** | **String**| None | [optional] - **binary** | **URL****URL**| None | [optional] - **date** | **Date**| None | [optional] - **dateTime** | **Date**| None | [optional] - **password** | **String**| None | [optional] - **callback** | **String**| None | [optional] + **number** | **Double** | None | + **double** | **Double** | None | + **patternWithoutDelimiter** | **String** | None | + **byte** | **Data** | None | + **integer** | **Int** | None | [optional] + **int32** | **Int** | None | [optional] + **int64** | **Int64** | None | [optional] + **float** | **Float** | None | [optional] + **string** | **String** | None | [optional] + **binary** | **URL** | None | [optional] + **date** | **Date** | None | [optional] + **dateTime** | **Date** | None | [optional] + **password** | **String** | None | [optional] + **callback** | **String** | None | [optional] ### Return type -void (empty response body) +Void (empty response body) ### Authorization @@ -440,7 +440,7 @@ void (empty response body) # **testEnumParameters** ```swift - open class func testEnumParameters(enumHeaderStringArray: [String]? = nil, enumHeaderString: EnumHeaderString_testEnumParameters? = nil, enumQueryStringArray: [String]? = nil, enumQueryString: EnumQueryString_testEnumParameters? = nil, enumQueryInteger: EnumQueryInteger_testEnumParameters? = nil, enumQueryDouble: EnumQueryDouble_testEnumParameters? = nil, enumFormStringArray: [String]? = nil, enumFormString: EnumFormString_testEnumParameters? = nil, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) + open class func testEnumParameters(enumHeaderStringArray: [String]? = nil, enumHeaderString: EnumHeaderString_testEnumParameters? = nil, enumQueryStringArray: [String]? = nil, enumQueryString: EnumQueryString_testEnumParameters? = nil, enumQueryInteger: EnumQueryInteger_testEnumParameters? = nil, enumQueryDouble: EnumQueryDouble_testEnumParameters? = nil, enumFormStringArray: [String]? = nil, enumFormString: EnumFormString_testEnumParameters? = nil, completion: @escaping (_ data: Void?, _ error: Error?) -> Void) ``` To test enum parameters @@ -478,18 +478,18 @@ FakeAPI.testEnumParameters(enumHeaderStringArray: enumHeaderStringArray, enumHea Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **enumHeaderStringArray** | [**[String]**](String.md)| Header parameter enum test (string array) | [optional] - **enumHeaderString** | **String**| Header parameter enum test (string) | [optional] [default to .-efg] - **enumQueryStringArray** | [**[String]**](String.md)| Query parameter enum test (string array) | [optional] - **enumQueryString** | **String**| Query parameter enum test (string) | [optional] [default to .-efg] - **enumQueryInteger** | **Int**| Query parameter enum test (double) | [optional] - **enumQueryDouble** | **Double**| Query parameter enum test (double) | [optional] - **enumFormStringArray** | [**[String]**](String.md)| Form parameter enum test (string array) | [optional] [default to .$] - **enumFormString** | **String**| Form parameter enum test (string) | [optional] [default to .-efg] + **enumHeaderStringArray** | [**[String]**](String.md) | Header parameter enum test (string array) | [optional] + **enumHeaderString** | **String** | Header parameter enum test (string) | [optional] [default to .-efg] + **enumQueryStringArray** | [**[String]**](String.md) | Query parameter enum test (string array) | [optional] + **enumQueryString** | **String** | Query parameter enum test (string) | [optional] [default to .-efg] + **enumQueryInteger** | **Int** | Query parameter enum test (double) | [optional] + **enumQueryDouble** | **Double** | Query parameter enum test (double) | [optional] + **enumFormStringArray** | [**[String]**](String.md) | Form parameter enum test (string array) | [optional] [default to .$] + **enumFormString** | **String** | Form parameter enum test (string) | [optional] [default to .-efg] ### Return type -void (empty response body) +Void (empty response body) ### Authorization @@ -504,7 +504,7 @@ No authorization required # **testGroupParameters** ```swift - open class func testGroupParameters(requiredStringGroup: Int, requiredBooleanGroup: Bool, requiredInt64Group: Int64, stringGroup: Int? = nil, booleanGroup: Bool? = nil, int64Group: Int64? = nil, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) + open class func testGroupParameters(requiredStringGroup: Int, requiredBooleanGroup: Bool, requiredInt64Group: Int64, stringGroup: Int? = nil, booleanGroup: Bool? = nil, int64Group: Int64? = nil, completion: @escaping (_ data: Void?, _ error: Error?) -> Void) ``` Fake endpoint to test group parameters (optional) @@ -517,10 +517,10 @@ Fake endpoint to test group parameters (optional) import PetstoreClient let requiredStringGroup = 987 // Int | Required String in group parameters -let requiredBooleanGroup = 987 // Bool | Required Boolean in group parameters +let requiredBooleanGroup = false // Bool | Required Boolean in group parameters let requiredInt64Group = 987 // Int64 | Required Integer in group parameters let stringGroup = 987 // Int | String in group parameters (optional) -let booleanGroup = 987 // Bool | Boolean in group parameters (optional) +let booleanGroup = false // Bool | Boolean in group parameters (optional) let int64Group = 987 // Int64 | Integer in group parameters (optional) // Fake endpoint to test group parameters (optional) @@ -540,16 +540,16 @@ FakeAPI.testGroupParameters(requiredStringGroup: requiredStringGroup, requiredBo Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **requiredStringGroup** | **Int**| Required String in group parameters | - **requiredBooleanGroup** | **Bool**| Required Boolean in group parameters | - **requiredInt64Group** | **Int64**| Required Integer in group parameters | - **stringGroup** | **Int**| String in group parameters | [optional] - **booleanGroup** | **Bool**| Boolean in group parameters | [optional] - **int64Group** | **Int64**| Integer in group parameters | [optional] + **requiredStringGroup** | **Int** | Required String in group parameters | + **requiredBooleanGroup** | **Bool** | Required Boolean in group parameters | + **requiredInt64Group** | **Int64** | Required Integer in group parameters | + **stringGroup** | **Int** | String in group parameters | [optional] + **booleanGroup** | **Bool** | Boolean in group parameters | [optional] + **int64Group** | **Int64** | Integer in group parameters | [optional] ### Return type -void (empty response body) +Void (empty response body) ### Authorization @@ -564,7 +564,7 @@ No authorization required # **testInlineAdditionalProperties** ```swift - open class func testInlineAdditionalProperties(param: [String:String], completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) + open class func testInlineAdditionalProperties(param: [String:String], completion: @escaping (_ data: Void?, _ error: Error?) -> Void) ``` test inline additionalProperties @@ -593,11 +593,11 @@ FakeAPI.testInlineAdditionalProperties(param: param) { (response, error) in Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **param** | [**[String:String]**](String.md)| request body | + **param** | [**[String:String]**](String.md) | request body | ### Return type -void (empty response body) +Void (empty response body) ### Authorization @@ -612,7 +612,7 @@ No authorization required # **testJsonFormData** ```swift - open class func testJsonFormData(param: String, param2: String, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) + open class func testJsonFormData(param: String, param2: String, completion: @escaping (_ data: Void?, _ error: Error?) -> Void) ``` test json serialization of form data @@ -642,12 +642,12 @@ FakeAPI.testJsonFormData(param: param, param2: param2) { (response, error) in Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **param** | **String**| field1 | - **param2** | **String**| field2 | + **param** | **String** | field1 | + **param2** | **String** | field2 | ### Return type -void (empty response body) +Void (empty response body) ### Authorization diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/FakeClassnameTags123API.md b/samples/client/petstore/swift4/unwrapRequired/docs/FakeClassnameTags123API.md index 704dacda40de..e46333f3454b 100644 --- a/samples/client/petstore/swift4/unwrapRequired/docs/FakeClassnameTags123API.md +++ b/samples/client/petstore/swift4/unwrapRequired/docs/FakeClassnameTags123API.md @@ -9,7 +9,7 @@ Method | HTTP request | Description # **testClassname** ```swift - open class func testClassname(body: Client, completion: @escaping ((_ data: Client?,_ error: Error?) -> Void)) + open class func testClassname(body: Client, completion: @escaping (_ data: Client?, _ error: Error?) -> Void) ``` To test class name in snake case @@ -40,7 +40,7 @@ FakeClassnameTags123API.testClassname(body: body) { (response, error) in Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**Client**](Client.md)| client model | + **body** | [**Client**](Client.md) | client model | ### Return type diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/FileSchemaTestClass.md b/samples/client/petstore/swift4/unwrapRequired/docs/FileSchemaTestClass.md index d0a8bbaaba95..afdacc60b2c3 100644 --- a/samples/client/petstore/swift4/unwrapRequired/docs/FileSchemaTestClass.md +++ b/samples/client/petstore/swift4/unwrapRequired/docs/FileSchemaTestClass.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **file** | [**File**](File.md) | | [optional] -**files** | [**[File]**](File.md) | | [optional] +**files** | [File] | | [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) diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/FormatTest.md b/samples/client/petstore/swift4/unwrapRequired/docs/FormatTest.md index 547eb88754f4..f74d94f6c46a 100644 --- a/samples/client/petstore/swift4/unwrapRequired/docs/FormatTest.md +++ b/samples/client/petstore/swift4/unwrapRequired/docs/FormatTest.md @@ -10,11 +10,11 @@ Name | Type | Description | Notes **float** | **Float** | | [optional] **double** | **Double** | | [optional] **string** | **String** | | [optional] -**byte** | [**Data**](Data.md) | | -**binary** | [**URL**](URL.md) | | [optional] -**date** | [**Date**](Date.md) | | -**dateTime** | [**Date**](Date.md) | | [optional] -**uuid** | [**UUID**](UUID.md) | | [optional] +**byte** | **Data** | | +**binary** | **URL** | | [optional] +**date** | **Date** | | +**dateTime** | **Date** | | [optional] +**uuid** | **UUID** | | [optional] **password** | **String** | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/MapTest.md b/samples/client/petstore/swift4/unwrapRequired/docs/MapTest.md index e910bc97518c..56213c4113f6 100644 --- a/samples/client/petstore/swift4/unwrapRequired/docs/MapTest.md +++ b/samples/client/petstore/swift4/unwrapRequired/docs/MapTest.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**mapMapOfString** | [**[String:[String:String]]**](Dictionary.md) | | [optional] +**mapMapOfString** | [String:[String:String]] | | [optional] **mapOfEnumString** | **[String:String]** | | [optional] **directMap** | **[String:Bool]** | | [optional] **indirectMap** | [**StringBooleanMap**](StringBooleanMap.md) | | [optional] diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/MixedPropertiesAndAdditionalPropertiesClass.md b/samples/client/petstore/swift4/unwrapRequired/docs/MixedPropertiesAndAdditionalPropertiesClass.md index 2c502eace42c..fcffb8ecdbf3 100644 --- a/samples/client/petstore/swift4/unwrapRequired/docs/MixedPropertiesAndAdditionalPropertiesClass.md +++ b/samples/client/petstore/swift4/unwrapRequired/docs/MixedPropertiesAndAdditionalPropertiesClass.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**uuid** | [**UUID**](UUID.md) | | [optional] -**dateTime** | [**Date**](Date.md) | | [optional] -**map** | [**[String:Animal]**](Animal.md) | | [optional] +**uuid** | **UUID** | | [optional] +**dateTime** | **Date** | | [optional] +**map** | [String:Animal] | | [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) diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/Order.md b/samples/client/petstore/swift4/unwrapRequired/docs/Order.md index 9d3205c1526a..15487f01175c 100644 --- a/samples/client/petstore/swift4/unwrapRequired/docs/Order.md +++ b/samples/client/petstore/swift4/unwrapRequired/docs/Order.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes **id** | **Int64** | | [optional] **petId** | **Int64** | | [optional] **quantity** | **Int** | | [optional] -**shipDate** | [**Date**](Date.md) | | [optional] +**shipDate** | **Date** | | [optional] **status** | **String** | Order Status | [optional] **complete** | **Bool** | | [optional] [default to false] diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/Pet.md b/samples/client/petstore/swift4/unwrapRequired/docs/Pet.md index c30a5292f537..5c05f98fad4a 100644 --- a/samples/client/petstore/swift4/unwrapRequired/docs/Pet.md +++ b/samples/client/petstore/swift4/unwrapRequired/docs/Pet.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes **category** | [**Category**](Category.md) | | [optional] **name** | **String** | | **photoUrls** | **[String]** | | -**tags** | [**[Tag]**](Tag.md) | | [optional] +**tags** | [Tag] | | [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) diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/PetAPI.md b/samples/client/petstore/swift4/unwrapRequired/docs/PetAPI.md index 3d57572d9498..02cb51983a82 100644 --- a/samples/client/petstore/swift4/unwrapRequired/docs/PetAPI.md +++ b/samples/client/petstore/swift4/unwrapRequired/docs/PetAPI.md @@ -17,7 +17,7 @@ Method | HTTP request | Description # **addPet** ```swift - open class func addPet(body: Pet, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) + open class func addPet(body: Pet, completion: @escaping (_ data: Void?, _ error: Error?) -> Void) ``` Add a new pet to the store @@ -46,11 +46,11 @@ PetAPI.addPet(body: body) { (response, error) in Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | + **body** | [**Pet**](Pet.md) | Pet object that needs to be added to the store | ### Return type -void (empty response body) +Void (empty response body) ### Authorization @@ -65,7 +65,7 @@ void (empty response body) # **deletePet** ```swift - open class func deletePet(petId: Int64, apiKey: String? = nil, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) + open class func deletePet(petId: Int64, apiKey: String? = nil, completion: @escaping (_ data: Void?, _ error: Error?) -> Void) ``` Deletes a pet @@ -95,12 +95,12 @@ PetAPI.deletePet(petId: petId, apiKey: apiKey) { (response, error) in Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **petId** | **Int64**| Pet id to delete | - **apiKey** | **String**| | [optional] + **petId** | **Int64** | Pet id to delete | + **apiKey** | **String** | | [optional] ### Return type -void (empty response body) +Void (empty response body) ### Authorization @@ -115,7 +115,7 @@ void (empty response body) # **findPetsByStatus** ```swift - open class func findPetsByStatus(status: [String], completion: @escaping ((_ data: [Pet]?,_ error: Error?) -> Void)) + open class func findPetsByStatus(status: [String], completion: @escaping (_ data: [Pet]?, _ error: Error?) -> Void) ``` Finds Pets by status @@ -146,7 +146,7 @@ PetAPI.findPetsByStatus(status: status) { (response, error) in Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **status** | [**[String]**](String.md)| Status values that need to be considered for filter | + **status** | [**[String]**](String.md) | Status values that need to be considered for filter | ### Return type @@ -165,7 +165,7 @@ Name | Type | Description | Notes # **findPetsByTags** ```swift - open class func findPetsByTags(tags: [String], completion: @escaping ((_ data: [Pet]?,_ error: Error?) -> Void)) + open class func findPetsByTags(tags: [String], completion: @escaping (_ data: [Pet]?, _ error: Error?) -> Void) ``` Finds Pets by tags @@ -196,7 +196,7 @@ PetAPI.findPetsByTags(tags: tags) { (response, error) in Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **tags** | [**[String]**](String.md)| Tags to filter by | + **tags** | [**[String]**](String.md) | Tags to filter by | ### Return type @@ -215,7 +215,7 @@ Name | Type | Description | Notes # **getPetById** ```swift - open class func getPetById(petId: Int64, completion: @escaping ((_ data: Pet?,_ error: Error?) -> Void)) + open class func getPetById(petId: Int64, completion: @escaping (_ data: Pet?, _ error: Error?) -> Void) ``` Find pet by ID @@ -246,7 +246,7 @@ PetAPI.getPetById(petId: petId) { (response, error) in Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **petId** | **Int64**| ID of pet to return | + **petId** | **Int64** | ID of pet to return | ### Return type @@ -265,7 +265,7 @@ Name | Type | Description | Notes # **updatePet** ```swift - open class func updatePet(body: Pet, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) + open class func updatePet(body: Pet, completion: @escaping (_ data: Void?, _ error: Error?) -> Void) ``` Update an existing pet @@ -294,11 +294,11 @@ PetAPI.updatePet(body: body) { (response, error) in Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | + **body** | [**Pet**](Pet.md) | Pet object that needs to be added to the store | ### Return type -void (empty response body) +Void (empty response body) ### Authorization @@ -313,7 +313,7 @@ void (empty response body) # **updatePetWithForm** ```swift - open class func updatePetWithForm(petId: Int64, name: String? = nil, status: String? = nil, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) + open class func updatePetWithForm(petId: Int64, name: String? = nil, status: String? = nil, completion: @escaping (_ data: Void?, _ error: Error?) -> Void) ``` Updates a pet in the store with form data @@ -344,13 +344,13 @@ PetAPI.updatePetWithForm(petId: petId, name: name, status: status) { (response, Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **petId** | **Int64**| ID of pet that needs to be updated | - **name** | **String**| Updated name of the pet | [optional] - **status** | **String**| Updated status of the pet | [optional] + **petId** | **Int64** | ID of pet that needs to be updated | + **name** | **String** | Updated name of the pet | [optional] + **status** | **String** | Updated status of the pet | [optional] ### Return type -void (empty response body) +Void (empty response body) ### Authorization @@ -365,7 +365,7 @@ void (empty response body) # **uploadFile** ```swift - open class func uploadFile(petId: Int64, additionalMetadata: String? = nil, file: URL? = nil, completion: @escaping ((_ data: ApiResponse?,_ error: Error?) -> Void)) + open class func uploadFile(petId: Int64, additionalMetadata: String? = nil, file: URL? = nil, completion: @escaping (_ data: ApiResponse?, _ error: Error?) -> Void) ``` uploads an image @@ -377,7 +377,7 @@ import PetstoreClient let petId = 987 // Int64 | ID of pet to update let additionalMetadata = "additionalMetadata_example" // String | Additional data to pass to server (optional) -let file = "TODO" // URL | file to upload (optional) +let file = URL(string: "https://example.com")! // URL | file to upload (optional) // uploads an image PetAPI.uploadFile(petId: petId, additionalMetadata: additionalMetadata, file: file) { (response, error) in @@ -396,9 +396,9 @@ PetAPI.uploadFile(petId: petId, additionalMetadata: additionalMetadata, file: fi Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **petId** | **Int64**| ID of pet to update | - **additionalMetadata** | **String**| Additional data to pass to server | [optional] - **file** | **URL****URL**| file to upload | [optional] + **petId** | **Int64** | ID of pet to update | + **additionalMetadata** | **String** | Additional data to pass to server | [optional] + **file** | **URL** | file to upload | [optional] ### Return type @@ -417,7 +417,7 @@ Name | Type | Description | Notes # **uploadFileWithRequiredFile** ```swift - open class func uploadFileWithRequiredFile(petId: Int64, requiredFile: URL, additionalMetadata: String? = nil, completion: @escaping ((_ data: ApiResponse?,_ error: Error?) -> Void)) + open class func uploadFileWithRequiredFile(petId: Int64, requiredFile: URL, additionalMetadata: String? = nil, completion: @escaping (_ data: ApiResponse?, _ error: Error?) -> Void) ``` uploads an image (required) @@ -428,7 +428,7 @@ uploads an image (required) import PetstoreClient let petId = 987 // Int64 | ID of pet to update -let requiredFile = "TODO" // URL | file to upload +let requiredFile = URL(string: "https://example.com")! // URL | file to upload let additionalMetadata = "additionalMetadata_example" // String | Additional data to pass to server (optional) // uploads an image (required) @@ -448,9 +448,9 @@ PetAPI.uploadFileWithRequiredFile(petId: petId, requiredFile: requiredFile, addi Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **petId** | **Int64**| ID of pet to update | - **requiredFile** | **URL****URL**| file to upload | - **additionalMetadata** | **String**| Additional data to pass to server | [optional] + **petId** | **Int64** | ID of pet to update | + **requiredFile** | **URL** | file to upload | + **additionalMetadata** | **String** | Additional data to pass to server | [optional] ### Return type diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/StoreAPI.md b/samples/client/petstore/swift4/unwrapRequired/docs/StoreAPI.md index 995b9cdea9ff..da5100bbab40 100644 --- a/samples/client/petstore/swift4/unwrapRequired/docs/StoreAPI.md +++ b/samples/client/petstore/swift4/unwrapRequired/docs/StoreAPI.md @@ -12,7 +12,7 @@ Method | HTTP request | Description # **deleteOrder** ```swift - open class func deleteOrder(orderId: String, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) + open class func deleteOrder(orderId: String, completion: @escaping (_ data: Void?, _ error: Error?) -> Void) ``` Delete purchase order by ID @@ -43,11 +43,11 @@ StoreAPI.deleteOrder(orderId: orderId) { (response, error) in Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **orderId** | **String**| ID of the order that needs to be deleted | + **orderId** | **String** | ID of the order that needs to be deleted | ### Return type -void (empty response body) +Void (empty response body) ### Authorization @@ -62,7 +62,7 @@ No authorization required # **getInventory** ```swift - open class func getInventory(completion: @escaping ((_ data: [String:Int]?,_ error: Error?) -> Void)) + open class func getInventory(completion: @escaping (_ data: [String:Int]?, _ error: Error?) -> Void) ``` Returns pet inventories by status @@ -108,7 +108,7 @@ This endpoint does not need any parameter. # **getOrderById** ```swift - open class func getOrderById(orderId: Int64, completion: @escaping ((_ data: Order?,_ error: Error?) -> Void)) + open class func getOrderById(orderId: Int64, completion: @escaping (_ data: Order?, _ error: Error?) -> Void) ``` Find purchase order by ID @@ -139,7 +139,7 @@ StoreAPI.getOrderById(orderId: orderId) { (response, error) in Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **orderId** | **Int64**| ID of pet that needs to be fetched | + **orderId** | **Int64** | ID of pet that needs to be fetched | ### Return type @@ -158,7 +158,7 @@ No authorization required # **placeOrder** ```swift - open class func placeOrder(body: Order, completion: @escaping ((_ data: Order?,_ error: Error?) -> Void)) + open class func placeOrder(body: Order, completion: @escaping (_ data: Order?, _ error: Error?) -> Void) ``` Place an order for a pet @@ -168,7 +168,7 @@ Place an order for a pet // the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -let body = Order(id: 123, petId: 123, quantity: 123, shipDate: "TODO", status: "status_example", complete: 123) // Order | order placed for purchasing the pet +let body = Order(id: 123, petId: 123, quantity: 123, shipDate: Date(), status: "status_example", complete: false) // Order | order placed for purchasing the pet // Place an order for a pet StoreAPI.placeOrder(body: body) { (response, error) in @@ -187,7 +187,7 @@ StoreAPI.placeOrder(body: body) { (response, error) in Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**Order**](Order.md)| order placed for purchasing the pet | + **body** | [**Order**](Order.md) | order placed for purchasing the pet | ### Return type diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/UserAPI.md b/samples/client/petstore/swift4/unwrapRequired/docs/UserAPI.md index 9c1b0500075a..b89e05125571 100644 --- a/samples/client/petstore/swift4/unwrapRequired/docs/UserAPI.md +++ b/samples/client/petstore/swift4/unwrapRequired/docs/UserAPI.md @@ -16,7 +16,7 @@ Method | HTTP request | Description # **createUser** ```swift - open class func createUser(body: User, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) + open class func createUser(body: User, completion: @escaping (_ data: Void?, _ error: Error?) -> Void) ``` Create user @@ -47,11 +47,11 @@ UserAPI.createUser(body: body) { (response, error) in Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**User**](User.md)| Created user object | + **body** | [**User**](User.md) | Created user object | ### Return type -void (empty response body) +Void (empty response body) ### Authorization @@ -66,7 +66,7 @@ No authorization required # **createUsersWithArrayInput** ```swift - open class func createUsersWithArrayInput(body: [User], completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) + open class func createUsersWithArrayInput(body: [User], completion: @escaping (_ data: Void?, _ error: Error?) -> Void) ``` Creates list of users with given input array @@ -95,11 +95,11 @@ UserAPI.createUsersWithArrayInput(body: body) { (response, error) in Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**[User]**](Array.md)| List of user object | + **body** | [**[User]**](Array.md) | List of user object | ### Return type -void (empty response body) +Void (empty response body) ### Authorization @@ -114,7 +114,7 @@ No authorization required # **createUsersWithListInput** ```swift - open class func createUsersWithListInput(body: [User], completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) + open class func createUsersWithListInput(body: [User], completion: @escaping (_ data: Void?, _ error: Error?) -> Void) ``` Creates list of users with given input array @@ -143,11 +143,11 @@ UserAPI.createUsersWithListInput(body: body) { (response, error) in Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**[User]**](Array.md)| List of user object | + **body** | [**[User]**](Array.md) | List of user object | ### Return type -void (empty response body) +Void (empty response body) ### Authorization @@ -162,7 +162,7 @@ No authorization required # **deleteUser** ```swift - open class func deleteUser(username: String, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) + open class func deleteUser(username: String, completion: @escaping (_ data: Void?, _ error: Error?) -> Void) ``` Delete user @@ -193,11 +193,11 @@ UserAPI.deleteUser(username: username) { (response, error) in Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **username** | **String**| The name that needs to be deleted | + **username** | **String** | The name that needs to be deleted | ### Return type -void (empty response body) +Void (empty response body) ### Authorization @@ -212,7 +212,7 @@ No authorization required # **getUserByName** ```swift - open class func getUserByName(username: String, completion: @escaping ((_ data: User?,_ error: Error?) -> Void)) + open class func getUserByName(username: String, completion: @escaping (_ data: User?, _ error: Error?) -> Void) ``` Get user by user name @@ -241,7 +241,7 @@ UserAPI.getUserByName(username: username) { (response, error) in Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **username** | **String**| The name that needs to be fetched. Use user1 for testing. | + **username** | **String** | The name that needs to be fetched. Use user1 for testing. | ### Return type @@ -260,7 +260,7 @@ No authorization required # **loginUser** ```swift - open class func loginUser(username: String, password: String, completion: @escaping ((_ data: String?,_ error: Error?) -> Void)) + open class func loginUser(username: String, password: String, completion: @escaping (_ data: String?, _ error: Error?) -> Void) ``` Logs user into the system @@ -290,8 +290,8 @@ UserAPI.loginUser(username: username, password: password) { (response, error) in Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **username** | **String**| The user name for login | - **password** | **String**| The password for login in clear text | + **username** | **String** | The user name for login | + **password** | **String** | The password for login in clear text | ### Return type @@ -310,7 +310,7 @@ No authorization required # **logoutUser** ```swift - open class func logoutUser(completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) + open class func logoutUser(completion: @escaping (_ data: Void?, _ error: Error?) -> Void) ``` Logs out current logged in user session @@ -339,7 +339,7 @@ This endpoint does not need any parameter. ### Return type -void (empty response body) +Void (empty response body) ### Authorization @@ -354,7 +354,7 @@ No authorization required # **updateUser** ```swift - open class func updateUser(username: String, body: User, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) + open class func updateUser(username: String, body: User, completion: @escaping (_ data: Void?, _ error: Error?) -> Void) ``` Updated user @@ -386,12 +386,12 @@ UserAPI.updateUser(username: username, body: body) { (response, error) in Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **username** | **String**| name that need to be deleted | - **body** | [**User**](User.md)| Updated user object | + **username** | **String** | name that need to be deleted | + **body** | [**User**](User.md) | Updated user object | ### Return type -void (empty response body) +Void (empty response body) ### Authorization From 818c89c1b7f3b34dcb5e479caf02c29c3d25abfd Mon Sep 17 00:00:00 2001 From: William Cheng Date: Tue, 16 Apr 2019 13:55:18 +0800 Subject: [PATCH 9/9] fix indentation --- .../main/resources/swift4/api_doc.mustache | 15 +- .../swift4/default/docs/AnotherFakeAPI.md | 2 +- .../petstore/swift4/default/docs/FakeAPI.md | 24 +-- .../default/docs/FakeClassnameTags123API.md | 2 +- .../petstore/swift4/default/docs/PetAPI.md | 18 +- .../petstore/swift4/default/docs/StoreAPI.md | 8 +- .../petstore/swift4/default/docs/UserAPI.md | 16 +- .../objcCompatible/docs/AnotherFakeAPI.md | 2 +- .../swift4/objcCompatible/docs/FakeAPI.md | 26 +-- .../docs/FakeClassnameTags123API.md | 2 +- .../swift4/objcCompatible/docs/PetAPI.md | 18 +- .../swift4/objcCompatible/docs/StoreAPI.md | 8 +- .../swift4/objcCompatible/docs/UserAPI.md | 16 +- .../swift4/promisekit/docs/AnotherFakeAPI.md | 13 +- .../swift4/promisekit/docs/FakeAPI.md | 156 ++++++++---------- .../docs/FakeClassnameTags123API.md | 13 +- .../petstore/swift4/promisekit/docs/PetAPI.md | 117 ++++++------- .../swift4/promisekit/docs/StoreAPI.md | 52 +++--- .../swift4/promisekit/docs/UserAPI.md | 104 ++++++------ .../swift4/rxswift/docs/AnotherFakeAPI.md | 4 +- .../petstore/swift4/rxswift/docs/FakeAPI.md | 48 +++--- .../rxswift/docs/FakeClassnameTags123API.md | 4 +- .../petstore/swift4/rxswift/docs/PetAPI.md | 36 ++-- .../petstore/swift4/rxswift/docs/StoreAPI.md | 16 +- .../petstore/swift4/rxswift/docs/UserAPI.md | 32 ++-- .../unwrapRequired/docs/AnotherFakeAPI.md | 2 +- .../swift4/unwrapRequired/docs/FakeAPI.md | 24 +-- .../docs/FakeClassnameTags123API.md | 2 +- .../swift4/unwrapRequired/docs/PetAPI.md | 18 +- .../swift4/unwrapRequired/docs/StoreAPI.md | 8 +- .../swift4/unwrapRequired/docs/UserAPI.md | 16 +- 31 files changed, 393 insertions(+), 429 deletions(-) diff --git a/modules/openapi-generator/src/main/resources/swift4/api_doc.mustache b/modules/openapi-generator/src/main/resources/swift4/api_doc.mustache index b392c9cf44eb..9ea5ae16149b 100644 --- a/modules/openapi-generator/src/main/resources/swift4/api_doc.mustache +++ b/modules/openapi-generator/src/main/resources/swift4/api_doc.mustache @@ -31,7 +31,7 @@ Method | HTTP request | Description ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import {{{projectName}}} {{#allParams}}let {{paramName}} = {{{vendorExtensions.x-swift-example}}} // {{{dataType}}} | {{{description}}}{{^required}} (optional){{/required}}{{#defaultValue}} (default to {{{.}}}){{/defaultValue}} @@ -59,16 +59,15 @@ import {{{projectName}}} // {{{.}}} {{/summary}} {{classname}}.{{{operationId}}}({{#allParams}}{{paramName}}: {{paramName}}{{#hasMore}}, {{/hasMore}}{{/allParams}}).then { - // when the promise is fulfilled - }.always { - // regardless of whether the promise is fulfilled, or rejected - }.catch { errorType in - // when the promise is rejected - } + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected } {{/usePromiseKit}} {{#useRxSwift}} -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +// TODO RxSwift sample code not yet implemented. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new {{/useRxSwift}} ``` diff --git a/samples/client/petstore/swift4/default/docs/AnotherFakeAPI.md b/samples/client/petstore/swift4/default/docs/AnotherFakeAPI.md index e4228cb018b6..aead5f1f980f 100644 --- a/samples/client/petstore/swift4/default/docs/AnotherFakeAPI.md +++ b/samples/client/petstore/swift4/default/docs/AnotherFakeAPI.md @@ -18,7 +18,7 @@ To test special tags and operation ID starting with number ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = Client(client: "client_example") // Client | client model diff --git a/samples/client/petstore/swift4/default/docs/FakeAPI.md b/samples/client/petstore/swift4/default/docs/FakeAPI.md index 3e96e7830c26..18fbf8147d88 100644 --- a/samples/client/petstore/swift4/default/docs/FakeAPI.md +++ b/samples/client/petstore/swift4/default/docs/FakeAPI.md @@ -29,7 +29,7 @@ Test serialization of outer boolean types ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = false // Bool | Input boolean as post body (optional) @@ -78,7 +78,7 @@ Test serialization of object with outer number type ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = OuterComposite(myNumber: 123, myString: "myString_example", myBoolean: false) // OuterComposite | Input composite as post body (optional) @@ -127,7 +127,7 @@ Test serialization of outer number types ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = 987 // Double | Input number as post body (optional) @@ -176,7 +176,7 @@ Test serialization of outer string types ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = "body_example" // String | Input string as post body (optional) @@ -225,7 +225,7 @@ For this test, the body for this request much reference a schema named `File`. ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = FileSchemaTestClass(file: File(sourceURI: "sourceURI_example"), files: [File(sourceURI: "sourceURI_example")]) // FileSchemaTestClass | @@ -272,7 +272,7 @@ No authorization required ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let query = "query_example" // String | @@ -323,7 +323,7 @@ To test \"client\" model ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = Client(client: "client_example") // Client | client model @@ -373,7 +373,7 @@ Fake endpoint for testing various parameters 假端點 偽のエンドポイン ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let number = 987 // Double | None @@ -449,7 +449,7 @@ To test enum parameters ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let enumHeaderStringArray = ["enumHeaderStringArray_example"] // [String] | Header parameter enum test (string array) (optional) @@ -513,7 +513,7 @@ Fake endpoint to test group parameters (optional) ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let requiredStringGroup = 987 // Int | Required String in group parameters @@ -571,7 +571,7 @@ test inline additionalProperties ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let param = "TODO" // [String:String] | request body @@ -619,7 +619,7 @@ test json serialization of form data ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let param = "param_example" // String | field1 diff --git a/samples/client/petstore/swift4/default/docs/FakeClassnameTags123API.md b/samples/client/petstore/swift4/default/docs/FakeClassnameTags123API.md index e46333f3454b..9f24b46edbc3 100644 --- a/samples/client/petstore/swift4/default/docs/FakeClassnameTags123API.md +++ b/samples/client/petstore/swift4/default/docs/FakeClassnameTags123API.md @@ -18,7 +18,7 @@ To test class name in snake case ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = Client(client: "client_example") // Client | client model diff --git a/samples/client/petstore/swift4/default/docs/PetAPI.md b/samples/client/petstore/swift4/default/docs/PetAPI.md index 02cb51983a82..27efe0833476 100644 --- a/samples/client/petstore/swift4/default/docs/PetAPI.md +++ b/samples/client/petstore/swift4/default/docs/PetAPI.md @@ -24,7 +24,7 @@ Add a new pet to the store ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = Pet(id: 123, category: Category(id: 123, name: "name_example"), name: "name_example", photoUrls: ["photoUrls_example"], tags: [Tag(id: 123, name: "name_example")], status: "status_example") // Pet | Pet object that needs to be added to the store @@ -72,7 +72,7 @@ Deletes a pet ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let petId = 987 // Int64 | Pet id to delete @@ -124,7 +124,7 @@ Multiple status values can be provided with comma separated strings ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let status = ["status_example"] // [String] | Status values that need to be considered for filter @@ -174,7 +174,7 @@ Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let tags = ["inner_example"] // [String] | Tags to filter by @@ -224,7 +224,7 @@ Returns a single pet ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let petId = 987 // Int64 | ID of pet to return @@ -272,7 +272,7 @@ Update an existing pet ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = Pet(id: 123, category: Category(id: 123, name: "name_example"), name: "name_example", photoUrls: ["photoUrls_example"], tags: [Tag(id: 123, name: "name_example")], status: "status_example") // Pet | Pet object that needs to be added to the store @@ -320,7 +320,7 @@ Updates a pet in the store with form data ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let petId = 987 // Int64 | ID of pet that needs to be updated @@ -372,7 +372,7 @@ uploads an image ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let petId = 987 // Int64 | ID of pet to update @@ -424,7 +424,7 @@ uploads an image (required) ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let petId = 987 // Int64 | ID of pet to update diff --git a/samples/client/petstore/swift4/default/docs/StoreAPI.md b/samples/client/petstore/swift4/default/docs/StoreAPI.md index da5100bbab40..36365ca51993 100644 --- a/samples/client/petstore/swift4/default/docs/StoreAPI.md +++ b/samples/client/petstore/swift4/default/docs/StoreAPI.md @@ -21,7 +21,7 @@ For valid response try integer IDs with value < 1000. Anything above 1000 or non ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let orderId = "orderId_example" // String | ID of the order that needs to be deleted @@ -71,7 +71,7 @@ Returns a map of status codes to quantities ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient @@ -117,7 +117,7 @@ For valid response try integer IDs with value <= 5 or > 10. Other values will ge ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let orderId = 987 // Int64 | ID of pet that needs to be fetched @@ -165,7 +165,7 @@ Place an order for a pet ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = Order(id: 123, petId: 123, quantity: 123, shipDate: Date(), status: "status_example", complete: false) // Order | order placed for purchasing the pet diff --git a/samples/client/petstore/swift4/default/docs/UserAPI.md b/samples/client/petstore/swift4/default/docs/UserAPI.md index b89e05125571..da20013482e0 100644 --- a/samples/client/petstore/swift4/default/docs/UserAPI.md +++ b/samples/client/petstore/swift4/default/docs/UserAPI.md @@ -25,7 +25,7 @@ This can only be done by the logged in user. ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = User(id: 123, username: "username_example", firstName: "firstName_example", lastName: "lastName_example", email: "email_example", password: "password_example", phone: "phone_example", userStatus: 123) // User | Created user object @@ -73,7 +73,7 @@ Creates list of users with given input array ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = [User(id: 123, username: "username_example", firstName: "firstName_example", lastName: "lastName_example", email: "email_example", password: "password_example", phone: "phone_example", userStatus: 123)] // [User] | List of user object @@ -121,7 +121,7 @@ Creates list of users with given input array ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = [User(id: 123, username: "username_example", firstName: "firstName_example", lastName: "lastName_example", email: "email_example", password: "password_example", phone: "phone_example", userStatus: 123)] // [User] | List of user object @@ -171,7 +171,7 @@ This can only be done by the logged in user. ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let username = "username_example" // String | The name that needs to be deleted @@ -219,7 +219,7 @@ Get user by user name ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let username = "username_example" // String | The name that needs to be fetched. Use user1 for testing. @@ -267,7 +267,7 @@ Logs user into the system ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let username = "username_example" // String | The user name for login @@ -317,7 +317,7 @@ Logs out current logged in user session ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient @@ -363,7 +363,7 @@ This can only be done by the logged in user. ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let username = "username_example" // String | name that need to be deleted diff --git a/samples/client/petstore/swift4/objcCompatible/docs/AnotherFakeAPI.md b/samples/client/petstore/swift4/objcCompatible/docs/AnotherFakeAPI.md index e4228cb018b6..aead5f1f980f 100644 --- a/samples/client/petstore/swift4/objcCompatible/docs/AnotherFakeAPI.md +++ b/samples/client/petstore/swift4/objcCompatible/docs/AnotherFakeAPI.md @@ -18,7 +18,7 @@ To test special tags and operation ID starting with number ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = Client(client: "client_example") // Client | client model diff --git a/samples/client/petstore/swift4/objcCompatible/docs/FakeAPI.md b/samples/client/petstore/swift4/objcCompatible/docs/FakeAPI.md index 7bc4275361b5..f63957bc8dbd 100644 --- a/samples/client/petstore/swift4/objcCompatible/docs/FakeAPI.md +++ b/samples/client/petstore/swift4/objcCompatible/docs/FakeAPI.md @@ -30,7 +30,7 @@ this route creates an XmlItem ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let xmlItem = XmlItem(attributeString: "attributeString_example", attributeNumber: 123, attributeInteger: 123, attributeBoolean: false, wrappedArray: [123], nameString: "nameString_example", nameNumber: 123, nameInteger: 123, nameBoolean: false, nameArray: [123], nameWrappedArray: [123], prefixString: "prefixString_example", prefixNumber: 123, prefixInteger: 123, prefixBoolean: false, prefixArray: [123], prefixWrappedArray: [123], namespaceString: "namespaceString_example", namespaceNumber: 123, namespaceInteger: 123, namespaceBoolean: false, namespaceArray: [123], namespaceWrappedArray: [123], prefixNsString: "prefixNsString_example", prefixNsNumber: 123, prefixNsInteger: 123, prefixNsBoolean: false, prefixNsArray: [123], prefixNsWrappedArray: [123]) // XmlItem | XmlItem Body @@ -80,7 +80,7 @@ Test serialization of outer boolean types ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = false // Bool | Input boolean as post body (optional) @@ -129,7 +129,7 @@ Test serialization of object with outer number type ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = OuterComposite(myNumber: 123, myString: "myString_example", myBoolean: false) // OuterComposite | Input composite as post body (optional) @@ -178,7 +178,7 @@ Test serialization of outer number types ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = 987 // Double | Input number as post body (optional) @@ -227,7 +227,7 @@ Test serialization of outer string types ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = "body_example" // String | Input string as post body (optional) @@ -276,7 +276,7 @@ For this test, the body for this request much reference a schema named `File`. ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = FileSchemaTestClass(file: File(sourceURI: "sourceURI_example"), files: [File(sourceURI: "sourceURI_example")]) // FileSchemaTestClass | @@ -323,7 +323,7 @@ No authorization required ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let query = "query_example" // String | @@ -374,7 +374,7 @@ To test \"client\" model ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = Client(client: "client_example") // Client | client model @@ -424,7 +424,7 @@ Fake endpoint for testing various parameters 假端點 偽のエンドポイン ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let number = 987 // Double | None @@ -500,7 +500,7 @@ To test enum parameters ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let enumHeaderStringArray = ["enumHeaderStringArray_example"] // [String] | Header parameter enum test (string array) (optional) @@ -564,7 +564,7 @@ Fake endpoint to test group parameters (optional) ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let requiredStringGroup = 987 // Int | Required String in group parameters @@ -622,7 +622,7 @@ test inline additionalProperties ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let param = "TODO" // [String:String] | request body @@ -670,7 +670,7 @@ test json serialization of form data ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let param = "param_example" // String | field1 diff --git a/samples/client/petstore/swift4/objcCompatible/docs/FakeClassnameTags123API.md b/samples/client/petstore/swift4/objcCompatible/docs/FakeClassnameTags123API.md index e46333f3454b..9f24b46edbc3 100644 --- a/samples/client/petstore/swift4/objcCompatible/docs/FakeClassnameTags123API.md +++ b/samples/client/petstore/swift4/objcCompatible/docs/FakeClassnameTags123API.md @@ -18,7 +18,7 @@ To test class name in snake case ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = Client(client: "client_example") // Client | client model diff --git a/samples/client/petstore/swift4/objcCompatible/docs/PetAPI.md b/samples/client/petstore/swift4/objcCompatible/docs/PetAPI.md index dcdb2886ccfb..c03e60bc084e 100644 --- a/samples/client/petstore/swift4/objcCompatible/docs/PetAPI.md +++ b/samples/client/petstore/swift4/objcCompatible/docs/PetAPI.md @@ -24,7 +24,7 @@ Add a new pet to the store ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = Pet(_id: 123, category: Category(_id: 123, name: "name_example"), name: "name_example", photoUrls: ["photoUrls_example"], tags: [Tag(_id: 123, name: "name_example")], status: "status_example") // Pet | Pet object that needs to be added to the store @@ -72,7 +72,7 @@ Deletes a pet ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let petId = 987 // Int64 | Pet id to delete @@ -124,7 +124,7 @@ Multiple status values can be provided with comma separated strings ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let status = ["status_example"] // [String] | Status values that need to be considered for filter @@ -174,7 +174,7 @@ Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let tags = ["inner_example"] // [String] | Tags to filter by @@ -224,7 +224,7 @@ Returns a single pet ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let petId = 987 // Int64 | ID of pet to return @@ -272,7 +272,7 @@ Update an existing pet ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = Pet(_id: 123, category: Category(_id: 123, name: "name_example"), name: "name_example", photoUrls: ["photoUrls_example"], tags: [Tag(_id: 123, name: "name_example")], status: "status_example") // Pet | Pet object that needs to be added to the store @@ -320,7 +320,7 @@ Updates a pet in the store with form data ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let petId = 987 // Int64 | ID of pet that needs to be updated @@ -372,7 +372,7 @@ uploads an image ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let petId = 987 // Int64 | ID of pet to update @@ -424,7 +424,7 @@ uploads an image (required) ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let petId = 987 // Int64 | ID of pet to update diff --git a/samples/client/petstore/swift4/objcCompatible/docs/StoreAPI.md b/samples/client/petstore/swift4/objcCompatible/docs/StoreAPI.md index 86c8f84e7b56..ba59be9d5433 100644 --- a/samples/client/petstore/swift4/objcCompatible/docs/StoreAPI.md +++ b/samples/client/petstore/swift4/objcCompatible/docs/StoreAPI.md @@ -21,7 +21,7 @@ For valid response try integer IDs with value < 1000. Anything above 1000 or non ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let orderId = "orderId_example" // String | ID of the order that needs to be deleted @@ -71,7 +71,7 @@ Returns a map of status codes to quantities ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient @@ -117,7 +117,7 @@ For valid response try integer IDs with value <= 5 or > 10. Other values will ge ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let orderId = 987 // Int64 | ID of pet that needs to be fetched @@ -165,7 +165,7 @@ Place an order for a pet ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = Order(_id: 123, petId: 123, quantity: 123, shipDate: Date(), status: "status_example", complete: false) // Order | order placed for purchasing the pet diff --git a/samples/client/petstore/swift4/objcCompatible/docs/UserAPI.md b/samples/client/petstore/swift4/objcCompatible/docs/UserAPI.md index a1b5cfaada5d..6a8e9dd372d3 100644 --- a/samples/client/petstore/swift4/objcCompatible/docs/UserAPI.md +++ b/samples/client/petstore/swift4/objcCompatible/docs/UserAPI.md @@ -25,7 +25,7 @@ This can only be done by the logged in user. ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = User(_id: 123, username: "username_example", firstName: "firstName_example", lastName: "lastName_example", email: "email_example", password: "password_example", phone: "phone_example", userStatus: 123) // User | Created user object @@ -73,7 +73,7 @@ Creates list of users with given input array ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = [User(_id: 123, username: "username_example", firstName: "firstName_example", lastName: "lastName_example", email: "email_example", password: "password_example", phone: "phone_example", userStatus: 123)] // [User] | List of user object @@ -121,7 +121,7 @@ Creates list of users with given input array ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = [User(_id: 123, username: "username_example", firstName: "firstName_example", lastName: "lastName_example", email: "email_example", password: "password_example", phone: "phone_example", userStatus: 123)] // [User] | List of user object @@ -171,7 +171,7 @@ This can only be done by the logged in user. ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let username = "username_example" // String | The name that needs to be deleted @@ -219,7 +219,7 @@ Get user by user name ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let username = "username_example" // String | The name that needs to be fetched. Use user1 for testing. @@ -267,7 +267,7 @@ Logs user into the system ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let username = "username_example" // String | The user name for login @@ -317,7 +317,7 @@ Logs out current logged in user session ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient @@ -363,7 +363,7 @@ This can only be done by the logged in user. ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let username = "username_example" // String | name that need to be deleted diff --git a/samples/client/petstore/swift4/promisekit/docs/AnotherFakeAPI.md b/samples/client/petstore/swift4/promisekit/docs/AnotherFakeAPI.md index 00b343464f8f..7ac52a2b1272 100644 --- a/samples/client/petstore/swift4/promisekit/docs/AnotherFakeAPI.md +++ b/samples/client/petstore/swift4/promisekit/docs/AnotherFakeAPI.md @@ -18,19 +18,18 @@ To test special tags and operation ID starting with number ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = Client(client: "client_example") // Client | client model // To test special tags AnotherFakeAPI.call123testSpecialTags(body: body).then { - // when the promise is fulfilled - }.always { - // regardless of whether the promise is fulfilled, or rejected - }.catch { errorType in - // when the promise is rejected - } + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected } ``` diff --git a/samples/client/petstore/swift4/promisekit/docs/FakeAPI.md b/samples/client/petstore/swift4/promisekit/docs/FakeAPI.md index eb46c5616a55..15f8e5f9f696 100644 --- a/samples/client/petstore/swift4/promisekit/docs/FakeAPI.md +++ b/samples/client/petstore/swift4/promisekit/docs/FakeAPI.md @@ -29,18 +29,17 @@ Test serialization of outer boolean types ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = false // Bool | Input boolean as post body (optional) FakeAPI.fakeOuterBooleanSerialize(body: body).then { - // when the promise is fulfilled - }.always { - // regardless of whether the promise is fulfilled, or rejected - }.catch { errorType in - // when the promise is rejected - } + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected } ``` @@ -76,18 +75,17 @@ Test serialization of object with outer number type ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = OuterComposite(myNumber: 123, myString: "myString_example", myBoolean: false) // OuterComposite | Input composite as post body (optional) FakeAPI.fakeOuterCompositeSerialize(body: body).then { - // when the promise is fulfilled - }.always { - // regardless of whether the promise is fulfilled, or rejected - }.catch { errorType in - // when the promise is rejected - } + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected } ``` @@ -123,18 +121,17 @@ Test serialization of outer number types ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = 987 // Double | Input number as post body (optional) FakeAPI.fakeOuterNumberSerialize(body: body).then { - // when the promise is fulfilled - }.always { - // regardless of whether the promise is fulfilled, or rejected - }.catch { errorType in - // when the promise is rejected - } + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected } ``` @@ -170,18 +167,17 @@ Test serialization of outer string types ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = "body_example" // String | Input string as post body (optional) FakeAPI.fakeOuterStringSerialize(body: body).then { - // when the promise is fulfilled - }.always { - // regardless of whether the promise is fulfilled, or rejected - }.catch { errorType in - // when the promise is rejected - } + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected } ``` @@ -217,18 +213,17 @@ For this test, the body for this request much reference a schema named `File`. ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = FileSchemaTestClass(file: File(sourceURI: "sourceURI_example"), files: [File(sourceURI: "sourceURI_example")]) // FileSchemaTestClass | FakeAPI.testBodyWithFileSchema(body: body).then { - // when the promise is fulfilled - }.always { - // regardless of whether the promise is fulfilled, or rejected - }.catch { errorType in - // when the promise is rejected - } + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected } ``` @@ -262,19 +257,18 @@ No authorization required ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let query = "query_example" // String | let body = User(id: 123, username: "username_example", firstName: "firstName_example", lastName: "lastName_example", email: "email_example", password: "password_example", phone: "phone_example", userStatus: 123) // User | FakeAPI.testBodyWithQueryParams(query: query, body: body).then { - // when the promise is fulfilled - }.always { - // regardless of whether the promise is fulfilled, or rejected - }.catch { errorType in - // when the promise is rejected - } + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected } ``` @@ -311,19 +305,18 @@ To test \"client\" model ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = Client(client: "client_example") // Client | client model // To test \"client\" model FakeAPI.testClientModel(body: body).then { - // when the promise is fulfilled - }.always { - // regardless of whether the promise is fulfilled, or rejected - }.catch { errorType in - // when the promise is rejected - } + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected } ``` @@ -359,7 +352,7 @@ Fake endpoint for testing various parameters 假端點 偽のエンドポイン ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let number = 987 // Double | None @@ -379,12 +372,11 @@ let callback = "callback_example" // String | None (optional) // Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 FakeAPI.testEndpointParameters(number: number, double: double, patternWithoutDelimiter: patternWithoutDelimiter, byte: byte, integer: integer, int32: int32, int64: int64, float: float, string: string, binary: binary, date: date, dateTime: dateTime, password: password, callback: callback).then { - // when the promise is fulfilled - }.always { - // regardless of whether the promise is fulfilled, or rejected - }.catch { errorType in - // when the promise is rejected - } + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected } ``` @@ -433,7 +425,7 @@ To test enum parameters ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let enumHeaderStringArray = ["enumHeaderStringArray_example"] // [String] | Header parameter enum test (string array) (optional) @@ -447,12 +439,11 @@ let enumFormString = "enumFormString_example" // String | Form parameter enum te // To test enum parameters FakeAPI.testEnumParameters(enumHeaderStringArray: enumHeaderStringArray, enumHeaderString: enumHeaderString, enumQueryStringArray: enumQueryStringArray, enumQueryString: enumQueryString, enumQueryInteger: enumQueryInteger, enumQueryDouble: enumQueryDouble, enumFormStringArray: enumFormStringArray, enumFormString: enumFormString).then { - // when the promise is fulfilled - }.always { - // regardless of whether the promise is fulfilled, or rejected - }.catch { errorType in - // when the promise is rejected - } + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected } ``` @@ -495,7 +486,7 @@ Fake endpoint to test group parameters (optional) ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let requiredStringGroup = 987 // Int | Required String in group parameters @@ -507,12 +498,11 @@ let int64Group = 987 // Int64 | Integer in group parameters (optional) // Fake endpoint to test group parameters (optional) FakeAPI.testGroupParameters(requiredStringGroup: requiredStringGroup, requiredBooleanGroup: requiredBooleanGroup, requiredInt64Group: requiredInt64Group, stringGroup: stringGroup, booleanGroup: booleanGroup, int64Group: int64Group).then { - // when the promise is fulfilled - }.always { - // regardless of whether the promise is fulfilled, or rejected - }.catch { errorType in - // when the promise is rejected - } + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected } ``` @@ -551,19 +541,18 @@ test inline additionalProperties ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let param = "TODO" // [String:String] | request body // test inline additionalProperties FakeAPI.testInlineAdditionalProperties(param: param).then { - // when the promise is fulfilled - }.always { - // regardless of whether the promise is fulfilled, or rejected - }.catch { errorType in - // when the promise is rejected - } + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected } ``` @@ -597,7 +586,7 @@ test json serialization of form data ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let param = "param_example" // String | field1 @@ -605,12 +594,11 @@ let param2 = "param2_example" // String | field2 // test json serialization of form data FakeAPI.testJsonFormData(param: param, param2: param2).then { - // when the promise is fulfilled - }.always { - // regardless of whether the promise is fulfilled, or rejected - }.catch { errorType in - // when the promise is rejected - } + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected } ``` diff --git a/samples/client/petstore/swift4/promisekit/docs/FakeClassnameTags123API.md b/samples/client/petstore/swift4/promisekit/docs/FakeClassnameTags123API.md index 9db73c90c0ed..1b1b9c141024 100644 --- a/samples/client/petstore/swift4/promisekit/docs/FakeClassnameTags123API.md +++ b/samples/client/petstore/swift4/promisekit/docs/FakeClassnameTags123API.md @@ -18,19 +18,18 @@ To test class name in snake case ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = Client(client: "client_example") // Client | client model // To test class name in snake case FakeClassnameTags123API.testClassname(body: body).then { - // when the promise is fulfilled - }.always { - // regardless of whether the promise is fulfilled, or rejected - }.catch { errorType in - // when the promise is rejected - } + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected } ``` diff --git a/samples/client/petstore/swift4/promisekit/docs/PetAPI.md b/samples/client/petstore/swift4/promisekit/docs/PetAPI.md index aa889a07b895..e767ea772f89 100644 --- a/samples/client/petstore/swift4/promisekit/docs/PetAPI.md +++ b/samples/client/petstore/swift4/promisekit/docs/PetAPI.md @@ -24,19 +24,18 @@ Add a new pet to the store ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = Pet(id: 123, category: Category(id: 123, name: "name_example"), name: "name_example", photoUrls: ["photoUrls_example"], tags: [Tag(id: 123, name: "name_example")], status: "status_example") // Pet | Pet object that needs to be added to the store // Add a new pet to the store PetAPI.addPet(body: body).then { - // when the promise is fulfilled - }.always { - // regardless of whether the promise is fulfilled, or rejected - }.catch { errorType in - // when the promise is rejected - } + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected } ``` @@ -70,7 +69,7 @@ Deletes a pet ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let petId = 987 // Int64 | Pet id to delete @@ -78,12 +77,11 @@ let apiKey = "apiKey_example" // String | (optional) // Deletes a pet PetAPI.deletePet(petId: petId, apiKey: apiKey).then { - // when the promise is fulfilled - }.always { - // regardless of whether the promise is fulfilled, or rejected - }.catch { errorType in - // when the promise is rejected - } + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected } ``` @@ -120,19 +118,18 @@ Multiple status values can be provided with comma separated strings ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let status = ["status_example"] // [String] | Status values that need to be considered for filter // Finds Pets by status PetAPI.findPetsByStatus(status: status).then { - // when the promise is fulfilled - }.always { - // regardless of whether the promise is fulfilled, or rejected - }.catch { errorType in - // when the promise is rejected - } + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected } ``` @@ -168,19 +165,18 @@ Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let tags = ["inner_example"] // [String] | Tags to filter by // Finds Pets by tags PetAPI.findPetsByTags(tags: tags).then { - // when the promise is fulfilled - }.always { - // regardless of whether the promise is fulfilled, or rejected - }.catch { errorType in - // when the promise is rejected - } + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected } ``` @@ -216,19 +212,18 @@ Returns a single pet ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let petId = 987 // Int64 | ID of pet to return // Find pet by ID PetAPI.getPetById(petId: petId).then { - // when the promise is fulfilled - }.always { - // regardless of whether the promise is fulfilled, or rejected - }.catch { errorType in - // when the promise is rejected - } + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected } ``` @@ -262,19 +257,18 @@ Update an existing pet ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = Pet(id: 123, category: Category(id: 123, name: "name_example"), name: "name_example", photoUrls: ["photoUrls_example"], tags: [Tag(id: 123, name: "name_example")], status: "status_example") // Pet | Pet object that needs to be added to the store // Update an existing pet PetAPI.updatePet(body: body).then { - // when the promise is fulfilled - }.always { - // regardless of whether the promise is fulfilled, or rejected - }.catch { errorType in - // when the promise is rejected - } + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected } ``` @@ -308,7 +302,7 @@ Updates a pet in the store with form data ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let petId = 987 // Int64 | ID of pet that needs to be updated @@ -317,12 +311,11 @@ let status = "status_example" // String | Updated status of the pet (optional) // Updates a pet in the store with form data PetAPI.updatePetWithForm(petId: petId, name: name, status: status).then { - // when the promise is fulfilled - }.always { - // regardless of whether the promise is fulfilled, or rejected - }.catch { errorType in - // when the promise is rejected - } + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected } ``` @@ -358,7 +351,7 @@ uploads an image ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let petId = 987 // Int64 | ID of pet to update @@ -367,12 +360,11 @@ let file = URL(string: "https://example.com")! // URL | file to upload (optional // uploads an image PetAPI.uploadFile(petId: petId, additionalMetadata: additionalMetadata, file: file).then { - // when the promise is fulfilled - }.always { - // regardless of whether the promise is fulfilled, or rejected - }.catch { errorType in - // when the promise is rejected - } + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected } ``` @@ -408,7 +400,7 @@ uploads an image (required) ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let petId = 987 // Int64 | ID of pet to update @@ -417,12 +409,11 @@ let additionalMetadata = "additionalMetadata_example" // String | Additional dat // uploads an image (required) PetAPI.uploadFileWithRequiredFile(petId: petId, requiredFile: requiredFile, additionalMetadata: additionalMetadata).then { - // when the promise is fulfilled - }.always { - // regardless of whether the promise is fulfilled, or rejected - }.catch { errorType in - // when the promise is rejected - } + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected } ``` diff --git a/samples/client/petstore/swift4/promisekit/docs/StoreAPI.md b/samples/client/petstore/swift4/promisekit/docs/StoreAPI.md index 7c421fed76e6..085d479bce24 100644 --- a/samples/client/petstore/swift4/promisekit/docs/StoreAPI.md +++ b/samples/client/petstore/swift4/promisekit/docs/StoreAPI.md @@ -21,19 +21,18 @@ For valid response try integer IDs with value < 1000. Anything above 1000 or non ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let orderId = "orderId_example" // String | ID of the order that needs to be deleted // Delete purchase order by ID StoreAPI.deleteOrder(orderId: orderId).then { - // when the promise is fulfilled - }.always { - // regardless of whether the promise is fulfilled, or rejected - }.catch { errorType in - // when the promise is rejected - } + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected } ``` @@ -69,18 +68,17 @@ Returns a map of status codes to quantities ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient // Returns pet inventories by status StoreAPI.getInventory().then { - // when the promise is fulfilled - }.always { - // regardless of whether the promise is fulfilled, or rejected - }.catch { errorType in - // when the promise is rejected - } + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected } ``` @@ -113,19 +111,18 @@ For valid response try integer IDs with value <= 5 or > 10. Other values will ge ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let orderId = 987 // Int64 | ID of pet that needs to be fetched // Find purchase order by ID StoreAPI.getOrderById(orderId: orderId).then { - // when the promise is fulfilled - }.always { - // regardless of whether the promise is fulfilled, or rejected - }.catch { errorType in - // when the promise is rejected - } + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected } ``` @@ -159,19 +156,18 @@ Place an order for a pet ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = Order(id: 123, petId: 123, quantity: 123, shipDate: Date(), status: "status_example", complete: false) // Order | order placed for purchasing the pet // Place an order for a pet StoreAPI.placeOrder(body: body).then { - // when the promise is fulfilled - }.always { - // regardless of whether the promise is fulfilled, or rejected - }.catch { errorType in - // when the promise is rejected - } + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected } ``` diff --git a/samples/client/petstore/swift4/promisekit/docs/UserAPI.md b/samples/client/petstore/swift4/promisekit/docs/UserAPI.md index f435388588df..2ec91cfda3fb 100644 --- a/samples/client/petstore/swift4/promisekit/docs/UserAPI.md +++ b/samples/client/petstore/swift4/promisekit/docs/UserAPI.md @@ -25,19 +25,18 @@ This can only be done by the logged in user. ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = User(id: 123, username: "username_example", firstName: "firstName_example", lastName: "lastName_example", email: "email_example", password: "password_example", phone: "phone_example", userStatus: 123) // User | Created user object // Create user UserAPI.createUser(body: body).then { - // when the promise is fulfilled - }.always { - // regardless of whether the promise is fulfilled, or rejected - }.catch { errorType in - // when the promise is rejected - } + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected } ``` @@ -71,19 +70,18 @@ Creates list of users with given input array ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = [User(id: 123, username: "username_example", firstName: "firstName_example", lastName: "lastName_example", email: "email_example", password: "password_example", phone: "phone_example", userStatus: 123)] // [User] | List of user object // Creates list of users with given input array UserAPI.createUsersWithArrayInput(body: body).then { - // when the promise is fulfilled - }.always { - // regardless of whether the promise is fulfilled, or rejected - }.catch { errorType in - // when the promise is rejected - } + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected } ``` @@ -117,19 +115,18 @@ Creates list of users with given input array ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = [User(id: 123, username: "username_example", firstName: "firstName_example", lastName: "lastName_example", email: "email_example", password: "password_example", phone: "phone_example", userStatus: 123)] // [User] | List of user object // Creates list of users with given input array UserAPI.createUsersWithListInput(body: body).then { - // when the promise is fulfilled - }.always { - // regardless of whether the promise is fulfilled, or rejected - }.catch { errorType in - // when the promise is rejected - } + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected } ``` @@ -165,19 +162,18 @@ This can only be done by the logged in user. ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let username = "username_example" // String | The name that needs to be deleted // Delete user UserAPI.deleteUser(username: username).then { - // when the promise is fulfilled - }.always { - // regardless of whether the promise is fulfilled, or rejected - }.catch { errorType in - // when the promise is rejected - } + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected } ``` @@ -211,19 +207,18 @@ Get user by user name ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let username = "username_example" // String | The name that needs to be fetched. Use user1 for testing. // Get user by user name UserAPI.getUserByName(username: username).then { - // when the promise is fulfilled - }.always { - // regardless of whether the promise is fulfilled, or rejected - }.catch { errorType in - // when the promise is rejected - } + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected } ``` @@ -257,7 +252,7 @@ Logs user into the system ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let username = "username_example" // String | The user name for login @@ -265,12 +260,11 @@ let password = "password_example" // String | The password for login in clear te // Logs user into the system UserAPI.loginUser(username: username, password: password).then { - // when the promise is fulfilled - }.always { - // regardless of whether the promise is fulfilled, or rejected - }.catch { errorType in - // when the promise is rejected - } + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected } ``` @@ -305,18 +299,17 @@ Logs out current logged in user session ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient // Logs out current logged in user session UserAPI.logoutUser().then { - // when the promise is fulfilled - }.always { - // regardless of whether the promise is fulfilled, or rejected - }.catch { errorType in - // when the promise is rejected - } + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected } ``` @@ -349,7 +342,7 @@ This can only be done by the logged in user. ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let username = "username_example" // String | name that need to be deleted @@ -357,12 +350,11 @@ let body = User(id: 123, username: "username_example", firstName: "firstName_exa // Updated user UserAPI.updateUser(username: username, body: body).then { - // when the promise is fulfilled - }.always { - // regardless of whether the promise is fulfilled, or rejected - }.catch { errorType in - // when the promise is rejected - } + // when the promise is fulfilled + }.always { + // regardless of whether the promise is fulfilled, or rejected + }.catch { errorType in + // when the promise is rejected } ``` diff --git a/samples/client/petstore/swift4/rxswift/docs/AnotherFakeAPI.md b/samples/client/petstore/swift4/rxswift/docs/AnotherFakeAPI.md index 2c5fc8f401cb..dcd62507d964 100644 --- a/samples/client/petstore/swift4/rxswift/docs/AnotherFakeAPI.md +++ b/samples/client/petstore/swift4/rxswift/docs/AnotherFakeAPI.md @@ -18,12 +18,12 @@ To test special tags and operation ID starting with number ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = Client(client: "client_example") // Client | client model -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +// TODO RxSwift sample code not yet implemented. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters diff --git a/samples/client/petstore/swift4/rxswift/docs/FakeAPI.md b/samples/client/petstore/swift4/rxswift/docs/FakeAPI.md index f0b3787008c6..a67ef1c28159 100644 --- a/samples/client/petstore/swift4/rxswift/docs/FakeAPI.md +++ b/samples/client/petstore/swift4/rxswift/docs/FakeAPI.md @@ -29,12 +29,12 @@ Test serialization of outer boolean types ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = false // Bool | Input boolean as post body (optional) -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +// TODO RxSwift sample code not yet implemented. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -69,12 +69,12 @@ Test serialization of object with outer number type ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = OuterComposite(myNumber: 123, myString: "myString_example", myBoolean: false) // OuterComposite | Input composite as post body (optional) -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +// TODO RxSwift sample code not yet implemented. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -109,12 +109,12 @@ Test serialization of outer number types ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = 987 // Double | Input number as post body (optional) -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +// TODO RxSwift sample code not yet implemented. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -149,12 +149,12 @@ Test serialization of outer string types ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = "body_example" // String | Input string as post body (optional) -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +// TODO RxSwift sample code not yet implemented. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -189,12 +189,12 @@ For this test, the body for this request much reference a schema named `File`. ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = FileSchemaTestClass(file: File(sourceURI: "sourceURI_example"), files: [File(sourceURI: "sourceURI_example")]) // FileSchemaTestClass | -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +// TODO RxSwift sample code not yet implemented. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -227,13 +227,13 @@ No authorization required ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let query = "query_example" // String | let body = User(id: 123, username: "username_example", firstName: "firstName_example", lastName: "lastName_example", email: "email_example", password: "password_example", phone: "phone_example", userStatus: 123) // User | -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +// TODO RxSwift sample code not yet implemented. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -269,12 +269,12 @@ To test \"client\" model ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = Client(client: "client_example") // Client | client model -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +// TODO RxSwift sample code not yet implemented. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -309,7 +309,7 @@ Fake endpoint for testing various parameters 假端點 偽のエンドポイン ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let number = 987 // Double | None @@ -327,7 +327,7 @@ let dateTime = Date() // Date | None (optional) let password = "password_example" // String | None (optional) let callback = "callback_example" // String | None (optional) -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +// TODO RxSwift sample code not yet implemented. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -375,7 +375,7 @@ To test enum parameters ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let enumHeaderStringArray = ["enumHeaderStringArray_example"] // [String] | Header parameter enum test (string array) (optional) @@ -387,7 +387,7 @@ let enumQueryDouble = 987 // Double | Query parameter enum test (double) (option let enumFormStringArray = ["inner_example"] // [String] | Form parameter enum test (string array) (optional) (default to .$) let enumFormString = "enumFormString_example" // String | Form parameter enum test (string) (optional) (default to .-efg) -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +// TODO RxSwift sample code not yet implemented. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -429,7 +429,7 @@ Fake endpoint to test group parameters (optional) ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let requiredStringGroup = 987 // Int | Required String in group parameters @@ -439,7 +439,7 @@ let stringGroup = 987 // Int | String in group parameters (optional) let booleanGroup = false // Bool | Boolean in group parameters (optional) let int64Group = 987 // Int64 | Integer in group parameters (optional) -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +// TODO RxSwift sample code not yet implemented. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -477,12 +477,12 @@ test inline additionalProperties ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let param = "TODO" // [String:String] | request body -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +// TODO RxSwift sample code not yet implemented. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -515,13 +515,13 @@ test json serialization of form data ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let param = "param_example" // String | field1 let param2 = "param2_example" // String | field2 -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +// TODO RxSwift sample code not yet implemented. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters diff --git a/samples/client/petstore/swift4/rxswift/docs/FakeClassnameTags123API.md b/samples/client/petstore/swift4/rxswift/docs/FakeClassnameTags123API.md index deeddb761639..1b94500e7940 100644 --- a/samples/client/petstore/swift4/rxswift/docs/FakeClassnameTags123API.md +++ b/samples/client/petstore/swift4/rxswift/docs/FakeClassnameTags123API.md @@ -18,12 +18,12 @@ To test class name in snake case ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = Client(client: "client_example") // Client | client model -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +// TODO RxSwift sample code not yet implemented. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters diff --git a/samples/client/petstore/swift4/rxswift/docs/PetAPI.md b/samples/client/petstore/swift4/rxswift/docs/PetAPI.md index 0c33b8450eb3..c0ec8a91fb4c 100644 --- a/samples/client/petstore/swift4/rxswift/docs/PetAPI.md +++ b/samples/client/petstore/swift4/rxswift/docs/PetAPI.md @@ -24,12 +24,12 @@ Add a new pet to the store ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = Pet(id: 123, category: Category(id: 123, name: "name_example"), name: "name_example", photoUrls: ["photoUrls_example"], tags: [Tag(id: 123, name: "name_example")], status: "status_example") // Pet | Pet object that needs to be added to the store -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +// TODO RxSwift sample code not yet implemented. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -62,13 +62,13 @@ Deletes a pet ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let petId = 987 // Int64 | Pet id to delete let apiKey = "apiKey_example" // String | (optional) -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +// TODO RxSwift sample code not yet implemented. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -104,12 +104,12 @@ Multiple status values can be provided with comma separated strings ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let status = ["status_example"] // [String] | Status values that need to be considered for filter -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +// TODO RxSwift sample code not yet implemented. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -144,12 +144,12 @@ Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let tags = ["inner_example"] // [String] | Tags to filter by -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +// TODO RxSwift sample code not yet implemented. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -184,12 +184,12 @@ Returns a single pet ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let petId = 987 // Int64 | ID of pet to return -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +// TODO RxSwift sample code not yet implemented. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -222,12 +222,12 @@ Update an existing pet ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = Pet(id: 123, category: Category(id: 123, name: "name_example"), name: "name_example", photoUrls: ["photoUrls_example"], tags: [Tag(id: 123, name: "name_example")], status: "status_example") // Pet | Pet object that needs to be added to the store -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +// TODO RxSwift sample code not yet implemented. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -260,14 +260,14 @@ Updates a pet in the store with form data ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let petId = 987 // Int64 | ID of pet that needs to be updated let name = "name_example" // String | Updated name of the pet (optional) let status = "status_example" // String | Updated status of the pet (optional) -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +// TODO RxSwift sample code not yet implemented. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -302,14 +302,14 @@ uploads an image ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let petId = 987 // Int64 | ID of pet to update let additionalMetadata = "additionalMetadata_example" // String | Additional data to pass to server (optional) let file = URL(string: "https://example.com")! // URL | file to upload (optional) -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +// TODO RxSwift sample code not yet implemented. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -344,14 +344,14 @@ uploads an image (required) ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let petId = 987 // Int64 | ID of pet to update let requiredFile = URL(string: "https://example.com")! // URL | file to upload let additionalMetadata = "additionalMetadata_example" // String | Additional data to pass to server (optional) -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +// TODO RxSwift sample code not yet implemented. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters diff --git a/samples/client/petstore/swift4/rxswift/docs/StoreAPI.md b/samples/client/petstore/swift4/rxswift/docs/StoreAPI.md index 35512242fa78..a648ce8859b8 100644 --- a/samples/client/petstore/swift4/rxswift/docs/StoreAPI.md +++ b/samples/client/petstore/swift4/rxswift/docs/StoreAPI.md @@ -21,12 +21,12 @@ For valid response try integer IDs with value < 1000. Anything above 1000 or non ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let orderId = "orderId_example" // String | ID of the order that needs to be deleted -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +// TODO RxSwift sample code not yet implemented. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -61,11 +61,11 @@ Returns a map of status codes to quantities ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +// TODO RxSwift sample code not yet implemented. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -97,12 +97,12 @@ For valid response try integer IDs with value <= 5 or > 10. Other values will ge ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let orderId = 987 // Int64 | ID of pet that needs to be fetched -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +// TODO RxSwift sample code not yet implemented. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -135,12 +135,12 @@ Place an order for a pet ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = Order(id: 123, petId: 123, quantity: 123, shipDate: Date(), status: "status_example", complete: false) // Order | order placed for purchasing the pet -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +// TODO RxSwift sample code not yet implemented. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters diff --git a/samples/client/petstore/swift4/rxswift/docs/UserAPI.md b/samples/client/petstore/swift4/rxswift/docs/UserAPI.md index 8e4cdcb38088..b5b1f40b47d4 100644 --- a/samples/client/petstore/swift4/rxswift/docs/UserAPI.md +++ b/samples/client/petstore/swift4/rxswift/docs/UserAPI.md @@ -25,12 +25,12 @@ This can only be done by the logged in user. ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = User(id: 123, username: "username_example", firstName: "firstName_example", lastName: "lastName_example", email: "email_example", password: "password_example", phone: "phone_example", userStatus: 123) // User | Created user object -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +// TODO RxSwift sample code not yet implemented. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -63,12 +63,12 @@ Creates list of users with given input array ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = [User(id: 123, username: "username_example", firstName: "firstName_example", lastName: "lastName_example", email: "email_example", password: "password_example", phone: "phone_example", userStatus: 123)] // [User] | List of user object -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +// TODO RxSwift sample code not yet implemented. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -101,12 +101,12 @@ Creates list of users with given input array ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = [User(id: 123, username: "username_example", firstName: "firstName_example", lastName: "lastName_example", email: "email_example", password: "password_example", phone: "phone_example", userStatus: 123)] // [User] | List of user object -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +// TODO RxSwift sample code not yet implemented. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -141,12 +141,12 @@ This can only be done by the logged in user. ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let username = "username_example" // String | The name that needs to be deleted -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +// TODO RxSwift sample code not yet implemented. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -179,12 +179,12 @@ Get user by user name ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let username = "username_example" // String | The name that needs to be fetched. Use user1 for testing. -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +// TODO RxSwift sample code not yet implemented. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -217,13 +217,13 @@ Logs user into the system ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let username = "username_example" // String | The user name for login let password = "password_example" // String | The password for login in clear text -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +// TODO RxSwift sample code not yet implemented. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -257,11 +257,11 @@ Logs out current logged in user session ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +// TODO RxSwift sample code not yet implemented. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters @@ -293,13 +293,13 @@ This can only be done by the logged in user. ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let username = "username_example" // String | name that need to be deleted let body = User(id: 123, username: "username_example", firstName: "firstName_example", lastName: "lastName_example", email: "email_example", password: "password_example", phone: "phone_example", userStatus: 123) // User | Updated user object -// TODO rxswift sample code. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new +// TODO RxSwift sample code not yet implemented. To contribute, please open a ticket via https://github.com/OpenAPITools/openapi-generator/issues/new ``` ### Parameters diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/AnotherFakeAPI.md b/samples/client/petstore/swift4/unwrapRequired/docs/AnotherFakeAPI.md index e4228cb018b6..aead5f1f980f 100644 --- a/samples/client/petstore/swift4/unwrapRequired/docs/AnotherFakeAPI.md +++ b/samples/client/petstore/swift4/unwrapRequired/docs/AnotherFakeAPI.md @@ -18,7 +18,7 @@ To test special tags and operation ID starting with number ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = Client(client: "client_example") // Client | client model diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/FakeAPI.md b/samples/client/petstore/swift4/unwrapRequired/docs/FakeAPI.md index 3e96e7830c26..18fbf8147d88 100644 --- a/samples/client/petstore/swift4/unwrapRequired/docs/FakeAPI.md +++ b/samples/client/petstore/swift4/unwrapRequired/docs/FakeAPI.md @@ -29,7 +29,7 @@ Test serialization of outer boolean types ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = false // Bool | Input boolean as post body (optional) @@ -78,7 +78,7 @@ Test serialization of object with outer number type ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = OuterComposite(myNumber: 123, myString: "myString_example", myBoolean: false) // OuterComposite | Input composite as post body (optional) @@ -127,7 +127,7 @@ Test serialization of outer number types ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = 987 // Double | Input number as post body (optional) @@ -176,7 +176,7 @@ Test serialization of outer string types ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = "body_example" // String | Input string as post body (optional) @@ -225,7 +225,7 @@ For this test, the body for this request much reference a schema named `File`. ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = FileSchemaTestClass(file: File(sourceURI: "sourceURI_example"), files: [File(sourceURI: "sourceURI_example")]) // FileSchemaTestClass | @@ -272,7 +272,7 @@ No authorization required ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let query = "query_example" // String | @@ -323,7 +323,7 @@ To test \"client\" model ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = Client(client: "client_example") // Client | client model @@ -373,7 +373,7 @@ Fake endpoint for testing various parameters 假端點 偽のエンドポイン ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let number = 987 // Double | None @@ -449,7 +449,7 @@ To test enum parameters ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let enumHeaderStringArray = ["enumHeaderStringArray_example"] // [String] | Header parameter enum test (string array) (optional) @@ -513,7 +513,7 @@ Fake endpoint to test group parameters (optional) ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let requiredStringGroup = 987 // Int | Required String in group parameters @@ -571,7 +571,7 @@ test inline additionalProperties ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let param = "TODO" // [String:String] | request body @@ -619,7 +619,7 @@ test json serialization of form data ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let param = "param_example" // String | field1 diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/FakeClassnameTags123API.md b/samples/client/petstore/swift4/unwrapRequired/docs/FakeClassnameTags123API.md index e46333f3454b..9f24b46edbc3 100644 --- a/samples/client/petstore/swift4/unwrapRequired/docs/FakeClassnameTags123API.md +++ b/samples/client/petstore/swift4/unwrapRequired/docs/FakeClassnameTags123API.md @@ -18,7 +18,7 @@ To test class name in snake case ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = Client(client: "client_example") // Client | client model diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/PetAPI.md b/samples/client/petstore/swift4/unwrapRequired/docs/PetAPI.md index 02cb51983a82..27efe0833476 100644 --- a/samples/client/petstore/swift4/unwrapRequired/docs/PetAPI.md +++ b/samples/client/petstore/swift4/unwrapRequired/docs/PetAPI.md @@ -24,7 +24,7 @@ Add a new pet to the store ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = Pet(id: 123, category: Category(id: 123, name: "name_example"), name: "name_example", photoUrls: ["photoUrls_example"], tags: [Tag(id: 123, name: "name_example")], status: "status_example") // Pet | Pet object that needs to be added to the store @@ -72,7 +72,7 @@ Deletes a pet ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let petId = 987 // Int64 | Pet id to delete @@ -124,7 +124,7 @@ Multiple status values can be provided with comma separated strings ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let status = ["status_example"] // [String] | Status values that need to be considered for filter @@ -174,7 +174,7 @@ Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let tags = ["inner_example"] // [String] | Tags to filter by @@ -224,7 +224,7 @@ Returns a single pet ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let petId = 987 // Int64 | ID of pet to return @@ -272,7 +272,7 @@ Update an existing pet ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = Pet(id: 123, category: Category(id: 123, name: "name_example"), name: "name_example", photoUrls: ["photoUrls_example"], tags: [Tag(id: 123, name: "name_example")], status: "status_example") // Pet | Pet object that needs to be added to the store @@ -320,7 +320,7 @@ Updates a pet in the store with form data ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let petId = 987 // Int64 | ID of pet that needs to be updated @@ -372,7 +372,7 @@ uploads an image ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let petId = 987 // Int64 | ID of pet to update @@ -424,7 +424,7 @@ uploads an image (required) ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let petId = 987 // Int64 | ID of pet to update diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/StoreAPI.md b/samples/client/petstore/swift4/unwrapRequired/docs/StoreAPI.md index da5100bbab40..36365ca51993 100644 --- a/samples/client/petstore/swift4/unwrapRequired/docs/StoreAPI.md +++ b/samples/client/petstore/swift4/unwrapRequired/docs/StoreAPI.md @@ -21,7 +21,7 @@ For valid response try integer IDs with value < 1000. Anything above 1000 or non ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let orderId = "orderId_example" // String | ID of the order that needs to be deleted @@ -71,7 +71,7 @@ Returns a map of status codes to quantities ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient @@ -117,7 +117,7 @@ For valid response try integer IDs with value <= 5 or > 10. Other values will ge ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let orderId = 987 // Int64 | ID of pet that needs to be fetched @@ -165,7 +165,7 @@ Place an order for a pet ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = Order(id: 123, petId: 123, quantity: 123, shipDate: Date(), status: "status_example", complete: false) // Order | order placed for purchasing the pet diff --git a/samples/client/petstore/swift4/unwrapRequired/docs/UserAPI.md b/samples/client/petstore/swift4/unwrapRequired/docs/UserAPI.md index b89e05125571..da20013482e0 100644 --- a/samples/client/petstore/swift4/unwrapRequired/docs/UserAPI.md +++ b/samples/client/petstore/swift4/unwrapRequired/docs/UserAPI.md @@ -25,7 +25,7 @@ This can only be done by the logged in user. ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = User(id: 123, username: "username_example", firstName: "firstName_example", lastName: "lastName_example", email: "email_example", password: "password_example", phone: "phone_example", userStatus: 123) // User | Created user object @@ -73,7 +73,7 @@ Creates list of users with given input array ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = [User(id: 123, username: "username_example", firstName: "firstName_example", lastName: "lastName_example", email: "email_example", password: "password_example", phone: "phone_example", userStatus: 123)] // [User] | List of user object @@ -121,7 +121,7 @@ Creates list of users with given input array ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let body = [User(id: 123, username: "username_example", firstName: "firstName_example", lastName: "lastName_example", email: "email_example", password: "password_example", phone: "phone_example", userStatus: 123)] // [User] | List of user object @@ -171,7 +171,7 @@ This can only be done by the logged in user. ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let username = "username_example" // String | The name that needs to be deleted @@ -219,7 +219,7 @@ Get user by user name ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let username = "username_example" // String | The name that needs to be fetched. Use user1 for testing. @@ -267,7 +267,7 @@ Logs user into the system ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let username = "username_example" // String | The user name for login @@ -317,7 +317,7 @@ Logs out current logged in user session ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient @@ -363,7 +363,7 @@ This can only be done by the logged in user. ### Example ```swift -// the following code samples are still beta. If you notice any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new +// The following code samples are still beta. For any issue, please report via https://github.com/OpenAPITools/openapi-generator/issues/new import PetstoreClient let username = "username_example" // String | name that need to be deleted