Skip to content

Commit ab908a7

Browse files
committed
Update README with info about meta in protocol
1 parent 9044180 commit ab908a7

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -196,6 +196,7 @@ The request from Manticore Search to Buddy is made in JSON format no matter how
196196
| `error` | An object containg information about error(error message, etc.) to be returned to the user, if any. |
197197
| `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 |
198198
| `version` | The maximum protocol version supported by the sender. |
199+
| `meta` | A JSON object containing additional information about the response or null. |
199200
200201
Example of the request:
201202
@@ -224,7 +225,8 @@ The response JSON structure:
224225
| `type` | Set to `json response` if the request type was `unknown json request` and `sql response` for `unknown sql request`. |
225226
| `message` | A JSON object potentially containing an `error` message for displaying and/or logging. This is what Manticore Search will forward to the end-user. |
226227
| `error_code` | An integer representing the HTTP error code which will be a part of the HTTP response to the user making a JSON over HTTP request. For SQL over HTTP/mysql communications, this field is ignored. |
227-
| `version` | Indicates the current protocol version being used. Currently version is 2. |
228+
| `version` | The maximum protocol version supported by the sender. |
229+
| `meta` | A JSON object containing additional information about the response or null. |
228230
229231
230232
Example of HTTP Response:
@@ -251,6 +253,9 @@ Example of HTTP Response:
251253
"b": "abc"
252254
},
253255
"error_code": 0,
256+
"meta": {
257+
...
258+
},
254259
"version": 3
255260
}
256261
```
@@ -317,6 +322,9 @@ Example of MySQL Response:
317322
}
318323
],
319324
"error_code": 0,
325+
"meta": {
326+
...
327+
},
320328
"version": 3
321329
}
322330
```

0 commit comments

Comments
 (0)