OpenAPITools / OpenAPITools/openapi-generator
[BUG] typescript-rxjs generate types for fields with uniqueItems property as Sets
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 (example)?
- 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
Schemas with fields which contain uniqueItems: true and type: "array" are typed as Sets, which is wrong, because there is no such conversion happening in the code.
Even though it would be the case, Set is converted to JSON as an empty object anyway, so does not fit particular use case.
openapi-generator version
OpenAPI declaration file content or url
openapi: 3.0.0
paths:
/users:
post:
responses:
'200':
content:
application/json:
schema:
uniqueItems: true
type: array
items:
type: string
Generation Details
openapi-generator generate -g typescript-rxjs -o test -i test.yaml
Steps to reproduce
Related issues/PRs
https://github.com/OpenAPITools/openapi-generator/issues/10770
Suggest a fix
Generate Arrays for uniqueItems: true fields, uniqueness of values in array will be checked on the server side or code anyway.
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 running openapi-generator generate -g typescript-rxjs -o test -i test.yaml with the declaration shown in the issue and inspect the generated type for the array field. Trace the TypeScript RxJS generator's handling of uniqueItems: true; done means the field is generated as an Array rather than a Set, with the behavior covered by a regression check.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, typescript
- Domain
- api, tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100