Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

## [0.32.2] - 2026-06-05

### Fixed
- **The README `docker run` command no longer leaves the API unreachable.** It mapped the host port to container port `8000`, but the published `rbardaji/ndp-ep-api` all-in-one image serves the app through nginx on container port **80**, so nothing answered and every verification URL failed even though the container was healthy. The command now maps to `:80`, with a note explaining the all-in-one image and its port.

### Changed
- **The "Verify Installation" section is clearer and more complete.** It now lists the Web UI (`/ui/`) and the liveness endpoint (`/health`) alongside the docs and status URLs, and notes that the `docker compose` default host port is `8002` (vs `8001` for the `docker run` example).

### Backwards compatibility
- Documentation only. No API behavior, request/response shapes, or routes change.

## [0.32.1] - 2026-06-04

### Fixed
Expand Down
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -247,8 +247,11 @@ S3_REGION=us-east-1

2. **Run the container**:
```bash
docker run -p 8001:8000 --env-file .env rbardaji/ndp-ep-api
docker run -p 8001:80 --env-file .env rbardaji/ndp-ep-api
```
The `rbardaji/ndp-ep-api` image is the all-in-one build (API + web UI behind
nginx) and listens on container port **80**. The command above maps it to host
port `8001`, so the API is reachable at `http://localhost:8001`.

### 3. Run with Docker Compose (Optional Services)

Expand Down Expand Up @@ -302,10 +305,14 @@ docker compose --profile mongodb --profile s3 --profile kafka --profile jupyter

### 4. Verify Installation

Once the container is running, verify everything is working:
Once the container is running, verify everything is working (replace `8001`
with `8002` if you started the stack with `docker compose`, whose default
host port is `8002`):

- **API Documentation**: http://localhost:8001/docs
- **Health Check**: http://localhost:8001/status/
- **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

### 5. Common Configuration Scenarios
Expand Down
2 changes: 1 addition & 1 deletion api/config/swagger_settings.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.1"
swagger_version: str = "0.32.2"
root_path: str = "" # API root path prefix (e.g., "/test" or "")
is_public: bool = True
metrics_endpoint: str = "https://federation.ndp.utah.edu/metrics/"
Expand Down
Loading