The url parameter description exists in the openApi.json file. But it is not generated into the ts file.

Open Beginner friendly
#323 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
70/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Stale
Tech stack
nodejs, typescript
Domain
api, tooling

Research direction

The issue is about a missing URL parameter description in the generated TypeScript file from an OpenAPI spec. Look at the code generation logic in the repository, likely in a file handling parameter parsing or template rendering. Start by examining the input OpenAPI JSON structure and compare it to the output TypeScript to see where the description field is dropped. Run the provided command locally to reproduce the issue.

Written by the indexing model from the issue text.

Description

The url parameter description exists in the openApi.json file. But it is not generated into the ts file.

swagger-typescript-api -p http://xxx/v3/api-docs -o src/api/knowledge -n autoApi --js --axios

image

  • swagger-typescript-api@9.2.0
  • windows 10 x64
  • node v14.15.5
Dominant language
TypeScript
Stars
4.1k
Forks
436
Avg merge
9d 7h
Merged PRs (30d)
3

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from acacode/swagger-typescript-api

All issues in acacode/swagger-typescript-api

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.