variable ownerType is already defined in class com.onshape.api.requests.MetadataCategoryUpdatePropertyRequest.Builder

[eak24]

I am trying to generate java-client from demo-c today, as we want updated java-client with some fixes recently submitted. The java-client generation is failing with below error. Could you please take a look?
[INFO] ------------------------------------------------------------------------
[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 22.730 s
[INFO] Finished at: 2020-07-30T10:58:23+05:30
[INFO] ------------------------------------------------------------------------
[ERROR] Failed to execute goal org.apache.maven.plugins:maven-compiler-plugin:3.8.0:compile (default-compile) on project api-client: Compilation failure: Compilation failure:
[ERROR] /home/ccsteam/repos/api-generator-from-chris/api-generator-master/onshape-java/api-generator/target/java-build/src/main/java/com/onshape/api/requests/MetadataCategoryUpdatePropertyRequest.java:[354,20] variable ownerType is already defined in class com.onshape.api.requests.MetadataCategoryUpdatePropertyRequest.Builder (edited)

[harmanpa]

@ethan92429 What is the endpoint json for the metadata-category-update-property method?

[eak24]

{
        "type": "post",
        "url": "/metadatacategory/property/:pid",
        "title": "Update metadata property and update its association with categories as needed.",
        "name": "updateProperty",
        "description": "Update metadata property and associate or disassociate with/from categories",
        "group": "MetadataCategory",
        "version": "1.0.0",
        "permission": [
          {
            "name": "public"
          },
          {
            "name": "OAuth2Read"
          },
          {
            "name": "OAuth2Write"
          }
        ],
        "parameter": {
          "fields": {
            "QueryParam": [
              {
                "group": "QueryParam",
                "type": "String",
                "optional": false,
                "field": "Requesting",
                "description": "owner id, required"
              },
              {
                "group": "QueryParam",
                "type": "Number",
                "optional": true,
                "field": "ownerType",
                "description": "Owner type, optional that can be: 1:company 2:onshape (default: 1)"
              }
            ],
            "PathParam": [
              {
                "group": "PathParam",
                "type": "String",
                "optional": false,
                "field": "pid",
                "description": "Property ID"
              }
            ],
            "Body": [
              {
                "group": "Body",
                "type": "String",
                "optional": true,
                "field": "name",
                "description": "Property name"
              },
              {
                "group": "Body",
                "type": "String",
                "optional": true,
                "field": "description",
                "description": "Property description"
              },
              {
                "group": "Body",
                "type": "String",
                "optional": true,
                "field": "ownerId",
                "description": "Property owner ID"
              },
              {
                "group": "Body",
                "type": "Number",
                "optional": true,
                "field": "ownerType",
                "description": "Property owner type, which can be: 1:company"
              },
              {
                "group": "Body",
                "type": "Number",
                "optional": true,
                "field": "valueType",
                "description": "Value type of property, which can be: 0:STRING, 1:BOOL, 2:INT, 3:DOUBLE, 4:DATE, 5:ENUM, 6:OBJECT, 7:BLOB, 8:USER"
              },
              {
                "group": "Body",
                "type": "Boolean",
                "optional": true,
                "field": "isArray",
                "description": "True if property is an array type"
              },
              {
                "group": "Body",
                "type": "String",
                "optional": true,
                "field": "objectDefName",
                "description": "Object type name if valueType == OBJECT (6)"
              },
              {
                "group": "Body",
                "type": "String",
                "optional": true,
                "field": "blobMimeType",
                "description": "Blob mime type if valueType == BLOB (7)"
              },
              {
                "group": "Body",
                "type": "Boolean",
                "optional": true,
                "field": "editableInVersion",
                "description": "True if this property can be edited in a Version"
              },
              {
                "group": "Body",
                "type": "Boolean",
                "optional": true,
                "field": "editableInMicroversion",
                "description": "True if this property can be edited in a Microversion"
              },
              {
                "group": "Body",
                "type": "Object",
                "optional": true,
                "field": "categoryPropertyConfigParams",
                "description": "Additional information about property"
              },
              {
                "group": "Body",
                "type": "String",
                "optional": true,
                "field": "categoryPropertyConfigParams.displayName",
                "description": "Display name of the property"
              },
              {
                "group": "Body",
                "type": "Number",
                "optional": true,
                "field": "categoryPropertyConfigParams.publishState",
                "description": "Property publish state, which can be: 0: PENDING, 1: ACTIVE, 2: INACTIVE"
              },
              {
                "group": "Body",
                "type": "Boolean",
                "optional": true,
                "field": "categoryPropertyConfigParams.required",
                "description": "True if property is required to have a non-empty value"
              },
              {
                "group": "Body",
                "type": "String",
                "optional": true,
                "field": "categoryPropertyConfigParams.defaultValue",
                "description": "Default value, must be set if required == true"
              },
              {
                "group": "Body",
                "type": "String",
                "optional": true,
                "field": "categoryPropertyConfigParams.pattern",
                "description": "Regular expression pattern validation for properties whose valueType == STRING (0)"
              },
              {
                "group": "Body",
                "type": "Number",
                "optional": true,
                "field": "categoryPropertyConfigParams.minLength",
                "description": "Min length validation for properties whose valueType == STRING (0)"
              },
              {
                "group": "Body",
                "type": "Number",
                "optional": true,
                "field": "categoryPropertyConfigParams.maxLength",
                "description": "Max length validation for properties whose valueType == STRING (0)"
              },
              {
                "group": "Body",
                "type": "Number",
                "optional": true,
                "field": "categoryPropertyConfigParams.minValue",
                "description": "Min value validation for properties whose valueType == DOUBLE (3) or INT (2)"
              },
              {
                "group": "Body",
                "type": "Number",
                "optional": true,
                "field": "categoryPropertyConfigParams.maxValue",
                "description": "Max value validation for properties whose valueType == DOUBLE (3) or INT (2)"
              },
              {
                "group": "Body",
                "type": "Date",
                "optional": true,
                "field": "categoryPropertyConfigParams.minDate",
                "description": "Min date validation for properties whose valueType == DATE (4)"
              },
              {
                "group": "Body",
                "type": "Number",
                "optional": true,
                "field": "categoryPropertyConfigParams.maxDate",
                "description": "Max date validation for properties whose valueType == DATE (4)"
              },
              {
                "group": "Body",
                "type": "Number",
                "optional": true,
                "field": "categoryPropertyConfigParams.minCount",
                "description": "Min count validation for properties whose valueType == USER (8)"
              },
              {
                "group": "Body",
                "type": "Number",
                "optional": true,
                "field": "categoryPropertyConfigParams.maxCount",
                "description": "Max count validation for properties whose valueType == USER (8)"
              },
              {
                "group": "Body",
                "type": "Boolean",
                "optional": true,
                "field": "categoryPropertyConfigParams.multiline",
                "description": "True if string input should be multiline. Only used if valueType == STRING (0)"
              },
              {
                "group": "Body",
                "type": "Object[]",
                "optional": true,
                "field": "categoryPropertyConfigParams.enumValues",
                "description": "Set of enum values if valueType == ENUM (5)"
              },
              {
                "group": "Body",
                "type": "String[]",
                "optional": true,
                "field": "addToCategoryIds",
                "description": "List of IDs of the categories to associate this property with"
              },
              {
                "group": "Body",
                "type": "String[]",
                "optional": true,
                "field": "removeFromCategoryIds",
                "description": "List of IDs of the categories to dis-associate this property from"
              }
            ]
          }
        },
        "groupTitle": "MetadataCategory",
        "header": {
          "fields": {
            "Header": [
              {
                "group": "Header",
                "type": "String",
                "optional": false,
                "field": "Accept",
                "defaultValue": "application/vnd.onshape.v1+json",
                "description": "Request JSON data response using version 1\n  request/response behavior"
              },
              {
                "group": "Header",
                "type": "String",
                "optional": false,
                "field": "Content-Type",
                "defaultValue": "application/json",
                "description": "Content type"
              }
            ]
          }
        },
        "success": {
          "fields": {
            "Response": [
              {
                "group": "Response",
                "type": "String",
                "optional": true,
                "field": "id",
                "description": "Property ID"
              },
              {
                "group": "Response",
                "type": "String",
                "optional": true,
                "field": "name",
                "description": "Property name"
              },
              {
                "group": "Response",
                "type": "String",
                "optional": true,
                "field": "ownerId",
                "description": "Property owner ID"
              },
              {
                "group": "Response",
                "type": "Number",
                "optional": true,
                "field": "ownerType",
                "description": "Property owner type, which can be: 1:company, 2: onshape"
              },
              {
                "group": "Response",
                "type": "Number",
                "optional": true,
                "field": "valueType",
                "description": "Value type of property, which can be: 0:STRING, 1:BOOL, 2:INT, 3:DOUBLE, 4:DATE, 5:ENUM, 6:OBJECT, 7:BLOB, 8:USER"
              },
              {
                "group": "Response",
                "type": "String",
                "optional": true,
                "field": "description",
                "description": "Property description"
              },
              {
                "group": "Response",
                "type": "Boolean",
                "optional": true,
                "field": "isArray",
                "description": "True if property is an array type"
              },
              {
                "group": "Response",
                "type": "String",
                "optional": true,
                "field": "objectDefName",
                "description": "Object type name if valueType == OBJECT (6)"
              },
              {
                "group": "Response",
                "type": "String",
                "optional": true,
                "field": "blobMimeType",
                "description": "Blob mime type if valueType == BLOB (7)"
              },
              {
                "group": "Response",
                "type": "Boolean",
                "optional": true,
                "field": "editableInVersion",
                "description": "True if this property can be edited in a Version"
              },
              {
                "group": "Response",
                "type": "Boolean",
                "optional": true,
                "field": "editableInMicroversion",
                "description": "True if this property can be edited in a Microversion"
              },
              {
                "group": "Response",
                "type": "Object",
                "optional": true,
                "field": "categoryPropertyConfigInfo",
                "description": "Additional information about property"
              },
              {
                "group": "Response",
                "type": "String",
                "optional": true,
                "field": "categoryPropertyConfigInfo.displayName",
                "description": "Display name of the property"
              },
              {
                "group": "Response",
                "type": "Number",
                "optional": true,
                "field": "categoryPropertyConfigInfo.publishState",
                "description": "Property publish state, which can be: 0: PENDING, 1: ACTIVE, 2: INACTIVE"
              },
              {
                "group": "Response",
                "type": "Boolean",
                "optional": true,
                "field": "categoryPropertyConfigInfo.required",
                "description": "True if property is required to have a non-empty value"
              },
              {
                "group": "Response",
                "type": "String",
                "optional": true,
                "field": "categoryPropertyConfigInfo.defaultValue",
                "description": "Default value, must be set if required == true"
              },
              {
                "group": "Response",
                "type": "String",
                "optional": true,
                "field": "categoryPropertyConfigInfo.pattern",
                "description": "Regular expression pattern validation for properties whose valueType == STRING (0)"
              },
              {
                "group": "Response",
                "type": "Number",
                "optional": true,
                "field": "categoryPropertyConfigInfo.minLength",
                "description": "Min length validation for properties whose valueType == STRING (0)"
              },
              {
                "group": "Response",
                "type": "Number",
                "optional": true,
                "field": "categoryPropertyConfigInfo.maxLength",
                "description": "Max length validation for properties whose valueType == STRING (0)"
              },
              {
                "group": "Response",
                "type": "Number",
                "optional": true,
                "field": "categoryPropertyConfigInfo.minValue",
                "description": "Min value validation for properties whose valueType == DOUBLE (3) or INT (2)"
              },
              {
                "group": "Response",
                "type": "Number",
                "optional": true,
                "field": "categoryPropertyConfigInfo.maxValue",
                "description": "Max value validation for properties whose valueType == DOUBLE (3) or INT (2)"
              },
              {
                "group": "Response",
                "type": "Date",
                "optional": true,
                "field": "categoryPropertyConfigInfo.minDate",
                "description": "Min date validation for properties whose valueType == DATE (4)"
              },
              {
                "group": "Response",
                "type": "Number",
                "optional": true,
                "field": "categoryPropertyConfigInfo.maxDate",
                "description": "Max date validation for properties whose valueType == DATE (4)"
              },
              {
                "group": "Response",
                "type": "Number",
                "optional": true,
                "field": "categoryPropertyConfigInfo.minCount",
                "description": "Min count validation for properties whose valueType == USER (8)"
              },
              {
                "group": "Response",
                "type": "Number",
                "optional": true,
                "field": "categoryPropertyConfigInfo.maxCount",
                "description": "Max count validation for properties whose valueType == USER (8)"
              },
              {
                "group": "Response",
                "type": "Boolean",
                "optional": true,
                "field": "categoryPropertyConfigInfo.multiline",
                "description": "True if string input should be multiline. Only used if valueType == STRING (0)"
              },
              {
                "group": "Response",
                "type": "Object[]",
                "optional": true,
                "field": "categoryPropertyConfigInfo.enumValues",
                "description": "Set of enum values if valueType == ENUM (5)"
              },
              {
                "group": "Response",
                "type": "Object[]",
                "optional": true,
                "field": "categorySummaryInfoList",
                "description": "List of member category summary info objects"
              },
              {
                "group": "Response",
                "type": "Object",
                "optional": true,
                "field": "categorySummaryInfoList.0",
                "description": "Member category"
              },
              {
                "group": "Response",
                "type": "String",
                "optional": true,
                "field": "categorySummaryInfoList.0.id",
                "description": "Member category id"
              },
              {
                "group": "Response",
                "type": "String",
                "optional": true,
                "field": "categorySummaryInfoList.0.name",
                "description": "Member category name"
              },
              {
                "group": "Response",
                "type": "String",
                "optional": true,
                "field": "categorySummaryInfoList.0.description",
                "description": "Member category description"
              },
              {
                "group": "Response",
                "type": "String",
                "optional": true,
                "field": "categorySummaryInfoList.0.ownerId",
                "description": "CompanyId that will own the member category"
              },
              {
                "group": "Response",
                "type": "Number",
                "optional": true,
                "field": "categorySummaryInfoList.0.ownerType",
                "description": "Owner type, which will be: 1:company, 2: onshape"
              },
              {
                "group": "Response",
                "type": "Number",
                "optional": true,
                "field": "categorySummaryInfoList.0.publishState",
                "description": "Member category publish state, which will be: 0: PENDING, 1: ACTIVE, 2: INACTIVE"
              }
            ]
          }
        }
      }

[eak24]

As you can see, ownerType is defined exactly once as a queryParam, as a body param, and as a response param.

[harmanpa]

Do the query param and body param have different meanings?

[eak24]

No - but they have to agree. Not the best design, but that is what we've got!

[harmanpa]

The offending line of code is here:
https://github.com/onshape-public/api-generator/blob/6762b20d0e9b331ba853c5ad6a73bac19135b405/onshape-java/api-generator/src/main/java/com/onshape/api/generator/java/JavaEndpointTarget.java#L298

If we can check that the field (i.e. ownerType) also exists as a body parameter at this point then we simply don't try to add another field to the Java class. The client behaviour will then be to use the same value as both a body param and query param (so no need to check in client they are same as they would use the same field).

[eak24]

I don't think the client should make the assumption that query params and body params should necessarily be the same? What do you think?

[harmanpa]

I guess it depends if this (having params of different types with same name) is a one-off or a common pattern?

[eak24]

Unfortunately we do this commonly, but I don't want to make an assumption that they are supposed to be the same... Our API seems to have a habit of not following patterns too well, so there may be some endpoints that actually have different behavior depending on which (body or query) param is changed.

[harmanpa]

OK, another option is to prefix/suffix the name of either affected query params or all query params (e.g. "queryOwnerType" / "ownerTypeQuery") so there isn't a clash?

[eak24]

Yes - I see that the alternative isn't that clean either. OK - for now, let's go with your original suggestion. If we come across a time when the names are the same but the behavior is different, that will probably be a good thing since it will alert us to unexpected behavior in our API.