Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Put swagger version at the top of generated spec so IDE recognises swagger file

See original GitHub issue

IntelliJ does not recognise the generated spec file as a swagger file, and just opens it as a YAML/JSON file.

Sorting

I’m submitting a …
- bug report
- feature request
- support request
I confirm that I
- used the search to make sure that a similar issue hasn’t already been submit

Expected Behavior

swagger: '2.0'
basePath: ...
...

Current Behavior

swagger: '2.0' is near the bottom of the generated spec file

...
paths: ...
produces: ...
swagger: '2.0'

Possible Solution

specGenerator2.ts

let spec: Swagger.Spec2 = {
      swagger: '2.0',
      basePath: normalisePath(this.config.basePath as string, '/', undefined, false),
      consumes: ['application/json'],
      definitions: this.buildDefinitions(),
      info: {
        title: '',
      },
      paths: this.buildPaths(),
      produces: ['application/json'],
    };

Steps to Reproduce

Context (Environment)

Version of the library: 3.7.0 Version of NodeJS: v15.11.0

Confirm you were using yarn not npm: [x]

Detailed Description

Breaking change?

Issue Analytics

State:
Created 2 years ago
Comments:6

Top GitHub Comments

2reactions

WoHcommented, May 21, 2021

Can you link the Jetbrains issue, so I can keep track of the progress? If they don’t decide to fix this, we should consider moving up the swagger/openapi key on our side to avoid the inconvenience, at least for tsoa users. However, I would prefer if Jetbrains decided to fix the detection on their end for everyone.

0reactions

dPetruniakcommented, Sep 24, 2021

The same problem with Cortex. It expects openapi: 3.0.0 on the first row