OpenAPITools / OpenAPITools/openapi-generator

[REQ] Print line number when there is an error in the swagger doc

Open
#12,415 2 comments 5 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Enhancement: Feature
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Is your feature request related to a problem? Please describe.

Please print line numbers when there is an error

Describe the solution you'd like

I am trying to generate nestjs from swagger, using this command:

openapi-generator-cli generate -i clean_oapi.json -g typescript-nestjs -o ../gen/

and I get an error like this:

-attribute paths.For path parameter id the required value should be true

I would like to know the line number of the swagger where the error is located, so i can fix it.

Describe alternatives you've considered

the best way is to have the line number

Additional context

Contributor guide

Open the contributing guide

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.

Research direction

The reported entry point is openapi-generator-cli generate with clean_oapi.json and the typescript-nestjs generator; start by tracing where the OpenAPI validation error for paths path parameters is produced. Done means the same error identifies the source line in the Swagger document, with coverage for this validation path.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, openapi
Domain
api, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.