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

remove warnings related to escaping the characters in the md generator (#12774)

Browse Source
This commit is contained in:
William Cheng 2022-07-06 14:19:40 +08:00 committed by GitHub
parent 1383be4a2e
commit f5b5feb58d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
15 changed files with 186 additions and 175 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/MarkdownDocumentationCodegen.java
View File

@ -110,4 +110,17 @@ public class MarkdownDocumentationCodegen extends DefaultCodegen implements Code
@Override
public GeneratorLanguage generatorLanguage() { return null; }
@Override
public String escapeUnsafeCharacters(String input) {
// do nothing as the output is just doc
return input;
}
@Override
public String escapeQuotationMark(String input) {
// do nothing as the output is just doc
return input;
}
}

2
samples/documentation/markdown/.openapi-generator/FILES
View File

@ -3,8 +3,6 @@ Apis/StoreApi.md
Apis/UserApi.md
Models/ApiResponse.md
Models/Category.md
Models/InlineObject.md
Models/InlineObject1.md
Models/Order.md
Models/Pet.md
Models/Tag.md

2
samples/documentation/markdown/.openapi-generator/VERSION
View File

@ -1 +1 @@
5.0.0-SNAPSHOT
6.1.0-SNAPSHOT

88
samples/documentation/markdown/Apis/PetApi.md
View File

@ -2,16 +2,16 @@
All URIs are relative to *http://petstore.swagger.io/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
| 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 |
<a name="addPet"></a>
@ -20,11 +20,13 @@ Method | HTTP request | Description
Add a new pet to the store
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**Pet** | [**Pet**](../Models/Pet.md)| Pet object that needs to be added to the store |
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **Pet** | [**Pet**](../Models/Pet.md)| Pet object that needs to be added to the store | |
### Return type
@ -45,12 +47,14 @@ Name | Type | Description | Notes
Deletes a pet
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**petId** | **Long**| Pet id to delete | [default to null]
**api\_key** | **String**| | [optional] [default to null]
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **petId** | **Long**| Pet id to delete | [default to null] |
| **api\_key** | **String**| | [optional] [default to null] |
### Return type
@ -75,9 +79,9 @@ Finds Pets by status
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**status** | [**List**](../Models/String.md)| Status values that need to be considered for filter | [default to null] [enum: available, pending, sold]
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **status** | [**List**](../Models/String.md)| Status values that need to be considered for filter | [default to null] [enum: available, pending, sold] |
### Return type
@ -102,9 +106,9 @@ Finds Pets by tags
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**tags** | [**List**](../Models/String.md)| Tags to filter by | [default to null]
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **tags** | [**List**](../Models/String.md)| Tags to filter by | [default to null] |
### Return type
@ -129,9 +133,9 @@ Find pet by ID
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**petId** | **Long**| ID of pet to return | [default to null]
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **petId** | **Long**| ID of pet to return | [default to null] |
### Return type
@ -152,11 +156,13 @@ Name | Type | Description | Notes
Update an existing pet
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**Pet** | [**Pet**](../Models/Pet.md)| Pet object that needs to be added to the store |
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **Pet** | [**Pet**](../Models/Pet.md)| Pet object that needs to be added to the store | |
### Return type
@ -177,13 +183,15 @@ Name | Type | Description | Notes
Updates a pet in the store with form data
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**petId** | **Long**| ID of pet that needs to be updated | [default to null]
**name** | **String**| Updated name of the pet | [optional] [default to null]
**status** | **String**| Updated status of the pet | [optional] [default to null]
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **petId** | **Long**| ID of pet that needs to be updated | [default to null] |
| **name** | **String**| Updated name of the pet | [optional] [default to null] |
| **status** | **String**| Updated status of the pet | [optional] [default to null] |
### Return type
@ -204,13 +212,15 @@ null (empty response body)
uploads an image
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**petId** | **Long**| ID of pet to update | [default to null]
**additionalMetadata** | **String**| Additional data to pass to server | [optional] [default to null]
**file** | **File**| file to upload | [optional] [default to null]
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **petId** | **Long**| ID of pet to update | [default to null] |
| **additionalMetadata** | **String**| Additional data to pass to server | [optional] [default to null] |
| **file** | **File**| file to upload | [optional] [default to null] |
### Return type

