fix: Обновил описание метода /tag/index и добавил /tag/items

This commit is contained in:
Anton Pomorzin
2025-04-14 15:58:36 +05:00
parent a48ac40899
commit 332850e8e0
+160 -12
View File
@@ -4086,49 +4086,88 @@ paths:
get: get:
tags: tags:
- tag - tag
summary: Tags index. summary: Список тегов
description: |
Возвращает список тегов по указанным фильтрам.
Если передан один из параметров (root_id, category_id, use_category_recursion) то будут выбраны только те теги которые используются в элементах текущего каталога с проверкой прав на просмотр этих элементов для пользователя. Данный функционал работает с каталогами страниц, обучений и процессов.
operationId: /tag/index operationId: /tag/index
parameters: parameters:
- name: id - name: id
in: query in: query
description: Tag ID description: Можно передать несколько id, разделенных запятыми.
schema: schema:
type: string type: string
format: uuid format: uuid
example: "0b6a186a-95b8-4c89-8e69-6b49f12d1474" example: "0b6a186a-95b8-4c89-8e69-6b49f12d1474"
- name: name - name: name
in: query in: query
description: Name description: Название
schema: schema:
type: string type: string
example: Tag 1 example: Tag 1
- name: entity_id - name: entity_id
in: query in: query
schema: schema:
type: integer type: number
enum:
- 50
- 100
- 300
- 375
- 500
- 550
description: > description: >
Entity ID: Entity ID - Идентификатор сущности. Можно передать несколько идентификаторов, разделенных запятыми.
* `100` - Article * `50` - Category (Категории)
* `50` - Category * `100` - Article (Новости/Страницы)
* `300` - LmsContent (Обучения)
* `375` - Book (Книги)
* `500` - WfWorkflow (Процессы)
* `550` - Training (Тренинги)
- name: root_id - name: root_id
in: query in: query
description: Category Root ID description: >
Category Root ID - Тип каталога
* `1` - Каталог страниц
* `2` - Каталог обучения
* `4` - Каталог процессов
schema: schema:
type: string type: number
format: integer enum:
- 1
- 2
- 3
- name: category_id - name: category_id
in: query in: query
description: ID of the category from which to start selecting tags description: Идентификатор категории каталога, с которой начать выбор тегов
schema: schema:
type: string type: string
format: uuid format: uuid
example: "0b6a186a-95b8-4c89-8e69-6b49f12d1474" example: "0b6a186a-95b8-4c89-8e69-6b49f12d1474"
- name: use_category_recursion - name: use_category_recursion
in: query in: query
description: Tags will be selected for all nested categories starting from the specified Category_id. description: Если true - то теги будут выбраны для всех вложенных категорий, начиная с указанного Category_id, в ином случае будут показаны теги только для Category_id
schema: schema:
type: boolean type: boolean
format: true format: true
- name: sort
description: Сортировка тегов
in: query
schema:
type: string
enum:
- name
- name: per-page
in: query
description: Сколько элементов возвращается на одной странице (по умолчанию 50).
schema:
type: string
- name: page
in: query
description: Текущая страница
schema:
type: string
responses: responses:
200: 200:
description: Timezone objects. description: Timezone objects.
@@ -4156,6 +4195,115 @@ paths:
500: 500:
description: Server Error. description: Server Error.
/tag/items:
get:
tags:
- tag
summary: Список тегов
description: |
Возвращает список тегов по указанным фильтрам.
Если передан один из параметров (root_id, category_id, use_category_recursion) то будут выбраны только те теги которые используются в элементах текущего каталога с проверкой прав на просмотр этих элементов для пользователя. Данный функционал работает с каталогами страниц, обучений и процессов.
operationId: /tag/items
parameters:
- name: id
in: query
description: Можно передать несколько id, разделенных запятыми.
schema:
type: string
format: uuid
example: "0b6a186a-95b8-4c89-8e69-6b49f12d1474"
- name: name
in: query
description: Название
schema:
type: string
example: Tag 1
- name: entity_id
in: query
schema:
type: number
enum:
- 50
- 100
- 300
- 375
- 500
- 550
description: >
Entity ID - Идентификатор сущности. Можно передать несколько идентификаторов, разделенных запятыми.
* `50` - Category (Категории)
* `100` - Article (Новости/Страницы)
* `300` - LmsContent (Обучения)
* `375` - Book (Книги)
* `500` - WfWorkflow (Процессы)
* `550` - Training (Тренинги)
- name: root_id
in: query
description: >
Category Root ID - Тип каталога
* `1` - Каталог страниц
* `2` - Каталог обучения
* `4` - Каталог процессов
schema:
type: number
enum:
- 1
- 2
- 3
- name: category_id
in: query
description: Идентификатор категории каталога, с которой начать выбор тегов
schema:
type: string
format: uuid
example: "0b6a186a-95b8-4c89-8e69-6b49f12d1474"
- name: use_category_recursion
in: query
description: Если true - то теги будут выбраны для всех вложенных категорий, начиная с указанного Category_id, в ином случае будут показаны теги только для Category_id
schema:
type: boolean
format: true
- name: sort
description: Сортировка тегов
in: query
schema:
type: string
enum:
- name
- name: per-page
in: query
description: Сколько элементов возвращается на одной странице (по умолчанию 50).
schema:
type: string
- name: page
in: query
description: Текущая страница
schema:
type: string
responses:
200:
description: Timezone objects.
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/tag'
400:
description: Bad Request.
401:
description: Unauthorized.
403:
description: Unauthorized.
404:
description: Not found.
500:
description: Server Error.
/survey/index: /survey/index:
get: get:
tags: tags: