diff --git a/openapi.json b/openapi.json index 0191e04..c913f6c 100644 --- a/openapi.json +++ b/openapi.json @@ -73,7 +73,7 @@ "Values" ], "summary": "Get value", - "description": "Get value from storage. If no filter query specified any row is returned.\n", + "description": "Get value from storage. If no filter query specified any row is returned. \nWhen filtering by value, service queries not by exact match, but searching for the nearest by \nhammming distance element. Also take into account that value is Base64 encoded, so may contain \nsome escape symbol that should be encoded.\n", "operationId": "GetData", "parameters": [ { diff --git a/openapi.yaml b/openapi.yaml index b4bbc3e..a78f3c4 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -49,7 +49,10 @@ paths: - Values summary: Get value description: | - Get value from storage. If no filter query specified any row is returned. + Get value from storage. If no filter query specified any row is returned. + When filtering by value, service queries not by exact match, but searching for the nearest by + hammming distance element. Also take into account that value is Base64 encoded, so may contain + some escape symbol that should be encoded. operationId: GetData parameters: - $ref: '#/components/parameters/DataKeyParam'