Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • O openapi-generator
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 3,476
    • Issues 3,476
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 402
    • Merge requests 402
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Package Registry
    • Infrastructure Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • OpenAPI Tools
  • openapi-generator
  • Issues
  • #5307
Closed
Open
Issue created Feb 13, 2020 by Administrator@rootContributor

[REQ] [Angular] JSDoc for useSingleRequestParameter

Created by: alexrashed

Is your feature request related to a problem? Please describe.

PR #4479 introduced the single-request-parameter, creating an interface with all parameters for each service method. While this is awesome for type safety and readability, the created interface members are currently not documented (in contrast to the documentation of the usual parameters in the functions JSDoc).

Describe the solution you'd like

The members of the generated interfaces should be commented using JSDoc syntax. F.e.:

export interface ExampleRequestParams {
  /** An example documentation of the request parameter test. */
  test: string;
}

This format can be seen in the official JSDoc examples and is supported by IntelliJ IDEs (like IDEA or WebStorm).

Additional context

A PR is in the making.

Assignee
Assign to
Time tracking