Fix example formatting

cvat-sdk/cvat_sdk/configuration.py

@@ -34,87 +34,88 @@
 
 
 class Configuration(object):
-    """NOTE: This class is auto generated by OpenAPI Generator
-
-        Ref: https://openapi-generator.tech
-        Do not edit the class manually.
-
-        :param host: Base url
-        :param api_key: Dict to store API key(s).
-          Each entry in the dict specifies an API key.
-          The dict key is the name of the security scheme in the OAS specification.
-          The dict value is the API key secret.
-        :param api_key_prefix: Dict to store API prefix (e.g. Bearer)
-          The dict key is the name of the security scheme in the OAS specification.
-          The dict value is an API key prefix when generating the auth data.
-        :param username: Username for HTTP basic authentication
-        :param password: Password for HTTP basic authentication
-        :param discard_unknown_keys: Boolean value indicating whether to discard
-          unknown properties. A server may send a response that includes additional
-          properties that are not known by the client in the following scenarios:
-          1. The OpenAPI document is incomplete, i.e. it does not match the server
-             implementation.
-          2. The client was generated using an older version of the OpenAPI document
-             and the server has been upgraded since then.
-          If a schema in the OpenAPI document defines the additionalProperties attribute,
-          then all undeclared properties received by the server are injected into the
-          additional properties map. In that case, there are undeclared properties, and
-          nothing to discard.
-        :param disabled_client_side_validations (string): Comma-separated list of
-          JSON schema validation keywords to disable JSON schema structural validation
-          rules. The following keywords may be specified: multipleOf, maximum,
-          exclusiveMaximum, minimum, exclusiveMinimum, maxLength, minLength, pattern,
-          maxItems, minItems.
-          By default, the validation is performed for data generated locally by the client
-          and data received from the server, independent of any validation performed by
-          the server side. If the input data does not satisfy the JSON schema validation
-          rules specified in the OpenAPI document, an exception is raised.
-          If disabled_client_side_validations is set, structural validation is
-          disabled. This can be useful to troubleshoot data validation problem, such as
-          when the OpenAPI document validation rules do not match the actual API data
-          received by the server.
-        :param server_index: Index to servers configuration.
-        :param server_variables: Mapping with string values to replace variables in
-          templated server configuration. The validation of enums is performed for
-          variables with defined enum values before.
-        :param server_operation_index: Mapping from operation ID to an index to server
-          configuration.
-        :param server_operation_variables: Mapping from operation ID to a mapping with
-          string values to replace variables in templated server configuration.
-          The validation of enums is performed for variables with defined enum values before.
-        :param ssl_ca_cert: str - the path to a file of concatenated CA certificates
-          in PEM format
-
-        :Example:
-
-        API Key Authentication Example.
-        Given the following security scheme in the OpenAPI specification:
-          components:
-            securitySchemes:
-              cookieAuth:         # name for the security scheme
-                type: apiKey
-                in: cookie
-                name: JSESSIONID  # cookie name
-
-        You can programmatically set the cookie:
+    """
+    NOTE: This class is auto generated by OpenAPI Generator
+
+    Ref: https://openapi-generator.tech
+    Do not edit the class manually.
+
+    :param host: Base url
+    :param api_key: Dict to store API key(s).
+      Each entry in the dict specifies an API key.
+      The dict key is the name of the security scheme in the OAS specification.
+      The dict value is the API key secret.
+    :param api_key_prefix: Dict to store API prefix (e.g. Bearer)
+      The dict key is the name of the security scheme in the OAS specification.
+      The dict value is an API key prefix when generating the auth data.
+    :param username: Username for HTTP basic authentication
+    :param password: Password for HTTP basic authentication
+    :param discard_unknown_keys: Boolean value indicating whether to discard
+      unknown properties. A server may send a response that includes additional
+      properties that are not known by the client in the following scenarios:
+      1. The OpenAPI document is incomplete, i.e. it does not match the server
+         implementation.
+      2. The client was generated using an older version of the OpenAPI document
+         and the server has been upgraded since then.
+      If a schema in the OpenAPI document defines the additionalProperties attribute,
+      then all undeclared properties received by the server are injected into the
+      additional properties map. In that case, there are undeclared properties, and
+      nothing to discard.
+    :param disabled_client_side_validations (string): Comma-separated list of
+      JSON schema validation keywords to disable JSON schema structural validation
+      rules. The following keywords may be specified: multipleOf, maximum,
+      exclusiveMaximum, minimum, exclusiveMinimum, maxLength, minLength, pattern,
+      maxItems, minItems.
+      By default, the validation is performed for data generated locally by the client
+      and data received from the server, independent of any validation performed by
+      the server side. If the input data does not satisfy the JSON schema validation
+      rules specified in the OpenAPI document, an exception is raised.
+      If disabled_client_side_validations is set, structural validation is
+      disabled. This can be useful to troubleshoot data validation problem, such as
+      when the OpenAPI document validation rules do not match the actual API data
+      received by the server.
+    :param server_index: Index to servers configuration.
+    :param server_variables: Mapping with string values to replace variables in
+      templated server configuration. The validation of enums is performed for
+      variables with defined enum values before.
+    :param server_operation_index: Mapping from operation ID to an index to server
+      configuration.
+    :param server_operation_variables: Mapping from operation ID to a mapping with
+      string values to replace variables in templated server configuration.
+      The validation of enums is performed for variables with defined enum values before.
+    :param ssl_ca_cert: str - the path to a file of concatenated CA certificates
+      in PEM format
+
+    :Example:
+
+    API Key Authentication Example.
+    Given the following security scheme in the OpenAPI specification:
+      components:
+        securitySchemes:
+          cookieAuth:         # name for the security scheme
+            type: apiKey
+            in: cookie
+            name: JSESSIONID  # cookie name
+
+    You can programmatically set the cookie:
 
     conf = cvat_sdk.Configuration(
         api_key={'cookieAuth': 'abc123'}
         api_key_prefix={'cookieAuth': 'JSESSIONID'}
     )
 
