Merge pull request #1658 from Agenta-AI/AGE-221/-Docs/-Fix-the-backen…

…d-api-reference [Bug Fix]: Fixed server URL in openai.json configuration file
Agenta-AI · May 17, 2024 · d9240a3 · d9240a3
2 parents 5802b7a + ba32df8
commit d9240a3
Show file tree

Hide file tree

Showing 63 changed files with 62 additions and 67 deletions.
diff --git a/docs/mint.json b/docs/mint.json
@@ -159,78 +159,73 @@
       ]
     },
     {
-      "group": "Reference",
+      "group": "API Reference",
       "pages": [
-        {
-          "group": "Backend API",
-          "pages": [
-            "reference/reference/backend_api/user-profile",
-            "reference/reference/backend_api/list-app-variants",
-            "reference/reference/backend_api/get-variant-by-env",
-            "reference/reference/backend_api/list-apps",
-            "reference/reference/backend_api/create-app",
-            "reference/reference/backend_api/add-variant-from-image",
-            "reference/reference/backend_api/remove-app",
-            "reference/reference/backend_api/create-app-and-variant-from-template",
-            "reference/reference/backend_api/list-environments",
-            "reference/reference/backend_api/add-variant-from-base-and-config",
-            "reference/reference/backend_api/start-variant",
-            "reference/reference/backend_api/remove-variant",
-            "reference/reference/backend_api/update-variant-parameters",
-            "reference/reference/backend_api/update-variant-image",
-            "reference/reference/backend_api/fetch-list-evaluations",
-            "reference/reference/backend_api/create-evaluation",
-            "reference/reference/backend_api/delete-evaluations",
-            "reference/reference/backend_api/fetch-evaluation",
-            "reference/reference/backend_api/update-evaluation-router",
-            "reference/reference/backend_api/fetch-evaluation-scenarios",
-            "reference/reference/backend_api/create-evaluation-scenario",
-            "reference/reference/backend_api/update-evaluation-scenario-router",
-            "reference/reference/backend_api/evaluate-ai-critique",
-            "reference/reference/backend_api/get-evaluation-scenario-score-router",
-            "reference/reference/backend_api/update-evaluation-scenario-score-router",
-            "reference/reference/backend_api/fetch-results",
-            "reference/reference/backend_api/create-custom-evaluation",
-            "reference/reference/backend_api/update-custom-evaluation",
-            "reference/reference/backend_api/list-custom-evaluations",
-            "reference/reference/backend_api/get-custom-evaluation",
-            "reference/reference/backend_api/get-custom-evaluation-names",
-            "reference/reference/backend_api/execute-custom-evaluation",
-            "reference/reference/backend_api/webhook-example-fake",
-            "reference/reference/backend_api/upload-file",
-            "reference/reference/backend_api/import-testset",
-            "reference/reference/backend_api/create-testset",
+            "reference/api_docs/backend_api/user-profile",
+            "reference/api_docs/backend_api/list-app-variants",
+            "reference/api_docs/backend_api/get-variant-by-env",
+            "reference/api_docs/backend_api/list-apps",
+            "reference/api_docs/backend_api/create-app",
+            "reference/api_docs/backend_api/add-variant-from-image",
+            "reference/api_docs/backend_api/remove-app",
+            "reference/api_docs/backend_api/create-app-and-variant-from-template",
+            "reference/api_docs/backend_api/list-environments",
+            "reference/api_docs/backend_api/add-variant-from-base-and-config",
+            "reference/api_docs/backend_api/start-variant",
+            "reference/api_docs/backend_api/remove-variant",
+            "reference/api_docs/backend_api/update-variant-parameters",
+            "reference/api_docs/backend_api/update-variant-image",
+            "reference/api_docs/backend_api/fetch-list-evaluations",
+            "reference/api_docs/backend_api/create-evaluation",
+            "reference/api_docs/backend_api/delete-evaluations",
+            "reference/api_docs/backend_api/fetch-evaluation",
+            "reference/api_docs/backend_api/update-evaluation-router",
+            "reference/api_docs/backend_api/fetch-evaluation-scenarios",
+            "reference/api_docs/backend_api/create-evaluation-scenario",
+            "reference/api_docs/backend_api/update-evaluation-scenario-router",
+            "reference/api_docs/backend_api/evaluate-ai-critique",
+            "reference/api_docs/backend_api/get-evaluation-scenario-score-router",
+            "reference/api_docs/backend_api/update-evaluation-scenario-score-router",
+            "reference/api_docs/backend_api/fetch-results",
+            "reference/api_docs/backend_api/create-custom-evaluation",
+            "reference/api_docs/backend_api/update-custom-evaluation",
+            "reference/api_docs/backend_api/list-custom-evaluations",
+            "reference/api_docs/backend_api/get-custom-evaluation",
+            "reference/api_docs/backend_api/get-custom-evaluation-names",
+            "reference/api_docs/backend_api/execute-custom-evaluation",
+            "reference/api_docs/backend_api/webhook-example-fake",
+            "reference/api_docs/backend_api/upload-file",
+            "reference/api_docs/backend_api/import-testset",
+            "reference/api_docs/backend_api/create-testset",
             {
               "group": "testsets",
               "pages": [
-                "reference/reference/backend_api/testsets/get-testset",
-                "reference/reference/backend_api/testsets/get-testsets"
+                "reference/api_docs/backend_api/testsets/get-testset",
+                "reference/api_docs/backend_api/testsets/get-testsets"
               ]
             },
-            "reference/reference/backend_api/update-testset",
-            "reference/reference/backend_api/delete-testsets",
-            "reference/reference/backend_api/build-image",
-            "reference/reference/backend_api/restart-docker-container",
-            "reference/reference/backend_api/container-templates",
-            "reference/reference/backend_api/construct-app-container-url",
-            "reference/reference/backend_api/deploy-to-environment",
-            "reference/reference/backend_api/create-trace",
-            "reference/reference/backend_api/get-traces",
-            "reference/reference/backend_api/get-trace",
-            "reference/reference/backend_api/update-trace-status",
-            "reference/reference/backend_api/create-span",
-            "reference/reference/backend_api/get-spans-of-trace",
-            "reference/reference/backend_api/get-feedbacks",
-            "reference/reference/backend_api/create-feedback",
-            "reference/reference/backend_api/get-feedback",
-            "reference/reference/backend_api/update-feedback",
-            "reference/reference/backend_api/list-organizations",
-            "reference/reference/backend_api/get-user-organization",
-            "reference/reference/backend_api/list-bases",
-            "reference/reference/backend_api/get-config",
-            "reference/reference/backend_api/save-config"
-          ]
-        }
+            "reference/api_docs/backend_api/update-testset",
+            "reference/api_docs/backend_api/delete-testsets",
+            "reference/api_docs/backend_api/build-image",
+            "reference/api_docs/backend_api/restart-docker-container",
+            "reference/api_docs/backend_api/container-templates",
+            "reference/api_docs/backend_api/construct-app-container-url",
+            "reference/api_docs/backend_api/deploy-to-environment",
+            "reference/api_docs/backend_api/create-trace",
+            "reference/api_docs/backend_api/get-traces",
+            "reference/api_docs/backend_api/get-trace",
+            "reference/api_docs/backend_api/update-trace-status",
+            "reference/api_docs/backend_api/create-span",
+            "reference/api_docs/backend_api/get-spans-of-trace",
+            "reference/api_docs/backend_api/get-feedbacks",
+            "reference/api_docs/backend_api/create-feedback",
+            "reference/api_docs/backend_api/get-feedback",
+            "reference/api_docs/backend_api/update-feedback",
+            "reference/api_docs/backend_api/list-organizations",
+            "reference/api_docs/backend_api/get-user-organization",
+            "reference/api_docs/backend_api/list-bases",
+            "reference/api_docs/backend_api/get-config",
+            "reference/api_docs/backend_api/save-config"
       ]
     },
     {

diff --git a/..._api/add-variant-from-base-and-config.mdx → ..._api/add-variant-from-base-and-config.mdx b/..._api/add-variant-from-base-and-config.mdx → ..._api/add-variant-from-base-and-config.mdx
diff --git a/...ce/backend_api/add-variant-from-image.mdx → ...cs/backend_api/add-variant-from-image.mdx b/...ce/backend_api/add-variant-from-image.mdx → ...cs/backend_api/add-variant-from-image.mdx
diff --git a/...nce/reference/backend_api/build-image.mdx → ...ence/api_docs/backend_api/build-image.mdx b/...nce/reference/backend_api/build-image.mdx → ...ence/api_docs/backend_api/build-image.mdx
diff --git a/...ckend_api/construct-app-container-url.mdx → ...ckend_api/construct-app-container-url.mdx b/...ckend_api/construct-app-container-url.mdx → ...ckend_api/construct-app-container-url.mdx
diff --git a/...rence/backend_api/container-templates.mdx → ..._docs/backend_api/container-templates.mdx b/...rence/backend_api/container-templates.mdx → ..._docs/backend_api/container-templates.mdx
diff --git a/.../create-app-and-variant-from-template.mdx → .../create-app-and-variant-from-template.mdx b/.../create-app-and-variant-from-template.mdx → .../create-app-and-variant-from-template.mdx
diff --git a/...ence/reference/backend_api/create-app.mdx → ...rence/api_docs/backend_api/create-app.mdx b/...ence/reference/backend_api/create-app.mdx → ...rence/api_docs/backend_api/create-app.mdx
diff --git a/.../backend_api/create-custom-evaluation.mdx → .../backend_api/create-custom-evaluation.mdx b/.../backend_api/create-custom-evaluation.mdx → .../backend_api/create-custom-evaluation.mdx
diff --git a/...ackend_api/create-evaluation-scenario.mdx → ...ackend_api/create-evaluation-scenario.mdx b/...ackend_api/create-evaluation-scenario.mdx → ...ackend_api/create-evaluation-scenario.mdx
diff --git a/...ference/backend_api/create-evaluation.mdx → ...pi_docs/backend_api/create-evaluation.mdx b/...ference/backend_api/create-evaluation.mdx → ...pi_docs/backend_api/create-evaluation.mdx
diff --git a/...reference/backend_api/create-feedback.mdx → .../api_docs/backend_api/create-feedback.mdx b/...reference/backend_api/create-feedback.mdx → .../api_docs/backend_api/create-feedback.mdx
diff --git a/...nce/reference/backend_api/create-span.mdx → ...ence/api_docs/backend_api/create-span.mdx b/...nce/reference/backend_api/create-span.mdx → ...ence/api_docs/backend_api/create-span.mdx
diff --git a/.../reference/backend_api/create-testset.mdx → ...e/api_docs/backend_api/create-testset.mdx b/.../reference/backend_api/create-testset.mdx → ...e/api_docs/backend_api/create-testset.mdx
diff --git a/...ce/reference/backend_api/create-trace.mdx → ...nce/api_docs/backend_api/create-trace.mdx b/...ce/reference/backend_api/create-trace.mdx → ...nce/api_docs/backend_api/create-trace.mdx
diff --git a/...nce/backend_api/create_doc_from_openai.sh → ...ocs/backend_api/create_doc_from_openai.sh b/...nce/backend_api/create_doc_from_openai.sh → ...ocs/backend_api/create_doc_from_openai.sh
diff --git a/...erence/backend_api/delete-evaluations.mdx → ...i_docs/backend_api/delete-evaluations.mdx b/...erence/backend_api/delete-evaluations.mdx → ...i_docs/backend_api/delete-evaluations.mdx
diff --git a/...reference/backend_api/delete-testsets.mdx → .../api_docs/backend_api/delete-testsets.mdx b/...reference/backend_api/delete-testsets.mdx → .../api_docs/backend_api/delete-testsets.mdx
diff --git a/...nce/backend_api/deploy-to-environment.mdx → ...ocs/backend_api/deploy-to-environment.mdx b/...nce/backend_api/deploy-to-environment.mdx → ...ocs/backend_api/deploy-to-environment.mdx
diff --git a/...ence/backend_api/evaluate-ai-critique.mdx → ...docs/backend_api/evaluate-ai-critique.mdx b/...ence/backend_api/evaluate-ai-critique.mdx → ...docs/backend_api/evaluate-ai-critique.mdx
diff --git a/...backend_api/execute-custom-evaluation.mdx → ...backend_api/execute-custom-evaluation.mdx b/...backend_api/execute-custom-evaluation.mdx → ...backend_api/execute-custom-evaluation.mdx
diff --git a/...ackend_api/fetch-evaluation-scenarios.mdx → ...ackend_api/fetch-evaluation-scenarios.mdx b/...ackend_api/fetch-evaluation-scenarios.mdx → ...ackend_api/fetch-evaluation-scenarios.mdx
diff --git a/...eference/backend_api/fetch-evaluation.mdx → ...api_docs/backend_api/fetch-evaluation.mdx b/...eference/backend_api/fetch-evaluation.mdx → ...api_docs/backend_api/fetch-evaluation.mdx
diff --git a/...ce/backend_api/fetch-list-evaluations.mdx → ...cs/backend_api/fetch-list-evaluations.mdx b/...ce/backend_api/fetch-list-evaluations.mdx → ...cs/backend_api/fetch-list-evaluations.mdx
diff --git a/...e/reference/backend_api/fetch-results.mdx → ...ce/api_docs/backend_api/fetch-results.mdx b/...e/reference/backend_api/fetch-results.mdx → ...ce/api_docs/backend_api/fetch-results.mdx
diff --git a/...ence/reference/backend_api/get-config.mdx → ...rence/api_docs/backend_api/get-config.mdx b/...ence/reference/backend_api/get-config.mdx → ...rence/api_docs/backend_api/get-config.mdx
diff --git a/...ckend_api/get-custom-evaluation-names.mdx → ...ckend_api/get-custom-evaluation-names.mdx b/...ckend_api/get-custom-evaluation-names.mdx → ...ckend_api/get-custom-evaluation-names.mdx
diff --git a/...nce/backend_api/get-custom-evaluation.mdx → ...ocs/backend_api/get-custom-evaluation.mdx b/...nce/backend_api/get-custom-evaluation.mdx → ...ocs/backend_api/get-custom-evaluation.mdx
diff --git a/.../get-evaluation-scenario-score-router.mdx → .../get-evaluation-scenario-score-router.mdx b/.../get-evaluation-scenario-score-router.mdx → .../get-evaluation-scenario-score-router.mdx
diff --git a/...ce/reference/backend_api/get-feedback.mdx → ...nce/api_docs/backend_api/get-feedback.mdx b/...ce/reference/backend_api/get-feedback.mdx → ...nce/api_docs/backend_api/get-feedback.mdx
diff --git a/...e/reference/backend_api/get-feedbacks.mdx → ...ce/api_docs/backend_api/get-feedbacks.mdx b/...e/reference/backend_api/get-feedbacks.mdx → ...ce/api_docs/backend_api/get-feedbacks.mdx
diff --git a/...erence/backend_api/get-spans-of-trace.mdx → ...i_docs/backend_api/get-spans-of-trace.mdx b/...erence/backend_api/get-spans-of-trace.mdx → ...i_docs/backend_api/get-spans-of-trace.mdx
diff --git a/...rence/reference/backend_api/get-trace.mdx → ...erence/api_docs/backend_api/get-trace.mdx b/...rence/reference/backend_api/get-trace.mdx → ...erence/api_docs/backend_api/get-trace.mdx
diff --git a/...ence/reference/backend_api/get-traces.mdx → ...rence/api_docs/backend_api/get-traces.mdx b/...ence/reference/backend_api/get-traces.mdx → ...rence/api_docs/backend_api/get-traces.mdx
diff --git a/...nce/backend_api/get-user-organization.mdx → ...ocs/backend_api/get-user-organization.mdx b/...nce/backend_api/get-user-organization.mdx → ...ocs/backend_api/get-user-organization.mdx
diff --git a/...erence/backend_api/get-variant-by-env.mdx → ...i_docs/backend_api/get-variant-by-env.mdx b/...erence/backend_api/get-variant-by-env.mdx → ...i_docs/backend_api/get-variant-by-env.mdx
diff --git a/.../reference/backend_api/import-testset.mdx → ...e/api_docs/backend_api/import-testset.mdx b/.../reference/backend_api/import-testset.mdx → ...e/api_docs/backend_api/import-testset.mdx
diff --git a/...ference/backend_api/list-app-variants.mdx → ...pi_docs/backend_api/list-app-variants.mdx b/...ference/backend_api/list-app-variants.mdx → ...pi_docs/backend_api/list-app-variants.mdx
diff --git a/...rence/reference/backend_api/list-apps.mdx → ...erence/api_docs/backend_api/list-apps.mdx b/...rence/reference/backend_api/list-apps.mdx → ...erence/api_docs/backend_api/list-apps.mdx
diff --git a/...ence/reference/backend_api/list-bases.mdx → ...rence/api_docs/backend_api/list-bases.mdx b/...ence/reference/backend_api/list-bases.mdx → ...rence/api_docs/backend_api/list-bases.mdx
diff --git a/...e/backend_api/list-custom-evaluations.mdx → ...s/backend_api/list-custom-evaluations.mdx b/...e/backend_api/list-custom-evaluations.mdx → ...s/backend_api/list-custom-evaluations.mdx
diff --git a/...ference/backend_api/list-environments.mdx → ...pi_docs/backend_api/list-environments.mdx b/...ference/backend_api/list-environments.mdx → ...pi_docs/backend_api/list-environments.mdx
diff --git a/...erence/backend_api/list-organizations.mdx → ...i_docs/backend_api/list-organizations.mdx b/...erence/backend_api/list-organizations.mdx → ...i_docs/backend_api/list-organizations.mdx
diff --git a/...erence/reference/backend_api/openapi.json → ...ference/api_docs/backend_api/openapi.json b/...erence/reference/backend_api/openapi.json → ...ference/api_docs/backend_api/openapi.json
@@ -6,7 +6,7 @@
     },
     "servers": [
         {
-            "url": "/api"
+            "url": "https://docs.agenta.ai"
         }
     ],
     "paths": {

diff --git a/...ence/reference/backend_api/remove-app.mdx → ...rence/api_docs/backend_api/remove-app.mdx b/...ence/reference/backend_api/remove-app.mdx → ...rence/api_docs/backend_api/remove-app.mdx
diff --git a/.../reference/backend_api/remove-variant.mdx → ...e/api_docs/backend_api/remove-variant.mdx b/.../reference/backend_api/remove-variant.mdx → ...e/api_docs/backend_api/remove-variant.mdx
diff --git a/.../backend_api/restart-docker-container.mdx → .../backend_api/restart-docker-container.mdx b/.../backend_api/restart-docker-container.mdx → .../backend_api/restart-docker-container.mdx
diff --git a/...nce/reference/backend_api/save-config.mdx → ...ence/api_docs/backend_api/save-config.mdx b/...nce/reference/backend_api/save-config.mdx → ...ence/api_docs/backend_api/save-config.mdx
diff --git a/...e/reference/backend_api/start-variant.mdx → ...ce/api_docs/backend_api/start-variant.mdx b/...e/reference/backend_api/start-variant.mdx → ...ce/api_docs/backend_api/start-variant.mdx
diff --git a/...ence/backend_api/testsets/get-testset.mdx → ...docs/backend_api/testsets/get-testset.mdx b/...ence/backend_api/testsets/get-testset.mdx → ...docs/backend_api/testsets/get-testset.mdx
diff --git a/...nce/backend_api/testsets/get-testsets.mdx → ...ocs/backend_api/testsets/get-testsets.mdx b/...nce/backend_api/testsets/get-testsets.mdx → ...ocs/backend_api/testsets/get-testsets.mdx
diff --git a/.../backend_api/update-custom-evaluation.mdx → .../backend_api/update-custom-evaluation.mdx b/.../backend_api/update-custom-evaluation.mdx → .../backend_api/update-custom-evaluation.mdx
diff --git a/.../backend_api/update-evaluation-router.mdx → .../backend_api/update-evaluation-router.mdx b/.../backend_api/update-evaluation-router.mdx → .../backend_api/update-evaluation-router.mdx
diff --git a/...api/update-evaluation-scenario-router.mdx → ...api/update-evaluation-scenario-router.mdx b/...api/update-evaluation-scenario-router.mdx → ...api/update-evaluation-scenario-router.mdx
diff --git a/...date-evaluation-scenario-score-router.mdx → ...date-evaluation-scenario-score-router.mdx b/...date-evaluation-scenario-score-router.mdx → ...date-evaluation-scenario-score-router.mdx
diff --git a/...reference/backend_api/update-feedback.mdx → .../api_docs/backend_api/update-feedback.mdx b/...reference/backend_api/update-feedback.mdx → .../api_docs/backend_api/update-feedback.mdx
diff --git a/.../reference/backend_api/update-testset.mdx → ...e/api_docs/backend_api/update-testset.mdx b/.../reference/backend_api/update-testset.mdx → ...e/api_docs/backend_api/update-testset.mdx
diff --git a/...rence/backend_api/update-trace-status.mdx → ..._docs/backend_api/update-trace-status.mdx b/...rence/backend_api/update-trace-status.mdx → ..._docs/backend_api/update-trace-status.mdx
diff --git a/...ence/backend_api/update-variant-image.mdx → ...docs/backend_api/update-variant-image.mdx b/...ence/backend_api/update-variant-image.mdx → ...docs/backend_api/update-variant-image.mdx
diff --git a/...backend_api/update-variant-parameters.mdx → ...backend_api/update-variant-parameters.mdx b/...backend_api/update-variant-parameters.mdx → ...backend_api/update-variant-parameters.mdx
diff --git a/...nce/reference/backend_api/upload-file.mdx → ...ence/api_docs/backend_api/upload-file.mdx b/...nce/reference/backend_api/upload-file.mdx → ...ence/api_docs/backend_api/upload-file.mdx
diff --git a/...ce/reference/backend_api/user-profile.mdx → ...nce/api_docs/backend_api/user-profile.mdx b/...ce/reference/backend_api/user-profile.mdx → ...nce/api_docs/backend_api/user-profile.mdx
diff --git a/...ence/backend_api/webhook-example-fake.mdx → ...docs/backend_api/webhook-example-fake.mdx b/...ence/backend_api/webhook-example-fake.mdx → ...docs/backend_api/webhook-example-fake.mdx