Skip to content

docs: Add health check endpoints from PR #11 to README#12

Merged
allisson merged 2 commits intomainfrom
copilot/update-readme-with-changes
Dec 29, 2025
Merged

docs: Add health check endpoints from PR #11 to README#12
allisson merged 2 commits intomainfrom
copilot/update-readme-with-changes

Conversation

Copy link
Contributor

Copilot AI commented Dec 29, 2025

PR #11 added /liveness and /readiness endpoints for container orchestration. This documents them in the README.

Changes

  • API Reference: Added Health Checks section documenting both endpoints

    • /liveness: Always returns {"status": "alive"} for restart decisions
    • /readiness: Returns 200 or 503 based on database connectivity
  • Usage Examples: Added Example 5 with curl commands and Kubernetes probe configuration

livenessProbe:
  httpGet:
    path: /liveness
    port: 8000
  initialDelaySeconds: 30
  periodSeconds: 10

readinessProbe:
  httpGet:
    path: /readiness
    port: 8000
  initialDelaySeconds: 10
  periodSeconds: 5
Original prompt

Update the README.md with the recent changes of #11


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Co-authored-by: allisson <5202+allisson@users.noreply.github.com>
@allisson allisson marked this pull request as ready for review December 29, 2025 18:33
Copilot AI changed the title [WIP] Update README.md with recent changes from pull request 11 docs: Add health check endpoints from PR #11 to README Dec 29, 2025
Copilot AI requested a review from allisson December 29, 2025 18:33
@allisson allisson merged commit a6649af into main Dec 29, 2025
1 check passed
@allisson allisson deleted the copilot/update-readme-with-changes branch December 29, 2025 18:35
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.

2 participants