Merge branch 'feature/H-1473' into 'master'

feature/H-1473 See merge request hrbox-public/api!12
2025-01-15 06:45:20 +00:00
parent 66e4f289dd 9f708c2b57
commit 2ac3674545
1 changed files with 83 additions and 0 deletions
@@ -870,6 +870,15 @@ paths:
      summary: News index. Infinite scroll done by paginating with {page} parameter
      operationId: articleNews
      parameters:
+        - name: tag_id
+          in: query
+          description: Tags ID to filter news
+          schema:
+            type: array
+            items:
+              type: string
+              format: uuid
+          example: b726280a-2be6-4e62-ab24-1736389c6474
        - name: per-page
          in: query
          description: How many items return in one page (default 10).
@@ -4052,6 +4061,80 @@ paths:
        500:
          description: Server Error.

+  /tag/index:
+    get:
+      tags:
+        - tag
+      summary: Tags index.
+      operationId: /tag/index
+      parameters:
+        - name: id
+          in: query
+          description: Tag ID
+          schema:
+            type: string
+            format: uuid
+          example: "0b6a186a-95b8-4c89-8e69-6b49f12d1474"
+        - name: name
+          in: query
+          description: Name
+          schema:
+            type: string
+          example: Tag 1
+        - name: entity_id
+          in: query
+          schema:
+            type: integer
+          description: >
+            Entity ID:
+              * `100` - Article
+              * `50`  - Category
+        - name: root_id
+          in: query
+          description: Category Root ID
+          schema:
+            type: string
+            format: integer
+        - name: category_id
+          in: query
+          description: ID of the category from which to start selecting tags
+          schema:
+            type: string
+            format: uuid
+          example: "0b6a186a-95b8-4c89-8e69-6b49f12d1474"
+        - name: use_category_recursion
+          in: query
+          description: Tags will be selected for all nested categories starting from the specified Category_id.
+          schema:
+            type: boolean
+            format: true
+      responses:
+        200:
+          description: Timezone objects.
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  data:
+                    type: array
+                    items:
+                      $ref: '#/components/schemas/tag'
+                  _links:
+                    $ref: '#/components/schemas/_links'
+                  _meta:
+                    $ref: '#/components/schemas/_meta'
+        400:
+          description: Bad Request.
+        401:
+          description: Unauthorized.
+        403:
+          description: Unauthorized.
+        404:
+          description: Not found.
+        500:
+          description: Server Error.
+        
 components:
  securitySchemes:
    SessionAuth: