fix(specs): correctly pass searchParams to the request
#531
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
✅ Deploy Preview for api-clients-automation ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
✗ The generated branch has been deleted.If the PR has been merged, you can check the generated code on the |
shortcuts
force-pushed
the
fix/specs-search-request
branch
from
158bb95
to
59e6ac0
Compare
shortcuts
requested review from
a team,
damcou,
millotp and
Haroenv
and removed request for
a team
Haroenv
previously approved these changes
May 23, 2022
millotp
previously approved these changes
May 23, 2022
Comment on lines
+49
to
+59
| searchTypeFacet: | ||
| type: string | ||
| enum: [facet] | ||
| default: facet | ||
| description: Perform a search query with `default`, will search for facet values if `facet` is given. | ||
|
|
||
| searchTypeDefault: | ||
| type: string | ||
| enum: [default] | ||
| default: default | ||
| description: Perform a search query with `default`, will search for facet values if `facet` is given. |
There was a problem hiding this comment.
could this be the same enum but with a different default value ?
There was a problem hiding this comment.
Do you mean allowing both? It made the type to complicate to predict so I had to duplicate it
There was a problem hiding this comment.
you can't mix the type actually, if you're in a facet "query" you can't use the default type, so separate or literal "default" | "facet" is the only option I think
Haroenv
reviewed
May 23, 2022
Haroenv
approved these changes
May 23, 2022
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
🎟 JIRA Ticket: https://algolia.atlassian.net/browse/APIC-496
Changes included:
Fixes #528
This PR solves two problem of the generated clients:
paramsparameters should be sent as a string (serialized) and not as an object1
This endpoint accepts both
facetandhitsqueries, which have distinct options while having some in common. We now provide a preciseallOf/oneOfto properly describe its usage.2
As the API accepts both
paramsparameter and root level parameters, we now only leverage the root level parameters to prevent any extra logicNext
Documentation will be added via https://algolia.atlassian.net/browse/APIC-484
🧪 Test
CI :D