Skip to content

Commit

Permalink
added new ref and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mmabrouk committed May 17, 2024
1 parent 7cc1c9b commit 8612c07
Show file tree
Hide file tree
Showing 93 changed files with 7,081 additions and 0 deletions.
21 changes: 21 additions & 0 deletions docs/reference/backend_api/README.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
To generate the reference documentation:
- Add the openapi.json to this folder
- Add the following to the openapi.json
"servers": [
{
"url": "https://cloud.agenta.ai/api",
"description": "Agenta Cloud"
},
{
"url": "http:/localhost/api",
"description": "Local Development"
}
],
- Run ./create_doc_from_openapi.sh
- Add the output of the script to mint.json
- Make sure that
"openapi": [
"/reference/backend_api/openapi.json"
],

is in the mint.json
3 changes: 3 additions & 0 deletions docs/reference/backend_api/accept-workspace-invitation.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: post /organizations/{org_id}/workspaces/{workspace_id}/invite/accept
---
3 changes: 3 additions & 0 deletions docs/reference/backend_api/apps/add-variant-from-image.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: post /apps/{app_id}/variant/from-image
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: post /apps/app_and_variant_from_template
---
3 changes: 3 additions & 0 deletions docs/reference/backend_api/apps/create-app.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: post /apps
---
3 changes: 3 additions & 0 deletions docs/reference/backend_api/apps/get-variant-by-env.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /apps/get_variant_by_env
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /apps/{app_id}/revisions/{environment_name}
---
3 changes: 3 additions & 0 deletions docs/reference/backend_api/apps/list-app-variants.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /apps/{app_id}/variants
---
3 changes: 3 additions & 0 deletions docs/reference/backend_api/apps/list-apps.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /apps
---
3 changes: 3 additions & 0 deletions docs/reference/backend_api/apps/list-environments.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /apps/{app_id}/environments
---
3 changes: 3 additions & 0 deletions docs/reference/backend_api/apps/remove-app.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: delete /apps/{app_id}
---
3 changes: 3 additions & 0 deletions docs/reference/backend_api/assign-role-to-user.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: post /workspaces/{workspace_id}/roles
---
3 changes: 3 additions & 0 deletions docs/reference/backend_api/bases/list-bases.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /bases
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /configs/deployment/{deployment_revision_id}
---
3 changes: 3 additions & 0 deletions docs/reference/backend_api/configs/get-config.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /configs
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: post /configs/deployment/{deployment_revision_id}/revert
---
3 changes: 3 additions & 0 deletions docs/reference/backend_api/configs/save-config.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: post /configs
---
3 changes: 3 additions & 0 deletions docs/reference/backend_api/containers/build-image.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: post /containers/build_image
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /containers/container_url
---
3 changes: 3 additions & 0 deletions docs/reference/backend_api/containers/container-templates.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /containers/templates
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: post /containers/restart_container
---
3 changes: 3 additions & 0 deletions docs/reference/backend_api/create-api-key.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: post /keys
---
3 changes: 3 additions & 0 deletions docs/reference/backend_api/create-organization.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: post /organizations
---
3 changes: 3 additions & 0 deletions docs/reference/backend_api/create-workspace.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: post /organizations/{org_id}/workspaces
---
1 change: 1 addition & 0 deletions docs/reference/backend_api/create_doc_from_openai.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
npx @mintlify/scraping@latest openapi-file openapi.json
3 changes: 3 additions & 0 deletions docs/reference/backend_api/delete-api-key.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: delete /keys/{key_prefix}
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: post /environments/deploy
---
3 changes: 3 additions & 0 deletions docs/reference/backend_api/evaluations/create-evaluation.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: post /evaluations
---
3 changes: 3 additions & 0 deletions docs/reference/backend_api/evaluations/delete-evaluations.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: delete /evaluations
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /evaluations/by_resource
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /evaluations/{evaluation_id}/results
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /evaluations/evaluation_scenarios/comparison-results
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /evaluations/{evaluation_id}/evaluation_scenarios
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /evaluations/{evaluation_id}/status
---
3 changes: 3 additions & 0 deletions docs/reference/backend_api/evaluations/fetch-evaluation.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /evaluations/{evaluation_id}
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /evaluations
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: post /evaluations/webhook_example_fake
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: post /evaluators/configs
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: delete /evaluators/configs/{evaluator_config_id}
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /evaluators/configs/{evaluator_config_id}
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /evaluators/configs
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /evaluators
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: put /evaluators/configs/{evaluator_config_id}
---
3 changes: 3 additions & 0 deletions docs/reference/backend_api/fetch-organization-details.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /organizations/{org_id}
---
3 changes: 3 additions & 0 deletions docs/reference/backend_api/get-all-workspace-permissions.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /workspaces/permissions
---
3 changes: 3 additions & 0 deletions docs/reference/backend_api/get-all-workspace-roles.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /workspaces/roles
---
3 changes: 3 additions & 0 deletions docs/reference/backend_api/get-user-organization.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /organizations/own
---
3 changes: 3 additions & 0 deletions docs/reference/backend_api/health-check.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /health
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: post /human-evaluations
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: delete /human-evaluations
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /human-evaluations/{evaluation_id}/evaluation_scenarios
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /human-evaluations/{evaluation_id}
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /human-evaluations
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /human-evaluations/{evaluation_id}/results
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /human-evaluations/evaluation_scenario/{evaluation_scenario_id}/score
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: put /human-evaluations/{evaluation_id}/evaluation_scenario/{evaluation_scenario_id}/{evaluation_type}
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: put /human-evaluations/evaluation_scenario/{evaluation_scenario_id}/score
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: put /human-evaluations/{evaluation_id}
---
3 changes: 3 additions & 0 deletions docs/reference/backend_api/invite-user-to-workspace.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: post /organizations/{org_id}/workspaces/{workspace_id}/invite
---
3 changes: 3 additions & 0 deletions docs/reference/backend_api/list-api-keys.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /keys
---
3 changes: 3 additions & 0 deletions docs/reference/backend_api/list-organizations.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /organizations
---
3 changes: 3 additions & 0 deletions docs/reference/backend_api/observability/create-traces.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: post /observability/trace/
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: delete /observability/spans/
---
3 changes: 3 additions & 0 deletions docs/reference/backend_api/observability/delete-traces.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: delete /observability/traces/
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /observability/dashboard/
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /observability/spans/{span_id}/
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /observability/spans/
---
3 changes: 3 additions & 0 deletions docs/reference/backend_api/observability/get-trace-detail.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /observability/traces/{trace_id}/
---
3 changes: 3 additions & 0 deletions docs/reference/backend_api/observability/get-traces.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /observability/traces/
---
Loading

0 comments on commit 8612c07

Please sign in to comment.