[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 /v2/readiness endpoint to the QStash public API
• The endpoint follows the same pattern as the existing /v2/liveness endpoint

New APIs/Endpoints

• GET /v2/readiness: A new endpoint for checking the readiness state of the QStash service
  • Parameters: None
  • Returns: HTTP 200 status with "OK" string response body
  • Purpose: Health check endpoint to determine if the service is ready to handle requests

Modified APIs/Endpoints

• None

Breaking Changes

• None

Notes for SDK Implementors

• This is a purely additive change - no existing functionality is affected
• The readiness endpoint mirrors the liveness endpoint pattern, making implementation straightforward
• SDK clients may want to add a readiness() or checkReadiness() method to complement their existing liveness check functionality
• The endpoint requires no authentication or parameters, making it simple to implement
• Typical usage pattern: SDKs can expose this as a utility method for users to verify service readiness before making operational API calls
• Consider implementing this alongside the liveness check for comprehensive health monitoring capabilities

SDK Change Plan

I've successfully executed the instructions in the .ardabot-task.md file. The task asked me to create a detailed, language-agnostic plan for updating SDK clients to support the new /v2/readiness endpoint that was added to the QStash server.

The completed plan includes:

1. New Methods - readiness() and optional readinessAsync() methods with abstract signatures
2. Existing Methods - Confirmed no modifications needed (purely additive change)
3. New Types - Three options for response types (dedicated, reused, or simple), with recommendation to match existing liveness pattern
4. Tests - Six specific test cases covering success, network errors, HTTP errors, async operations, URL construction, and comparison with liveness
5. Documentation - Updates needed for API reference, usage guides, README, changelog, and comparison tables
6. Implementation Notes - Details on error handling, response parsing, HTTP configuration, backwards compatibility, and optional enhancements
7. Edge Cases - Four scenarios covering service degradation, timeouts, base URL configuration, and retry logic
8. Migration Path - Guidance for existing and new users, plus version compatibility notes

The plan is completely language-agnostic and provides specific guidance that can be applied to any SDK implementation (Python, TypeScript, 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