Fix python generated markdown documentation for Jekyll (#10111)

* Fix python generated markdown documentation

* Generated `build the project` and upate sample scripts
This commit is contained in:
guy-har
2021-08-18 11:25:30 +03:00
committed by GitHub
parent d9f3a02d5b
commit 50acdcb4a3
22 changed files with 268 additions and 0 deletions

View File

@@ -16,6 +16,7 @@ To test special tags and operation ID starting with number
### Example
```python
import time
import petstore_api
@@ -68,6 +69,7 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |

View File

@@ -31,6 +31,7 @@ Test serialization of ArrayModel
### Example
```python
import time
import petstore_api
@@ -83,6 +84,7 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Output model | - |
@@ -98,6 +100,7 @@ Test serialization of outer boolean types
### Example
```python
import time
import petstore_api
@@ -147,6 +150,7 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Output boolean | - |
@@ -162,6 +166,7 @@ this route creates an XmlItem
### Example
```python
import time
import petstore_api
@@ -259,6 +264,7 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
@@ -274,6 +280,7 @@ Test serialization of outer number types
### Example
```python
import time
import petstore_api
@@ -324,6 +331,7 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Output number | - |
@@ -339,6 +347,7 @@ Test serialization of object with $refed properties
### Example
```python
import time
import petstore_api
@@ -393,6 +402,7 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Output model | - |
@@ -408,6 +418,7 @@ Test serialization of outer string types
### Example
```python
import time
import petstore_api
@@ -457,6 +468,7 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Output string | - |
@@ -472,6 +484,7 @@ Test serialization of outer enum
### Example
```python
import time
import petstore_api
@@ -522,6 +535,7 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Output enum | - |
@@ -537,6 +551,7 @@ For this test, the body for this request much reference a schema named `File`.
### Example
```python
import time
import petstore_api
@@ -594,6 +609,7 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Success | - |
@@ -607,6 +623,7 @@ No authorization required
### Example
```python
import time
import petstore_api
@@ -666,6 +683,7 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Success | - |
@@ -681,6 +699,7 @@ To test \"client\" model
### Example
```python
import time
import petstore_api
@@ -733,6 +752,7 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
@@ -748,6 +768,7 @@ This route has required values with enums of 1
### Example
```python
import time
import petstore_api
@@ -798,6 +819,7 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Success | - |
@@ -814,6 +836,7 @@ Fake endpoint for testing various parameters 假端點 偽のエンドポイ
### Example
* Basic Authentication (http_basic_test):
```python
import time
import petstore_api
@@ -906,6 +929,7 @@ void (empty response body)
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**400** | Invalid username supplied | - |
@@ -922,6 +946,7 @@ To test enum parameters
### Example
```python
import time
import petstore_api
@@ -989,6 +1014,7 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**400** | Invalid request | - |
@@ -1005,6 +1031,7 @@ Fake endpoint to test group parameters (optional)
### Example
```python
import time
import petstore_api
@@ -1071,6 +1098,7 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**400** | Someting wrong | - |
@@ -1084,6 +1112,7 @@ test inline additionalProperties
### Example
```python
import time
import petstore_api
@@ -1134,6 +1163,7 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
@@ -1147,6 +1177,7 @@ test json serialization of form data
### Example
```python
import time
import petstore_api
@@ -1197,6 +1228,7 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |

View File

@@ -17,6 +17,7 @@ To test class name in snake case
### Example
* Api Key Authentication (api_key_query):
```python
import time
import petstore_api
@@ -79,6 +80,7 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |

View File

@@ -23,6 +23,7 @@ Add a new pet to the store
### Example
* OAuth Authentication (petstore_auth):
```python
import time
import petstore_api
@@ -100,6 +101,7 @@ void (empty response body)
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
@@ -115,6 +117,7 @@ Deletes a pet
### Example
* OAuth Authentication (petstore_auth):
```python
import time
import petstore_api
@@ -183,6 +186,7 @@ void (empty response body)
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
@@ -200,6 +204,7 @@ Multiple status values can be provided with comma separated strings
### Example
* OAuth Authentication (petstore_auth):
```python
import time
import petstore_api
@@ -262,6 +267,7 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
@@ -279,6 +285,7 @@ Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3
### Example
* OAuth Authentication (petstore_auth):
```python
import time
import petstore_api
@@ -341,6 +348,7 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
@@ -358,6 +366,7 @@ Returns a single pet
### Example
* Api Key Authentication (api_key):
```python
import time
import petstore_api
@@ -418,6 +427,7 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
@@ -434,6 +444,7 @@ Update an existing pet
### Example
* OAuth Authentication (petstore_auth):
```python
import time
import petstore_api
@@ -511,6 +522,7 @@ void (empty response body)
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
@@ -528,6 +540,7 @@ Updates a pet in the store with form data
### Example
* OAuth Authentication (petstore_auth):
```python
import time
import petstore_api
@@ -598,6 +611,7 @@ void (empty response body)
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**405** | Invalid input | - |
@@ -612,6 +626,7 @@ uploads an image
### Example
* OAuth Authentication (petstore_auth):
```python
import time
import petstore_api
@@ -687,6 +702,7 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
@@ -701,6 +717,7 @@ uploads an image (required)
### Example
* OAuth Authentication (petstore_auth):
```python
import time
import petstore_api
@@ -774,6 +791,7 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |

View File

@@ -19,6 +19,7 @@ For valid response try integer IDs with value < 1000. Anything above 1000 or non
### Example
```python
import time
import petstore_api
@@ -67,6 +68,7 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**400** | Invalid ID supplied | - |
@@ -84,6 +86,7 @@ Returns a map of status codes to quantities
### Example
* Api Key Authentication (api_key):
```python
import time
import petstore_api
@@ -139,6 +142,7 @@ This endpoint does not need any parameter.
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
@@ -154,6 +158,7 @@ For valid response try integer IDs with value <= 5 or > 10. Other values will ge
### Example
```python
import time
import petstore_api
@@ -204,6 +209,7 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
@@ -219,6 +225,7 @@ Place an order for a pet
### Example
```python
import time
import petstore_api
@@ -276,6 +283,7 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |

View File

@@ -23,6 +23,7 @@ This can only be done by the logged in user.
### Example
```python
import time
import petstore_api
@@ -81,6 +82,7 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**0** | successful operation | - |
@@ -94,6 +96,7 @@ Creates list of users with given input array
### Example
```python
import time
import petstore_api
@@ -154,6 +157,7 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**0** | successful operation | - |
@@ -167,6 +171,7 @@ Creates list of users with given input array
### Example
```python
import time
import petstore_api
@@ -227,6 +232,7 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**0** | successful operation | - |
@@ -242,6 +248,7 @@ This can only be done by the logged in user.
### Example
```python
import time
import petstore_api
@@ -290,6 +297,7 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**400** | Invalid username supplied | - |
@@ -304,6 +312,7 @@ Get user by user name
### Example
```python
import time
import petstore_api
@@ -354,6 +363,7 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
@@ -369,6 +379,7 @@ Logs user into the system
### Example
```python
import time
import petstore_api
@@ -420,6 +431,7 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | * X-Rate-Limit - calls per hour allowed by the user <br> * X-Expires-After - date in UTC when token expires <br> |
@@ -434,6 +446,7 @@ Logs out current logged in user session
### Example
```python
import time
import petstore_api
@@ -478,6 +491,7 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**0** | successful operation | - |
@@ -493,6 +507,7 @@ This can only be done by the logged in user.
### Example
```python
import time
import petstore_api
@@ -553,6 +568,7 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**400** | Invalid user supplied | - |