Feature/Update API Docs README (FlowiseAI#3078)

* Add interactive swagger-ui auto-generated API docs from express

* Update README.md

* Update index.ts //@ts-ignore

* Fix eslint no-console error

* Add swagger paths

* Add all end  points

* Update swagger.yml

* update swagger yml file

* update swagger config

* update swagger response indentation

* update api-docs README

* update README

---------

Co-authored-by: Octavian FlowiseAI <154992625+ocflowiseai@users.noreply.github.com>

README.md

@@ -126,9 +126,9 @@ Flowise has 3 different modules in a single mono repository.
 
 6.  For development build:
 
-    - Create `.env` file and specify the `VITE_PORT` (refer to `.env.example`) in `packages/ui`
-    - Create `.env` file and specify the `PORT` (refer to `.env.example`) in `packages/server`
-    - Run
+    -   Create `.env` file and specify the `VITE_PORT` (refer to `.env.example`) in `packages/ui`
+    -   Create `.env` file and specify the `PORT` (refer to `.env.example`) in `packages/server`
+    -   Run
 
         ```bash
         pnpm dev
@@ -190,9 +190,9 @@ Deploy Flowise self-hosted in your existing infrastructure, we support various [
 
       </details>
 
-## 💻 Cloud Hosted
+## ☁️ Flowise Cloud
 
-Coming soon
+[Get Started with Flowise Cloud](https://flowiseai.com/)
 
 ## 🙋 Support
 

i18n/CONTRIBUTING-ZH.md

@@ -165,5 +165,3 @@ npx flowise start --PORT=3000 --DEBUG=true
 ## 🏷️ Pull Request 流程
 
 当您打开一个 Pull Request 时，FlowiseAI 团队的成员将自动收到通知/指派。您也可以在 [Discord](https://discord.gg/jbaHfsRVBW) 上联系我们。
-
-##

i18n/README-JA.md

@@ -180,9 +180,9 @@ Flowise は、インスタンスを設定するためのさまざまな環境変
 
       </details>
 
-## 💻 クラウドホスト
+## ☁️ クラウドホスト
 
-近日公開
+[Flowise Cloud の使い方を始める](https://flowiseai.com/)
 
 ## 🙋 サポート
 

i18n/README-KR.md

@@ -180,9 +180,9 @@ Flowise는 인스턴스 구성을 위한 다양한 환경 변수를 지원합니
 
       </details>
 
-## 💻 클라우드 호스팅 서비스
+## ☁️ 클라우드 호스팅 서비스
 
-곧 출시될 예정입니다.
+[Flowise Cloud 시작하기](https://flowiseai.com/)
 
 ## 🙋 기술 지원
 

i18n/README-ZH.md

@@ -180,9 +180,9 @@ Flowise 支持不同的环境变量来配置您的实例。您可以在 `package
 
       </details>
 
-## 💻 云托管
+## ☁️ 云托管
 
-即将推出
+[开始使用云托管](https://flowiseai.com/)
 
 ## 🙋 支持
 

packages/api-documentation/README-ZH.md

@@ -0,0 +1,33 @@
+<!-- markdownlint-disable MD030 -->
+
+# Flowise API 文档
+
+[English](./README.md) | 中文
+
+这是 Flowise 公共 API 的列表，允许用户以编程方式执行与 GUI 中相同的许多任务。
+
+独立运行：
+
+1. 启动 Flowise 服务器：
+    ```sh
+    cd Flowise
+    pnpm start
+    ```
+2. 启动 API 文档服务器：
+    ```sh
+    cd packages/api-documentation
+    pnpm start
+    ```
+
+开发模式下运行：
+
+```sh
+cd Flowise
+pnpm dev
+```
+
+文档将在此地址提供：http://localhost:6655/api-docs
+
+## 许可证
+
+此存储库中的源代码根据 Apache 2.0 许可证 提供

packages/api-documentation/README.md

@@ -0,0 +1,33 @@
+<!-- markdownlint-disable MD030 -->
+
+# Flowise API Docs
+
+English | [中文](./README-ZH.md)
+
+A list of Flowise public APIs, allowing users to programmatically execute many of the same tasks as the same in the GUI.
+
+To run this standalone:
+
+1. Spin up Flowise server:
+    ```sh
+    cd Flowise
+    pnpm start
+    ```
+2. Start API Docs server:
+    ```sh
+    cd packages/api-documentation
+    pnpm start
+    ```
+
+To run in dev mode:
+
+```sh
+cd Flowise
+pnpm dev
+```
+
+Docs will be served on: `http://localhost:6655/api-docs`
+
+## License
+
+Source code in this repository is made available under the [Apache License Version 2.0](https://github.com/FlowiseAI/Flowise/blob/master/LICENSE.md).

packages/api-documentation/src/yml/swagger.yml

@@ -280,17 +280,17 @@ paths:
                         schema:
                             $ref: '#/components/schemas/Assistant'
                 required: true
-        responses:
-            '200':
-                description: Assistant created successfully
-                content:
-                    application/json:
-                        schema:
-                            $ref: '#/components/schemas/Assistant'
-            '400':
-                description: Invalid input provided
-            '422':
-                description: Validation exception
+            responses:
+                '200':
+                    description: Assistant created successfully
+                    content:
+                        application/json:
+                            schema:
+                                $ref: '#/components/schemas/Assistant'
+                '400':
+                    description: Invalid input provided
+                '422':
+                    description: Validation exception
         get:
             tags:
                 - assistants

packages/server/README-ZH.md

@@ -47,25 +47,44 @@ npx flowise start --PORT=3000 --DEBUG=true
 
 ## 🌐 自托管
 
-### [Railway](https://docs.flowiseai.com/deployment/railway)
+在您现有的基础设施中部署自托管的 Flowise，我们支持各种[部署](https://docs.flowiseai.com/configuration/deployment)
 
-[![在Railway上部署](https://railway.app/button.svg)](https://railway.app/template/YK7J0v)
+-   [AWS](https://docs.flowiseai.com/deployment/aws)
+-   [Azure](https://docs.flowiseai.com/deployment/azure)
+-   [Digital Ocean](https://docs.flowiseai.com/deployment/digital-ocean)
+-   [GCP](https://docs.flowiseai.com/deployment/gcp)
+-   <details>
+      <summary>其他</summary>
 
-### [Render](https://docs.flowiseai.com/deployment/render)
+    -   [Railway](https://docs.flowiseai.com/deployment/railway)
 
-[![部署到Render](https://render.com/images/deploy-to-render-button.svg)](https://docs.flowiseai.com/deployment/render)
+        [![在 Railway 上部署](https://railway.app/button.svg)](https://railway.app/template/pn4G8S?referralCode=WVNPD9)
 
-### [AWS](https://docs.flowiseai.com/deployment/aws)
+    -   [Render](https://docs.flowiseai.com/deployment/render)
 
-### [Azure](https://docs.flowiseai.com/deployment/azure)
+        [![部署到 Render](https://render.com/images/deploy-to-render-button.svg)](https://docs.flowiseai.com/deployment/render)
 
-### [DigitalOcean](https://docs.flowiseai.com/deployment/digital-ocean)
+    -   [HuggingFace Spaces](https://docs.flowiseai.com/deployment/hugging-face)
 
-### [GCP](https://docs.flowiseai.com/deployment/gcp)
+        <a href="https://huggingface.co/spaces/FlowiseAI/Flowise"><img src="https://huggingface.co/datasets/huggingface/badges/raw/main/open-in-hf-spaces-sm.svg" alt="HuggingFace Spaces"></a>
 
-## 💻 云托管
+    -   [Elestio](https://elest.io/open-source/flowiseai)
 
-即将推出
+        [![Deploy](https://pub-da36157c854648669813f3f76c526c2b.r2.dev/deploy-on-elestio-black.png)](https://elest.io/open-source/flowiseai)
+
+    -   [Sealos](https://cloud.sealos.io/?openapp=system-template%3FtemplateName%3Dflowise)
+
+        [![部署到 Sealos](https://raw.githubusercontent.com/labring-actions/templates/main/Deploy-on-Sealos.svg)](https://cloud.sealos.io/?openapp=system-template%3FtemplateName%3Dflowise)
+
+    -   [RepoCloud](https://repocloud.io/details/?app_id=29)
+
+        [![部署到 RepoCloud](https://d16t0pc4846x52.cloudfront.net/deploy.png)](https://repocloud.io/details/?app_id=29)
+
+      </details>
+
+## ☁️ 云托管
+
+[开始使用云托管](https://flowiseai.com/)
 
 ## 🙋 支持
 

packages/server/README.md

@@ -60,25 +60,42 @@ pnpm run e2e
 
 ## 🌐 Self Host
 
-### [Railway](https://docs.flowiseai.com/deployment/railway)
+-   [AWS](https://docs.flowiseai.com/deployment/aws)
+-   [Azure](https://docs.flowiseai.com/deployment/azure)
+-   [Digital Ocean](https://docs.flowiseai.com/deployment/digital-ocean)
+-   [GCP](https://docs.flowiseai.com/deployment/gcp)
+-   <details>
+      <summary>Others</summary>
 
-[![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/template/YK7J0v)
+    -   [Railway](https://docs.flowiseai.com/deployment/railway)
 
-### [Render](https://docs.flowiseai.com/deployment/render)
+        [![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/template/pn4G8S?referralCode=WVNPD9)
 
-[![Deploy to Render](https://render.com/images/deploy-to-render-button.svg)](https://docs.flowiseai.com/deployment/render)
+    -   [Render](https://docs.flowiseai.com/deployment/render)
 
-### [AWS](https://docs.flowiseai.com/deployment/aws)
+        [![Deploy to Render](https://render.com/images/deploy-to-render-button.svg)](https://docs.flowiseai.com/deployment/render)
 
-### [Azure](https://docs.flowiseai.com/deployment/azure)
+    -   [HuggingFace Spaces](https://docs.flowiseai.com/deployment/hugging-face)
 
-### [DigitalOcean](https://docs.flowiseai.com/deployment/digital-ocean)
+        <a href="https://huggingface.co/spaces/FlowiseAI/Flowise"><img src="https://huggingface.co/datasets/huggingface/badges/raw/main/open-in-hf-spaces-sm.svg" alt="HuggingFace Spaces"></a>
 
-### [GCP](https://docs.flowiseai.com/deployment/gcp)
+    -   [Elestio](https://elest.io/open-source/flowiseai)
 
-## 💻 Cloud Hosted
+        [![Deploy on Elestio](https://elest.io/images/logos/deploy-to-elestio-btn.png)](https://elest.io/open-source/flowiseai)
 
-Coming Soon
+    -   [Sealos](https://cloud.sealos.io/?openapp=system-template%3FtemplateName%3Dflowise)
+
+        [![](https://raw.githubusercontent.com/labring-actions/templates/main/Deploy-on-Sealos.svg)](https://cloud.sealos.io/?openapp=system-template%3FtemplateName%3Dflowise)
+
+    -   [RepoCloud](https://repocloud.io/details/?app_id=29)
+
+        [![Deploy on RepoCloud](https://d16t0pc4846x52.cloudfront.net/deploy.png)](https://repocloud.io/details/?app_id=29)
+
+      </details>
+
+## ☁️ Flowise Cloud
+
+[Get Started with Flowise Cloud](https://flowiseai.com/)
 
 ## 🙋 Support