Merge branch 'master' into cleanup-template-management

* master: update java jersey2 samples [Java] Fix mustache tag in pom template for HTTP signature (OpenAPITools#6404) [Python-experimental] Rename from_server variable to json_variable_naming (OpenAPITools#6390) Add a link to medium blog post (OpenAPITools#6403) Clean up debug in test (OpenAPITools#6398) readding bin/swift5-petstore-readonlyProperties.json remove ./bin/swift5-petstore-readonlyProperties.json
jimschubert · May 23, 2020 · ccbcf6f · ccbcf6f
2 parents edaa592 + f200122
commit ccbcf6f
Show file tree

Hide file tree

Showing 160 changed files with 1,274 additions and 843 deletions.
diff --git a/README.md b/README.md
@@ -745,6 +745,7 @@ Here are some companies/projects (alphabetical order) using OpenAPI Generator in
 - 2020-03-15 - [Load Testing Your API with Swagger/OpenAPI and k6](https://k6.io/blog/load-testing-your-api-with-swagger-openapi-and-k6)
 - 2020-04-13 - [俺的【OAS】との向き合い方 (爆速でOpenAPIと友達になろう)](https://tech-blog.optim.co.jp/entry/2020/04/13/100000) in [OPTim Blog](https://tech-blog.optim.co.jp/)
 - 2020-04-22 - [Introduction to OpenAPI Generator](https://nordicapis.com/introduction-to-openapi-generator/) by [Kristopher Sandoval](https://nordicapis.com/author/sandovaleffect/) in [Nordic APIs](https://nordicapis.com/)
+- 2020-04-27 - [How we use Open API v3 specification to auto-generate API documentation, code-snippets and clients](https://medium.com/pdf-generator-api/how-we-use-open-api-v3-specification-to-auto-generate-api-documentation-code-snippets-and-clients-d127a3cea784) by [Tanel Tähepõld](https://medium.com/@tanel.tahepold)
 - 2020-05-09 - [OpenAPIでお手軽にモックAPIサーバーを動かす](https://qiita.com/kasa_le/items/97ca6a8dd4605695c25c) by [Sachie Kamba](https://qiita.com/kasa_le)
 - 2020-05-18 - [Spring Boot REST with OpenAPI 3](https://dev.to/alfonzjanfrithz/spring-boot-rest-with-openapi-3-59jm) by [Alfonz Jan Frithz](https://dev.to/alfonzjanfrithz)
 - 2020-05-19 - [Dead Simple APIs with Open API](https://www.youtube.com/watch?v=sIaXmR6xRAw) by [Chris Tankersley](https://github.com/dragonmantank) at [Nexmo](https://developer.nexmo.com/)

diff --git a/bin/swift5-petstore-readOnlyProperties.json → bin/swift5-petstore-readonlyProperties.json b/bin/swift5-petstore-readOnlyProperties.json → bin/swift5-petstore-readonlyProperties.json
diff --git a/modules/openapi-generator/src/main/resources/Java/libraries/jersey2/pom.mustache b/modules/openapi-generator/src/main/resources/Java/libraries/jersey2/pom.mustache
@@ -338,13 +338,13 @@
             <version>${commons-io-version}</version>
         </dependency>
         {{/supportJava6}}
-        {{#hasHttpBasicMethods}}
+        {{#hasHttpSignatureMethods}}
         <dependency>
             <groupId>org.tomitribe</groupId>
             <artifactId>tomitribe-http-signatures</artifactId>
             <version>${http-signature-version}</version>
         </dependency>
-        {{/hasHttpBasicMethods}}
+        {{/hasHttpSignatureMethods}}
         {{#hasOAuthMethods}}
         <dependency>
             <groupId>com.github.scribejava</groupId>
@@ -387,9 +387,9 @@
         <threetenbp-version>2.9.10</threetenbp-version>
         {{/threetenbp}}
         <junit-version>4.13</junit-version>
-        {{#hasHttpBasicMethods}}
+        {{#hasHttpSignatureMethods}}
         <http-signature-version>1.4</http-signature-version>
-        {{/hasHttpBasicMethods}}
+        {{/hasHttpSignatureMethods}}
         {{#hasOAuthMethods}}
         <scribejava-apis-version>6.9.0</scribejava-apis-version>
         {{/hasOAuthMethods}}

diff --git a/...c/main/resources/python/python-experimental/model_templates/method_init_composed.mustache b/...c/main/resources/python/python-experimental/model_templates/method_init_composed.mustache
@@ -1,7 +1,7 @@
     required_properties = set([
         '_data_store',
         '_check_type',
-        '_from_server',
+        '_spec_property_naming',
         '_path_to_item',
         '_configuration',
         '_visited_composed_classes',
@@ -15,7 +15,7 @@
         constant_args = {
             '_check_type': _check_type,
             '_path_to_item': _path_to_item,
-            '_from_server': _from_server,
+            '_spec_property_naming': _spec_property_naming,
             '_configuration': _configuration,
             '_visited_composed_classes': self._visited_composed_classes,
         }

diff --git a/...src/main/resources/python/python-experimental/model_templates/method_init_normal.mustache b/...src/main/resources/python/python-experimental/model_templates/method_init_normal.mustache
@@ -1,7 +1,7 @@
     required_properties = set([
         '_data_store',
         '_check_type',
-        '_from_server',
+        '_spec_property_naming',
         '_path_to_item',
         '_configuration',
         '_visited_composed_classes',

diff --git a/...src/main/resources/python/python-experimental/model_templates/method_init_shared.mustache b/...src/main/resources/python/python-experimental/model_templates/method_init_shared.mustache
@@ -1,5 +1,5 @@
     @convert_js_args_to_python_args
-    def __init__(self{{#requiredVars}}{{^defaultValue}}, {{name}}{{/defaultValue}}{{/requiredVars}}{{#requiredVars}}{{#defaultValue}}, {{name}}={{{defaultValue}}}{{/defaultValue}}{{/requiredVars}}, _check_type=True, _from_server=False, _path_to_item=(), _configuration=None, _visited_composed_classes=(), **kwargs):  # noqa: E501
+    def __init__(self{{#requiredVars}}{{^defaultValue}}, {{name}}{{/defaultValue}}{{/requiredVars}}{{#requiredVars}}{{#defaultValue}}, {{name}}={{{defaultValue}}}{{/defaultValue}}{{/requiredVars}}, _check_type=True, _spec_property_naming=False, _path_to_item=(), _configuration=None, _visited_composed_classes=(), **kwargs):  # noqa: E501
         """{{classname}} - a model defined in OpenAPI
 
 {{#requiredVars}}
@@ -26,8 +26,10 @@
             _path_to_item (tuple/list): This is a list of keys or values to
                                 drill down to the model in received_data
                                 when deserializing a response
-            _from_server (bool): True if the data is from the server
-                                False if the data is from the client (default)
+            _spec_property_naming (bool): True if the variable names in the input data
+                                are serialized names, as specified in the OpenAPI document.
+                                False if the variable names in the input data
+                                are pythonic names, e.g. snake case (default)
             _configuration (Configuration): the instance to use when
                                 deserializing a file_type parameter.
                                 If passed, type conversion is attempted
@@ -54,7 +56,7 @@
 
         self._data_store = {}
         self._check_type = _check_type
-        self._from_server = _from_server
+        self._spec_property_naming = _spec_property_naming
         self._path_to_item = _path_to_item
         self._configuration = _configuration
         self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
diff --git a/...c/main/resources/python/python-experimental/model_templates/method_set_attribute.mustache b/...c/main/resources/python/python-experimental/model_templates/method_set_attribute.mustache
@@ -33,7 +33,7 @@
 
         if self._check_type:
             value = validate_and_convert_types(
-                value, required_types_mixed, path_to_item, self._from_server,
+                value, required_types_mixed, path_to_item, self._spec_property_naming,
                 self._check_type, configuration=self._configuration)
         if (name,) in self.allowed_values:
             check_allowed_values(

diff --git a/modules/openapi-generator/src/main/resources/python/python-experimental/model_utils.mustache b/modules/openapi-generator/src/main/resources/python/python-experimental/model_utils.mustache
@@ -564,15 +564,17 @@ def order_response_types(required_types):
     return sorted_types
 
 
-def remove_uncoercible(required_types_classes, current_item, from_server,
+def remove_uncoercible(required_types_classes, current_item, spec_property_naming,
                        must_convert=True):
     """Only keeps the type conversions that are possible
 
     Args:
         required_types_classes (tuple): tuple of classes that are required
                           these should be ordered by COERCION_INDEX_BY_TYPE
-        from_server (bool): a boolean of whether the data is from the server
-                          if false, the data is from the client
+        spec_property_naming (bool): True if the variable names in the input
+            data are serialized names as specified in the OpenAPI document.
+            False if the variables names in the input data are python
+            variable names in PEP-8 snake case.
         current_item (any): the current item (input data) to be converted
 
     Keyword Args:
@@ -602,7 +604,7 @@ def remove_uncoercible(required_types_classes, current_item, from_server,
             continue
 
         class_pair = (current_type_simple, required_type_class_simplified)
-        if must_convert and class_pair in COERCIBLE_TYPE_PAIRS[from_server]:
+        if must_convert and class_pair in COERCIBLE_TYPE_PAIRS[spec_property_naming]:
             results_classes.append(required_type_class)
         elif class_pair in UPCONVERSION_TYPE_PAIRS:
             results_classes.append(required_type_class)
@@ -786,7 +788,7 @@ def get_discriminator_class(model_class,
 
 
 def deserialize_model(model_data, model_class, path_to_item, check_type,
-                      configuration, from_server):
+                      configuration, spec_property_naming):
     """Deserializes model_data to model instance.
 
     Args:
@@ -796,8 +798,10 @@ def deserialize_model(model_data, model_class, path_to_item, check_type,
         check_type (bool): whether to check the data tupe for the values in
             the model
         configuration (Configuration): the instance to use to convert files
-        from_server (bool): True if the data is from the server
-            False if the data is from the client
+        spec_property_naming (bool): True if the variable names in the input
+            data are serialized names as specified in the OpenAPI document.
+            False if the variables names in the input data are python
+            variable names in PEP-8 snake case.
 
     Returns:
         model instance
@@ -811,7 +815,7 @@ def deserialize_model(model_data, model_class, path_to_item, check_type,
     kw_args = dict(_check_type=check_type,
                    _path_to_item=path_to_item,
                    _configuration=configuration,
-                   _from_server=from_server)
+                   _spec_property_naming=spec_property_naming)
 
     if issubclass(model_class, ModelSimple):
         instance = model_class(value=model_data, **kw_args)
@@ -862,16 +866,18 @@ def deserialize_file(response_data, configuration, content_disposition=None):
 
 
 def attempt_convert_item(input_value, valid_classes, path_to_item,
-                         configuration, from_server, key_type=False,
+                         configuration, spec_property_naming, key_type=False,
                          must_convert=False, check_type=True):
     """
     Args:
         input_value (any): the data to convert
         valid_classes (any): the classes that are valid
         path_to_item (list): the path to the item to convert
         configuration (Configuration): the instance to use to convert files
-        from_server (bool): True if data is from the server, False is data is
-            from the client
+        spec_property_naming (bool): True if the variable names in the input
+            data are serialized names as specified in the OpenAPI document.
+            False if the variables names in the input data are python
+            variable names in PEP-8 snake case.
         key_type (bool): if True we need to convert a key type (not supported)
         must_convert (bool): if True we must convert
         check_type (bool): if True we check the type or the returned data in
@@ -887,7 +893,7 @@ def attempt_convert_item(input_value, valid_classes, path_to_item,
     """
     valid_classes_ordered = order_response_types(valid_classes)
     valid_classes_coercible = remove_uncoercible(
-        valid_classes_ordered, input_value, from_server)
+        valid_classes_ordered, input_value, spec_property_naming)
     if not valid_classes_coercible or key_type:
         # we do not handle keytype errors, json will take care
         # of this for us
@@ -899,7 +905,7 @@ def attempt_convert_item(input_value, valid_classes, path_to_item,
             if issubclass(valid_class, OpenApiModel):
                 return deserialize_model(input_value, valid_class,
                                          path_to_item, check_type,
-                                         configuration, from_server)
+                                         configuration, spec_property_naming)
             elif valid_class == file_type:
                 return deserialize_file(input_value, configuration)
             return deserialize_primitive(input_value, valid_class,
@@ -971,7 +977,7 @@ def is_valid_type(input_class_simple, valid_classes):
 
 
 def validate_and_convert_types(input_value, required_types_mixed, path_to_item,
-                               from_server, _check_type, configuration=None):
+                               spec_property_naming, _check_type, configuration=None):
     """Raises a TypeError is there is a problem, otherwise returns value
 
     Args:
@@ -982,8 +988,10 @@ def validate_and_convert_types(input_value, required_types_mixed, path_to_item,
         path_to_item: (list) the path to the data being validated
             this stores a list of keys or indices to get to the data being
             validated
-        from_server (bool): True if data is from the server
-            False if data is from the client
+        spec_property_naming (bool): True if the variable names in the input
+            data are serialized names as specified in the OpenAPI document.
+            False if the variables names in the input data are python
+            variable names in PEP-8 snake case.
         _check_type: (boolean) if true, type will be checked and conversion
             will be attempted.
         configuration: (Configuration): the configuration class to use
@@ -1011,7 +1019,7 @@ def validate_and_convert_types(input_value, required_types_mixed, path_to_item,
                 valid_classes,
                 path_to_item,
                 configuration,
-                from_server,
+                spec_property_naming,
                 key_type=False,
                 must_convert=True
             )
@@ -1024,14 +1032,14 @@ def validate_and_convert_types(input_value, required_types_mixed, path_to_item,
     if len(valid_classes) > 1 and configuration:
         # there are valid classes which are not the current class
         valid_classes_coercible = remove_uncoercible(
-            valid_classes, input_value, from_server, must_convert=False)
+            valid_classes, input_value, spec_property_naming, must_convert=False)
         if valid_classes_coercible:
             converted_instance = attempt_convert_item(
                 input_value,
                 valid_classes_coercible,
                 path_to_item,
                 configuration,
-                from_server,
+                spec_property_naming,
                 key_type=False,
                 must_convert=False
             )
@@ -1058,7 +1066,7 @@ def validate_and_convert_types(input_value, required_types_mixed, path_to_item,
                 inner_value,
                 inner_required_types,
                 inner_path,
-                from_server,
+                spec_property_naming,
                 _check_type,
                 configuration=configuration
             )
@@ -1076,7 +1084,7 @@ def validate_and_convert_types(input_value, required_types_mixed, path_to_item,
                 inner_val,
                 inner_required_types,
                 inner_path,
-                from_server,
+                spec_property_naming,
                 _check_type,
                 configuration=configuration
             )
@@ -1182,8 +1190,8 @@ def convert_js_args_to_python_args(fn):
     from functools import wraps
     @wraps(fn)
     def wrapped_init(self, *args, **kwargs):
-        from_server = kwargs.get('_from_server', False)
-        if from_server:
+        spec_property_naming = kwargs.get('_spec_property_naming', False)
+        if spec_property_naming:
             kwargs = change_keys_js_to_python(kwargs, self.__class__)
         return fn(self, *args, **kwargs)
     return wrapped_init

diff --git a/samples/client/petstore/cpp-qt5/.openapi-generator/VERSION b/samples/client/petstore/cpp-qt5/.openapi-generator/VERSION
@@ -1 +1 @@
-4.3.1-SNAPSHOT
+5.0.0-SNAPSHOT
diff --git a/samples/client/petstore/java/jersey2-java7/pom.xml b/samples/client/petstore/java/jersey2-java7/pom.xml
@@ -279,11 +279,6 @@
             <artifactId>migbase64</artifactId>
             <version>2.2</version>
         </dependency>
-        <dependency>
-            <groupId>org.tomitribe</groupId>
-            <artifactId>tomitribe-http-signatures</artifactId>
-            <version>${http-signature-version}</version>
-        </dependency>
         <dependency>
             <groupId>com.github.scribejava</groupId>
             <artifactId>scribejava-apis</artifactId>
@@ -306,7 +301,6 @@
         <jackson-databind-nullable-version>0.2.1</jackson-databind-nullable-version>
         <threetenbp-version>2.9.10</threetenbp-version>
         <junit-version>4.13</junit-version>
-        <http-signature-version>1.4</http-signature-version>
         <scribejava-apis-version>6.9.0</scribejava-apis-version>
     </properties>
 </project>
diff --git a/samples/client/petstore/java/jersey2-java8/pom.xml b/samples/client/petstore/java/jersey2-java8/pom.xml
@@ -273,11 +273,6 @@
             <artifactId>jackson-datatype-jsr310</artifactId>
             <version>${jackson-version}</version>
         </dependency>
-        <dependency>
-            <groupId>org.tomitribe</groupId>
-            <artifactId>tomitribe-http-signatures</artifactId>
-            <version>${http-signature-version}</version>
-        </dependency>
         <dependency>
             <groupId>com.github.scribejava</groupId>
             <artifactId>scribejava-apis</artifactId>
@@ -299,7 +294,6 @@
         <jackson-databind-version>2.10.4</jackson-databind-version>
         <jackson-databind-nullable-version>0.2.1</jackson-databind-nullable-version>
         <junit-version>4.13</junit-version>
-        <http-signature-version>1.4</http-signature-version>
         <scribejava-apis-version>6.9.0</scribejava-apis-version>
     </properties>
 </project>