chore(oas): replace response with $ref class JSDoc (Admin SHI-V) #3031
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
🦋 Changeset detectedLatest commit: 9ed7b3c The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
| * description: Whether or not the items were deleted. | ||
| * default: true | ||
| */ | ||
| export type AdminDeleteShippingProfileRes = DeleteResponse |
There was a problem hiding this comment.
simply moved below all relation declarations
| export type AdminStockLocationsRes = { | ||
| stock_location: StockLocationDTO | ||
| } | ||
|
|
||
| export type AdminStockLocationsDeleteRes = DeleteResponse |
There was a problem hiding this comment.
No usage found across the codebase. Not implemented.
adrien2p
approved these changes
Jan 15, 2023
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.
Scope
Admin routes directories SHI to V.
What
Move inline OAS response schema declaration under their respective class declarations in order to expose them through
#/components/schemas. Replace inline OAS response schema with a$refreference pointing to the newly declared schema.Why
Having response declared as its own "named" schema will allow OAS code generators to output typed entities/DTO that can be consumed without having to reference the route/operation.
How
Declare a new @Schema JSDoc for each "Res" class used to parse and validate request body. Move the current inline requestBody to the new @Schema.
Test
Expect no visible changes to the documentation.