Serialization and Deserialization of Guid[] fields is incorrectly handled #1478
Labels
Comments
|
Thanks for raising this @TheDusty01 With the changes in #1475 as well as the latest release of the generator, any chance you can confirm this is still an issue with the latest versions of the packages? |
andrueastman
added
the
status:waiting-for-author-feedback
|
Hey, we tried it out with the new Kiota v1.20.0 release and kiota TS preview 74 but when trying to send the Guid array we now get a request generated like this: Click to expandSeems to be an error in the kiota json parser. This is the generated code for parsing the request object to json: /**
* Serializes information the current object
* @param writer Serialization writer to use to serialize this model
*/
// @ts-ignore
export function serializeUpdatePlanRequest(writer: SerializationWriter, updatePlanRequest: Partial<UpdatePlanRequest> | undefined | null = {}) : void {
if (updatePlanRequest) {
writer.writeCollectionOfPrimitiveValues<Guid>("scheduleIds", updatePlanRequest.scheduleIds);
writer.writeTimeOnlyValue("endTime", updatePlanRequest.endTime);
writer.writeStringValue("name", updatePlanRequest.name);
writer.writeCollectionOfObjectValues<PlanConfigurationRequest>("planConfigurations", updatePlanRequest.planConfigurations, serializePlanConfigurationRequest);
writer.writeCollectionOfObjectValues<PlanDataRequest>("planDatas", updatePlanRequest.planDatas, serializePlanDataRequest);
writer.writeGuidValue("projectId", updatePlanRequest.projectId);
}
}Even if I comment out everything apart from the simple string |
microsoft-github-policy-service
bot
added
Needs: Attention 👋
and removed
status:waiting-for-author-feedback
|
Hi @TheDusty01 |
baywet
added
status:waiting-for-author-feedback
|
Thanks for clarifying. This issue got fixed by #1475. Could you possibly link/share some details on how to setup a default kiota client with the request compression disabled? Creating a new http client by manually adding the default middleware seems weird: const http = KiotaClientFactory.create(undefined, [
new RetryHandler(), new RedirectHandler(), new ParametersNameDecodingHandler(), new UserAgentHandler(), new HeadersInspectionHandler()
]);
const adapter = new FetchRequestAdapter(undefined, undefined, undefined, http);
const client = createApiClient(adapter); |
microsoft-github-policy-service
bot
added
Needs: Attention 👋
and removed
status:waiting-for-author-feedback
|
Thanks for confirming this is solved. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
What are you generating using Kiota, clients or plugins?
API Client
In what context or format are you using Kiota?
Nuget Tool
Describe the bug
When fetching a response with a
Guid[]field, Kiota serializes it as astring[]at runtime, even though it's defined asGuid[]. Similarly, when sending a request containing aGuid[]field, the generated JSON is malformed, causing a server-side parse error. See examples below.Actual behavior
Serialization
The current generated request:
The payload sent to the server is malformed (generated by the call to the resource's
postmethod on the Kiota generated api client). ThescheduleIdsfield is incorrectly serialized as an object array instead of astring[]. Meanwhile, theprojectIdfield is correctly serialized as astring:{ "name": "Plan Name", "projectId": "896efb3d-ac5a-8d1c-b275-d6f393e5c5dc", "scheduleIds": [ { "value": "2eeda716-fdfb-ad99-e972-f7826a62a92f" }, , { "value": "dadde388-b68c-ac73-1653-0508a722bf02" }, ] }Deserialization
This generated response:
At runtime, the
scheduleIdsfield is incorrectly deserialized as astring[], whileGuidfields likeidandprojectIdare correctly deserialized as objects:TL;DR:
The
scheduleIdsfield is defined asGuid[]in the model, but is treated asstring[]at runtime.Expected behavior
Serialization
The resulting JSON should be well-formed with the
scheduleIdsfield serialized as an array of strings, not as an array of objects.{ "name": "Plan Name", "projectId": "896efb3d-ac5a-8d1c-b275-d6f393e5c5dc", "scheduleIds": [ "2eeda716-fdfb-ad99-e972-f7826a62a92f", "dadde388-b68c-ac73-1653-0508a722bf02" ] }Deserialization
The
scheduleIdsfield should be deserialized as an array ofGuidobjects, not as an array of strings.How to reproduce
Open API description file
Click to expand Open API description file
{ "openapi": "3.0.1", "info": { "title": "ProjectsApi, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null", "version": "1.0" }, "paths": { "/api/v1/Plans/{planId}": { "get": { "tags": [ "PlanEndpoints" ], "operationId": "ApiRoutes.Plans.Get", "parameters": [ { "name": "planId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlanResponse" } } } }, "404": { "description": "Not Found" } } }, "put": { "tags": [ "PlanEndpoints" ], "parameters": [ { "name": "planId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePlanRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found" } } }, "delete": { "tags": [ "PlanEndpoints" ], "parameters": [ { "name": "planId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found" } } } }, "/api/v1/Plans": { "get": { "tags": [ "PlanEndpoints" ], "parameters": [ { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 10 } }, { "name": "ProjectId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAllPlansResponse" } } } } } }, "post": { "tags": [ "PlanEndpoints" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePlanRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlanResponse" } } } } } } } }, "components": { "schemas": { "CreatePlanRequest": { "required": [ "name", "projectId", "scheduleIds" ], "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "projectId": { "type": "string", "format": "uuid" }, "scheduleIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true } }, "additionalProperties": false }, "GetAllPlansResponse": { "type": "object", "properties": { "totalItemsCount": { "type": "integer", "format": "int32" }, "paginatedItems": { "type": "array", "items": { "$ref": "#/components/schemas/PlanResponse" }, "nullable": true } }, "additionalProperties": false }, "PlanResponse": { "required": [ "id", "name", "projectId", "scheduleIds" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "projectId": { "type": "string", "format": "uuid" }, "scheduleIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true } }, "additionalProperties": false }, "UpdatePlanRequest": { "required": [ "name", "projectId", "scheduleIds" ], "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "projectId": { "type": "string", "format": "uuid" }, "scheduleIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true } }, "additionalProperties": false } } } }Kiota Version
Kiota Version:
1.19.1+d294e04ba7f756896878a7015df1648f9dc0bcdeKiota TS package version:
"@microsoft/kiota-bundle": "^1.0.0-preview.69"Known Workarounds
Serialization
Use the following workaround to send
Guid[]asstring[]during runtime:Deserialization
TypeScript treats
scheduleIdsas aGuid[], while Kiota assigns it as astring[]. Consequently, we must iterate over the array to parse each element into aGuid. However, since TypeScript assumes every element is already aGuid, we first need to cast each element to astring. SinceGuidcannot be directly cast to a string, we first cast it tounknownand then tostring.TypeScript expects each element of
scheduleIdsto already be aGuid, but Kiota assigns it as astring[]. To handle this, we need to convert each element to aGuid. Since TypeScript assumes the elements are alreadyGuids, we first cast them tostringby casting tounknownand then tostring.Configuration
Other information
Could be related to #1467 and potentially fixed by #1475
The text was updated successfully, but these errors were encountered: