-
Notifications
You must be signed in to change notification settings - Fork 17
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: add multiclusters endpoints for the search client #34
Conversation
Could you merge |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(First pass)
Great job! That's a lot :D
Overall there's a few missing description
fields and response properties should be required
since the engine does not return empty responses.
clients/algoliasearch-client-javascript/client-search/model/inlineResponse200.ts
Outdated
Show resolved
Hide resolved
clients/algoliasearch-client-javascript/client-search/model/listClustersReponse.ts
Outdated
Show resolved
Hide resolved
clients/algoliasearch-client-javascript/client-search/model/listUserIdsResponse.ts
Outdated
Show resolved
Hide resolved
Co-authored-by: Clément Vannicatte <[email protected]>
Co-authored-by: Clément Vannicatte <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice job ! Thanks for your contribution :)
clients/algoliasearch-client-javascript/client-search/model/inlineObject.ts
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
All good for me !
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
that's a lot, gg!
userID?: HighlightResult; | ||
clusterName?: HighlightResult; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing description or regen
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think we can add a description since they are defined like so:
properties:
userID:
$ref: '../../common/schemas/Record.yml#/highlightResult'
clusterName:
$ref: '../../common/schemas/Record.yml#/highlightResult'
Sibling elements of $ref
are ignored: https://swagger.io/docs/specification/using-ref/#sibling
Also the original documentation doesn't seem to have a description for those: https://www.algolia.com/doc/api-reference/api-methods/search-user-id/#method-response-_highlightresult-object
What do you think?
* List of user object matching the query. | ||
*/ | ||
hits: SearchUserIdsResponseHits[]; | ||
nbHits: Record<string, any>; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing descriptions
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same as above, sibling elements of $ref
are ignored so I'm not sure how to add a description here?
@@ -1,3 +0,0 @@ | |||
export type SearchParamsAsString = { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should not be deleted
clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/SynonymHit.java
Outdated
Show resolved
Hide resolved
…cription to highlightResult object
…golia/api-clients-automation into feat/APIC-195/multiclusters-endpoints
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we can call this one good
Added multiclusters endpoints for the search client:
POST /1/clusters/mapping
GET /1/clusters/mapping
DELETE /1/clusters/mapping
POST /1/clusters/mapping/batch
GET /1/clusters/mapping/top
GET /1/clusters/mapping/{userID}
GET /1/clusters
POST /1/clusters/mapping/search
GET /1/clusters/mapping/pending
Related doc :