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

fix(jsdoc): add jsDoc to query parameters #741

Merged
merged 1 commit into from
Mar 2, 2023

Conversation

lukaw3d
Copy link
Contributor

@lukaw3d lukaw3d commented Jan 24, 2023

Status

READY

Description

Use parameter descriptions to document the types
https://github.com/anymaniax/orval/blob/ba7ee988557a63c392c6d9bee50bbd7eddfe3b86/samples/react-app/petstore.yaml#L16-L22

- export type ListPetsParams = { limit?: string };
+ export type ListPetsParams = {
+ /**
+  * How many items to return at one time (max 100)
+  */
+ limit?: string;
+ };

Todos

  • Tests
  • Documentation
  • Changelog Entry (unreleased)

@vercel
Copy link

vercel bot commented Jan 24, 2023

Someone is attempting to deploy a commit to a Personal Account owned by @anymaniax on Vercel.

@anymaniax first needs to authorize it.

@anymaniax
Copy link
Collaborator

Seems really good thanks @lukaw3d

@anymaniax anymaniax merged commit b384ff4 into orval-labs:master Mar 2, 2023
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.

2 participants