@opengis/fastify-table 1.1.46 → 1.1.47

package/docs/api/widget/widget.get.md

@@ -0,0 +1,233 @@
+# `GET` WIDGET
+
+## Опис
+
+Отримання даних віджету по id
+
+```example
+/api/widget/comment/1
+```
+
+## Параметри
+
+```scheme-api
+/api/widget/:type/:id
+```
+
+::: tabs
+
+===params
+
+| Назва | Тип    | Опис          |
+| ----- | ------ | ------------- |
+| type | String | Віджет       |
+| id | String | ID об'єкту       |
+
+:::
+
+## Віджети
+
+- comment
+- history
+- checklist
+- file
+- gallery
+
+## Відповідь
+
+::: details comment
+
+```json
+{
+    "time": {
+        "data": 13,
+        "format": 5
+    },
+    "rows": [
+        {
+            "body": "body",
+            "cdate": "2024-05-03T09:23:01.336Z",
+            "comment_id": "3359796548786455946",
+            "object_id": "1",
+            "uid": "0",
+            "username": "  ",
+            "avatar": null
+        }
+    ],
+    "user": {
+        "uid": "1"
+    },
+    "data": {
+        "author": "",
+        "cdate": "2022-08-03T04:41:00.000Z",
+        "edate": "2023-05-26T13:57:06.235Z"
+    },
+    "objectid": "1"
+}
+```
+
+:::
+
+::: details history
+
+```json
+{
+    "time": {
+        "data": 2,
+        "format": 2
+    },
+    "rows": [
+        {
+            "object_id": "1",
+            "table_name": "gis.dataset",
+            "change_key": "1",
+            "change_date": null,
+            "json_old": null,
+            "json_new": null,
+            "date_old": null,
+            "date_new": null,
+            "number_old": null,
+            "number_new": null,
+            "bool_old": null,
+            "bool_new": null,
+            "text_old": null,
+            "text_new": null,
+            "uid": null,
+            "cdate": "2024-05-03T08:27:49.476Z"
+        }
+    ],
+    "user": {
+        "uid": "1"
+    },
+    "data": {
+    "author": "",
+    "cdate": "2022-08-03T04:41:00.000Z",
+    "edate": "2023-05-26T13:57:06.235Z"
+    },
+    "objectid": "1"
+}
+```
+
+:::
+
+::: details checklist
+
+```json
+{
+    "time": {
+        "data": 3,
+        "format": 2
+    },
+    "rows": [
+        {
+            "checklist_id": "3359774917577934117",
+            "title": null,
+            "is_done": false,
+            "done_date": null,
+            "uid": "0",
+            "cdate": "2024-05-03T08:40:02.695Z",
+            "username": "  ",
+            "avatar": null
+        }
+    ],
+    "user": {
+        "uid": "1"
+    },
+    "data": {
+    "author": "",
+    "cdate": "2022-08-03T04:41:00.000Z",
+    "edate": "2023-05-26T13:57:06.235Z"
+    },
+    "objectid": "1"
+}
+```
+
+:::
+
+::: details file
+
+```json
+{
+    "time": {
+        "data": 6,
+        "format": 10
+    },
+    "rows": [
+        {
+            "file_id": "3359776025234900264",
+            "file_path": "/files/uploads/2024-05-01/52a452addac501a8ffe7dc301.png",
+            "uploaded_name": null,
+            "ext": "png",
+            "size": "9923",
+            "uid": null,
+            "cdate": "2024-05-01T08:11:55.734Z",
+            "file_type": null,
+            "ismain": null,
+            "username": "  ",
+            "isverified": null,
+            "avatar": null,
+            "author": null,
+            "file_status": "1"
+        }
+    ],
+    "user": {
+        "uid": "1"
+    },
+    "data": {
+        "author": "",
+        "cdate": "2022-08-03T04:41:00.000Z",
+        "edate": "2023-05-26T13:57:06.235Z"
+        },
+    "objectid": "1"
+}
+```
+
+:::
+
+::: details gallery
+
+```json
+{
+    "time": {
+        "data": 6,
+        "format": 10
+    },
+    "rows": [
+        {
+            "file_id": "3359776025234900264",
+            "file_path": "/files/uploads/2024-05-01/52a452addac501a8ffe7dc301.png",
+            "uploaded_name": null,
+            "ext": "png",
+            "size": "9923",
+            "uid": null,
+            "cdate": "2024-05-01T08:11:55.734Z",
+            "file_type": null,
+            "ismain": null,
+            "username": "  ",
+            "isverified": null,
+            "avatar": null,
+            "author": null,
+            "file_status": "1"
+        }
+    ],
+    "user": {
+        "uid": "1"
+    },
+    "data": {
+    "author": "",
+    "cdate": "2022-08-03T04:41:00.000Z",
+    "edate": "2023-05-26T13:57:06.235Z"
+    },
+    "objectid": "1"
+}
+```
+
+:::
+
+## Статус коди
+
+| Ключ                                                       | Опис                                      |
+| ---------------------------------------------------------- | ----------------------------------------- |
+| <Badge type="code_2xx" text="200" /> Success               | Успішний запит                            |
+| <Badge type="code_4xx" text="404" /> Not Found             | Інформації не знайдено                    |
+| <Badge type="code_5xx" text="500" /> Internal Server Error | Помилка на стороні сервера                |

package/docs/api/widget/widget.set.md

@@ -0,0 +1,88 @@
+# `POST` WIDGET
+
+## Опис
+
+Внесення / оновлення даних віджету
+
+За наявності параметру `id` виконується оновлення існуючого запису в БД
+
+Структура body має відповідати структурі таблиці, що використовується у віджеті
+
+Віджет gallery використовує ту ж таблицю, що й віджет file, проте наявні обмеження по розширенню завантажуваних файлів
+
+Перелік підтримуваних розширень файлі віджету gallery:
+
+- png
+- svg
+- jpg
+- jpeg
+- gif
+- mp4
+- mov
+- avi
+
+```example
+/api/widget/comment/1
+```
+
+## Параметри
+
+```scheme-api
+/api/widget/:type/:id?
+```
+
+::: tabs
+
+===params
+
+| Назва | Тип    | Опис          |
+| ----- | ------ | ------------- |
+| type | String | Віджет         |
+| id | String | ID об'єкту       |
+
+:::
+
+## Віджети
+
+- comment
+- history
+- checklist
+- file
+- gallery
+
+## Відповідь
+
+::: tabs
+
+==200
+::: details Приклад відповіді
+
+```json
+{
+    "rowCount": 1,
+    "data": "ok",
+    "command": "INSERT",
+    "id": "3374171120805611106",
+    "entity_id": "3064823525807228447"
+}
+```
+
+==403
+
+```text
+access restricted
+```
+
+:::
+
+## Статус коди
+
+| Ключ                                                       | Опис                                      |
+| ---------------------------------------------------------- | ----------------------------------------- |
+| <Badge type="code_2xx" text="200" /> Success               | Успішний запит                            |
+| <Badge type="code_4xx" text="404" /> Not Found             | Інформації не знайдено                    |
+| <Badge type="code_5xx" text="500" /> Internal Server Error | Помилка на стороні сервера                |
+
+## Посилання
+
+- [Опис таблиць віджетів](db.md)