@opengis/cms 0.0.2 → 0.0.3

package/docs/api/category/cms.category.list.md

@@ -0,0 +1,77 @@
+# `GET` cms-category
+
+## Опис
+
+Повертає список
+
+```example
+/api/cms-category
+```
+
+## Параметри
+
+```scheme-api
+/api/cms-category?id={id}
+```
+
+:::tabs
+
+== query
+
+| Назва | Тип    | Опис          |
+| ----- | ------ | ------------- |
+| id    | String | Ідентифікатор |
+
+:::
+
+## Відповідь
+
+::: tabs
+==200
+
+:::details Приклад відповіді
+
+```json
+{
+  "total": 2,
+  "rows": [
+    {
+      "id": "3577962879690737064",
+      "category_id": "3577962879690737064",
+      "title": "Категорія 1",
+      "url": null,
+      "lang": "uk",
+      "template": null,
+      "type": "1",
+      "parent": null,
+      "prefix": null,
+      "uid": "1",
+      "cdate": "2025-02-28 14:40:34.647636",
+      "editor_id": null,
+      "editor_date": null
+    },
+    {
+      "id": "testCategory",
+      "category_id": "testCategory",
+      "title": "Категорія 2",
+      "url": null,
+      "lang": "en",
+      "template": null,
+      "type": "1",
+      "parent": null,
+      "prefix": null,
+      "uid": "1",
+      "cdate": "2025-02-28 14:46:27.857494",
+      "editor_id": null,
+      "editor_date": "2025-02-28 14:46:27.96942"
+    }
+  ]
+}
+
+```
+
+==500
+```
+ServerError
+```
+:::

package/docs/api/category/cms.category.post.md

@@ -0,0 +1,62 @@
+# `POST` cms-category
+
+## Опис
+
+Створює запис
+
+```example
+/api/cms-category
+```
+
+## Запит
+
+:::details Приклад запиту
+
+```json
+{
+    "title": "Created value",
+    "url": null,
+    "lang": "ua",
+    "template": null,
+    "type": null,
+    "parent": null,
+    "prefix": null,
+}
+```
+:::
+
+
+## Відповідь
+
+::: tabs
+==200
+
+:::details Приклад відповіді
+
+```json
+{
+  "id": "testCategory",
+  "rows": [
+    {
+      "category_id": "testCategory",
+      "title": "Created value",
+      "url": null,
+      "lang": "en",
+      "template": "news",
+      "type": "1",
+      "parent": null,
+      "prefix": null,
+      "uid": "1",
+      "cdate": "2025-02-28 14:47:43.410737",
+      "editor_id": null,
+      "editor_date": "2025-02-28 14:47:43.410737"
+    }
+  ]
+}
+```
+
+==500
+```
+ServerError
+```
+:::

package/docs/api/category/cms.category.put.md

@@ -0,0 +1,78 @@
+# `PUT` cms-category/:id
+
+## Опис
+
+Редагує запис
+
+```example
+/api/cms-category/3577962879690737064
+```
+
+## Параметри
+
+```scheme-api
+/api/cms-category/:id
+```
+
+:::tabs
+
+== params
+
+| Назва | Тип    | Опис          |
+| ----- | ------ | ------------- |
+| id    | String | Ідентифікатор |
+
+:::
+
+## Запит
+
+:::details Приклад запиту
+
+```json
+{
+    "title": "Edited value",
+    "url": null,
+    "lang": "ua",
+    "template_id": null,
+    "type": null,
+    "parent": null,
+    "prefix": null,
+}
+```
+:::
+
+
+## Відповідь
+
+::: tabs
+==200
+
+:::details Приклад відповіді
+
+```json
+{
+  "id": "testCategory",
+  "rows": [
+    {
+      "category_id": "testCategory",
+      "title": "Edited value",
+      "url": null,
+      "lang": "en",
+      "template": "news",
+      "type": "1",
+      "parent": null,
+      "prefix": null,
+      "uid": "1",
+      "cdate": "2025-02-28 14:51:58.55249",
+      "editor_id": null,
+      "editor_date": "2025-02-28 14:51:58.754333"
+    }
+  ]
+}
+```
+
+==500
+```
+ServerError
+```
+:::

