Skip to content

Fix breaking JSDoc changes (#1012) #1029

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

Merged
merged 6 commits into from
Mar 10, 2023

Conversation

mitchell-merry
Copy link
Contributor

@mitchell-merry mitchell-merry commented Jan 26, 2023

Changes

Fixes #1012

  • Parameters correctly generate next to the intended parameter (this was a typo I believe)
  • Operation comments now generate above the operation instead of inside (in this case there was also a duplicate comment generated when the operation had no operationId)

The example linked in the issue now generates as:

export type operations = {

  /** getVisits description (now attached to getVisits) */
  getVisits: {
    parameters: {
      path: {
        /** @description storeId description (now correctly on the property) */
        storeId: string;
        /** @description storeName description */
        storeName: string;
      };
    };
    responses: {
      /** @description Success */
      200: {
        content: {
          "application/json": components["schemas"]["SchedulerVisitReadModel"];
        };
      };
    };
  };
};

How to Review

The tests were wrong in this instance, so they have been updated as well.

Checklist

  • Unit tests updated
  • examples/ directory updated (if applicable)

@mitchell-merry
Copy link
Contributor Author

mitchell-merry commented Jan 26, 2023

Need to make a couple changes

@mitchell-merry
Copy link
Contributor Author

mitchell-merry commented Feb 6, 2023

Hi @drwpow, just wondering what's blocking you from merging some of these PRs? I'd like to work on additional features (i.e. #941 ) but I'm hesitant since it seems like this project has stagnated.

Copy link
Contributor

@drwpow drwpow left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a great fix, and great tests. Thank you! Will merge as soon as the lint errors & minor conflicts are resolved.

@drwpow
Copy link
Contributor

drwpow commented Feb 23, 2023

Hi @drwpow, just wondering what's blocking you from merging some of these PRs?

I contribute as much time to the project as I can, which is several hours every month. I’d love help with additional maintainers if you’re interested or know someone who is.

@mitchell-merry
Copy link
Contributor Author

mitchell-merry commented Feb 24, 2023

This is a great fix, and great tests. Thank you! Will merge as soon as the lint errors & minor conflicts are resolved.

Thanks! Could you rerun the workflow? I'm getting Response is not a constructor errors on my local (for load.test.ts) for both my branch and main, so I want to make sure that it works in CI (no idea what my issue is on local).

I contribute as much time to the project as I can, which is several hours every month. I’d love help with additional maintainers if you’re interested or know someone who is.

That's good to hear. I want to start using this package, so I'm hoping that it's still being at least somewhat maintained. As long as I can submit PRs and there's someone around to check them, that's good by me :D thanks for what you do.

Edit: Seems good, just needs a merge! @drwpow

@drwpow drwpow merged commit 728c361 into openapi-ts:main Mar 10, 2023
@drwpow
Copy link
Contributor

drwpow commented Mar 10, 2023

@all-contributors please add @mitchell-merry for code, test, bug

@allcontributors
Copy link
Contributor

@drwpow

I've put up a pull request to add @mitchell-merry! 🎉

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 this pull request may close these issues.

JsDoc breaking changes from 5-6
2 participants