Repository navigation
[doc] Bump sphinxcontrib-openapi to 0.10.0 - #66957
Merged
Merged
Conversation
0.10.0 fixes the two upstream bugs the Jobs API page named as blockers for request and response examples (sphinx-contrib/openapi#165, #166). Regenerate the docs deplock; the diff is the one package block. Examples still can't be enabled: a schema-derived string example is emitted without JSON encoding, which fails the http lexer under -W (sphinx-contrib/openapi#172). Update the source comment in api.md to name that bug instead. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Signed-off-by: Douglas Strodtman <douglas@anyscale.com>
Contributor
There was a problem hiding this comment.
Code Review
This pull request upgrades the sphinxcontrib-openapi package from version 0.9.0 to 0.10.0 in both the requirements file and the Python 3.11 dependency lockfile. Additionally, it updates the documentation in api.md to revise the explanation of why request and response examples remain disabled, noting that while some previous issues were resolved, a new upstream bug still prevents enabling them. There are no review comments, and I have no feedback to provide.
ronny-anyscale
approved these changes
Oct 13, 2026
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.
Description
Bumps
sphinxcontrib-openapi, which renders the Ray Jobs REST API specification page, from 0.9.0 to 0.10.0, and regenerates the docs deplock.0.10.0 fixes five upstream bugs, two of which this page's source comment named as blockers for request and response examples:
:generate-examples-from-schemas:crashed on anallOfthat targets a non-object schema, which is howJobDetailsattaches descriptions to theJobTypeandJobStatusenums.:response-examples-for:and the other whitespace-delimited options were rejected as unknown options.**, the old renderer's request body block was left unclosed, and the 3.0 renderer crashed on a non-object request body.Examples still can't be enabled. With
:generate-examples-from-schemas:on 0.10.0, the stop endpoint's 200 response, a bareJobStatusenum, renders asPENDINGrather than"PENDING"underContent-Type: application/json. Thehttplexer rejects it, and the warning fails the build. That's sphinx-contrib/openapi#172, fixed for thehttpdomainrenderer on the open sphinx-contrib/openapi#185. This PR updates the source comment inapi.mdto name that bug instead of the two that are now fixed. The rendered page doesn't change.What changes:
doc/requirements-doc.txt:sphinxcontrib-openapi==0.9.0→0.10.0.python/deplocks/docs/docbuild_depset_py3.11.lock: regenerated with raydepsets. The diff is the one package block. 0.10.0 declares the same dependencies as 0.9.0, so there's no transitive churn.doc/source/cluster/running-applications/job-submission/api.md: source comment only.0.10.0 raises
requires-pythonfrom>=3.10to>=3.11. The only consumer is the docbuild depset, which is Python 3.11 on both Read the Docs and thedocbuild-py3.11CI image.Related issues
Related to sphinx-contrib/openapi#172.
Additional information
Not a duplicate. No open PR touches
sphinxcontrib-openapior bumps this pin, and no open Dependabot PR targetsdoc/requirements-doc.txt.Tests run:
bazelisk run //ci/raydepsets:raydepsets -- build ci/raydepsets/configs/docs.depsets.yaml --name docbuild_depset_311regenerated the lock.bazelisk run //ci/raydepsets:raydepsets -- build ci/raydepsets/configs/docs.depsets.yaml --checkpassed for all three docs depsets. The doctest lock is unchanged.make -C doc rtd-buildin a Python 3.11 venv installed fromdoc/requirements-doc.lock.txt:build succeeded., zero Sphinx warnings under-W. Thertd-doctorpreflight confirmed the environment matches Read the Docs. The rendered Jobs API page has all 8 endpoints, including/stop.openapi_default_renderer = "httpdomain"under-W: clean on 0.10.0 with no example options. With:generate-examples-from-schemas:it fails on the unquotedPENDING, which is the bug the updated comment describes.AI assistance (Claude Code) was used to prepare this change. I reviewed every changed line.
🤖 Generated with Claude Code