Skip to content

docs: document time_of_last_update in /ping response#479

Closed
jesseturner21 wants to merge 1 commit into
mainfrom
fix/document-ping-time-of-last-update
Closed

docs: document time_of_last_update in /ping response#479
jesseturner21 wants to merge 1 commit into
mainfrom
fix/document-ping-time-of-last-update

Conversation

@jesseturner21
Copy link
Copy Markdown
Contributor

Summary

  • Documents the previously undocumented time_of_last_update field in the /ping endpoint response
  • Adds the full response schema (status + time_of_last_update) to the API reference section
  • Adds a note in the Custom Ping Handler section explaining the timestamp semantics

Context

The /ping endpoint has always returned {"status": "...", "time_of_last_update": <unix_timestamp>} across all runtime protocols (main app, A2A, AG-UI), but the time_of_last_update field was never documented. This caused confusion for developers integrating with the health check endpoint (#471).

The code is correct — this is purely a documentation fix.

Test plan

  • Verify markdown renders correctly
  • No code changes, so no runtime testing needed

Fixes #471

The /ping endpoint returns a time_of_last_update field (Unix timestamp)
alongside the status, but this was not documented anywhere. Developers
using the SDK had no way to know this field exists or what it represents.

Fixes #471
@jesseturner21
Copy link
Copy Markdown
Contributor Author

Closing — the real fix belongs in the public AWS docs (AWSGenesisDocs), not the SDK docs. The SDK already emits the field correctly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: /ping response requires undocumented time_of_last_update field — without it AgentCore silently reaps microVMs even when status is HealthyBusy

1 participant