Skip to content

[Python] List enum members in docs #18804

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.

Sign up for GitHub

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

Merged
wing328 merged 4 commits into from
Jun 1, 2024
Merged

[Python] List enum members in docs #18804

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ad98887
List enum values in docs
Mythir May 31, 2024
8a49804
Remove newline
Mythir May 31, 2024
48fb28c
Remove another newline
Mythir May 31, 2024
1f752ac
Generate samples
Mythir May 31, 2024
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
8 changes: 7 additions & 1 deletion modules/openapi-generator/src/main/resources/python-fastapi/model_doc.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@
{{#description}}{{&description}}
{{/description}}

{{^isEnum}}
## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
{{#vars}}**{{name}}** | {{#isPrimitiveType}}**{{dataType}}**{{/isPrimitiveType}}{{^isPrimitiveType}}[**{{dataType}}**]({{complexType}}.md){{/isPrimitiveType}} | {{description}} | {{^required}}[optional] {{/required}}{{#isReadOnly}}[readonly] {{/isReadOnly}}{{#defaultValue}}[default to {{{.}}}]{{/defaultValue}}
{{/vars}}

{{^isEnum}}
## Example

```python
Expand All @@ -29,6 +29,12 @@ print {{classname}}.to_json()
{{#lambda.snakecase}}{{classname}}{{/lambda.snakecase}}_from_dict = {{classname}}.from_dict({{#lambda.snakecase}}{{classname}}{{/lambda.snakecase}}_dict)
```
{{/isEnum}}
{{#isEnum}}
## Enum
{{#allowableValues}}{{#enumVars}}
* `{{name}}` (value: `{{{value}}}`)
{{/enumVars}}{{/allowableValues}}
{{/isEnum}}
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

{{/model}}{{/models}}
8 changes: 7 additions & 1 deletion modules/openapi-generator/src/main/resources/python-pydantic-v1/model_doc.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@
{{#description}}{{&description}}
{{/description}}

{{^isEnum}}
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
{{#vars}}**{{name}}** | {{#isPrimitiveType}}**{{dataType}}**{{/isPrimitiveType}}{{^isPrimitiveType}}[**{{dataType}}**]({{complexType}}.md){{/isPrimitiveType}} | {{description}} | {{^required}}[optional] {{/required}}{{#isReadOnly}}[readonly] {{/isReadOnly}}{{#defaultValue}}[default to {{{.}}}]{{/defaultValue}}
{{/vars}}

{{^isEnum}}
## Example

```python
Expand All @@ -28,6 +28,12 @@ print {{classname}}.to_json()
{{#lambda.snakecase}}{{classname}}{{/lambda.snakecase}}_from_dict = {{classname}}.from_dict({{#lambda.snakecase}}{{classname}}{{/lambda.snakecase}}_dict)
```
{{/isEnum}}
{{#isEnum}}
## Enum
{{#allowableValues}}{{#enumVars}}
* `{{name}}` (value: `{{{value}}}`)
{{/enumVars}}{{/allowableValues}}
{{/isEnum}}
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

{{/model}}{{/models}}
8 changes: 7 additions & 1 deletion modules/openapi-generator/src/main/resources/python/model_doc.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@
{{#description}}{{&description}}
{{/description}}

{{^isEnum}}
## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
{{#vars}}**{{name}}** | {{#isPrimitiveType}}**{{dataType}}**{{/isPrimitiveType}}{{^isPrimitiveType}}[**{{dataType}}**]({{complexType}}.md){{/isPrimitiveType}} | {{description}} | {{^required}}[optional] {{/required}}{{#isReadOnly}}[readonly] {{/isReadOnly}}{{#defaultValue}}[default to {{{.}}}]{{/defaultValue}}
{{/vars}}

{{^isEnum}}
## Example

```python
Expand All @@ -29,6 +29,12 @@ print({{classname}}.to_json())
{{#lambda.snakecase}}{{classname}}{{/lambda.snakecase}}_from_dict = {{classname}}.from_dict({{#lambda.snakecase}}{{classname}}{{/lambda.snakecase}}_dict)
```
{{/isEnum}}
{{#isEnum}}
## Enum
{{#allowableValues}}{{#enumVars}}
* `{{name}}` (value: `{{{value}}}`)
{{/enumVars}}{{/allowableValues}}
{{/isEnum}}
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

{{/model}}{{/models}}
9 changes: 6 additions & 3 deletions .../echo_api/python-disallowAdditionalPropertiesIfNotPresent/docs/StringEnumRef.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
# StringEnumRef


## Properties
## Enum

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
* `SUCCESS` (value: `'success'`)

* `FAILURE` (value: `'failure'`)

* `UNCLASSIFIED` (value: `'unclassified'`)

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
10 changes: 7 additions & 3 deletions samples/client/echo_api/python-pydantic-v1/docs/StringEnumRef.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
# StringEnumRef


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
## Enum

* `SUCCESS` (value: `'success'`)

* `FAILURE` (value: `'failure'`)

* `UNCLASSIFIED` (value: `'unclassified'`)

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
9 changes: 6 additions & 3 deletions samples/client/echo_api/python/docs/StringEnumRef.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
# StringEnumRef


## Properties
## Enum

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
* `SUCCESS` (value: `'success'`)

* `FAILURE` (value: `'failure'`)

* `UNCLASSIFIED` (value: `'unclassified'`)

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
9 changes: 6 additions & 3 deletions samples/openapi3/client/petstore/python-aiohttp/docs/EnumClass.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
# EnumClass


## Properties
## Enum

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
* `ABC` (value: `'_abc'`)

* `MINUS_EFG` (value: `'-efg'`)

* `LEFT_PARENTHESIS_XYZ_RIGHT_PARENTHESIS` (value: `'(xyz)'`)

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
7 changes: 4 additions & 3 deletions samples/openapi3/client/petstore/python-aiohttp/docs/EnumString1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
# EnumString1


## Properties
## Enum

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
* `A` (value: `'a'`)

* `B` (value: `'b'`)

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
7 changes: 4 additions & 3 deletions samples/openapi3/client/petstore/python-aiohttp/docs/EnumString2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
# EnumString2


## Properties
## Enum

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
* `C` (value: `'c'`)

* `D` (value: `'d'`)

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
9 changes: 6 additions & 3 deletions samples/openapi3/client/petstore/python-aiohttp/docs/OuterEnum.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
# OuterEnum


## Properties
## Enum

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
* `PLACED` (value: `'placed'`)

* `APPROVED` (value: `'approved'`)

* `DELIVERED` (value: `'delivered'`)

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
9 changes: 6 additions & 3 deletions samples/openapi3/client/petstore/python-aiohttp/docs/OuterEnumDefaultValue.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
# OuterEnumDefaultValue


## Properties
## Enum

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
* `PLACED` (value: `'placed'`)

* `APPROVED` (value: `'approved'`)

* `DELIVERED` (value: `'delivered'`)

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
9 changes: 6 additions & 3 deletions samples/openapi3/client/petstore/python-aiohttp/docs/OuterEnumInteger.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
# OuterEnumInteger


## Properties
## Enum

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
* `NUMBER_0` (value: `0`)

* `NUMBER_1` (value: `1`)

* `NUMBER_2` (value: `2`)

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
11 changes: 8 additions & 3 deletions ...es/openapi3/client/petstore/python-aiohttp/docs/OuterEnumIntegerDefaultValue.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,15 @@
# OuterEnumIntegerDefaultValue


## Properties
## Enum

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
* `NUMBER_MINUS_1` (value: `-1`)

* `NUMBER_0` (value: `0`)

* `NUMBER_1` (value: `1`)

* `NUMBER_2` (value: `2`)

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
7 changes: 4 additions & 3 deletions samples/openapi3/client/petstore/python-aiohttp/docs/SingleRefType.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
# SingleRefType


## Properties
## Enum

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
* `ADMIN` (value: `'admin'`)

* `USER` (value: `'user'`)

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
23 changes: 20 additions & 3 deletions samples/openapi3/client/petstore/python-aiohttp/docs/SpecialCharacterEnum.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,27 @@
# SpecialCharacterEnum


## Properties
## Enum

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
* `ENUM_456` (value: `'456'`)

* `ENUM_123ABC` (value: `'123abc'`)

* `UNDERSCORE` (value: `'_'`)

* `SPACE` (value: `' '`)

* `AMPERSAND` (value: `'&'`)

* `DOLLAR` (value: `'$'`)

* `GREATER_THAN_EQUAL` (value: `'>='`)

* `THIS_IS_EXCLAMATION` (value: `'this_is_!'`)

* `IMPORT` (value: `'import'`)

* `HELLO_WORLD` (value: `' hello world '`)

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
10 changes: 7 additions & 3 deletions samples/openapi3/client/petstore/python-pydantic-v1-aiohttp/docs/EnumClass.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
# EnumClass


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
## Enum

* `ABC` (value: `'_abc'`)

* `MINUS_EFG` (value: `'-efg'`)

* `LEFT_PARENTHESIS_XYZ_RIGHT_PARENTHESIS` (value: `'(xyz)'`)

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
8 changes: 5 additions & 3 deletions samples/openapi3/client/petstore/python-pydantic-v1-aiohttp/docs/EnumString1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
# EnumString1


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
## Enum

* `A` (value: `'a'`)

* `B` (value: `'b'`)

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
8 changes: 5 additions & 3 deletions samples/openapi3/client/petstore/python-pydantic-v1-aiohttp/docs/EnumString2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
# EnumString2


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
## Enum

* `C` (value: `'c'`)

* `D` (value: `'d'`)

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
10 changes: 7 additions & 3 deletions samples/openapi3/client/petstore/python-pydantic-v1-aiohttp/docs/OuterEnum.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
# OuterEnum


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
## Enum

* `PLACED` (value: `'placed'`)

* `APPROVED` (value: `'approved'`)

* `DELIVERED` (value: `'delivered'`)

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
10 changes: 7 additions & 3 deletions ...enapi3/client/petstore/python-pydantic-v1-aiohttp/docs/OuterEnumDefaultValue.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
# OuterEnumDefaultValue


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
## Enum

* `PLACED` (value: `'placed'`)

* `APPROVED` (value: `'approved'`)

* `DELIVERED` (value: `'delivered'`)

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
10 changes: 7 additions & 3 deletions ...es/openapi3/client/petstore/python-pydantic-v1-aiohttp/docs/OuterEnumInteger.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
# OuterEnumInteger


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
## Enum

* `NUMBER_0` (value: `0`)

* `NUMBER_1` (value: `1`)

* `NUMBER_2` (value: `2`)

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
Loading