[python-nextgen] Better docstring/documentation (#14880)

* better docstring/documentation in python nextgen client * update instruction in test files
2025-12-03 17:00:43 +00:00 · 2023-03-06 21:22:43 +08:00
parent 8ede021ec5
commit d497c3d087
187 changed files with 811 additions and 790 deletions
--- a/samples/client/echo_api/python-nextgen/openapi_client/init.py
+++ b/samples/client/echo_api/python-nextgen/openapi_client/init.py
@@ -9,7 +9,9 @@

    The version of the OpenAPI document: 0.1.0
    Contact: team@openapitools.org
-    Generated by: https://openapi-generator.tech
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
 """


--- a/samples/client/echo_api/python-nextgen/openapi_client/api/body_api.py
+++ b/samples/client/echo_api/python-nextgen/openapi_client/api/body_api.py
@@ -7,7 +7,9 @@

    The version of the OpenAPI document: 0.1.0
    Contact: team@openapitools.org
-    Generated by: https://openapi-generator.tech
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
 """


--- a/samples/client/echo_api/python-nextgen/openapi_client/api/form_api.py
+++ b/samples/client/echo_api/python-nextgen/openapi_client/api/form_api.py
@@ -7,7 +7,9 @@

    The version of the OpenAPI document: 0.1.0
    Contact: team@openapitools.org
-    Generated by: https://openapi-generator.tech
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
 """


--- a/samples/client/echo_api/python-nextgen/openapi_client/api/header_api.py
+++ b/samples/client/echo_api/python-nextgen/openapi_client/api/header_api.py
@@ -7,7 +7,9 @@

    The version of the OpenAPI document: 0.1.0
    Contact: team@openapitools.org
-    Generated by: https://openapi-generator.tech
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
 """


--- a/samples/client/echo_api/python-nextgen/openapi_client/api/path_api.py
+++ b/samples/client/echo_api/python-nextgen/openapi_client/api/path_api.py
@@ -7,7 +7,9 @@

    The version of the OpenAPI document: 0.1.0
    Contact: team@openapitools.org
-    Generated by: https://openapi-generator.tech
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
 """


--- a/samples/client/echo_api/python-nextgen/openapi_client/api/query_api.py
+++ b/samples/client/echo_api/python-nextgen/openapi_client/api/query_api.py
@@ -7,7 +7,9 @@

    The version of the OpenAPI document: 0.1.0
    Contact: team@openapitools.org
-    Generated by: https://openapi-generator.tech
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
 """


--- a/samples/client/echo_api/python-nextgen/openapi_client/api_client.py
+++ b/samples/client/echo_api/python-nextgen/openapi_client/api_client.py
@@ -6,7 +6,9 @@

    The version of the OpenAPI document: 0.1.0
    Contact: team@openapitools.org
-    Generated by: https://openapi-generator.tech
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
 """

 from __future__ import absolute_import
@@ -37,10 +39,6 @@ class ApiClient(object):
    the methods and models for each application are generated from the OpenAPI
    templates.

-    NOTE: This class is auto generated by OpenAPI Generator.
-    Ref: https://openapi-generator.tech
-    Do not edit the class manually.
-
    :param configuration: .Configuration object for this client
    :param header_name: a header to pass when making calls to the API.
    :param header_value: a header value to pass when making calls to
--- a/samples/client/echo_api/python-nextgen/openapi_client/configuration.py
+++ b/samples/client/echo_api/python-nextgen/openapi_client/configuration.py
@@ -7,7 +7,9 @@

    The version of the OpenAPI document: 0.1.0
    Contact: team@openapitools.org
-    Generated by: https://openapi-generator.tech
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
 """


@@ -22,7 +24,6 @@ import urllib3
 import http.client as httplib
 from openapi_client.exceptions import ApiValueError

-
 JSON_SCHEMA_VALIDATION_KEYWORDS = {
    'multipleOf', 'maximum', 'exclusiveMaximum',
    'minimum', 'exclusiveMinimum', 'maxLength',
@@ -30,10 +31,7 @@ JSON_SCHEMA_VALIDATION_KEYWORDS = {
 }

 class Configuration(object):
-    """NOTE: This class is auto generated by OpenAPI Generator
-
-    Ref: https://openapi-generator.tech
-    Do not edit the class manually.
+    """This class contains various settings of the API client.

    :param host: Base url.
    :param api_key: Dict to store API key(s).
--- a/samples/client/echo_api/python-nextgen/openapi_client/exceptions.py
+++ b/samples/client/echo_api/python-nextgen/openapi_client/exceptions.py
@@ -7,7 +7,9 @@

    The version of the OpenAPI document: 0.1.0
    Contact: team@openapitools.org
-    Generated by: https://openapi-generator.tech
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
 """


--- a/samples/client/echo_api/python-nextgen/openapi_client/models/init.py
+++ b/samples/client/echo_api/python-nextgen/openapi_client/models/init.py
@@ -8,7 +8,9 @@

    The version of the OpenAPI document: 0.1.0
    Contact: team@openapitools.org
-    Generated by: https://openapi-generator.tech
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
 """


--- a/samples/client/echo_api/python-nextgen/openapi_client/models/bird.py
+++ b/samples/client/echo_api/python-nextgen/openapi_client/models/bird.py
@@ -7,7 +7,9 @@

    The version of the OpenAPI document: 0.1.0
    Contact: team@openapitools.org
-    Generated by: https://openapi-generator.tech
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
 """


@@ -22,10 +24,8 @@ from typing import Optional
 from pydantic import BaseModel, StrictStr

 class Bird(BaseModel):
-    """NOTE: This class is auto generated by OpenAPI Generator.
-    Ref: https://openapi-generator.tech
-
-    Do not edit the class manually.
+    """
+    Bird
    """
    size: Optional[StrictStr] = None
    color: Optional[StrictStr] = None
--- a/samples/client/echo_api/python-nextgen/openapi_client/models/category.py
+++ b/samples/client/echo_api/python-nextgen/openapi_client/models/category.py
@@ -7,7 +7,9 @@

    The version of the OpenAPI document: 0.1.0
    Contact: team@openapitools.org
-    Generated by: https://openapi-generator.tech
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
 """


@@ -22,10 +24,8 @@ from typing import Optional
 from pydantic import BaseModel, StrictInt, StrictStr

 class Category(BaseModel):
-    """NOTE: This class is auto generated by OpenAPI Generator.
-    Ref: https://openapi-generator.tech
-
-    Do not edit the class manually.
+    """
+    Category
    """
    id: Optional[StrictInt] = None
    name: Optional[StrictStr] = None
--- a/samples/client/echo_api/python-nextgen/openapi_client/models/data_query.py
+++ b/samples/client/echo_api/python-nextgen/openapi_client/models/data_query.py
@@ -7,7 +7,9 @@

    The version of the OpenAPI document: 0.1.0
    Contact: team@openapitools.org
-    Generated by: https://openapi-generator.tech
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
 """


@@ -23,10 +25,8 @@ from pydantic import BaseModel, Field, StrictStr
 from openapi_client.models.query import Query

 class DataQuery(Query):
-    """NOTE: This class is auto generated by OpenAPI Generator.
-    Ref: https://openapi-generator.tech
-
-    Do not edit the class manually.
+    """
+    DataQuery
    """
    suffix: Optional[StrictStr] = Field(None, description="test suffix")
    text: Optional[StrictStr] = Field(None, description="Some text containing white spaces")
--- a/samples/client/echo_api/python-nextgen/openapi_client/models/data_query_all_of.py
+++ b/samples/client/echo_api/python-nextgen/openapi_client/models/data_query_all_of.py
@@ -7,7 +7,9 @@

    The version of the OpenAPI document: 0.1.0
    Contact: team@openapitools.org
-    Generated by: https://openapi-generator.tech
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
 """


@@ -22,10 +24,8 @@ from typing import Optional
 from pydantic import BaseModel, Field, StrictStr

 class DataQueryAllOf(BaseModel):
-    """NOTE: This class is auto generated by OpenAPI Generator.
-    Ref: https://openapi-generator.tech
-
-    Do not edit the class manually.
+    """
+    DataQueryAllOf
    """
    suffix: Optional[StrictStr] = Field(None, description="test suffix")
    text: Optional[StrictStr] = Field(None, description="Some text containing white spaces")
--- a/samples/client/echo_api/python-nextgen/openapi_client/models/default_value.py
+++ b/samples/client/echo_api/python-nextgen/openapi_client/models/default_value.py
@@ -7,7 +7,9 @@

    The version of the OpenAPI document: 0.1.0
    Contact: team@openapitools.org
-    Generated by: https://openapi-generator.tech
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
 """


@@ -23,10 +25,8 @@ from pydantic import BaseModel, StrictInt, StrictStr, conlist, validator
 from openapi_client.models.string_enum_ref import StringEnumRef

 class DefaultValue(BaseModel):
-    """NOTE: This class is auto generated by OpenAPI Generator.
-    Ref: https://openapi-generator.tech
-
-    Do not edit the class manually.
+    """
+    to test the default value of properties
    """
    array_string_enum_ref_default: Optional[conlist(StringEnumRef)] = None
    array_string_enum_default: Optional[conlist(StrictStr)] = None
--- a/samples/client/echo_api/python-nextgen/openapi_client/models/pet.py
+++ b/samples/client/echo_api/python-nextgen/openapi_client/models/pet.py
@@ -7,7 +7,9 @@

    The version of the OpenAPI document: 0.1.0
    Contact: team@openapitools.org
-    Generated by: https://openapi-generator.tech
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
 """


@@ -24,10 +26,8 @@ from openapi_client.models.category import Category
 from openapi_client.models.tag import Tag

 class Pet(BaseModel):
-    """NOTE: This class is auto generated by OpenAPI Generator.
-    Ref: https://openapi-generator.tech
-
-    Do not edit the class manually.
+    """
+    Pet
    """
    id: Optional[StrictInt] = None
    name: StrictStr = ...
--- a/samples/client/echo_api/python-nextgen/openapi_client/models/query.py
+++ b/samples/client/echo_api/python-nextgen/openapi_client/models/query.py
@@ -7,7 +7,9 @@

    The version of the OpenAPI document: 0.1.0
    Contact: team@openapitools.org
-    Generated by: https://openapi-generator.tech
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
 """


@@ -22,10 +24,8 @@ from typing import List, Optional
 from pydantic import BaseModel, Field, StrictInt, StrictStr, conlist, validator

 class Query(BaseModel):
-    """NOTE: This class is auto generated by OpenAPI Generator.
-    Ref: https://openapi-generator.tech
-
-    Do not edit the class manually.
+    """
+    Query
    """
    id: Optional[StrictInt] = Field(None, description="Query")
    outcomes: Optional[conlist(StrictStr)] = None
--- a/samples/client/echo_api/python-nextgen/openapi_client/models/string_enum_ref.py
+++ b/samples/client/echo_api/python-nextgen/openapi_client/models/string_enum_ref.py
@@ -7,7 +7,9 @@

    The version of the OpenAPI document: 0.1.0
    Contact: team@openapitools.org
-    Generated by: https://openapi-generator.tech
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
 """


@@ -21,16 +23,13 @@ from aenum import Enum, no_arg


 class StringEnumRef(str, Enum):
-    """NOTE: This class is auto generated by OpenAPI Generator.
-    Ref: https://openapi-generator.tech
-
-    Do not edit the class manually.
+    """
+    StringEnumRef
    """

    """
    allowed enum values
    """
-
    SUCCESS = 'success'
    FAILURE = 'failure'
    UNCLASSIFIED = 'unclassified'
--- a/samples/client/echo_api/python-nextgen/openapi_client/models/tag.py
+++ b/samples/client/echo_api/python-nextgen/openapi_client/models/tag.py
@@ -7,7 +7,9 @@

    The version of the OpenAPI document: 0.1.0
    Contact: team@openapitools.org
-    Generated by: https://openapi-generator.tech
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
 """


@@ -22,10 +24,8 @@ from typing import Optional
 from pydantic import BaseModel, StrictInt, StrictStr

 class Tag(BaseModel):
-    """NOTE: This class is auto generated by OpenAPI Generator.
-    Ref: https://openapi-generator.tech
-
-    Do not edit the class manually.
+    """
+    Tag
    """
    id: Optional[StrictInt] = None
    name: Optional[StrictStr] = None
--- a/samples/client/echo_api/python-nextgen/openapi_client/models/test_query_style_deep_object_explode_true_object_all_of_query_object_parameter.py
+++ b/samples/client/echo_api/python-nextgen/openapi_client/models/test_query_style_deep_object_explode_true_object_all_of_query_object_parameter.py
@@ -7,7 +7,9 @@

    The version of the OpenAPI document: 0.1.0
    Contact: team@openapitools.org
-    Generated by: https://openapi-generator.tech
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
 """


@@ -22,10 +24,8 @@ from typing import Optional
 from pydantic import BaseModel, StrictInt, StrictStr

 class TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter(BaseModel):
-    """NOTE: This class is auto generated by OpenAPI Generator.
-    Ref: https://openapi-generator.tech
-
-    Do not edit the class manually.
+    """
+    TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter
    """
    size: Optional[StrictStr] = None
    color: Optional[StrictStr] = None
--- a/samples/client/echo_api/python-nextgen/openapi_client/models/test_query_style_form_explode_true_array_string_query_object_parameter.py
+++ b/samples/client/echo_api/python-nextgen/openapi_client/models/test_query_style_form_explode_true_array_string_query_object_parameter.py
@@ -7,7 +7,9 @@

    The version of the OpenAPI document: 0.1.0
    Contact: team@openapitools.org
-    Generated by: https://openapi-generator.tech
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
 """


@@ -22,10 +24,8 @@ from typing import List, Optional
 from pydantic import BaseModel, StrictStr, conlist

 class TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter(BaseModel):
-    """NOTE: This class is auto generated by OpenAPI Generator.
-    Ref: https://openapi-generator.tech
-
-    Do not edit the class manually.
+    """
+    TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter
    """
    values: Optional[conlist(StrictStr)] = None
    __properties = ["values"]
--- a/samples/client/echo_api/python-nextgen/openapi_client/rest.py
+++ b/samples/client/echo_api/python-nextgen/openapi_client/rest.py
@@ -7,7 +7,9 @@

    The version of the OpenAPI document: 0.1.0
    Contact: team@openapitools.org
-    Generated by: https://openapi-generator.tech
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
 """