OpenAPITools / OpenAPITools/openapi-generator
[BUG] typescript-fetch api doesn't compile with unique items array in the response body
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 26.8k
- Forks
- 7.7k
- PR merge metrics
- PR metrics pending
Description
Bug Report Checklist
- Have you provided a full/minimal spec to reproduce the issue?
- Have you validated the input using an OpenAPI validator?
- Have you tested with the latest master to confirm the issue still exists?
- Have you searched for related issues/PRs?
- What's the actual output vs expected output?
- [Optional] Sponsorship to speed up the bug fix or feature request (example)
Description
Generated Api for unique item collection on the response body is not compiling because map operation is executed on a Set.
TS2339: Property map does not exist on type Set<Tag>
openapi-generator version
7.25.0
OpenAPI declaration file content or url
openapi: 3.0.0
info:
title: uniqueItems test spec
version: 1.0.0
description: >-
Spec used to test arrays with uniqueItems across every OpenAPI location
and item type (string, integer, number, boolean, object, array, $ref).
paths:
/unique-request-body:
post:
operationId: uniqueRequestBody
requestBody:
$ref: '#/components/requestBodies/UniqueArrayRequest'
responses:
'200':
description: OK
components:
schemas:
Tag:
type: object
properties:
id:
type: integer
format: int64
name:
type: string
requestBodies:
UniqueArrayRequest:
description: Request body that is an array with uniqueItems
required: true
content:
application/json:
schema:
type: array
uniqueItems: true
items:
$ref: '#/components/schemas/Tag'
Generation Details
Default generation, without Set to Array type mapping.
Steps to reproduce
Generate typescript-fetch client for the provided
Related issues/PRs
N/A
Suggest a fix
I will fix it myself.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by generating a typescript-fetch client from the provided OpenAPI declaration using openapi-generator 7.25.0 or the latest master, then inspect the generated unique-request-body handling where map is called on a Set. Done means the generated client compiles without the TS2339 error for the supplied uniqueItems request body.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100