fix(specs): fix example in Composition API specs #5650
Merged
Conversation
This file contains hidden or 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
Collaborator
✔️ Code generated!
📊 Benchmark resultsBenchmarks performed on the method using a mock server, the results might not reflect the real-world performance.
|
Fluf22
previously approved these changes
Nov 18, 2025
Collaborator
Fluf22
left a comment
Fluf22
left a comment
There was a problem hiding this comment.
Ah yes apparently it must be an object, not a list
Let's see if it works this way
Contributor
Author
|
@Fluf22 unclear what is expected, documentation (https://swagger.io/docs/specification/v3_0/adding-examples/) asks for an object, but the lint specs failed because it expects an iterator it seems ? |
Contributor
Author
|
I had the same error locally (whereas my initial proposal) |
shortcuts
reviewed
Nov 18, 2025
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.
🧭 What and Why
I saw that the final documentation of
facetsquery parameter in Comp API in the documentation is not valid because we made an error in the specs:(the value in example is not valid) ⬆️
This PR aims to fix the examples
Changes included:
🧪 Test
yarn cli build specs all && yarn cli build clients javascript