docs: add explanation on crud usage #3486
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
maximilianwerk
previously approved these changes
Sep 27, 2021
Codecov Report
@@ Coverage Diff @@
## master #3486 +/- ##
==========================================
- Coverage 90.12% 89.57% -0.56%
==========================================
Files 151 151
Lines 11070 11070
==========================================
- Hits 9977 9916 -61
- Misses 1093 1154 +61
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
Latency summaryCurrent PR yields:
Breakdown
Backed by latency-tracking. Further commits will update this comment. |
hanxiao
reviewed
Sep 27, 2021
hanxiao
previously approved these changes
Sep 27, 2021
|
@hanxiao Headers need to be in Title Case, afaik. https://en.wikipedia.org/wiki/Title_case Also, the commit message is invalid |
c7ca77c to
1c71db8
Compare
|
@hanxiao Fixed. Please re-approve |
|
📝 Docs are deployed on https://docs-crud-endpoints--jina-docs.netlify.app 🎉 |
alexcg1
requested changes
Sep 27, 2021
| | **D**elete | `/delete` | Storage | | ||
|
|
||
| The Create, Update, Delete are implemented by the Storage Indexers, while the Read operation is implemented in the `/search` endpoints in the Search Indexers. | ||
| The `/search` endpoints do not correspond perfectly with the Read operation, as it _searches_ for sim 8000 ilar results, and not return a specific Document by id. |
| | **U**pdate | `/update` | Storage | | ||
| | **D**elete | `/delete` | Storage | | ||
|
|
||
| The Create, Update, Delete are implemented by the Storage Indexers, while the Read operation is implemented in the `/search` endpoints in the Search Indexers. |
|
|
||
| The Create, Update, Delete are implemented by the Storage Indexers, while the Read operation is implemented in the `/search` endpoints in the Search Indexers. | ||
| The `/search` endpoints do not correspond perfectly with the Read operation, as it _searches_ for similar results, and not return a specific Document by id. | ||
| Some Storage Indexers do implement a `/fill_embedding` endpoint, which function as a Read by id. |
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.
This is required in order to explain what a Storage vs Searcher implements (generally).