[ardabot] SDK changes for upstash/qstash-server#884

[CahidArda]

Automated SDK Update

This PR was automatically generated by ardabot based on changes in upstash/qstash-server#884.

Server Change Summary

Now I'll analyze the PR diff and produce the structured summary as requested.

Changes Summary

• Added a new readiness endpoint at /v2/readiness to check the readiness state of QStash
• New endpoint follows the same pattern as the existing liveness endpoint

New APIs/Endpoints

• GET /v2/readiness: New endpoint to check readiness state
  • Parameters: None
  • Response: HTTP 200 with "OK" string body
  • Purpose: Allows clients to verify that the QStash service is ready to handle requests

Modified APIs/Endpoints

• None

Breaking Changes

• None

Notes for SDK Implementors

• This is a purely additive change that introduces a new health check endpoint
• The readiness endpoint returns a simple string "OK" with HTTP 200 status, identical in format to the existing liveness endpoint
• SDKs may want to add a readiness() or checkReadiness() method to complement their existing liveness() methods
• The endpoint does not require authentication or special headers
• This follows common Kubernetes health check patterns where liveness checks if the service is running, while readiness checks if it can accept traffic
• Implementation in SDKs is optional but recommended for users who need to verify service readiness before sending requests

SDK Change Plan

I've successfully executed the instructions in the .ardabot-task.md file. Here's what I created:

SDK_UPDATE_PLAN.md - A comprehensive, language-agnostic plan for updating SDK clients to support the new /v2/readiness endpoint.

The plan includes:

1. New Methods - Detailed specification for a readiness() method that mirrors the existing liveness() method
2. Existing Methods - Confirmed no modifications needed (purely additive change)
3. New Types - Defined ReadinessResponse type with guidance to match existing patterns
4. Test Cases - 6 comprehensive test scenarios covering success, errors, consistency, and edge cases
5. Documentation Updates - Specific sections to update in API docs, README, changelog, and examples
6. Implementation Guidelines - Consistency requirements, authentication notes, and best practices
7. Edge Cases - 5 edge cases to consider during implementation
8. Rollout Strategy - Phased approach for implementation, testing, documentation, and release

The plan emphasizes consistency with the existing liveness() method and provides abstract signatures without any language-specific syntax, making it applicable to any SDK implementation (TypeScript, Python, Go, etc.).

---

This PR was generated by ardabot. Review the changes carefully before merging.
To request changes, leave review comments and ardabot will address them.
Original PR: https://github.com/upstash/qstash-server/pull/884