bcherny/json-schema-to-typescript

The key property named deprecated is wrong behavior

Open

#626 opened on Sep 1, 2024

View on GitHub
 (1 comment) (6 reactions) (0 assignees)TypeScript (449 forks)github user discovery
bughelp wanted

Repository metrics

Stars
 (3,302 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

I Cannot generate OpenAPI v3.1.0 types from json schema.

https://github.com/OAI/OpenAPI-Specification/blob/main/schemas/v3.1/schema.json

> curl https://spec.openapis.org/oas/3.1/schema/2022-10-07 | pnpm json2ts > ./src/openapi/OpenAPIV31.d.ts
[
  'Error at key "properties" in file "undefined": deprecated must be a boolean'
]
[
  'Error at key "properties" in file "undefined": deprecated must be a boolean'
]
[
  ValidationError
      at C:\Users\user\Documents\workspace\hono-typia-openapi\node_modules\.pnpm\json-schema-to-typescript@15.0.1\node_modules\json-schema-to-typescript\dist\src\index.js:97:19
      at Generator.next (<anonymous>)
      at fulfilled (C:\Users\user\Documents\workspace\hono-typia-openapi\node_modules\.pnpm\json-schema-to-typescript@15.0.1\node_modules\json-schema-to-typescript\dist\src\index.js:5:58)
      at process.processTicksAndRejections (node:internal/process/task_queues:95:5)
]

Contributor guide

Research direction
Trace the validation of the 'deprecated' property in the JSON Schema to TypeScript compiler to fix the boolean type check.
Tech stack
typescript
Domain
developer experiencetooling
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Node.js
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80