Skip to content

JsDoc breaking changes from 5-6 #1012

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

Closed
npbenjohnson opened this issue Dec 4, 2022 · 0 comments · Fixed by #1029
Closed

JsDoc breaking changes from 5-6 #1012

npbenjohnson opened this issue Dec 4, 2022 · 0 comments · Fixed by #1029

Comments

@npbenjohnson
Copy link

Using version 6.1.0

  1. The jsdoc comments for operations is generated above the first child of the operation in document order. This means the comment intended for the operation may end up parameters/responses/etc depending on which child is defined first.
  2. All parameter descriptions are mashed together as @description tags above "path" instead of being rendered above the corresponding parameter

Example:

export interface operations {

  getVisits: {
    /** swagger description value from getVisits INCORRECTLY renders here */
    parameters: {
      /** 
            @description The numeric store Id (this should be above storeId)
            @description The store name (this should be above storeName)
      */
      path: {
        storeId: number;
        storeName: number;
      };
    };
    responses: {
      /** @description Success */
      200: {
        content: {
          "application/json": (components["schemas"]["SchedulerVisitReadModel"])[];
        };
      };
    };
  };
mitchell-merry pushed a commit to mitchell-merry/openapi-typescript that referenced this issue Jan 26, 2023
mitchell-merry added a commit to mitchell-merry/openapi-typescript that referenced this issue Jan 26, 2023
mitchell-merry added a commit to mitchell-merry/openapi-typescript that referenced this issue Feb 24, 2023
drwpow pushed a commit that referenced this issue Mar 10, 2023
* Fix #1012

* Update examples

* Fix the operation comment

* Fix subschemas (digital ocean)

* indentation

* Fix lints and examples
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

Successfully merging a pull request may close this issue.

1 participant