Update examples to REST CRUD interface
FionnD opened this issue · 13 comments
Maintenance
All our examples should be using the REST CRUD interface and not the /api/{mode}which is deprecated.
Acceptance Criteria
This ticket is done when: All 13 examples on the example repo are working correctly and using the REST CRUD interface.
[Updated by Fionn Friday 30th April]
The checklist for each of these would be:
- update Jina to 1.1.0 (if not already at that version or higher)
- modify flow yamls to enable REST API
- add
index_restmethod that indexes docs using the /index REST API - add
index_restas CLI option to-t(via click options) - change README to point towards
/search(NOT/api/search)
The checklist for each of these would be:
- update Jina to 1.1.0 (if not already at that version or higher)
- modify flow yamls to enable REST API
- add
index_restmethod that indexes docs using the /index REST API- add
index_restas CLI option to-t(via click options)- change README to point towards
/search(NOT/api/search)
Good point. @rutujasurve94 Let's start to update the examples.
I'm beginning work on this today onwards
@rutujasurve94 make sure to add the PRs to this issue's parent comment and check it off
I'm happy to take on pokedex since I'm looking at doing some work on it anyway
#465 closes Advanced Vector Search
#466 closes Cross Modal Search
#470 solves Multires Lyrics
#471 solves Object Search
#473 solves Pokedex with Bit
#469 solves Fashion Example
@cristianmtr @FionnD I suggest we hold on progressing this ticket because it will introduce quite a lot of duplicated codes in all the examples. Basically, this will require that all the examples load the files, wrap them up to an HTTP request and send to different APIs. This will make the examples even harder to maintain. I see the motivation is to show how to use RESTful API to do CRUD in jina, but I suggest to show this in one example instead of copy-paste to every example.