-        The following cookie will be added to the HTTP request:
-           Cookie: JSESSIONID abc123
+    The following cookie will be added to the HTTP request:
+       Cookie: JSESSIONID abc123
 
-        HTTP Basic Authentication Example.
-        Given the following security scheme in the OpenAPI specification:
-          components:
-            securitySchemes:
-              http_basic_auth:
-                type: http
-                scheme: basic
+    HTTP Basic Authentication Example.
+    Given the following security scheme in the OpenAPI specification:
+      components:
+        securitySchemes:
+          http_basic_auth:
+            type: http
+            scheme: basic
 
-        Configure API client with HTTP basic authentication:
+    Configure API client with HTTP basic authentication:
 
     conf = cvat_sdk.Configuration(
         username='the-user',

cvat-sdk/gen/templates/openapi-generator/configuration.mustache

@@ -19,7 +19,8 @@ JSON_SCHEMA_VALIDATION_KEYWORDS = {
 }
 
 class Configuration(object):
-    """NOTE: This class is auto generated by OpenAPI Generator
+    """
+    NOTE: This class is auto generated by OpenAPI Generator
 
     Ref: https://openapi-generator.tech
     Do not edit the class manually.
@@ -89,10 +90,10 @@ class Configuration(object):
 
     You can programmatically set the cookie:
 
-conf = {{{packageName}}}.Configuration(
-    api_key={'cookieAuth': 'abc123'}
-    api_key_prefix={'cookieAuth': 'JSESSIONID'}
-)
+    conf = {{{packageName}}}.Configuration(
+        api_key={'cookieAuth': 'abc123'}
+        api_key_prefix={'cookieAuth': 'JSESSIONID'}
+    )
 
     The following cookie will be added to the HTTP request:
        Cookie: JSESSIONID abc123
@@ -109,10 +110,10 @@ conf = {{{packageName}}}.Configuration(
 
     Configure API client with HTTP basic authentication:
 
-conf = {{{packageName}}}.Configuration(
-    username='the-user',
-    password='the-password',
-)
+    conf = {{{packageName}}}.Configuration(
+        username='the-user',
+        password='the-password',
+    )
 
 {{/hasHttpBasicMethods}}
 {{#hasHttpSignatureMethods}}
@@ -137,23 +138,23 @@ conf = {{{packageName}}}.Configuration(
     load balancers may add/modify/remove headers. Include the HTTP headers that you know
     are not going to be modified in transit.
 
-conf = {{{packageName}}}.Configuration(
-    signing_info = {{{packageName}}}.signing.HttpSigningConfiguration(
-        key_id =                 'my-key-id',
-        private_key_path =       'rsa.pem',
-        signing_scheme =         {{{packageName}}}.signing.SCHEME_HS2019,
-        signing_algorithm =      {{{packageName}}}.signing.ALGORITHM_RSASSA_PSS,
-        signed_headers =         [{{{packageName}}}.signing.HEADER_REQUEST_TARGET,
-                                    {{{packageName}}}.signing.HEADER_CREATED,
-                                    {{{packageName}}}.signing.HEADER_EXPIRES,
-                                    {{{packageName}}}.signing.HEADER_HOST,
-                                    {{{packageName}}}.signing.HEADER_DATE,
-                                    {{{packageName}}}.signing.HEADER_DIGEST,
-                                    'Content-Type',
-                                    'User-Agent'
-                                    ],
-        signature_max_validity = datetime.timedelta(minutes=5)
-    )
+    conf = {{{packageName}}}.Configuration(
+        signing_info = {{{packageName}}}.signing.HttpSigningConfiguration(
+            key_id =                 'my-key-id',
+            private_key_path =       'rsa.pem',
+            signing_scheme =         {{{packageName}}}.signing.SCHEME_HS2019,
+            signing_algorithm =      {{{packageName}}}.signing.ALGORITHM_RSASSA_PSS,
+            signed_headers =         [{{{packageName}}}.signing.HEADER_REQUEST_TARGET,
+                                        {{{packageName}}}.signing.HEADER_CREATED,
+                                        {{{packageName}}}.signing.HEADER_EXPIRES,
+                                        {{{packageName}}}.signing.HEADER_HOST,
+                                        {{{packageName}}}.signing.HEADER_DATE,
+                                        {{{packageName}}}.signing.HEADER_DIGEST,
+                                        'Content-Type',
+                                        'User-Agent'
+                                        ],
+            signature_max_validity = datetime.timedelta(minutes=5)
+        )
 )
 {{/hasHttpSignatureMethods}}
 {{/hasAuthMethods}}