feat(clients): add collections #5224
Conversation
🪓 The generated code will be pushed at the end of the CI.Action triggered by commit Please do not push any generated code to this pull request. |
dhayab
force-pushed
the
feat/clients-add-collections
branch
5 times, most recently
from
7f4b6dc to
e3f542b
Compare
dhayab
force-pushed
the
feat/clients-add-collections
branch
from
e3f542b to
2f29689
Compare
|
|
||
| The base URL for requests to the Collections API is: | ||
|
|
||
| - `https://experiences.algolia.com` |
There was a problem hiding this comment.
maybe
| - `https://experiences.algolia.com` | |
| - `https://experiences.algolia.com/1/collections` |
as in theory we use this endpoint for other things too
| # ############################# | ||
| # ### Collections Endpoints ### | ||
| # ############################# | ||
| /1/collections: |
| # ### Collections Endpoints ### | ||
| # ############################# | ||
| /1/collections: | ||
| $ref: 'paths/collections.yml' |
There was a problem hiding this comment.
is the yaml always based on the path? If not I think we should call this one list, next one upsert, third one commit makes sense
| title: getCollectionResponse | ||
| $ref: '../common/schemas/collection.yml#/Collection' | ||
|
|
||
| delete: |
There was a problem hiding this comment.
maybe unrelated, but really this is soft-deleting. I wonder if we could build in a "active" status in the collection separate from whether it's existing or not, and a separate endpoint that really deletes the collection. Maybe doesn't matter as we can use a different endpoint for that
| facetFilters: | ||
| $ref: '../../../common/schemas/SearchParams.yml#/facetFilters' | ||
| numericFilters: | ||
| $ref: '../../../common/schemas/SearchParams.yml#/numericFilters' |
There was a problem hiding this comment.
do we actually support everything? I think the no-code/go transformation didn't implement TO in numeric right?
🧭 What and Why
This PR creates a client and describes endpoints for the Collections API.
🎟 JIRA Ticket: FX-3433
Changes included:
🧪 Test