From b9d41a5f4a95c752e744fdc39be0cac57ec8ff32 Mon Sep 17 00:00:00 2001 From: Raul Bardaji Date: Fri, 5 Jun 2026 07:08:33 -0600 Subject: [PATCH] fix(docs): drop the 401 /status/ URL from Verify Installation steps /status/ requires an auth token and returns 401 without one, so listing it as a post-install check produced a misleading failure. Keep only the unauthenticated URLs that return success (/docs, /ui/, /health) and note that /status/ exists but needs a token. Closes #189 --- CHANGELOG.md | 8 ++++++++ README.md | 5 ++++- api/config/swagger_settings.py | 2 +- 3 files changed, 13 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index b52e71f..62a437c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +## [0.32.3] - 2026-06-05 + +### Fixed +- **The "Verify Installation" steps no longer point to an endpoint that returns `401`.** `/status/` requires an authentication token and returns `401` without one, so following the verification list produced a misleading failure on a fresh install. The quick verification now lists only the unauthenticated URLs that return success (`/docs`, `/ui/`, `/health`), with a note that `/status/` exists but requires a token. + +### Backwards compatibility +- Documentation only. No API behavior, request/response shapes, or routes change. + ## [0.32.2] - 2026-06-05 ### Fixed diff --git a/README.md b/README.md index 68b8679..fe83d11 100644 --- a/README.md +++ b/README.md @@ -312,9 +312,12 @@ host port is `8002`): - **API Documentation**: http://localhost:8001/docs - **Web UI**: http://localhost:8001/ui/ - **Health Check (liveness)**: http://localhost:8001/health -- **Status**: http://localhost:8001/status/ - **Interactive API Explorer**: Available at the docs URL +> The `/status/` endpoint also reports detailed service status, but it requires +> an authentication token and returns `401` without one, so it is not part of +> the quick unauthenticated verification above. + ### 5. Common Configuration Scenarios #### Scenario 1: NDP Central Catalog Only (Read-Only) diff --git a/api/config/swagger_settings.py b/api/config/swagger_settings.py index 977f5d7..c58fd64 100644 --- a/api/config/swagger_settings.py +++ b/api/config/swagger_settings.py @@ -12,7 +12,7 @@ class Settings(BaseSettings): swagger_title: str = "API Documentation" swagger_description: str = "This is the API documentation." - swagger_version: str = "0.32.2" + swagger_version: str = "0.32.3" root_path: str = "" # API root path prefix (e.g., "/test" or "") is_public: bool = True metrics_endpoint: str = "https://federation.ndp.utah.edu/metrics/"