From 458339cf6240dc1cbea0c49b9602edad5ffa0e4b Mon Sep 17 00:00:00 2001 From: mitrikov Date: Thu, 6 Mar 2025 17:30:40 +1200 Subject: [PATCH] =?UTF-8?q?feat:=20docs=20api=20=D0=BA=D0=BD=D0=BE=D0=BF?= =?UTF-8?q?=D0=BA=D0=B8=20=D0=B8=D0=BD=D1=81=D1=82=D1=80=D1=83=D0=BA=D1=86?= =?UTF-8?q?=D0=B8=D0=B8?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- v2/swagger.yaml | 77 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 77 insertions(+) diff --git a/v2/swagger.yaml b/v2/swagger.yaml index 5ed9407..08c5a5d 100644 --- a/v2/swagger.yaml +++ b/v2/swagger.yaml @@ -4424,6 +4424,83 @@ paths: 500: description: Server Error. + /instruction/index: + get: + tags: + - Instruction + summary: + Ссылки на инструкции + parameters: + - name: langId + description: "Id языка локализации. При отсутствии параметра будет использоваться langId пользователя" + in: query + schema: + type: string + responses: + 200: + description: "Ключи иструкций со ссылками" + content: + application/json: + schema: + type: object + properties: + data: + type: array + items: + type: object + properties: + key: + type: string + description: "Ключ иструкции" + value: + type: string + format: link + description: "Ссылка на инструкцию" + _links: + $ref: '#/components/schemas/_links' + _meta: + $ref: '#/components/schemas/_meta' + 400: + description: Bad Request. + 401: + description: Unauthorized request. + 403: + description: Unauthorized request. + + /instruction/view/{key}: + get: + tags: + - Instruction + summary: + Ссылка на иструкцию по ключу + parameters: + - name: key + description: "Ключ ссылки на инструкцию. В большинстве случаев соответствует пути в web-версии, напр /core/user/view -> CoreUserView" + in: path + schema: + type: string + responses: + 200: + description: Ключи иструкции со ссылкой + content: + application/json: + schema: + type: object + properties: + key: + type: string + description: "Ключ иструкции" + value: + type: string + format: link + description: "Ссылка на инструкцию" + 400: + description: Bad Request. + 401: + description: Unauthorized request. + 403: + description: Unauthorized request. + components: securitySchemes: SessionAuth: