refactor(docs): Remove root + move api ref files into api-reference/r…

…eference
TracecatHQ · Jun 8, 2024 · ccf1876 · ccf1876
1 parent 26b0951
commit ccf1876
Show file tree

Hide file tree

Showing 67 changed files with 64 additions and 82 deletions.
diff --git a/...i-reference/actions/create-action-run.mdx → ...e/reference/actions/create-action-run.mdx b/...i-reference/actions/create-action-run.mdx → ...e/reference/actions/create-action-run.mdx
diff --git a/docs/api-reference/actions/create-action.mdx → ...rence/reference/actions/create-action.mdx b/docs/api-reference/actions/create-action.mdx → ...rence/reference/actions/create-action.mdx
diff --git a/docs/api-reference/actions/delete-action.mdx → ...rence/reference/actions/delete-action.mdx b/docs/api-reference/actions/delete-action.mdx → ...rence/reference/actions/delete-action.mdx
diff --git a/.../api-reference/actions/get-action-run.mdx → ...ence/reference/actions/get-action-run.mdx b/.../api-reference/actions/get-action-run.mdx → ...ence/reference/actions/get-action-run.mdx
diff --git a/docs/api-reference/actions/get-action.mdx → ...eference/reference/actions/get-action.mdx b/docs/api-reference/actions/get-action.mdx → ...eference/reference/actions/get-action.mdx
diff --git a/...pi-reference/actions/list-action-runs.mdx → ...ce/reference/actions/list-action-runs.mdx b/...pi-reference/actions/list-action-runs.mdx → ...ce/reference/actions/list-action-runs.mdx
diff --git a/docs/api-reference/actions/list-actions.mdx → ...erence/reference/actions/list-actions.mdx b/docs/api-reference/actions/list-actions.mdx → ...erence/reference/actions/list-actions.mdx
diff --git a/...i-reference/actions/update-action-run.mdx → ...e/reference/actions/update-action-run.mdx b/...i-reference/actions/update-action-run.mdx → ...e/reference/actions/update-action-run.mdx
diff --git a/docs/api-reference/actions/update-action.mdx → ...rence/reference/actions/update-action.mdx b/docs/api-reference/actions/update-action.mdx → ...rence/reference/actions/update-action.mdx
diff --git a/...pi-reference/cases/create-case-action.mdx → ...ce/reference/cases/create-case-action.mdx b/...pi-reference/cases/create-case-action.mdx → ...ce/reference/cases/create-case-action.mdx
diff --git a/...i-reference/cases/create-case-context.mdx → ...e/reference/cases/create-case-context.mdx b/...i-reference/cases/create-case-context.mdx → ...e/reference/cases/create-case-context.mdx
diff --git a/...api-reference/cases/create-case-event.mdx → ...nce/reference/cases/create-case-event.mdx b/...api-reference/cases/create-case-event.mdx → ...nce/reference/cases/create-case-event.mdx
diff --git a/docs/api-reference/cases/create-case.mdx → ...reference/reference/cases/create-case.mdx b/docs/api-reference/cases/create-case.mdx → ...reference/reference/cases/create-case.mdx
diff --git a/...pi-reference/cases/delete-case-action.mdx → ...ce/reference/cases/delete-case-action.mdx b/...pi-reference/cases/delete-case-action.mdx → ...ce/reference/cases/delete-case-action.mdx
diff --git a/...i-reference/cases/delete-case-context.mdx → ...e/reference/cases/delete-case-context.mdx b/...i-reference/cases/delete-case-context.mdx → ...e/reference/cases/delete-case-context.mdx
diff --git a/docs/api-reference/cases/get-case-event.mdx → ...erence/reference/cases/get-case-event.mdx b/docs/api-reference/cases/get-case-event.mdx → ...erence/reference/cases/get-case-event.mdx
diff --git a/.../api-reference/cases/get-case-metrics.mdx → ...ence/reference/cases/get-case-metrics.mdx b/.../api-reference/cases/get-case-metrics.mdx → ...ence/reference/cases/get-case-metrics.mdx
diff --git a/docs/api-reference/cases/get-case.mdx → ...pi-reference/reference/cases/get-case.mdx b/docs/api-reference/cases/get-case.mdx → ...pi-reference/reference/cases/get-case.mdx
diff --git a/...api-reference/cases/list-case-actions.mdx → ...nce/reference/cases/list-case-actions.mdx b/...api-reference/cases/list-case-actions.mdx → ...nce/reference/cases/list-case-actions.mdx
diff --git a/...pi-reference/cases/list-case-contexts.mdx → ...ce/reference/cases/list-case-contexts.mdx b/...pi-reference/cases/list-case-contexts.mdx → ...ce/reference/cases/list-case-contexts.mdx
diff --git a/.../api-reference/cases/list-case-events.mdx → ...ence/reference/cases/list-case-events.mdx b/.../api-reference/cases/list-case-events.mdx → ...ence/reference/cases/list-case-events.mdx
diff --git a/docs/api-reference/cases/list-cases.mdx → ...-reference/reference/cases/list-cases.mdx b/docs/api-reference/cases/list-cases.mdx → ...-reference/reference/cases/list-cases.mdx
diff --git a/.../cases/streaming-autofill-case-fields.mdx → .../cases/streaming-autofill-case-fields.mdx b/.../cases/streaming-autofill-case-fields.mdx → .../cases/streaming-autofill-case-fields.mdx
diff --git a/docs/api-reference/cases/update-case.mdx → ...reference/reference/cases/update-case.mdx b/docs/api-reference/cases/update-case.mdx → ...reference/reference/cases/update-case.mdx
diff --git a/docs/api-reference/check-health.mdx → .../api-reference/reference/check-health.mdx b/docs/api-reference/check-health.mdx → .../api-reference/reference/check-health.mdx
diff --git a/docs/api-reference/events/search-events.mdx → ...erence/reference/events/search-events.mdx b/docs/api-reference/events/search-events.mdx → ...erence/reference/events/search-events.mdx
diff --git a/...api-reference/public/incoming-webhook.mdx → ...nce/reference/public/incoming-webhook.mdx b/...api-reference/public/incoming-webhook.mdx → ...nce/reference/public/incoming-webhook.mdx
diff --git a/docs/api-reference/secrets/create-secret.mdx → ...rence/reference/secrets/create-secret.mdx b/docs/api-reference/secrets/create-secret.mdx → ...rence/reference/secrets/create-secret.mdx
diff --git a/docs/api-reference/secrets/delete-secret.mdx → ...rence/reference/secrets/delete-secret.mdx b/docs/api-reference/secrets/delete-secret.mdx → ...rence/reference/secrets/delete-secret.mdx
diff --git a/docs/api-reference/secrets/get-secret.mdx → ...eference/reference/secrets/get-secret.mdx b/docs/api-reference/secrets/get-secret.mdx → ...eference/reference/secrets/get-secret.mdx
diff --git a/docs/api-reference/secrets/list-secrets.mdx → ...erence/reference/secrets/list-secrets.mdx b/docs/api-reference/secrets/list-secrets.mdx → ...erence/reference/secrets/list-secrets.mdx
diff --git a/.../api-reference/secrets/search-secrets.mdx → ...ence/reference/secrets/search-secrets.mdx b/.../api-reference/secrets/search-secrets.mdx → ...ence/reference/secrets/search-secrets.mdx
diff --git a/docs/api-reference/secrets/update-secret.mdx → ...rence/reference/secrets/update-secret.mdx b/docs/api-reference/secrets/update-secret.mdx → ...rence/reference/secrets/update-secret.mdx
diff --git a/...pi-reference/triggers/create-schedule.mdx → ...ce/reference/triggers/create-schedule.mdx b/...pi-reference/triggers/create-schedule.mdx → ...ce/reference/triggers/create-schedule.mdx
diff --git a/...api-reference/triggers/create-webhook.mdx → ...nce/reference/triggers/create-webhook.mdx b/...api-reference/triggers/create-webhook.mdx → ...nce/reference/triggers/create-webhook.mdx
diff --git a/...pi-reference/triggers/delete-schedule.mdx → ...ce/reference/triggers/delete-schedule.mdx b/...pi-reference/triggers/delete-schedule.mdx → ...ce/reference/triggers/delete-schedule.mdx
diff --git a/...api-reference/triggers/delete-webhook.mdx → ...nce/reference/triggers/delete-webhook.mdx b/...api-reference/triggers/delete-webhook.mdx → ...nce/reference/triggers/delete-webhook.mdx
diff --git a/docs/api-reference/triggers/get-schedule.mdx → ...rence/reference/triggers/get-schedule.mdx b/docs/api-reference/triggers/get-schedule.mdx → ...rence/reference/triggers/get-schedule.mdx
diff --git a/docs/api-reference/triggers/get-webhook.mdx → ...erence/reference/triggers/get-webhook.mdx b/docs/api-reference/triggers/get-webhook.mdx → ...erence/reference/triggers/get-webhook.mdx
diff --git a/...api-reference/triggers/list-schedules.mdx → ...nce/reference/triggers/list-schedules.mdx b/...api-reference/triggers/list-schedules.mdx → ...nce/reference/triggers/list-schedules.mdx
diff --git a/.../api-reference/triggers/list-webhooks.mdx → ...ence/reference/triggers/list-webhooks.mdx b/.../api-reference/triggers/list-webhooks.mdx → ...ence/reference/triggers/list-webhooks.mdx
diff --git a/...api-reference/triggers/update-webhook.mdx → ...nce/reference/triggers/update-webhook.mdx b/...api-reference/triggers/update-webhook.mdx → ...nce/reference/triggers/update-webhook.mdx
diff --git a/docs/api-reference/udfs/create-udf.mdx → ...i-reference/reference/udfs/create-udf.mdx b/docs/api-reference/udfs/create-udf.mdx → ...i-reference/reference/udfs/create-udf.mdx
diff --git a/docs/api-reference/udfs/get-udf.mdx → .../api-reference/reference/udfs/get-udf.mdx b/docs/api-reference/udfs/get-udf.mdx → .../api-reference/reference/udfs/get-udf.mdx
diff --git a/docs/api-reference/udfs/list-udfs.mdx → ...pi-reference/reference/udfs/list-udfs.mdx b/docs/api-reference/udfs/list-udfs.mdx → ...pi-reference/reference/udfs/list-udfs.mdx
diff --git a/.../api-reference/udfs/validate-udf-args.mdx → ...ence/reference/udfs/validate-udf-args.mdx b/.../api-reference/udfs/validate-udf-args.mdx → ...ence/reference/udfs/validate-udf-args.mdx
diff --git a/docs/api-reference/users/create-user.mdx → ...reference/reference/users/create-user.mdx b/docs/api-reference/users/create-user.mdx → ...reference/reference/users/create-user.mdx
diff --git a/docs/api-reference/users/delete-user.mdx → ...reference/reference/users/delete-user.mdx b/docs/api-reference/users/delete-user.mdx → ...reference/reference/users/delete-user.mdx
diff --git a/docs/api-reference/users/get-user.mdx → ...pi-reference/reference/users/get-user.mdx b/docs/api-reference/users/get-user.mdx → ...pi-reference/reference/users/get-user.mdx
diff --git a/docs/api-reference/users/update-user.mdx → ...reference/reference/users/update-user.mdx b/docs/api-reference/users/update-user.mdx → ...reference/reference/users/update-user.mdx
diff --git a/...i-reference/workflows/commit-workflow.mdx → ...e/reference/workflows/commit-workflow.mdx b/...i-reference/workflows/commit-workflow.mdx → ...e/reference/workflows/commit-workflow.mdx
diff --git a/...api-reference/workflows/copy-workflow.mdx → ...nce/reference/workflows/copy-workflow.mdx b/...api-reference/workflows/copy-workflow.mdx → ...nce/reference/workflows/copy-workflow.mdx
diff --git a/...ference/workflows/create-workflow-run.mdx → ...ference/workflows/create-workflow-run.mdx b/...ference/workflows/create-workflow-run.mdx → ...ference/workflows/create-workflow-run.mdx
diff --git a/...i-reference/workflows/create-workflow.mdx → ...e/reference/workflows/create-workflow.mdx b/...i-reference/workflows/create-workflow.mdx → ...e/reference/workflows/create-workflow.mdx
diff --git a/...i-reference/workflows/delete-workflow.mdx → ...e/reference/workflows/delete-workflow.mdx b/...i-reference/workflows/delete-workflow.mdx → ...e/reference/workflows/delete-workflow.mdx
diff --git a/...nce/workflows/get-workflow-definition.mdx → ...nce/workflows/get-workflow-definition.mdx b/...nce/workflows/get-workflow-definition.mdx → ...nce/workflows/get-workflow-definition.mdx
diff --git a/...-reference/workflows/get-workflow-run.mdx → .../reference/workflows/get-workflow-run.mdx b/...-reference/workflows/get-workflow-run.mdx → .../reference/workflows/get-workflow-run.mdx
diff --git a/.../api-reference/workflows/get-workflow.mdx → ...ence/reference/workflows/get-workflow.mdx b/.../api-reference/workflows/get-workflow.mdx → ...ence/reference/workflows/get-workflow.mdx
diff --git a/...eference/workflows/list-workflow-runs.mdx → ...eference/workflows/list-workflow-runs.mdx b/...eference/workflows/list-workflow-runs.mdx → ...eference/workflows/list-workflow-runs.mdx
diff --git a/...pi-reference/workflows/list-workflows.mdx → ...ce/reference/workflows/list-workflows.mdx b/...pi-reference/workflows/list-workflows.mdx → ...ce/reference/workflows/list-workflows.mdx
diff --git a/...erence/workflows/trigger-workflow-run.mdx → ...erence/workflows/trigger-workflow-run.mdx b/...erence/workflows/trigger-workflow-run.mdx → ...erence/workflows/trigger-workflow-run.mdx
diff --git a/...ference/workflows/update-workflow-run.mdx → ...ference/workflows/update-workflow-run.mdx b/...ference/workflows/update-workflow-run.mdx → ...ference/workflows/update-workflow-run.mdx
diff --git a/...i-reference/workflows/update-workflow.mdx → ...e/reference/workflows/update-workflow.mdx b/...i-reference/workflows/update-workflow.mdx → ...e/reference/workflows/update-workflow.mdx
diff --git a/.../workflows/upsert-workflow-definition.mdx → .../workflows/upsert-workflow-definition.mdx b/.../workflows/upsert-workflow-definition.mdx → .../workflows/upsert-workflow-definition.mdx
diff --git a/docs/api-reference/root.mdx b/docs/api-reference/root.mdx
diff --git a/docs/mint.json b/docs/mint.json
@@ -89,114 +89,113 @@
         {
           "group": "Reference",
           "pages": [
-            "api-reference/root",
-            "api-reference/check-health",
+            "api-reference/reference/check-health",
             {
               "group": "public",
               "pages": [
-                "api-reference/public/incoming-webhook"
+                "api-reference/reference/public/incoming-webhook"
               ]
             },
             {
               "group": "workflows",
               "pages": [
-                "api-reference/workflows/list-workflows",
-                "api-reference/workflows/create-workflow",
-                "api-reference/workflows/get-workflow",
-                "api-reference/workflows/update-workflow",
-                "api-reference/workflows/delete-workflow",
-                "api-reference/workflows/copy-workflow",
-                "api-reference/workflows/commit-workflow",
-                "api-reference/workflows/get-workflow-definition",
-                "api-reference/workflows/upsert-workflow-definition",
-                "api-reference/workflows/list-workflow-runs",
-                "api-reference/workflows/create-workflow-run",
-                "api-reference/workflows/get-workflow-run",
-                "api-reference/workflows/update-workflow-run",
-                "api-reference/workflows/trigger-workflow-run"
+                "api-reference/reference/workflows/list-workflows",
+                "api-reference/reference/workflows/create-workflow",
+                "api-reference/reference/workflows/get-workflow",
+                "api-reference/reference/workflows/update-workflow",
+                "api-reference/reference/workflows/delete-workflow",
+                "api-reference/reference/workflows/copy-workflow",
+                "api-reference/reference/workflows/commit-workflow",
+                "api-reference/reference/workflows/get-workflow-definition",
+                "api-reference/reference/workflows/upsert-workflow-definition",
+                "api-reference/reference/workflows/list-workflow-runs",
+                "api-reference/reference/workflows/create-workflow-run",
+                "api-reference/reference/workflows/get-workflow-run",
+                "api-reference/reference/workflows/update-workflow-run",
+                "api-reference/reference/workflows/trigger-workflow-run"
               ]
             },
             {
               "group": "triggers",
               "pages": [
-                "api-reference/triggers/list-webhooks",
-                "api-reference/triggers/create-webhook",
-                "api-reference/triggers/get-webhook",
-                "api-reference/triggers/delete-webhook",
-                "api-reference/triggers/update-webhook",
-                "api-reference/triggers/list-schedules",
-                "api-reference/triggers/create-schedule",
-                "api-reference/triggers/get-schedule",
-                "api-reference/triggers/delete-schedule"
+                "api-reference/reference/triggers/list-webhooks",
+                "api-reference/reference/triggers/create-webhook",
+                "api-reference/reference/triggers/get-webhook",
+                "api-reference/reference/triggers/delete-webhook",
+                "api-reference/reference/triggers/update-webhook",
+                "api-reference/reference/triggers/list-schedules",
+                "api-reference/reference/triggers/create-schedule",
+                "api-reference/reference/triggers/get-schedule",
+                "api-reference/reference/triggers/delete-schedule"
               ]
             },
             {
               "group": "actions",
               "pages": [
-                "api-reference/actions/list-actions",
-                "api-reference/actions/create-action",
-                "api-reference/actions/get-action",
-                "api-reference/actions/update-action",
-                "api-reference/actions/delete-action",
-                "api-reference/actions/list-action-runs",
-                "api-reference/actions/create-action-run",
-                "api-reference/actions/get-action-run",
-                "api-reference/actions/update-action-run"
+                "api-reference/reference/actions/list-actions",
+                "api-reference/reference/actions/create-action",
+                "api-reference/reference/actions/get-action",
+                "api-reference/reference/actions/update-action",
+                "api-reference/reference/actions/delete-action",
+                "api-reference/reference/actions/list-action-runs",
+                "api-reference/reference/actions/create-action-run",
+                "api-reference/reference/actions/get-action-run",
+                "api-reference/reference/actions/update-action-run"
               ]
             },
             {
               "group": "events",
               "pages": [
-                "api-reference/events/search-events"
+                "api-reference/reference/events/search-events"
               ]
             },
             {
               "group": "cases",
               "pages": [
-                "api-reference/cases/list-cases",
-                "api-reference/cases/create-case",
-                "api-reference/cases/get-case",
-                "api-reference/cases/update-case",
-                "api-reference/cases/list-case-events",
-                "api-reference/cases/create-case-event",
-                "api-reference/cases/get-case-event",
-                "api-reference/cases/get-case-metrics",
-                "api-reference/cases/list-case-actions",
-                "api-reference/cases/create-case-action",
-                "api-reference/cases/delete-case-action",
-                "api-reference/cases/list-case-contexts",
-                "api-reference/cases/create-case-context",
-                "api-reference/cases/delete-case-context",
-                "api-reference/cases/streaming-autofill-case-fields"
+                "api-reference/reference/cases/list-cases",
+                "api-reference/reference/cases/create-case",
+                "api-reference/reference/cases/get-case",
+                "api-reference/reference/cases/update-case",
+                "api-reference/reference/cases/list-case-events",
+                "api-reference/reference/cases/create-case-event",
+                "api-reference/reference/cases/get-case-event",
+                "api-reference/reference/cases/get-case-metrics",
+                "api-reference/reference/cases/list-case-actions",
+                "api-reference/reference/cases/create-case-action",
+                "api-reference/reference/cases/delete-case-action",
+                "api-reference/reference/cases/list-case-contexts",
+                "api-reference/reference/cases/create-case-context",
+                "api-reference/reference/cases/delete-case-context",
+                "api-reference/reference/cases/streaming-autofill-case-fields"
               ]
             },
             {
               "group": "users",
               "pages": [
-                "api-reference/users/get-user",
-                "api-reference/users/create-user",
-                "api-reference/users/update-user",
-                "api-reference/users/delete-user"
+                "api-reference/reference/users/get-user",
+                "api-reference/reference/users/create-user",
+                "api-reference/reference/users/update-user",
+                "api-reference/reference/users/delete-user"
               ]
             },
             {
               "group": "secrets",
               "pages": [
-                "api-reference/secrets/list-secrets",
-                "api-reference/secrets/create-secret",
-                "api-reference/secrets/update-secret",
-                "api-reference/secrets/get-secret",
-                "api-reference/secrets/delete-secret",
-                "api-reference/secrets/search-secrets"
+                "api-reference/reference/secrets/list-secrets",
+                "api-reference/reference/secrets/create-secret",
+                "api-reference/reference/secrets/update-secret",
+                "api-reference/reference/secrets/get-secret",
+                "api-reference/reference/secrets/delete-secret",
+                "api-reference/reference/secrets/search-secrets"
               ]
             },
             {
               "group": "udfs",
               "pages": [
-                "api-reference/udfs/list-udfs",
-                "api-reference/udfs/get-udf",
-                "api-reference/udfs/create-udf",
-                "api-reference/udfs/validate-udf-args"
+                "api-reference/reference/udfs/list-udfs",
+                "api-reference/reference/udfs/get-udf",
+                "api-reference/reference/udfs/create-udf",
+                "api-reference/reference/udfs/validate-udf-args"
               ]
             }
           ]

diff --git a/docs/openapi.yml b/docs/openapi.yml
@@ -20,20 +20,6 @@ info:
     url: https://www.gnu.org/licenses/agpl-3.0.html
   version: 0.1.0
 paths:
-  /:
-    get:
-      summary: Root
-      operationId: root__get
-      responses:
-        '200':
-          description: Successful Response
-          content:
-            application/json:
-              schema:
-                additionalProperties:
-                  type: string
-                type: object
-                title: Response Root  Get
   /health:
     get:
       summary: Check Health