34
samples/documentation/markdown/Apis/StoreApi.md
View File

@ -2,12 +2,12 @@
All URIs are relative to *http://petstore.swagger.io/v2*
Method | HTTP request | Description
------------- | ------------- | -------------
[**deleteOrder**](StoreApi.md#deleteOrder) | **DELETE** /store/order/{orderId} | Delete purchase order by ID
[**getInventory**](StoreApi.md#getInventory) | **GET** /store/inventory | Returns pet inventories by status
[**getOrderById**](StoreApi.md#getOrderById) | **GET** /store/order/{orderId} | Find purchase order by ID
[**placeOrder**](StoreApi.md#placeOrder) | **POST** /store/order | Place an order for a pet
| Method | HTTP request | Description |
|------------- | ------------- | -------------|
| [**deleteOrder**](StoreApi.md#deleteOrder) | **DELETE** /store/order/{orderId} | Delete purchase order by ID |
| [**getInventory**](StoreApi.md#getInventory) | **GET** /store/inventory | Returns pet inventories by status |
| [**getOrderById**](StoreApi.md#getOrderById) | **GET** /store/order/{orderId} | Find purchase order by ID |
| [**placeOrder**](StoreApi.md#placeOrder) | **POST** /store/order | Place an order for a pet |
<a name="deleteOrder"></a>
@ -20,9 +20,9 @@ Delete purchase order by ID
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**orderId** | **String**| ID of the order that needs to be deleted | [default to null]
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **orderId** | **String**| ID of the order that needs to be deleted | [default to null] |
### Return type
@ -50,7 +50,7 @@ This endpoint does not need any parameter.
### Return type
[**Map**](../Models/integer.md)
**Map**
### Authorization
@ -71,9 +71,9 @@ Find purchase order by ID
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**orderId** | **Long**| ID of pet that needs to be fetched | [default to null]
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **orderId** | **Long**| ID of pet that needs to be fetched | [default to null] |
### Return type
@ -94,11 +94,13 @@ No authorization required
Place an order for a pet
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**Order** | [**Order**](../Models/Order.md)| order placed for purchasing the pet |
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **Order** | [**Order**](../Models/Order.md)| order placed for purchasing the pet | |
### Return type

78
samples/documentation/markdown/Apis/UserApi.md
View File

@ -2,16 +2,16 @@
All URIs are relative to *http://petstore.swagger.io/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
| 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 |
<a name="createUser"></a>
@ -24,9 +24,9 @@ Create user
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**User** | [**User**](../Models/User.md)| Created user object |
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **User** | [**User**](../Models/User.md)| Created user object | |
### Return type
@ -47,11 +47,13 @@ null (empty response body)
Creates list of users with given input array
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**User** | [**List**](../Models/User.md)| List of user object |
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **User** | [**List**](../Models/User.md)| List of user object | |
### Return type
@ -72,11 +74,13 @@ null (empty response body)
Creates list of users with given input array
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**User** | [**List**](../Models/User.md)| List of user object |
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **User** | [**List**](../Models/User.md)| List of user object | |
### Return type
@ -101,9 +105,9 @@ Delete user
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **String**| The name that needs to be deleted | [default to null]
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **username** | **String**| The name that needs to be deleted | [default to null] |
### Return type
@ -124,11 +128,13 @@ null (empty response body)
Get user by user name
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **String**| The name that needs to be fetched. Use user1 for testing. | [default to null]
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **username** | **String**| The name that needs to be fetched. Use user1 for testing. | [default to null] |
### Return type
@ -149,16 +155,18 @@ No authorization required
Logs user into the system
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **String**| The user name for login | [default to null]
**password** | **String**| The password for login in clear text | [default to null]
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **username** | **String**| The user name for login | [default to null] |
| **password** | **String**| The password for login in clear text | [default to null] |
### Return type
[**String**](../Models/string.md)
**String**
### Authorization
@ -175,6 +183,8 @@ No authorization required
Logs out current logged in user session
### Parameters
This endpoint does not need any parameter.
@ -201,10 +211,10 @@ Updated user
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **String**| name that need to be deleted | [default to null]
**User** | [**User**](../Models/User.md)| Updated user object |
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **username** | **String**| name that need to be deleted | [default to null] |
| **User** | [**User**](../Models/User.md)| Updated user object | |
### Return type

10
samples/documentation/markdown/Models/ApiResponse.md
View File

@ -1,11 +1,11 @@
# ApiResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**code** | [**Integer**](integer.md) | | [optional] [default to null]
**type** | [**String**](string.md) | | [optional] [default to null]
**message** | [**String**](string.md) | | [optional] [default to null]
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **code** | **Integer** | | [optional] [default to null] |
| **type** | **String** | | [optional] [default to null] |
| **message** | **String** | | [optional] [default to null] |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

8
samples/documentation/markdown/Models/Category.md
View File

@ -1,10 +1,10 @@
# Category
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | [**Long**](long.md) | | [optional] [default to null]
**name** | [**String**](string.md) | | [optional] [default to null]
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **id** | **Long** | | [optional] [default to null] |
| **name** | **String** | | [optional] [default to null] |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10
samples/documentation/markdown/Models/InlineObject.md
View File

@ -1,10 +0,0 @@
# InlineObject
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | [**String**](string.md) | Updated name of the pet | [optional] [default to null]
**status** | [**String**](string.md) | Updated status of the pet | [optional] [default to null]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10
samples/documentation/markdown/Models/InlineObject1.md
View File

@ -1,10 +0,0 @@
# InlineObject1
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**additionalMetadata** | [**String**](string.md) | Additional data to pass to server | [optional] [default to null]
**file** | [**File**](file.md) | file to upload | [optional] [default to null]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

16
samples/documentation/markdown/Models/Order.md
View File

@ -1,14 +1,14 @@
# Order
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | [**Long**](long.md) | | [optional] [default to null]
**petId** | [**Long**](long.md) | | [optional] [default to null]
**quantity** | [**Integer**](integer.md) | | [optional] [default to null]
**shipDate** | [**Date**](DateTime.md) | | [optional] [default to null]
**status** | [**String**](string.md) | Order Status | [optional] [default to null]
**complete** | [**Boolean**](boolean.md) | | [optional] [default to false]
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **id** | **Long** | | [optional] [default to null] |
| **petId** | **Long** | | [optional] [default to null] |
| **quantity** | **Integer** | | [optional] [default to null] |
| **shipDate** | **Date** | | [optional] [default to null] |
| **status** | **String** | Order Status | [optional] [default to null] |
| **complete** | **Boolean** | | [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)

16
samples/documentation/markdown/Models/Pet.md
View File

@ -1,14 +1,14 @@
# Pet
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | [**Long**](long.md) | | [optional] [default to null]
**category** | [**Category**](Category.md) | | [optional] [default to null]
**name** | [**String**](string.md) | | [default to null]
**photoUrls** | [**List**](string.md) | | [default to null]
**tags** | [**List**](Tag.md) | | [optional] [default to null]
**status** | [**String**](string.md) | pet status in the store | [optional] [default to null]
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **id** | **Long** | | [optional] [default to null] |
| **category** | [**Category**](Category.md) | | [optional] [default to null] |
| **name** | **String** | | [default to null] |
| **photoUrls** | **List** | | [default to null] |
| **tags** | [**List**](Tag.md) | | [optional] [default to null] |
| **status** | **String** | pet status in the store | [optional] [default to null] |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

8
samples/documentation/markdown/Models/Tag.md
View File

@ -1,10 +1,10 @@
# Tag
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | [**Long**](long.md) | | [optional] [default to null]
**name** | [**String**](string.md) | | [optional] [default to null]
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **id** | **Long** | | [optional] [default to null] |
| **name** | **String** | | [optional] [default to null] |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

20
samples/documentation/markdown/Models/User.md
View File

@ -1,16 +1,16 @@
# User
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | [**Long**](long.md) | | [optional] [default to null]
**username** | [**String**](string.md) | | [optional] [default to null]
**firstName** | [**String**](string.md) | | [optional] [default to null]
**lastName** | [**String**](string.md) | | [optional] [default to null]
**email** | [**String**](string.md) | | [optional] [default to null]
**password** | [**String**](string.md) | | [optional] [default to null]
**phone** | [**String**](string.md) | | [optional] [default to null]
**userStatus** | [**Integer**](integer.md) | User Status | [optional] [default to null]
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **id** | **Long** | | [optional] [default to null] |
| **username** | **String** | | [optional] [default to null] |
| **firstName** | **String** | | [optional] [default to null] |
| **lastName** | **String** | | [optional] [default to null] |
| **email** | **String** | | [optional] [default to null] |
| **password** | **String** | | [optional] [default to null] |
| **phone** | **String** | | [optional] [default to null] |
| **userStatus** | **Integer** | User Status | [optional] [default to null] |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

46
samples/documentation/markdown/README.md
View File

@ -5,28 +5,28 @@
All URIs are relative to *http://petstore.swagger.io/v2*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*PetApi* | [**addPet**](Apis/PetApi.md#addpet) | **POST** /pet | Add a new pet to the store
*PetApi* | [**deletePet**](Apis/PetApi.md#deletepet) | **DELETE** /pet/{petId} | Deletes a pet
*PetApi* | [**findPetsByStatus**](Apis/PetApi.md#findpetsbystatus) | **GET** /pet/findByStatus | Finds Pets by status
*PetApi* | [**findPetsByTags**](Apis/PetApi.md#findpetsbytags) | **GET** /pet/findByTags | Finds Pets by tags
*PetApi* | [**getPetById**](Apis/PetApi.md#getpetbyid) | **GET** /pet/{petId} | Find pet by ID
*PetApi* | [**updatePet**](Apis/PetApi.md#updatepet) | **PUT** /pet | Update an existing pet
*PetApi* | [**updatePetWithForm**](Apis/PetApi.md#updatepetwithform) | **POST** /pet/{petId} | Updates a pet in the store with form data
*PetApi* | [**uploadFile**](Apis/PetApi.md#uploadfile) | **POST** /pet/{petId}/uploadImage | uploads an image
*StoreApi* | [**deleteOrder**](Apis/StoreApi.md#deleteorder) | **DELETE** /store/order/{orderId} | Delete purchase order by ID
*StoreApi* | [**getInventory**](Apis/StoreApi.md#getinventory) | **GET** /store/inventory | Returns pet inventories by status
*StoreApi* | [**getOrderById**](Apis/StoreApi.md#getorderbyid) | **GET** /store/order/{orderId} | Find purchase order by ID
*StoreApi* | [**placeOrder**](Apis/StoreApi.md#placeorder) | **POST** /store/order | Place an order for a pet
*UserApi* | [**createUser**](Apis/UserApi.md#createuser) | **POST** /user | Create user
*UserApi* | [**createUsersWithArrayInput**](Apis/UserApi.md#createuserswitharrayinput) | **POST** /user/createWithArray | Creates list of users with given input array
*UserApi* | [**createUsersWithListInput**](Apis/UserApi.md#createuserswithlistinput) | **POST** /user/createWithList | Creates list of users with given input array
*UserApi* | [**deleteUser**](Apis/UserApi.md#deleteuser) | **DELETE** /user/{username} | Delete user
*UserApi* | [**getUserByName**](Apis/UserApi.md#getuserbyname) | **GET** /user/{username} | Get user by user name
*UserApi* | [**loginUser**](Apis/UserApi.md#loginuser) | **GET** /user/login | Logs user into the system
*UserApi* | [**logoutUser**](Apis/UserApi.md#logoutuser) | **GET** /user/logout | Logs out current logged in user session
*UserApi* | [**updateUser**](Apis/UserApi.md#updateuser) | **PUT** /user/{username} | Updated user
| Class | Method | HTTP request | Description |
|------------ | ------------- | ------------- | -------------|
| *PetApi* | [**addPet**](Apis/PetApi.md#addpet) | **POST** /pet | Add a new pet to the store |
*PetApi* | [**deletePet**](Apis/PetApi.md#deletepet) | **DELETE** /pet/{petId} | Deletes a pet |
*PetApi* | [**findPetsByStatus**](Apis/PetApi.md#findpetsbystatus) | **GET** /pet/findByStatus | Finds Pets by status |
*PetApi* | [**findPetsByTags**](Apis/PetApi.md#findpetsbytags) | **GET** /pet/findByTags | Finds Pets by tags |
*PetApi* | [**getPetById**](Apis/PetApi.md#getpetbyid) | **GET** /pet/{petId} | Find pet by ID |
*PetApi* | [**updatePet**](Apis/PetApi.md#updatepet) | **PUT** /pet | Update an existing pet |
*PetApi* | [**updatePetWithForm**](Apis/PetApi.md#updatepetwithform) | **POST** /pet/{petId} | Updates a pet in the store with form data |
*PetApi* | [**uploadFile**](Apis/PetApi.md#uploadfile) | **POST** /pet/{petId}/uploadImage | uploads an image |
| *StoreApi* | [**deleteOrder**](Apis/StoreApi.md#deleteorder) | **DELETE** /store/order/{orderId} | Delete purchase order by ID |
*StoreApi* | [**getInventory**](Apis/StoreApi.md#getinventory) | **GET** /store/inventory | Returns pet inventories by status |
*StoreApi* | [**getOrderById**](Apis/StoreApi.md#getorderbyid) | **GET** /store/order/{orderId} | Find purchase order by ID |
*StoreApi* | [**placeOrder**](Apis/StoreApi.md#placeorder) | **POST** /store/order | Place an order for a pet |
| *UserApi* | [**createUser**](Apis/UserApi.md#createuser) | **POST** /user | Create user |
*UserApi* | [**createUsersWithArrayInput**](Apis/UserApi.md#createuserswitharrayinput) | **POST** /user/createWithArray | Creates list of users with given input array |
*UserApi* | [**createUsersWithListInput**](Apis/UserApi.md#createuserswithlistinput) | **POST** /user/createWithList | Creates list of users with given input array |
*UserApi* | [**deleteUser**](Apis/UserApi.md#deleteuser) | **DELETE** /user/{username} | Delete user |
*UserApi* | [**getUserByName**](Apis/UserApi.md#getuserbyname) | **GET** /user/{username} | Get user by user name |
*UserApi* | [**loginUser**](Apis/UserApi.md#loginuser) | **GET** /user/login | Logs user into the system |
*UserApi* | [**logoutUser**](Apis/UserApi.md#logoutuser) | **GET** /user/logout | Logs out current logged in user session |
*UserApi* | [**updateUser**](Apis/UserApi.md#updateuser) | **PUT** /user/{username} | Updated user |
<a name="documentation-for-models"></a>
@ -34,8 +34,6 @@ Class | Method | HTTP request | Description
- [ApiResponse](./Models/ApiResponse.md)
- [Category](./Models/Category.md)
- [InlineObject](./Models/InlineObject.md)
- [InlineObject1](./Models/InlineObject1.md)
- [Order](./Models/Order.md)
- [Pet](./Models/Pet.md)
- [Tag](./Models/Tag.md)