Update README with info about meta in protocol #396
Conversation
This file contains 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
donhardman
force-pushed
the
doc/protocol-update
branch
from
ab908a7 to
28fb82a
Compare
sanikolaev
requested changes
Nov 13, 2024
| @@ -196,6 +196,7 @@ The request from Manticore Search to Buddy is made in JSON format no matter how | |||
| | `error` | An object containg information about error(error message, etc.) to be returned to the user, if any. | | |||
| | `message` | An object containing details such as `path_query` (specific to JSON over HTTP requests), `http_method` (`HEAD`, `GET`, etc) and `body` which holds the main content of the request. For JSON over HTTP, `path_query` can include specific endpoints like `_doc`, `_create`, etc., while for SQL over HTTP/mysql, it remains empty (`""`). `http_method` is set to `""` for SQL over HTTP/mysql | | |||
| | `version` | The maximum protocol version supported by the sender. | | |||
| | `meta` | A JSON object containing additional information about the response or null. | | |||
There was a problem hiding this comment.
I think it's important to mention the fields important for the daemon (for query logging and show meta).
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.
No description provided.