package/docs/api/index.md

@@ -0,0 +1,50 @@
+---
+order: 0
+---
+
+# Список API
+
+## Builder
+
+- **`GET` [cms-builder/:id](builder/cms.builder.get.md)** - Повертає об'єкт
+- **`GET` [cms-builder](builder/cms.builder.list.md)** - Повертає список
+- **`POST` [cms-builder](builder/cms.builder.post.md)** - Створює об'єкт.
+- **`PUT` [cms-builder/:id](builder/cms.builder.put.md)** - Редагує об'єкт.
+- **`DELETE` [cms-builder/:id](builder/cms.builder.delete.md)** - Видаляє об'єкт.
+
+## Category
+
+- **`GET` [cms-category/:id](category/cms.category.get.md)** - Повертає об'єкт
+- **`GET` [cms-category](category/cms.category.list.md)** - Повертає список
+- **`POST` [cms-category](category/cms.category.post.md)** - Створює об'єкт.
+- **`PUT` [cms-category/:id](category/cms.category.put.md)** - Редагує об'єкт.
+- **`DELETE` [cms-category/:id](category/cms.category.delete.md)** - Видаляє об'єкт.
+
+## Manager
+
+- **`GET` [cms-manager/:template/:id](manager/cms.manager.get.md)** - Повертає об'єкт
+- **`GET` [cms-manager/:template](manager/cms.manager.list.md)** - Повертає список
+- **`POST` [cms-manager/:template](manager/cms.manager.post.md)** - Створює об'єкт.
+- **`PUT` [cms-manager/:id](manager/cms.manager.put.md)** - Редагує об'єкт.
+- **`DELETE` [cms-manager/:id](manager/cms.manager.delete.md)** - Видаляє об'єкт.
+
+## Media
+
+- **`GET` [/cms-media](media/list.md)** - Повертає список файлів
+- **`POST` [/cms-media/:token](media/upload.md)** - Завантаження файлів / Створення директорій
+- **`PUT` [/cms-media/:token](media/edit.md)** - Перейменування директорій, редагування метаданих файлів
+- **`GET` [/cms-media-metadata/:token](media/metadata.md)** - Отримання метаданих файлу
+- **`GET` [/cms-media/:token](media/preview.md)** - Preview / download файлу
+- **`DELETE` [/cms-media/:token](media/del.md)** - Видалення директорій, файлів
+
+## Статус коди
+
+| Ключ                                                       | Опис                                                             |
+| ---------------------------------------------------------- | ---------------------------------------------------------------- |
+| <Badge type="code_2xx" text="200" /> Success               | Успішний запит                                                   |
+| <Badge type="code_4xx" text="400" /> Bad Request           | Неправильно сформований запит від клієнта                        |
+| <Badge type="code_4xx" text="401" /> Unauthorized          | API потребує аутентифікації                                      |
+| <Badge type="code_4xx" text="403" /> Forbidden             | Відмова запиту                                                   |
+| <Badge type="code_4xx" text="404" /> Not Found             | Інформації не знайдено                                           |
+| <Badge type="code_5xx" text="500" /> Internal Server Error | Помилка на стороні сервера                                       |
+| <Badge type="code_5xx" text="503" /> Service Unavailable   | Сервер тимчасово не може опрацьовувати запити з технічних причин |

package/docs/api/manager/cms.manager.delete.md

@@ -0,0 +1,64 @@
+# `DELETE` cms-manager/:id
+
+## Опис
+
+Видаляє запис
+
+```example
+/api/cms-manager/3577973636662822313
+```
+
+## Параметри
+
+```scheme-api
+/api/cms-manager/:id
+```
+
+:::tabs
+
+== params
+
+| Назва | Тип    | Опис          |
+| ----- | ------ | ------------- |
+| id    | String | Ідентифікатор |
+
+:::
+
+## Відповідь
+
+::: tabs
+==200
+
+:::details Приклад відповіді
+
+```json
+{
+  "id": "3577973636662822313",
+  "rows": [
+    {
+      "content_id": "3577973636662822313",
+      "key": null,
+      "url": "test1234",
+      "title": "Новина 1",
+      "template": "news",
+      "lang": "uk",
+      "body": "Запускаємо новий сайт ",
+      "category_id": "3577962879690737064",
+      "type_id": "3577955220287653286",
+      "enabled": true,
+      "status": "draft",
+      "review_status": "pending",
+      "uid": "1",
+      "cdate": "2025-02-28 15:01:56.976167",
+      "editor_id": null,
+      "editor_date": null
+    }
+  ]
+}
+```
+
+==500
+```
+ServerError
+```
+:::

package/docs/api/manager/cms.manager.get.md

@@ -0,0 +1,72 @@
+# `GET` cms-manager/:template/:id
+
+## Опис
+
+Повертає об'єкт за шаблоном та ідентифікатором
+
+```example
+/api/cms-manager/news/3577973636662822313
+```
+
+## Параметри
+
+```scheme-api
+/api/cms-manager/:template/:id
+```
+
+:::tabs
+
+== params
+
+| Назва    | Тип    | Опис          |
+| -------- | ------ | ------------- |
+| template | String | шаблоном      |
+| id       | String | Ідентифікатор |
+
+:::
+
+## Відповідь
+
+::: tabs
+==200
+
+:::details Приклад відповіді
+
+```json
+{
+  "total": 1,
+  "rows": [
+    {
+      "id": "3577973636662822313",
+      "content_id": "3577973636662822313",
+      "key": null,
+      "url": "test1234",
+      "title": "Новина 1",
+      "template": "news",
+      "lang": "uk",
+      "body": "Запускаємо новий сайт ",
+      "category_id": "3577962879690737064",
+      "type_id": "3577955220287653286",
+      "enabled": true,
+      "status": "draft",
+      "review_status": "pending",
+      "uid": "1",
+      "cdate": "2025-02-28 15:01:56.976167",
+      "editor_id": null,
+      "editor_date": null
+    }
+  ],
+  "type": {
+    "name": "Новини",
+    "template": "news",
+    "description": "Шаблон для новин",
+    "type": "collection"
+  }
+}
+```
+
+==500
+```
+ServerError
+```
+:::

package/docs/api/manager/cms.manager.list.md

@@ -0,0 +1,96 @@
+# `GET` cms-manager/:template
+
+## Опис
+
+Повертає список за шаблоном
+
+```example
+/api/cms-manager/news
+```
+
+## Параметри
+
+```scheme-api
+/api/cms-manager/:template
+```
+
+:::tabs
+
+== params
+
+| Назва | Тип    | Опис |
+| ----- | ------ | ---- |
+| template  | String | Шаблон  |
+
+:::
+
+## Відповідь
+
+::: tabs
+==200
+
+:::details Приклад відповіді
+
+```json
+{
+  "total": 2,
+  "rows": [
+    {
+      "id": "3577973636662822313",
+      "content_id": "3577973636662822313",
+      "key": null,
+      "url": "test1234",
+      "title": "Новина 1",
+      "template": "news",
+      "lang": "uk",
+      "body": "Запускаємо новий сайт ",
+      "category_id": "3577962879690737064",
+      "type_id": "3577955220287653286",
+      "enabled": true,
+      "status": "draft",
+      "review_status": "pending",
+      "uid": "1",
+      "cdate": "2025-02-28 15:01:56.976167",
+      "editor_id": null,
+      "editor_date": null,
+      "type": {
+        "name": "Новини",
+        "template": "news",
+        "description": "Шаблон для новин",
+        "type": "collection"
+      }
+    },
+    {
+      "id": "3582924136302773703",
+      "content_id": "3582924136302773703",
+      "key": null,
+      "url": null,
+      "title": "Новина 2",
+      "template": "news",
+      "lang": "uk",
+      "body": "Оновлення",
+      "category_id": "3577962879690737064",
+      "type_id": "3577880114538481061",
+      "enabled": true,
+      "status": "draft",
+      "review_status": "pending",
+      "uid": "1",
+      "cdate": "2025-03-07 10:57:42.524206",
+      "editor_id": null,
+      "editor_date": null,
+      "type": {
+        "name": "Новини",
+        "template": "news",
+        "description": "Шаблон для новин",
+        "type": "collection"
+      }
+    }
+  ]
+}
+```
+
+==500
+```
+ServerError
+```
+:::

package/docs/api/manager/cms.manager.post.md

@@ -0,0 +1,70 @@
+# `POST` cms-manager/:template
+
+## Опис
+
+Створює запис
+
+```example
+/api/cms-manager/news
+```
+
+## Запит
+
+:::details Приклад запиту
+
+```json
+{
+      "key": null,
+      "url": null,
+      "title": "Created value",
+      "lang": "uk",
+      "body": "Some Text",
+      "category_id": "3577962879690737064",
+      "type_id": "3577880114538481061",
+      "enabled": true,
+      "status": "1",
+      "review_status": "1",
+}
+```
+:::
+
+
+## Відповідь
+
+::: tabs
+==200
+
+:::details Приклад відповіді
+
+```json
+{
+  "id": "testContent",
+  "rows": [
+    {
+      "content_id": "testContent",
+      "key": null,
+      "url": null,
+      "title": "Created value",
+      "template": "news",
+      "lang": "uk",
+      "body": "Some Text",
+      "category_id": "3577962879690737064",
+      "type_id": "3577880114538481061",
+      "enabled": true,
+      "status": "1",
+      "review_status": "1",
+      "uid": "1",
+      "cdate": "2025-02-28 15:05:03.727722",
+      "editor_id": null,
+      "editor_date": "2025-02-28 15:05:03.727722"
+    }
+  ]
+}
+
+```
+
+==500
+```
+ServerError
+```
+:::

package/docs/api/manager/cms.manager.put.md

@@ -0,0 +1,86 @@
+# `PUT` cms-manager/:id
+
+## Опис
+
+Редагує запис
+
+```example
+/api/cms-manager/3577973636662822313
+```
+
+## Параметри
+
+```scheme-api
+/api/cms-manager/:id
+```
+
+:::tabs
+
+== params
+
+| Назва | Тип    | Опис          |
+| ----- | ------ | ------------- |
+| id    | String | Ідентифікатор |
+
+:::
+
+## Запит
+
+:::details Приклад запиту
+
+```json
+{
+      "key": null,
+      "url": null,
+      "title": "Edited value",
+      "template": "news",
+      "lang": "uk",
+      "body": "Some Text",
+      "category_id": "3577962879690737064",      //NOT NULL
+      "type_id": "3577880114538481061",          //NOT NULL
+      "enabled": true,
+      "status": "1",
+      "review_status": "1",
+}
+```
+:::
+
+
+## Відповідь
+
+::: tabs
+==200
+
+:::details Приклад відповіді
+
+```json
+{
+  "id": "testContent",
+  "rows": [
+    {
+      "content_id": "testContent",
+      "key": null,
+      "url": null,
+      "title": "Edited value",
+      "template": null,
+      "lang": "ua",
+      "body": null,
+      "category_id": "3577962879690737064",
+      "type_id": "3577880114538481061",
+      "enabled": true,
+      "status": "1",
+      "review_status": "1",
+      "uid": "1",
+      "cdate": "2025-02-28 15:06:54.912934",
+      "editor_id": null,
+      "editor_date": "2025-02-28 15:06:55.006947"
+    }
+  ]
+}
+```
+
+==500
+```
+ServerError
+```
+:::