feat(spec): add Predict client #129
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
added 22 commits
January 31, 2022 17:12
…utomation into feat/predict-pilot
shortcuts
reviewed
Feb 10, 2022
| content: | ||
| application/json: | ||
| schema: | ||
| title: params |
There was a problem hiding this comment.
methodNameParams is more descriptive and less likely to have duplicate conflict
Suggested change
| title: params | |
| title: fetchUserProfileParams |
There was a problem hiding this comment.
I used the name params to have a cleaner DX, since the requestBody params are currently merged in a single object. So we can have:
const userProfile = await predictClient.fetchUserProfile({
userId: 'user1',
params: { modelsToRetrieve: [], typesToRetrieve: [] },
});
instead of
const userProfile = await predictClient.fetchUserProfile({
userId: 'user1',
fetchUserProfileParams: { modelsToRetrieve: [], typesToRetrieve: [] },
});
There was a problem hiding this comment.
We plan to flatten this nested object anyway so it's not a big deal if not done now, but I wanted to point it.
The JS client have separated clients, while other languages only have algoliasearch, which can cause duplicate if the generated Params type is used elsewhere, or if an other method uses the same naming logic.
clients/algoliasearch-client-javascript/client-predict/git_push.sh
Outdated
Show resolved
Hide resolved
|
Semantic PR title should be edit: sorry it's |
anghelalexandra
changed the title
shortcuts
previously approved these changes
Feb 11, 2022
shortcuts
approved these changes
Feb 11, 2022
shortcuts
added a commit
that referenced
this pull request
Apr 22, 2022
* Fetch user profile endpoint * Fix errors * Add Javascript client * Update configuration * Add JavaScript API client * Fetch user profile endpoint * Fix errors * Add Javascript client * Add JavaScript API client * Fix configuration * Remove old files * Remove long descriptions * Clean up old files, regenerate client * Disable enum validation * Update request body to remove InlineObject name * Remove old file * Update requestBody name * Add 400 error * Add example * Update example and config files * Remove duplicate error spec, formatting * Remove git push file * Fix error base path * Remove extra empty lines * regenerate and fix host edge case * Add response titles, regenerate client * update clients/README.md Co-authored-by: Clément Vannicatte <[email protected]> Co-authored-by: Clément Vannicatte <[email protected]>
This was referenced May 24, 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
Predict JavaScript client for pilot phase, useful for creating demos and UI components.
🎟 JIRA Tickets: https://algolia.atlassian.net/browse/PRED-142, https://algolia.atlassian.net/browse/PRED-138
Changes included:
Create Predict client & spec, only the endpoint for reading the user profile for now. The API URL will be changed in the future once a more stable version of the API will be released.