MembershipsUpdateResponse required fields are not returned on API operations

RMoldes — Wed, 15 May 2024 14:27:12 GMT

Hello,

First of all, thanks for all the support provided regarding OpenAPI usage.

Problem

We are currently using the HubSpot OpenAPI spec to auto-generate a client for a Kotlin based application we are working on.
We've successfully integrated it and managed to generate all required code. Also made some tests to retrieve some entities and seems to be working like a charm.

After some testing, we are having an error with the Add records to a List operation (Probably happening with other operations on the List Membermship API).

As described in the specification, it should return a MembershipsUpdateResponse, and we are getting an error when the client tries to parse the reponse body, as it expecting some required fields that are not returned when adding a record to a List (e.g: recordIdsRemoved)

com.squareup.moshi.JsonDataException: Required value 'recordIdsRemoved' missing at $
	at com.squareup.moshi.internal.Util.missingProperty(Util.java:660)
	at com.squareup.moshi.kotlin.reflect.KotlinJsonAdapter.fromJson(KotlinJsonAdapter.kt:105)
	at com.squareup.moshi.internal.NullSafeJsonAdapter.fromJson(NullSafeJsonAdapter.java:41)
	at com.squareup.moshi.JsonAdapter.fromJson(JsonAdapter.java:70)
	at com.hubspot.lists.api.MembershipsApi.putCrmV3ListsListIdMembershipsAddWithHttpInfo(MembershipsApi.kt:1405)
	at com.hubspot.lists.api.MembershipsApi.putCrmV3ListsListIdMembershipsAdd(MembershipsApi.kt:225)
[...]

The actual response from the API is like (required fields are not present in the response):

{
    "recordsIdsAdded": [
        "13XXXXXXXX"
    ]
}

Workarround

After digging and debugging a bit the issue, we removed the required fields of MembershipsUpdateResponse from the local file for the OpenAPI specification we use and regenerated again all the code for the client.
This seems to be fixing the issue and we can now successfully run the Add records to a List operation.

I've already created a Github issue in case it helps to keep track of this issue/question:
- https://github.com/HubSpot/HubSpot-public-api-spec-collection/issues/15

Thanks in advance

Re: MembershipsUpdateResponse required fields are not returned on API operations

Jaycee_Lewis — Thu, 16 May 2024 17:57:49 GMT

Thanks for sharing your workaround. And thank you for taking the time to file the GitHub issue — Jaycee

Re: MembershipsUpdateResponse required fields are not returned on API operations

RMoldes — Thu, 23 May 2024 08:31:11 GMT

Hi @Jaycee_Lewis ,

Thanks for your response.
Are there any plans to take any action on this issue?

Regards,

topic Re: MembershipsUpdateResponse required fields are not returned on API operations in APIs & Integrations

MembershipsUpdateResponse required fields are not returned on API operations

Problem

Workarround

Re: MembershipsUpdateResponse required fields are not returned on API operations

Re: MembershipsUpdateResponse required fields are not returned on API operations