Merge branch 'feature/instruction' into 'master'

feature/instruction See merge request hrbox-public/api!14
2025-03-06 07:53:04 +00:00
parent e00a6e295b 458339cf62
commit 3d17ad10a9
1 changed files with 77 additions and 0 deletions
@@ -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: