Skip to content

Types are missing JSDocs #90

@scottc

Description

@scottc

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions