make jobs api stable#5202
Open
cicoyle wants to merge 2 commits into
Open
Conversation
Signed-off-by: Cassandra Coyle <cassie@diagrid.io>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates Dapr documentation to reflect that the Jobs API has moved from alpha to stable, aligning docs and SDK samples with the stable /v1.0/jobs HTTP endpoints and non-Alpha1 Go SDK method names.
Changes:
- Updated Go SDK documentation and samples to use
ScheduleJob,GetJob, andDeleteJob(non-Alpha method names). - Updated Jobs API reference examples to use
/v1.0/jobs/...endpoints and removed alpha-stage alerts. - Removed Jobs from the “Alpha APIs” list and updated building-blocks endpoint tables to show stable Jobs endpoints.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| sdkdocs/go/content/en/go-sdk-docs/go-client/_index.md | Updates Go SDK Jobs samples from *Alpha1 methods to stable method names. |
| daprdocs/content/en/reference/api/jobs_api.md | Removes alpha notice and updates Jobs HTTP endpoints to /v1.0/jobs. |
| daprdocs/content/en/operations/support/alpha-beta-apis.md | Removes Jobs entry from the alpha API list. |
| daprdocs/content/en/getting-started/quickstarts/jobs-quickstart.md | Removes alpha warning and updates Go quickstart sample calls to stable methods. |
| daprdocs/content/en/developing-applications/building-blocks/jobs/jobs-features-concepts.md | Updates gRPC callback naming/registration examples to non-alpha variants. |
| daprdocs/content/en/developing-applications/building-blocks/jobs/howto-schedule-and-handle-triggered-jobs.md | Updates narrative to reference ScheduleJob rather than ScheduleJobAlpha1. |
| daprdocs/content/en/concepts/building-blocks-concept.md | Updates Jobs endpoint in the building blocks table to /v1.0/jobs. |
Comments suppressed due to low confidence (1)
daprdocs/content/en/reference/api/jobs_api.md:12
- Now that this page and endpoints are documenting the stable
/v1.0/jobsAPI, the statement that the HTTP APIs are "intended for development and testing only" reads like an alpha-only restriction and may contradict the "make jobs api stable" goal. Consider rewording to keep the SDK recommendation (performance/capability) without implying HTTP is non-production-only.
> The HTTP APIs are intended for development and testing only. For production scenarios, the use of the SDKs is strongly
> recommended as they implement the gRPC APIs providing higher performance and capability than the HTTP APIs. This is because HTTP does JSON marshalling which can be expensive, while with gRPC, the data is transmitted over the wire and stored as-is being more performant.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
make jobs api stable