# Ragic API Documentation / Ragic API 文件
# https://www.ragic.com/ai.txt
#
# This file helps AI assistants and LLMs find machine-readable API documentation.
# 此檔案協助 AI 助理與 LLM 找到機器可讀的 API 文件。

# ===================
# HTTP API / HTTP API
# ===================

# English Documentation
OpenAPI-EN: https://www.ragic.com/docs/api/en/ragic-api.yaml
Docs-EN: https://www.ragic.com/docs/api/en/
Markdown-EN: https://www.ragic.com/docs/api/markdown/en/
Cheatsheet-EN: https://www.ragic.com/docs/api/API_CHEATSHEET.md

# 繁體中文文件
OpenAPI-TW: https://www.ragic.com/docs/api/zh-TW/ragic-api.yaml
Docs-TW: https://www.ragic.com/docs/api/zh-TW/
Markdown-TW: https://www.ragic.com/docs/api/markdown/zh-TW/
Cheatsheet-TW: https://www.ragic.com/docs/api/API_CHEATSHEET_zh-TW.md

# =======================================
# JavaScript Workflow / JavaScript 工作流程
# =======================================

# English Documentation
Workflow-Docs-EN: https://www.ragic.com/docs/workflow/en/
Workflow-Markdown-EN: https://www.ragic.com/docs/workflow/markdown/en/

# 繁體中文文件
Workflow-Docs-TW: https://www.ragic.com/docs/workflow/zh-TW/
Workflow-Markdown-TW: https://www.ragic.com/docs/workflow/markdown/zh-TW/

# Quick Reference / 快速參考
# ----------------------------
#
# HTTP API:
#   Base URL: https://www.ragic.com
#   Endpoints:
#     GET  /{apname}{path}/{sheetIndex}                  - List records / 列出資料
#     GET  /{apname}{path}/{sheetIndex}/{rootNodeId}     - Get single record / 取得單筆資料
#     POST /{apname}{path}/{sheetIndex}                  - Create record / 新增資料
#     POST /{apname}{path}/{sheetIndex}/{rootNodeId}     - Update record / 更新資料
#     GET  /{apname}{path}/{sheetIndex}?def              - Form definition / 表單定義
#     GET  /{apname}{path}/{sheetIndex}/metadata/schema  - Field schema / 欄位結構
#   Authentication / 認證: HTTP Basic Auth
#     Username: user email / 使用者電子郵件
#     Password: API key (from account settings) / API 金鑰（從帳號設定取得）
#   Version: V3 (current) / 版本：V3（目前）
#
# JavaScript Workflow:
#   Engine: Nashorn (ECMAScript 5.1)
#   Objects: db, query, entry, param, response, user, account, mailer, util, log, approval
#   Types: Pre-workflow, Post-workflow, Daily, Action Button, Approval, Global
#   引擎：Nashorn (ECMAScript 5.1)
#   物件：db, query, entry, param, response, user, account, mailer, util, log, approval
#   類型：前置工作流程、後置工作流程、每日工作流程、動作按鈕、簽核工作流程、全域工作流程