loafle/openapi-generator-original
3
0
Fork 1
mirror of https://github.com/OpenAPITools/openapi-generator.git synced 2025-12-09 13:06:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

migrate doc samples to oas3.0 spec (#6293)

Browse Source
This commit is contained in:
William Cheng
2020-05-14 12:22:40 +08:00
committed by GitHub
parent 81d307d8ca
commit 9c4b37299a
34 changed files with 1045 additions and 394 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -1 +1 @@
4.2.3-SNAPSHOT
5.0.0-SNAPSHOT

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

@@ -16,7 +16,7 @@ Method | HTTP request | Description
<a name="addPet"></a>
# **addPet**
> addPet(body)
> Pet addPet(pet)
Add a new pet to the store
@@ -24,11 +24,11 @@ Add a new pet to the store
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**Pet**](..//Models/Pet.md)| Pet object that needs to be added to the store |
**pet** | [**Pet**](..//Models/Pet.md)| Pet object that needs to be added to the store |
### Return type
null (empty response body)
[**Pet**](..//Models/Pet.md)
### Authorization
@@ -37,7 +37,7 @@ null (empty response body)
### HTTP request headers
- **Content-Type**: application/json, application/xml
- **Accept**: Not defined
- **Accept**: application/xml, application/json
<a name="deletePet"></a>
# **deletePet**
@@ -148,7 +148,7 @@ Name | Type | Description | Notes
<a name="updatePet"></a>
# **updatePet**
> updatePet(body)
> Pet updatePet(pet)
Update an existing pet
@@ -156,11 +156,11 @@ Update an existing pet
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**Pet**](..//Models/Pet.md)| Pet object that needs to be added to the store |
**pet** | [**Pet**](..//Models/Pet.md)| Pet object that needs to be added to the store |
### Return type
null (empty response body)
[**Pet**](..//Models/Pet.md)
### Authorization
@@ -169,7 +169,7 @@ null (empty response body)
### HTTP request headers
- **Content-Type**: application/json, application/xml
- **Accept**: Not defined
- **Accept**: application/xml, application/json
<a name="updatePetWithForm"></a>
# **updatePetWithForm**

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

@@ -50,7 +50,7 @@ This endpoint does not need any parameter.
### Return type
[**Map**](/Models/integer.md)
[**Map**](..//Models/integer.md)
### Authorization
@@ -77,7 +77,7 @@ Name | Type | Description | Notes
### Return type
[**Order**](/Models/Order.md)
[**Order**](..//Models/Order.md)
### Authorization
@@ -90,7 +90,7 @@ No authorization required
<a name="placeOrder"></a>
# **placeOrder**
> Order placeOrder(body)
> Order placeOrder(order)
Place an order for a pet
@@ -98,11 +98,11 @@ Place an order for a pet
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**Order**](/Models/Order.md)| order placed for purchasing the pet |
**order** | [**Order**](..//Models/Order.md)| order placed for purchasing the pet |
### Return type
[**Order**](/Models/Order.md)
[**Order**](..//Models/Order.md)
### Authorization
@@ -110,6 +110,6 @@ No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Content-Type**: application/json
- **Accept**: application/xml, application/json

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

@@ -16,7 +16,7 @@ Method | HTTP request | Description
<a name="createUser"></a>
# **createUser**
> createUser(body)
> createUser(user)
Create user
@@ -26,7 +26,7 @@ Create user
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**User**](/Models/User.md)| Created user object |
**user** | [**User**](..//Models/User.md)| Created user object |
### Return type
@@ -34,16 +34,16 @@ null (empty response body)
### Authorization
No authorization required
[auth_cookie](../README.md#auth_cookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Content-Type**: application/json
- **Accept**: Not defined
<a name="createUsersWithArrayInput"></a>
# **createUsersWithArrayInput**
> createUsersWithArrayInput(body)
> createUsersWithArrayInput(user)
Creates list of users with given input array
@@ -51,7 +51,7 @@ Creates list of users with given input array
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**List**](/Models/User.md)| List of user object |
**user** | [**List**](..//Models/User.md)| List of user object |
### Return type
@@ -59,16 +59,16 @@ null (empty response body)
### Authorization
No authorization required
[auth_cookie](../README.md#auth_cookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Content-Type**: application/json
- **Accept**: Not defined
<a name="createUsersWithListInput"></a>
# **createUsersWithListInput**
> createUsersWithListInput(body)
> createUsersWithListInput(user)
Creates list of users with given input array
@@ -76,7 +76,7 @@ Creates list of users with given input array
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**List**](/Models/User.md)| List of user object |
**user** | [**List**](..//Models/User.md)| List of user object |
### Return type
@@ -84,11 +84,11 @@ null (empty response body)
### Authorization
No authorization required
[auth_cookie](../README.md#auth_cookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Content-Type**: application/json
- **Accept**: Not defined
<a name="deleteUser"></a>
@@ -111,7 +111,7 @@ null (empty response body)
### Authorization
No authorization required
[auth_cookie](../README.md#auth_cookie)
### HTTP request headers
@@ -132,7 +132,7 @@ Name | Type | Description | Notes
### Return type
[**User**](/Models/User.md)
[**User**](..//Models/User.md)
### Authorization
@@ -158,7 +158,7 @@ Name | Type | Description | Notes
### Return type
[**String**](/Models/string.md)
[**String**](..//Models/string.md)
### Authorization
@@ -184,7 +184,7 @@ null (empty response body)
### Authorization
No authorization required
[auth_cookie](../README.md#auth_cookie)
### HTTP request headers
@@ -193,7 +193,7 @@ No authorization required
<a name="updateUser"></a>
# **updateUser**
> updateUser(username, body)
> updateUser(username, user)
Updated user
@@ -204,7 +204,7 @@ Updated user
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **String**| name that need to be deleted | [default to null]
**body** | [**User**](/Models/User.md)| Updated user object |
**user** | [**User**](..//Models/User.md)| Updated user object |
### Return type
@@ -212,10 +212,10 @@ null (empty response body)
### Authorization
No authorization required
[auth_cookie](../README.md#auth_cookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Content-Type**: application/json
- **Accept**: Not defined

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

@@ -0,0 +1,10 @@
# 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 Normal file
View File

@@ -0,0 +1,10 @@
# 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)

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

@@ -34,6 +34,8 @@ 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)
@@ -50,6 +52,13 @@ Class | Method | HTTP request | Description
- **API key parameter name**: api_key
- **Location**: HTTP header
<a name="auth_cookie"></a>
### auth_cookie
- **Type**: API key
- **API key parameter name**: AUTH_KEY
- **Location**:
<a name="petstore_auth"></a>
### petstore_auth