Skip to content
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(specs): add composition API #4056

Merged
merged 30 commits into from
Nov 6, 2024
Merged

feat(specs): add composition API #4056

merged 30 commits into from
Nov 6, 2024

Conversation

e-krebs
Copy link
Contributor

@e-krebs e-krebs commented Oct 30, 2024

🧭 What and Why

🎟 JIRA Ticket:

Changes included:

this pr adds a new package for the javascript client, for the composition API. we only provide an alpha version, in javascript for now, and will make it globally available (and in algoliasearch) once the stable version has been reached.

@e-krebs e-krebs self-assigned this Oct 30, 2024
@algolia-bot
Copy link
Collaborator

algolia-bot commented Oct 30, 2024

🪓 The generated code will be pushed at the end of the CI.

Action triggered by commit e7b454ece9efc99c74a5b9a7dd36e4af270ece57.

Please do not push any generated code to this pull request.

@shortcuts shortcuts changed the title Feat/composition-alpha feat(specs): add composition API Oct 30, 2024
@shortcuts
Copy link
Member

good @e-krebs everything should work once our testing app has been allowed to use composition, so that our e2e can runs

@e-krebs
Copy link
Contributor Author

e-krebs commented Oct 31, 2024

good @e-krebs everything should work once our testing app has been allowed to use composition, so that our e2e can runs

is it a metis App ?

@shortcuts
Copy link
Member

good @e-krebs everything should work once our testing app has been allowed to use composition, so that our e2e can runs

is it a metis App ?

nope, is it required? we could migrate it or make a new one

@e-krebs
Copy link
Contributor Author

e-krebs commented Oct 31, 2024

good @e-krebs everything should work once our testing app has been allowed to use composition, so that our e2e can runs

is it a metis App ?

nope, is it required? we could migrate it or make a new one

yes, it is required.
once you have a metis app it's fairly easy to activate composition

@shortcuts
Copy link
Member

good @e-krebs everything should work once our testing app has been allowed to use composition, so that our e2e can runs

is it a metis App ?

nope, is it required? we could migrate it or make a new one

yes, it is required. once you have a metis app it's fairly easy to activate composition

ok! i'll be off next week so I guess @millotp will be the point of contact to help setting those for the e2e

type: object
additionalProperties: false
properties:
index:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the search API and all the other spec, the property for an index name is always called indexName and not just index.
This is just a matter of consistency, I saw that in the composition spec indexName is also used

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree in theory, but this property is named index in the API itself, according to the documentation: https://algolia.atlassian.net/wiki/spaces/CMP/pages/5149753345/Models

@e-krebs e-krebs force-pushed the feat/composition-alpha branch from 725804d to ca7bbd8 Compare November 6, 2024 15:32
@e-krebs e-krebs marked this pull request as ready for review November 6, 2024 16:05
@e-krebs e-krebs requested a review from a team as a code owner November 6, 2024 16:05
@e-krebs e-krebs requested review from millotp and shortcuts November 6, 2024 16:05
Copy link
Collaborator

@millotp millotp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the contribution, let release a first version !

@millotp millotp merged commit a38ceec into main Nov 6, 2024
3 checks passed
@millotp millotp deleted the feat/composition-alpha branch November 6, 2024 16:19
algolia-bot added a commit that referenced this pull request Nov 6, 2024
Co-authored-by: Emmanuel Krebs <e-krebs@users.noreply.github.com>
Co-authored-by: shortcuts <vannicattec@gmail.com>
Co-authored-by: Pierre Millot <pierre.millot@algolia.com>
algolia-bot added a commit to algolia/algoliasearch-client-javascript that referenced this pull request Nov 6, 2024
algolia/api-clients-automation#4056

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Emmanuel Krebs <e-krebs@users.noreply.github.com>
Co-authored-by: shortcuts <vannicattec@gmail.com>
Co-authored-by: Pierre Millot <pierre.millot@algolia.com>
millotp added a commit that referenced this pull request Nov 18, 2024
Co-authored-by: shortcuts <vannicattec@gmail.com>
Co-authored-by: Pierre Millot <pierre.millot@algolia.com>
millotp added a commit that referenced this pull request Nov 18, 2024
Co-authored-by: Emmanuel Krebs <e-krebs@users.noreply.github.com>
Co-authored-by: shortcuts <vannicattec@gmail.com>
Co-authored-by: Pierre Millot <pierre.millot@algolia.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants