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

Types are missing JSDocs #90

Open
scottc opened this issue Jul 31, 2019 · 1 comment
Open

Types are missing JSDocs #90

scottc opened this issue Jul 31, 2019 · 1 comment
Labels

Comments

@scottc
Copy link

scottc commented Jul 31, 2019

The api methods have docs, but the types themselves do not.

Actual:
Response types are missing JSDocs

export type User {
    id: number;
    username: string;
}

Expected:
JSDocs containing the definition descriptions.

/** */
export type User {
    /** {integer} The user ID. */
    id: number;
    /** The user name. */
    username: string;
}

Spec:
https://swagger.io/docs/specification/2-0/describing-responses/

definitions:
  User:
    type: object
    properties:
      id:
        type: integer
        description: The user ID.
      username:
        type: string
        description: The user name.
@mtennoe
Copy link
Owner

mtennoe commented Jul 31, 2019

Yo! Yep, seems like we are missing this. Shouldnt be too hard to add either, so should be an easy win.
Might also be interesting to make it togglable so consumers can disable comments if desired.

@mtennoe mtennoe added the bug label Oct 14, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants