Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support @ start symbol in property definition #261

Open
PanGan21 opened this issue Feb 29, 2024 · 0 comments
Open

Support @ start symbol in property definition #261

PanGan21 opened this issue Feb 29, 2024 · 0 comments

Comments

@PanGan21
Copy link

PanGan21 commented Feb 29, 2024

Is your feature request related to a problem? Please describe.
When using the express-jsdoc-swagger library, the @context property in the @property tag of a JSDoc typedef is not properly recognized, and it appears as null in the generated Swagger documentation.

Describe the solution you'd like
I would like the @context property to be correctly recognized and displayed in the Swagger documentation when defined in the @property tag of a JSDoc typedef.

Describe alternatives you've considered
One alternative is to define all properties that start with special symbol using an escape or special symbol.

Additional context
This issue affects the accuracy and completeness of the generated Swagger documentation, as it fails to properly represent the structure of the data defined in the JSDoc comments. My example use case is service a DID document as a part of did:web.
Reference: https://w3c-ccg.github.io/did-method-web/#example-example-did-web-did-document-using-json-web-keys

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant