From 7ed77ef128f80a15860b29868c41480bbd833337 Mon Sep 17 00:00:00 2001 From: mhrynenko Date: Tue, 24 Dec 2024 16:35:15 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20=20@=20ee79d?= =?UTF-8?q?dc00dd5e55ccb11d86b3a19782daf958951=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- openapi.json | 45 +++++++++++++++++++++++++++++++++++++++++++++ openapi.yaml | 30 ++++++++++++++++++++++++++++++ 2 files changed, 75 insertions(+) diff --git a/openapi.json b/openapi.json index c913f6c..8ab46c0 100644 --- a/openapi.json +++ b/openapi.json @@ -68,6 +68,51 @@ } } }, + "delete": { + "tags": [ + "Values" + ], + "summary": "Delete value", + "description": "Delete value from storage. If no filter query specified nothing is delete, because one of filters is required. \nWhen filtering by value, service queries not by exact match and if any value found deletes it. \nAlso take into account that value is Base64 encoded, so may contain some escape symbol that should be encoded.\n", + "operationId": "GetData", + "parameters": [ + { + "$ref": "#/components/parameters/DataKeyParam" + }, + { + "$ref": "#/components/parameters/DataValueParam" + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Value" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/invalidParameter" + }, + "404": { + "$ref": "#/components/responses/notFound" + }, + "500": { + "$ref": "#/components/responses/internalError" + } + } + }, "get": { "tags": [ "Values" diff --git a/openapi.yaml b/openapi.yaml index a78f3c4..c76e238 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -44,6 +44,36 @@ paths: $ref: '#/components/responses/notFound' '500': $ref: '#/components/responses/internalError' + delete: + tags: + - Values + summary: Delete value + description: | + Delete value from storage. If no filter query specified nothing is delete, because one of filters is required. + When filtering by value, service queries not by exact match and if any value found deletes it. + 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' + - $ref: '#/components/parameters/DataValueParam' + responses: + '200': + description: Success + content: + application/vnd.api+json: + schema: + type: object + required: + - data + properties: + data: + $ref: '#/components/schemas/Value' + '400': + $ref: '#/components/responses/invalidParameter' + '404': + $ref: '#/components/responses/notFound' + '500': + $ref: '#/components/responses/internalError' get: tags: - Values