feat(oas): identify required fields in responses - admin #3278
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: 454621a The changes in this PR will be included in the next version bump. This PR includes changesets to release 2 packages
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 |
olivermrbl
approved these changes
Feb 17, 2023
shahednasser
requested changes
Feb 17, 2023
Comment on lines
+58
to
+60
| * required: | ||
| * - shipping_options | ||
| * - count |
There was a problem hiding this comment.
I think we should also have here offset and limit but they're also missing from the response properties.
There was a problem hiding this comment.
Good catch 🎣 . Fixed in 5c3615b
I also added the missing required on the other schemas.
adrien2p
pushed a commit
that referenced
this pull request
Feb 20, 2023
## Scope Admin routes ## What Add OAS `required` to response schemas. ## Why Code generator can use the `required` property of a schema to mark fields as optional or not when generating TS types. ## Test * Run `yarn build` * Run `yarn openapi:generate` * Run `yarn redocly preview-docs docs/api/admin/openapi.yaml --config=docs-util/redocly/config.yaml` * Open the documentation preview URL in a browser (http://127.0.0.1:8080) * Expect responses to have their fields declared as `required`
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
What
Add OAS
requiredto response schemas.Why
Code generator can use the
requiredproperty of a schema to mark fields as optional or not when generating TS types.Test
yarn buildyarn openapi:generateyarn redocly preview-docs docs/api/admin/openapi.yaml --config=docs-util/redocly/config.yamlrequired