Bug Report Checklist
Description
When the request body is directly a set of strings (NOT wrapped in an object), the application crashes at runtime because the Set<string> is not converted to an Array first, thus it generates the JSON {}.
If the request body is wrapped in an object, then it works fine.
openapi-generator version
I am using the openapitools/openapi-generator-cli:latest Docker image.
OpenAPI declaration file content or url
openapi: 3.0.0
info:
version: 1.0.0
title: OpenAPI Petstore
paths:
/pet:
post:
operationId: addPet
responses:
'204':
description: successful operation
requestBody:
content:
application/json:
schema:
type: array
items:
type: string
uniqueItems: true
The generated Typescript file is:
import * as runtime from '../runtime';
export interface AddPetRequest {
requestBody?: Set<string>;
}
export class DefaultApi extends runtime.BaseAPI {
async addPetRaw(requestParameters: AddPetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
const queryParameters: any = {};
const headerParameters: runtime.HTTPHeaders = {};
headerParameters['Content-Type'] = 'application/json';
const response = await this.request({
path: `/pet`,
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: requestParameters['requestBody'],
}, initOverrides);
return new runtime.VoidApiResponse(response);
}
async addPet(requestParameters: AddPetRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
await this.addPetRaw(requestParameters, initOverrides);
}
}
⚠️ Notice requestParameters['requestBody']
I think it should actually be something like (I'm no Typescript expert so maybe it should be slightly different):
- body: requestParameters['requestBody'],
+ body: Array.from(requestParameters['requestBody']),
Generation Details
$ docker run --rm -v "${PWD}:/local" openapitools/openapi-generator-cli:latest generate -i /local/pet.yaml -g typescript-fetch -o /local/dist
Steps to reproduce
- Generate the client code
- Call it with
addPet({requestBody: new Set<string>(["a"])}) (it typechecks)
- At runtime it actually fails because it sent the JSON body
{} instead of ["a"]
Related issues/PRs
Note that using the workaround --type-mappings='set=Array' as suggested in some related issues does NOT work, it results in a type-checking error.
The workaround I have to use for now is to wrap the request body in an object.
Then Array.from is used in the generated code.
But it adds an unnecessary layer in the model.
Bug Report Checklist
Description
When the request body is directly a set of strings (NOT wrapped in an object), the application crashes at runtime because the
Set<string>is not converted to anArrayfirst, thus it generates the JSON{}.If the request body is wrapped in an object, then it works fine.
openapi-generator version
I am using the
openapitools/openapi-generator-cli:latestDocker image.OpenAPI declaration file content or url
The generated Typescript file is:
requestParameters['requestBody']I think it should actually be something like (I'm no Typescript expert so maybe it should be slightly different):
Generation Details
Steps to reproduce
addPet({requestBody: new Set<string>(["a"])})(it typechecks){}instead of["a"]Related issues/PRs
typescript-angular, nottypescript-fetchtypescript-rxjsNote that using the workaround
--type-mappings='set=Array'as suggested in some related issues does NOT work, it results in a type-checking error.The workaround I have to use for now is to wrap the request body in an object.
Then
Array.fromis used in the generated code.But it adds an unnecessary layer in the model.