diff --git a/docs/develop/api.md b/docs/develop/api.md new file mode 100644 index 00000000..062d3e8e --- /dev/null +++ b/docs/develop/api.md @@ -0,0 +1,3 @@ +# API Reference + +Latest Beta: . diff --git a/docs/develop/index.md b/docs/develop/index.md index 01107c77..f37c2a43 100644 --- a/docs/develop/index.md +++ b/docs/develop/index.md @@ -1,6 +1,6 @@ --- hide: - - toc + - toc --- # Developing Browsertrix Cloud @@ -13,7 +13,7 @@ The deployment can then be [further customized for local development](./local-de ### Backend -The backend is an API-only system, using the FastAPI framework. The latest API reference is available under ./api of a running cluster. +The backend is an API-only system, using the FastAPI framework. Latest API docs can be viewed in the browser by adding `/api/redoc` to the URL of a running cluster (ex: `http://localhost:30870/api/redoc` when running locally on port `30870`.) At this time, the backend must be deployed in the Kubernetes cluster. diff --git a/mkdocs.yml b/mkdocs.yml index 1d3ab9a0..c339cb0e 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -59,6 +59,7 @@ nav: - develop/local-dev-setup.md - develop/frontend-dev.md - develop/docs.md + - develop/api.md - User Guide: - user-guide/index.md - user-guide/signup.md