Merge pull request #148 from macisamuele/maci-fix-reserved-keywords-in-parameters

Author: cortinico

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
 - repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v3.3.0
+  rev: v3.4.0
   hooks:
   - id: check-merge-conflict
   - id: trailing-whitespace
@@ -12,7 +12,7 @@ repos:
     exclude: ^samples/[^/]+/src/main/java/swagger.json$
   - id: check-yaml
 - repo: https://github.com/macisamuele/language-formatters-pre-commit-hooks
-  rev: v1.6.0
+  rev: v2.0.0
   hooks:
   - id: pretty-format-java
     args: [--autofix]

gradle-plugin/plugin/src/main/resources/kotlin/retrofit2/api.mustache

@@ -11,7 +11,7 @@ interface {{classname}} {
     /**{{#summary}}{{{newline}}}     * {{{summary}}}{{/summary}}{{#notes}}{{{newline}}}     * {{{<br/>}}}{{{notes}}}{{/notes}}
      * The endpoint is owned by {{{vendorExtensions.x-team-owners}}}{{^vendorExtensions.x-team-owners}}{{service_name}} service owner{{/vendorExtensions.x-team-owners}}
 {{#allParams}}
-     * @param {{paramName}}{{#description}} {{description}}{{/description}} ({{#required}}required{{/required}}{{^required}}optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}{{/required}})
+     * @param {{{paramName}}}{{#description}} {{description}}{{/description}} ({{#required}}required{{/required}}{{^required}}optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}{{/required}})
 {{/allParams}}
 {{#externalDocs}}
      * {{description}}

gradle-plugin/plugin/src/main/resources/kotlin/retrofit2/bodyParams.mustache

@@ -1 +1 @@
-{{#isBodyParam}}@retrofit2.http.Body {{paramName}}: {{{dataType}}}{{/isBodyParam}}
+{{#isBodyParam}}@retrofit2.http.Body {{{paramName}}}: {{{dataType}}}{{/isBodyParam}}

gradle-plugin/plugin/src/main/resources/kotlin/retrofit2/formParams.mustache

@@ -1 +1 @@
-{{#isFormParam}}{{#notFile}}{{#isMultipart}}@retrofit2.http.Part{{/isMultipart}}{{^isMultipart}}@retrofit2.http.Field{{/isMultipart}}("{{baseName}}") {{paramName}}: {{{dataType}}}{{/notFile}}{{#isFile}}{{#isMultipart}}@retrofit2.http.Part{{/isMultipart}}{{^isMultipart}}@retrofit2.http.Field{{/isMultipart}}("{{baseName}}\"; filename=\"{{baseName}}") {{paramName}}: RequestBody{{^required}}?{{/required}}{{/isFile}}{{/isFormParam}}
+{{#isFormParam}}{{#notFile}}{{#isMultipart}}@retrofit2.http.Part{{/isMultipart}}{{^isMultipart}}@retrofit2.http.Field{{/isMultipart}}("{{baseName}}") {{{paramName}}}: {{{dataType}}}{{/notFile}}{{#isFile}}{{#isMultipart}}@retrofit2.http.Part{{/isMultipart}}{{^isMultipart}}@retrofit2.http.Field{{/isMultipart}}("{{baseName}}\"; filename=\"{{baseName}}") {{{paramName}}}: RequestBody{{^required}}?{{/required}}{{/isFile}}{{/isFormParam}}

gradle-plugin/plugin/src/main/resources/kotlin/retrofit2/headerParams.mustache

@@ -1 +1 @@
-{{#isHeaderParam}}@retrofit2.http.Header("{{baseName}}") {{paramName}}: {{{dataType}}}{{/isHeaderParam}}
+{{#isHeaderParam}}@retrofit2.http.Header("{{baseName}}") {{{paramName}}}: {{{dataType}}}{{/isHeaderParam}}

gradle-plugin/plugin/src/main/resources/kotlin/retrofit2/pathParams.mustache

@@ -1 +1 @@
-{{#isPathParam}}@retrofit2.http.Path("{{baseName}}") {{paramName}}: {{{dataType}}}{{/isPathParam}}
+{{#isPathParam}}@retrofit2.http.Path("{{baseName}}") {{{paramName}}}: {{{dataType}}}{{/isPathParam}}

gradle-plugin/plugin/src/main/resources/kotlin/retrofit2/queryParams.mustache

@@ -1 +1 @@
-{{#isQueryParam}}@retrofit2.http.Query("{{baseName}}") {{#collectionFormat}}{{^isCollectionFormatMulti}}@{{{collectionFormat.toUpperCase}}} {{/isCollectionFormatMulti}}{{/collectionFormat}}{{paramName}}: {{{dataType}}}{{^required}} = null{{/required}}{{/isQueryParam}}
+{{#isQueryParam}}@retrofit2.http.Query("{{baseName}}") {{#collectionFormat}}{{^isCollectionFormatMulti}}@{{{collectionFormat.toUpperCase}}} {{/isCollectionFormatMulti}}{{/collectionFormat}}{{{paramName}}}: {{{dataType}}}{{^required}} = null{{/required}}{{/isQueryParam}}

samples/junit-tests/junit_tests_specs.json

@@ -123,6 +123,9 @@
                 "class": {
                     "type": "string"
                 },
+                "data": {
+                    "type": "string"
+                },
                 "for": {
                     "type": "string"
                 },
@@ -727,6 +730,43 @@
         "/reserved_keywords": {
             "get": {
                 "operationId": "get_reserved_keywords",
+                "parameters": [
+                    {
+                        "in": "query",
+                        "name": "class",
+                        "type": "string"
+                    },
+                    {
+                        "in": "query",
+                        "name": "data",
+                        "type": "string"
+                    },
+                    {
+                        "in": "query",
+                        "name": "for",
+                        "type": "string"
+                    },
+                    {
+                        "in": "query",
+                        "name": "operator",
+                        "type": "string"
+                    },
+                    {
+                        "in": "query",
+                        "name": "val",
+                        "type": "string"
+                    },
+                    {
+                        "in": "query",
+                        "name": "var",
+                        "type": "string"
+                    },
+                    {
+                        "in": "query",
+                        "name": "when",
+                        "type": "string"
+                    }
+                ],
                 "responses": {
                     "200": {
                         "description": "",

samples/junit-tests/src/main/java/com/yelp/codegen/generatecodesamples/apis/ResourceApi.kt

@@ -95,12 +95,27 @@ interface ResourceApi {
     fun getRequiredTypeEndpoint(): Single<RequiredTypeResponses>
     /**
      * The endpoint is owned by junittests service owner
+     * @param `class` (optional)
+     * @param `data` (optional)
+     * @param `for` (optional)
+     * @param `operator` (optional)
+     * @param `val` (optional)
+     * @param `var` (optional)
+     * @param `when` (optional)
      */
     @Headers(
         "X-Operation-ID: get_reserved_keywords"
     )
     @GET("/reserved_keywords")
-    fun getReservedKeywords(): Single<ReservedKeywords>
+    fun getReservedKeywords(
+        @retrofit2.http.Query("class") `class`: String? = null,
+        @retrofit2.http.Query("data") `data`: String? = null,
+        @retrofit2.http.Query("for") `for`: String? = null,
+        @retrofit2.http.Query("operator") `operator`: String? = null,
+        @retrofit2.http.Query("val") `val`: String? = null,
+        @retrofit2.http.Query("var") `var`: String? = null,
+        @retrofit2.http.Query("when") `when`: String? = null
+    ): Single<ReservedKeywords>
     /**
      * Test symbols in parameter name
      * Make sure that symbols in parameter name are treated properly

samples/junit-tests/src/main/java/com/yelp/codegen/generatecodesamples/models/ReservedKeywords.kt

@@ -11,6 +11,7 @@ import com.squareup.moshi.JsonClass
 
 /**
  * @property `class`
+ * @property `data`
  * @property `for`
  * @property `operator`
  * @property `val`
@@ -20,6 +21,7 @@ import com.squareup.moshi.JsonClass
 @JsonClass(generateAdapter = true)
 data class ReservedKeywords(
     @Json(name = "class") @field:Json(name = "class") var `class`: String? = null,
+    @Json(name = "data") @field:Json(name = "data") var `data`: String? = null,
     @Json(name = "for") @field:Json(name = "for") var `for`: String? = null,
     @Json(name = "operator") @field:Json(name = "operator") var `operator`: String? = null,
     @Json(name = "val") @field:Json(name = "val") var `val`: String? = null,