Skip to content

Add support for in-line openapi #1300

@RandomUsername12222

Description

@RandomUsername12222

Motivation

I use package Swagger-Jsdoc . This plugin seems to be complaining about

/ **
* @openapi
*/

Which is used by Swagger-jsdoc, to mark openapi syntax.
image

I would love for this plugin to have option to ignore jsdoc, which includes @openapi.

Sample code: https://github.com/Monsters-RPG-game/Gateway/blob/dev/src/structure/modules/user/register/router.ts
Minimal eslint rules. related this issue

{
         "jsdoc/check-tag-names": 1,
         "jsdoc/check-indentation": 1
}

Current behavior

Currently plugin complains about jsdoc, which has @openapi

Desired behavior

Add some way to ignore jsdoc, which include @openapi, or add a way to ignore jsdoc blocks, which include specific tag

Alternatives considered

N/A

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions