sphinx-contrib / sphinx-contrib/openapi

jsonschema deprecation warning

Open
#154 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
126
Forks
88
PR merge metrics
No merged PRs in 30d

Description

Running the tests using jsonschema version 4.19.2, I received the following warning:

../../../../../usr/lib/python3/dist-packages/sphinxcontrib/openapi/utils.py:27
  /usr/lib/python3/dist-packages/sphinxcontrib/openapi/utils.py:27: DeprecationWarning:
  jsonschema.RefResolver is deprecated as of v4.18.0, in favor of the
  https://github.com/python-jsonschema/referencing library, which provides more compliant
  referencing behavior as well as more flexible APIs for customization. A future release will remove
  RefResolver. Please file a feature request (on referencing) if you are missing an API for the kind
  of customization you need.
    class OpenApiRefResolver(jsonschema.RefResolver):

So utils.py should be updated at some point, probably in the not-too-distant future.

[EDIT: manually wrapped the long warning message to avoid having to scroll as far]

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with sphinxcontrib/openapi/utils.py at the OpenApiRefResolver definition and review the jsonschema deprecation warning for the referencing replacement. Run the project tests with jsonschema 4.19.2 and confirm the warning is no longer emitted while the OpenAPI extension remains functional.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.