Skip to content

[doc] Bump sphinxcontrib-openapi to 0.10.0 - #66957

Merged
dstrodtman merged 1 commit into
masterfrom
doc-1516-openapi-0-10-bump
Oct 13, 2026
Merged

dstrodtman merged 1 commit into
masterfrom
doc-1516-openapi-0-10-bump

Conversation

@dstrodtman

Copy link
Copy Markdown
Contributor

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:

  • sphinx-contrib/openapi#166: :generate-examples-from-schemas: crashed on an allOf that targets a non-object schema, which is how JobDetails attaches descriptions to the JobType and JobStatus enums.
  • sphinx-contrib/openapi#165: :response-examples-for: and the other whitespace-delimited options were rejected as unknown options.
  • #173, #171, and #178: an operation summary written as a YAML block scalar rendered literal **, 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 bare JobStatus enum, renders as PENDING rather than "PENDING" under Content-Type: application/json. The http lexer rejects it, and the warning fails the build. That's sphinx-contrib/openapi#172, fixed for the httpdomain renderer on the open sphinx-contrib/openapi#185. This PR updates the source comment in api.md to 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-python from >=3.10 to >=3.11. The only consumer is the docbuild depset, which is Python 3.11 on both Read the Docs and the docbuild-py3.11 CI image.

Related issues

Related to sphinx-contrib/openapi#172.

Additional information

Not a duplicate. No open PR touches sphinxcontrib-openapi or bumps this pin, and no open Dependabot PR targets doc/requirements-doc.txt.

Tests run:

  • bazelisk run //ci/raydepsets:raydepsets -- build ci/raydepsets/configs/docs.depsets.yaml --name docbuild_depset_311 regenerated the lock.
  • bazelisk run //ci/raydepsets:raydepsets -- build ci/raydepsets/configs/docs.depsets.yaml --check passed for all three docs depsets. The doctest lock is unchanged.
  • make -C doc rtd-build in a Python 3.11 venv installed from doc/requirements-doc.lock.txt: build succeeded., zero Sphinx warnings under -W. The rtd-doctor preflight confirmed the environment matches Read the Docs. The rendered Jobs API page has all 8 endpoints, including /stop.
  • The Jobs spec rendered standalone with openapi_default_renderer = "httpdomain" under -W: clean on 0.10.0 with no example options. With :generate-examples-from-schemas: it fails on the unquoted PENDING, 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

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>
@dstrodtman
dstrodtman requested review from a team as code owners October 13, 2026 17:15

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@dstrodtman dstrodtman added the go add ONLY when ready to merge, run all tests label Oct 13, 2026
@dstrodtman
dstrodtman merged commit 226d267 into master Oct 13, 2026
6 checks passed
@dstrodtman
dstrodtman deleted the doc-1516-openapi-0-10-bump branch October 13, 2026 17:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

go add ONLY when ready to merge, run all tests

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants