fix: include route description as ts comment #82
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
epeters3
commented
Sep 21, 2023
| @@ -171,6 +172,9 @@ export const Schema: OneSchema<Endpoints> = { | |||
| import type { OneSchema } from "@lifeomic/one-schema"; | |||
|
|
|||
| export type Endpoints = { | |||
| /** | |||
| * Fetches an array of all fruits. | |||
| */ | |||
There was a problem hiding this comment.
This is the outcome ☝️: the route description is included on each route in Endpoints, when provided.
There was a problem hiding this comment.
This type still gets generated for clients (even in the case of a non-YAML flow). Will be great to have client-side.
There was a problem hiding this comment.
Oh excellent, good to hear.
|
🎉 This PR is included in version 5.3.3 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
A small enhancement: for the
schema.yamlflow, this PR makes a change to pass a route's description into the rendered ts code for theEndpointstype. Since you refer toone-schemaroutes by their route, its especially useful to have the route description propagate down into theEndpointstype, e.g. so you can see a route's description on hover:endpoint-descriptions.mp4