forked from loafle/openapi-generator-original
commit c5a0d0f7394aa742fa336fff7e7c1d3049761868 Merge: 8c4991ba3ed f8ff8c87609 Author: William Cheng <wing328hk@gmail.com> Date: Tue Aug 17 18:28:12 2021 +0800 Merge branch 'mustache-linting' of https://github.com/NathanBaulch/openapi-generator into NathanBaulch-mustache-linting commit f8ff8c87609b1ca36fa26fb8474806999638195e Author: Nathan Baulch <nathan.baulch@gmail.com> Date: Thu Aug 5 14:12:47 2021 +1000 Reorder tags that handle missing values commit f5d8a33709d6a3f846a9fe4520b78c3d637051d9 Author: Nathan Baulch <nathan.baulch@gmail.com> Date: Thu Aug 5 14:08:59 2021 +1000 Use dot notation where possible commit 493d14921e2333f3ae19ef6fc89318b7e263a80c Author: Nathan Baulch <nathan.baulch@gmail.com> Date: Thu Aug 5 14:10:49 2021 +1000 Remove empty tags commit 32480dc53f48227d55531b94e307d72671373737 Author: Nathan Baulch <nathan.baulch@gmail.com> Date: Thu Aug 5 10:41:58 2021 +1000 Remove redundant sections commit a8edabd722c34aa094b4aeb11c22664529c3a219 Author: Nathan Baulch <nathan.baulch@gmail.com> Date: Wed Aug 4 22:02:22 2021 +1000 Trim extra EOF new lines commit e89bd7458e3594bf0d30e580bc9408e45b018a57 Author: Nathan Baulch <nathan.baulch@gmail.com> Date: Wed Aug 4 21:59:26 2021 +1000 Trim trailing whitespace
Swift5 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 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.Swift5ClientCodegen
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 | PATCH /another-fake/dummy | To test special tags |
FakeAPI | fakeOuterBooleanSerialize | POST /fake/outer/boolean | |
FakeAPI | fakeOuterCompositeSerialize | POST /fake/outer/composite | |
FakeAPI | fakeOuterNumberSerialize | POST /fake/outer/number | |
FakeAPI | fakeOuterStringSerialize | POST /fake/outer/string | |
FakeAPI | testBodyWithFileSchema | PUT /fake/body-with-file-schema | |
FakeAPI | testBodyWithQueryParams | PUT /fake/body-with-query-params | |
FakeAPI | testClientModel | PATCH /fake | To test "client" model |
FakeAPI | testEndpointParameters | POST /fake | Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 |
FakeAPI | testEnumParameters | GET /fake | To test enum parameters |
FakeAPI | testGroupParameters | DELETE /fake | Fake endpoint to test group parameters (optional) |
FakeAPI | testInlineAdditionalProperties | POST /fake/inline-additionalProperties | test inline additionalProperties |
FakeAPI | testJsonFormData | GET /fake/jsonFormData | test json serialization of form data |
FakeClassnameTags123API | testClassname | PATCH /fake_classname_test | To test class name in snake case |
PetAPI | addPet | POST /pet | Add a new pet to the store |
PetAPI | deletePet | DELETE /pet/{petId} | Deletes a pet |
PetAPI | findPetsByStatus | GET /pet/findByStatus | Finds Pets by status |
PetAPI | findPetsByTags | GET /pet/findByTags | Finds Pets by tags |
PetAPI | getPetById | GET /pet/{petId} | Find pet by ID |
PetAPI | updatePet | PUT /pet | Update an existing pet |
PetAPI | updatePetWithForm | POST /pet/{petId} | Updates a pet in the store with form data |
PetAPI | uploadFile | POST /pet/{petId}/uploadImage | uploads an image |
PetAPI | uploadFileWithRequiredFile | POST /fake/{petId}/uploadImageWithRequiredFile | uploads an image (required) |
StoreAPI | deleteOrder | DELETE /store/order/{order_id} | Delete purchase order by ID |
StoreAPI | getInventory | GET /store/inventory | Returns pet inventories by status |
StoreAPI | getOrderById | GET /store/order/{order_id} | Find purchase order by ID |
StoreAPI | placeOrder | POST /store/order | Place an order for a pet |
UserAPI | createUser | POST /user | Create user |
UserAPI | createUsersWithArrayInput | POST /user/createWithArray | Creates list of users with given input array |
UserAPI | createUsersWithListInput | POST /user/createWithList | Creates list of users with given input array |
UserAPI | deleteUser | DELETE /user/{username} | Delete user |
UserAPI | getUserByName | GET /user/{username} | Get user by user name |
UserAPI | loginUser | GET /user/login | Logs user into the system |
UserAPI | logoutUser | GET /user/logout | Logs out current logged in user session |
UserAPI | updateUser | PUT /user/{username} | Updated user |
Documentation For Models
- AdditionalPropertiesClass
- Animal
- AnimalFarm
- ApiResponse
- ArrayOfArrayOfNumberOnly
- ArrayOfNumberOnly
- ArrayTest
- Capitalization
- Cat
- CatAllOf
- Category
- ClassModel
- Client
- Dog
- DogAllOf
- EnumArrays
- EnumClass
- EnumTest
- File
- FileSchemaTestClass
- FormatTest
- HasOnlyReadOnly
- List
- MapTest
- MixedPropertiesAndAdditionalPropertiesClass
- Model200Response
- Name
- NumberOnly
- Order
- OuterComposite
- OuterEnum
- Pet
- ReadOnlyFirst
- Return
- SpecialModelName
- StringBooleanMap
- Tag
- TypeHolderDefault
- TypeHolderExample
- User
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