Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: display of markdown in notes section #20534

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ Method | HTTP request | Description
# **{{{operationId}}}**
> {{#returnType}}{{{.}}} {{/returnType}}{{{operationId}}}({{#allParams}}{{#required}}{{{paramName}}}{{/required}}{{^required}}{{{paramName}}}={{{paramName}}}{{/required}}{{^-last}}, {{/-last}}{{/allParams}})

{{{summary}}}{{#notes}}
{{{summary}}}

{{{.}}}{{/notes}}
{{#unescapedNotes}}{{{.}}}{{/unescapedNotes}}

### Example

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,14 @@ Method | HTTP request | Description
# **{{{operationId}}}**
> {{#returnType}}{{{.}}} {{/returnType}}{{{operationId}}}({{#allParams}}{{#required}}{{{paramName}}}{{/required}}{{^required}}{{{paramName}}}={{{paramName}}}{{/required}}{{^-last}}, {{/-last}}{{/allParams}})

{{{summary}}}{{#notes}}
{{#summary}}
{{{summary}}}

{{{.}}}{{/notes}}
{{/summary}}
{{#unescapedNotes}}
{{{.}}}

{{/unescapedNotes}}
### Example

{{#hasAuthMethods}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,6 @@ Method | HTTP request | Description
# **foo_get**
> FooGetDefaultResponse foo_get()



### Example


Expand Down
30 changes: 6 additions & 24 deletions samples/openapi3/client/petstore/python-aiohttp/docs/FakeApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -370,8 +370,6 @@ void (empty response body)
# **fake_outer_boolean_serialize**
> bool fake_outer_boolean_serialize(body=body)



Test serialization of outer boolean types

### Example
Expand Down Expand Up @@ -436,8 +434,6 @@ No authorization required
# **fake_outer_composite_serialize**
> OuterComposite fake_outer_composite_serialize(outer_composite=outer_composite)



Test serialization of object with outer number type

### Example
Expand Down Expand Up @@ -503,8 +499,6 @@ No authorization required
# **fake_outer_number_serialize**
> float fake_outer_number_serialize(body=body)



Test serialization of outer number types

### Example
Expand Down Expand Up @@ -569,8 +563,6 @@ No authorization required
# **fake_outer_string_serialize**
> str fake_outer_string_serialize(body=body)



Test serialization of outer string types

### Example
Expand Down Expand Up @@ -635,8 +627,6 @@ No authorization required
# **fake_property_enum_integer_serialize**
> OuterObjectWithEnumProperty fake_property_enum_integer_serialize(outer_object_with_enum_property, param=param)



Test serialization of enum (int) properties with examples

### Example
Expand Down Expand Up @@ -1445,8 +1435,6 @@ No authorization required
# **test_body_with_binary**
> test_body_with_binary(body)



For this test, the body has to be a binary file.

### Example
Expand Down Expand Up @@ -1509,8 +1497,6 @@ No authorization required
# **test_body_with_file_schema**
> test_body_with_file_schema(file_schema_test_class)



For this test, the body for this request must reference a schema named `File`.

### Example
Expand Down Expand Up @@ -1574,8 +1560,6 @@ No authorization required
# **test_body_with_query_params**
> test_body_with_query_params(query, user)



### Example


Expand Down Expand Up @@ -1641,7 +1625,7 @@ No authorization required

To test \"client\" model

To test \"client\" model
To test "client" model

### Example

Expand Down Expand Up @@ -1707,8 +1691,6 @@ No authorization required
# **test_date_time_query_parameter**
> test_date_time_query_parameter(date_time_query, str_query)



### Example


Expand Down Expand Up @@ -1835,7 +1817,11 @@ No authorization required

Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트

Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트
Fake endpoint for testing various parameters
假端點
偽のエンドポイント
가짜 엔드 포인트


### Example

Expand Down Expand Up @@ -2282,8 +2268,6 @@ No authorization required
# **test_object_for_multipart_requests**
> test_object_for_multipart_requests(marker)



### Example


Expand Down Expand Up @@ -2345,8 +2329,6 @@ No authorization required
# **test_query_parameter_collection_format**
> test_query_parameter_collection_format(pipe, ioutil, http, url, context, allow_empty, language=language)



To test the collection format in query parameters

### Example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ Method | HTTP request | Description





### Example

```python
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,8 @@ Method | HTTP request | Description

test any type request body



### Example

```python
Expand Down Expand Up @@ -110,6 +112,8 @@ No authorization required

test enum reference query parameter



### Example

```python
Expand Down Expand Up @@ -173,6 +177,8 @@ No authorization required

Health check endpoint



### Example

```python
Expand Down Expand Up @@ -234,6 +240,8 @@ No authorization required

test http signature authentication



### Example

```python
Expand Down Expand Up @@ -698,6 +706,8 @@ No authorization required

test ref to enum string



### Example

```python
Expand Down Expand Up @@ -759,6 +769,8 @@ No authorization required

test returning boolean



### Example

```python
Expand Down Expand Up @@ -819,6 +831,8 @@ No authorization required

test byte like json



### Example

```python
Expand Down Expand Up @@ -879,6 +893,8 @@ No authorization required

test returning enum



### Example

```python
Expand Down Expand Up @@ -939,6 +955,8 @@ No authorization required

test enum like json



### Example

```python
Expand Down Expand Up @@ -999,6 +1017,8 @@ No authorization required

test returning float



### Example

```python
Expand Down Expand Up @@ -1059,6 +1079,8 @@ No authorization required

test returning int



### Example

```python
Expand Down Expand Up @@ -1119,6 +1141,8 @@ No authorization required

test returning list of objects



### Example

```python
Expand Down Expand Up @@ -1180,6 +1204,8 @@ No authorization required

test str like json



### Example

```python
Expand Down Expand Up @@ -1240,6 +1266,8 @@ No authorization required

test returning string



### Example

```python
Expand Down Expand Up @@ -1300,6 +1328,8 @@ No authorization required

test uuid example



### Example

```python
Expand Down Expand Up @@ -1553,6 +1583,8 @@ No authorization required





### Example

```python
Expand Down Expand Up @@ -1617,7 +1649,7 @@ No authorization required

To test \"client\" model

To test \"client\" model
To test "client" model

### Example

Expand Down Expand Up @@ -1684,6 +1716,8 @@ No authorization required





### Example

```python
Expand Down Expand Up @@ -1808,7 +1842,11 @@ No authorization required

Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트

Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트
Fake endpoint for testing various parameters
假端點
偽のエンドポイント
가짜 엔드 포인트


### Example

Expand Down Expand Up @@ -1912,6 +1950,8 @@ void (empty response body)

test error responses with model



### Example

```python
Expand Down Expand Up @@ -2251,6 +2291,8 @@ No authorization required





### Example

```python
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ Method | HTTP request | Description

test date time



### Example

```python
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ Method | HTTP request | Description





### Example

```python
Expand Down
Loading
Loading