Skip to content

docs: document time_of_last_update in /ping response #479

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
jesseturner21 wants to merge 1 commit into from
Closed

docs: document time_of_last_update in /ping response #479

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 8 additions & 1 deletion docs/examples/a2a_protocol_examples.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,12 @@ Builds a Starlette ASGI application without starting a server. Useful for testin
Returns a `Starlette` application with routes:
- `POST /` — A2A JSON-RPC endpoint (`message/send`, `message/stream`, `tasks/get`, `tasks/cancel`)
- `GET /.well-known/agent-card.json` — Agent card discovery
- `GET /ping` — Bedrock health check
- `GET /ping` — Bedrock health check. Returns JSON:
```json
{"status": "Healthy" | "HealthyBusy", "time_of_last_update": 1715000000}
```
- `status` — current health status from the `ping_handler` (or `"Healthy"` by default)
- `time_of_last_update` — Unix timestamp (seconds) indicating when the status was last updated

### `build_runtime_url(agent_arn, region=None)`

Expand Down Expand Up @@ -192,3 +197,5 @@ serve_a2a(executor, ping_handler=my_ping)
```

If the ping handler raises an exception, the server falls back to `PingStatus.HEALTHY`.

The `/ping` response always includes a `time_of_last_update` field (Unix timestamp in seconds) reflecting when the status last changed. Clients can use this to detect stale health state.
Loading