mirror of
https://github.com/OpenAPITools/openapi-generator.git
synced 2025-12-03 00:43:46 +00:00
update samples
This commit is contained in:
@@ -18,6 +18,7 @@ To test HTTP basic authentication
|
||||
### Example
|
||||
|
||||
* Basic Authentication (http_auth):
|
||||
|
||||
```python
|
||||
import time
|
||||
import os
|
||||
@@ -59,6 +60,7 @@ with openapi_client.ApiClient(configuration) as api_client:
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
@@ -75,6 +77,7 @@ This endpoint does not need any parameter.
|
||||
- **Accept**: text/plain
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | Successful operation | - |
|
||||
@@ -91,6 +94,7 @@ To test HTTP bearer authentication
|
||||
### Example
|
||||
|
||||
* Bearer Authentication (http_bearer_auth):
|
||||
|
||||
```python
|
||||
import time
|
||||
import os
|
||||
@@ -131,6 +135,7 @@ with openapi_client.ApiClient(configuration) as api_client:
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
@@ -147,6 +152,7 @@ This endpoint does not need any parameter.
|
||||
- **Accept**: text/plain
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | Successful operation | - |
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**size** | **str** | | [optional]
|
||||
|
||||
@@ -23,6 +23,7 @@ Test binary (gif) response body
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
```python
|
||||
import time
|
||||
import os
|
||||
@@ -54,6 +55,7 @@ with openapi_client.ApiClient(configuration) as api_client:
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
@@ -70,6 +72,7 @@ No authorization required
|
||||
- **Accept**: image/gif
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | Successful operation | - |
|
||||
@@ -85,6 +88,7 @@ Test body parameter(s)
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
```python
|
||||
import time
|
||||
import os
|
||||
@@ -118,6 +122,7 @@ with openapi_client.ApiClient(configuration) as api_client:
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**body** | **bytearray**| | [optional]
|
||||
@@ -136,6 +141,7 @@ No authorization required
|
||||
- **Accept**: text/plain
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | Successful operation | - |
|
||||
@@ -151,6 +157,7 @@ Test array of binary in multipart mime
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
```python
|
||||
import time
|
||||
import os
|
||||
@@ -184,6 +191,7 @@ with openapi_client.ApiClient(configuration) as api_client:
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**files** | **List[bytearray]**| |
|
||||
@@ -202,6 +210,7 @@ No authorization required
|
||||
- **Accept**: text/plain
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | Successful operation | - |
|
||||
@@ -217,6 +226,7 @@ Test body parameter(s)
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
```python
|
||||
import time
|
||||
import os
|
||||
@@ -251,6 +261,7 @@ with openapi_client.ApiClient(configuration) as api_client:
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**pet** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | [optional]
|
||||
@@ -269,6 +280,7 @@ No authorization required
|
||||
- **Accept**: application/json
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | Successful operation | - |
|
||||
@@ -284,6 +296,7 @@ Test free form object
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
```python
|
||||
import time
|
||||
import os
|
||||
@@ -317,6 +330,7 @@ with openapi_client.ApiClient(configuration) as api_client:
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**body** | **object**| Free form object | [optional]
|
||||
@@ -335,6 +349,7 @@ No authorization required
|
||||
- **Accept**: text/plain
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | Successful operation | - |
|
||||
@@ -350,6 +365,7 @@ Test body parameter(s)
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
```python
|
||||
import time
|
||||
import os
|
||||
@@ -384,6 +400,7 @@ with openapi_client.ApiClient(configuration) as api_client:
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**pet** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | [optional]
|
||||
@@ -402,6 +419,7 @@ No authorization required
|
||||
- **Accept**: application/json
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | Successful operation | - |
|
||||
@@ -417,6 +435,7 @@ Test empty response body
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
```python
|
||||
import time
|
||||
import os
|
||||
@@ -451,6 +470,7 @@ with openapi_client.ApiClient(configuration) as api_client:
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**pet** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | [optional]
|
||||
@@ -469,6 +489,7 @@ No authorization required
|
||||
- **Accept**: text/plain
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | Successful operation | - |
|
||||
@@ -484,6 +505,7 @@ Test empty json (request body)
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
```python
|
||||
import time
|
||||
import os
|
||||
@@ -518,6 +540,7 @@ with openapi_client.ApiClient(configuration) as api_client:
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**tag** | [**Tag**](Tag.md)| Tag object | [optional]
|
||||
@@ -536,6 +559,7 @@ No authorization required
|
||||
- **Accept**: text/plain
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | Successful operation | - |
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **int** | | [optional]
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**suffix** | **str** | test suffix | [optional]
|
||||
|
||||
@@ -3,6 +3,7 @@
|
||||
to test the default value of properties
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**array_string_enum_ref_default** | [**List[StringEnumRef]**](StringEnumRef.md) | | [optional] [default to ["success","failure"]]
|
||||
|
||||
@@ -17,6 +17,7 @@ Test form parameter(s)
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
```python
|
||||
import time
|
||||
import os
|
||||
@@ -52,6 +53,7 @@ with openapi_client.ApiClient(configuration) as api_client:
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**integer_form** | **int**| | [optional]
|
||||
@@ -72,6 +74,7 @@ No authorization required
|
||||
- **Accept**: text/plain
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | Successful operation | - |
|
||||
@@ -87,6 +90,7 @@ Test form parameter(s) for oneOf schema
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
```python
|
||||
import time
|
||||
import os
|
||||
@@ -125,6 +129,7 @@ with openapi_client.ApiClient(configuration) as api_client:
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**form1** | **str**| | [optional]
|
||||
@@ -148,6 +153,7 @@ No authorization required
|
||||
- **Accept**: text/plain
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | Successful operation | - |
|
||||
|
||||
@@ -16,6 +16,7 @@ Test header parameter(s)
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
```python
|
||||
import time
|
||||
import os
|
||||
@@ -54,6 +55,7 @@ with openapi_client.ApiClient(configuration) as api_client:
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**integer_header** | **int**| | [optional]
|
||||
@@ -76,6 +78,7 @@ No authorization required
|
||||
- **Accept**: text/plain
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | Successful operation | - |
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**number** | **float** | | [optional]
|
||||
|
||||
@@ -16,6 +16,7 @@ Test path parameter(s)
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
```python
|
||||
import time
|
||||
import os
|
||||
@@ -53,6 +54,7 @@ with openapi_client.ApiClient(configuration) as api_client:
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**path_string** | **str**| |
|
||||
@@ -74,6 +76,7 @@ No authorization required
|
||||
- **Accept**: text/plain
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | Successful operation | - |
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **int** | | [optional]
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **int** | Query | [optional]
|
||||
|
||||
@@ -23,6 +23,7 @@ Test query parameter(s)
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
```python
|
||||
import time
|
||||
import os
|
||||
@@ -58,6 +59,7 @@ with openapi_client.ApiClient(configuration) as api_client:
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**enum_nonref_string_query** | **str**| | [optional]
|
||||
@@ -77,6 +79,7 @@ No authorization required
|
||||
- **Accept**: text/plain
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | Successful operation | - |
|
||||
@@ -92,6 +95,7 @@ Test query parameter(s)
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
```python
|
||||
import time
|
||||
import os
|
||||
@@ -127,6 +131,7 @@ with openapi_client.ApiClient(configuration) as api_client:
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**datetime_query** | **datetime**| | [optional]
|
||||
@@ -147,6 +152,7 @@ No authorization required
|
||||
- **Accept**: text/plain
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | Successful operation | - |
|
||||
@@ -162,6 +168,7 @@ Test query parameter(s)
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
```python
|
||||
import time
|
||||
import os
|
||||
@@ -197,6 +204,7 @@ with openapi_client.ApiClient(configuration) as api_client:
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**integer_query** | **int**| | [optional]
|
||||
@@ -217,6 +225,7 @@ No authorization required
|
||||
- **Accept**: text/plain
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | Successful operation | - |
|
||||
@@ -232,6 +241,7 @@ Test query parameter(s)
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
```python
|
||||
import time
|
||||
import os
|
||||
@@ -266,6 +276,7 @@ with openapi_client.ApiClient(configuration) as api_client:
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**query_object** | [**Pet**](.md)| | [optional]
|
||||
@@ -284,6 +295,7 @@ No authorization required
|
||||
- **Accept**: text/plain
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | Successful operation | - |
|
||||
@@ -299,6 +311,7 @@ Test query parameter(s)
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
```python
|
||||
import time
|
||||
import os
|
||||
@@ -332,6 +345,7 @@ with openapi_client.ApiClient(configuration) as api_client:
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**query_object** | [**TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter**](.md)| | [optional]
|
||||
@@ -350,6 +364,7 @@ No authorization required
|
||||
- **Accept**: text/plain
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | Successful operation | - |
|
||||
@@ -365,6 +380,7 @@ Test query parameter(s)
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
```python
|
||||
import time
|
||||
import os
|
||||
@@ -399,6 +415,7 @@ with openapi_client.ApiClient(configuration) as api_client:
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**query_object** | [**TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter**](.md)| | [optional]
|
||||
@@ -417,6 +434,7 @@ No authorization required
|
||||
- **Accept**: text/plain
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | Successful operation | - |
|
||||
@@ -432,6 +450,7 @@ Test query parameter(s)
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
```python
|
||||
import time
|
||||
import os
|
||||
@@ -466,6 +485,7 @@ with openapi_client.ApiClient(configuration) as api_client:
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**query_object** | [**Pet**](.md)| | [optional]
|
||||
@@ -484,6 +504,7 @@ No authorization required
|
||||
- **Accept**: text/plain
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | Successful operation | - |
|
||||
@@ -499,6 +520,7 @@ Test query parameter(s)
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
```python
|
||||
import time
|
||||
import os
|
||||
@@ -532,6 +554,7 @@ with openapi_client.ApiClient(configuration) as api_client:
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**query_object** | [**DataQuery**](.md)| | [optional]
|
||||
@@ -550,6 +573,7 @@ No authorization required
|
||||
- **Accept**: text/plain
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | Successful operation | - |
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **int** | | [optional]
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**size** | **str** | | [optional]
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**values** | **List[str]** | | [optional]
|
||||
|
||||
Reference in New Issue
Block a user