doc: add a dependency to sphinx-paramlinks

Author: azmeuk

doc/changelog.rst

@@ -1,6 +1,16 @@
 Changelog
 =========
 
+[0.3.2] - 2024-11-29
+--------------------
+
+Added
+^^^^^
+- Implement :class:`~scim2_client.BaseSCIMClient` :paramref:`~scim2_client.BaseSCIMClient.check_request_payload`,
+  :paramref:`~scim2_client.BaseSCIMClient.check_response_payload` and
+  :paramref:`~scim2_client.BaseSCIMClient.raise_scim_errors` paramibutes,
+  to keep the same values for all the requests.
+
 [0.3.1] - 2024-11-29
 --------------------
 

doc/conf.py

@@ -17,6 +17,7 @@
     "sphinx.ext.todo",
     "sphinx.ext.viewcode",
     "sphinx_issues",
+    "sphinx_paramlinks",
     "sphinxcontrib.autodoc_pydantic",
     "myst_parser",
 ]

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "scim2-client"
-version = "0.3.1"
+version = "0.3.2"
 description = "Pythonically build SCIM requests and parse SCIM responses"
 authors = [{name="Yaal Coop", email="[email protected]"}]
 license = {file = "LICENSE.md"}
@@ -64,6 +64,7 @@ doc = [
     "shibuya>=2024.5.15",
     "sphinx-issues >= 5.0.0",
     "sphinx>=7.3.7",
+    "sphinx-paramlinks>=0.6.0",
 ]
 
 [tool.coverage.run]

scim2_client/client.py

@@ -495,11 +495,11 @@ def create(
 
         :param resource: The resource to create
             If is a :data:`dict`, the resource type will be guessed from the schema.
-        :param check_request_payload: If set, overwrites the :attr:`client value<BaseSCIMClient.check_request_payload`.
-        :param check_response_payload: If set, overwrites the :attr:`client value<BaseSCIMClient.check_response_payload`.
+        :param check_request_payload: If set, overwrites :paramref:`BaseSCIMClient.check_request_payload`.
+        :param check_response_payload: If set, overwrites :paramref:`BaseSCIMClient.check_response_payload`.
         :param expected_status_codes: The list of expected status codes form the response.
             If :data:`None` any status code is accepted.
-        :param raise_scim_errors: If set, overwrites the :attr:`client value<BaseSCIMClient.raise_scim_errors`.
+        :param raise_scim_errors: If set, overwrites :paramref:`BaseSCIMClient.raise_scim_errors`.
         :param kwargs: Additional parameters passed to the underlying HTTP request
             library.
 
@@ -547,11 +547,11 @@ def query(
         :param resource_model: A :class:`~scim2_models.Resource` subtype or :data:`None`
         :param id: The SCIM id of an object to get, or :data:`None`
         :param search_request: An object detailing the search query parameters.
-        :param check_request_payload: If set, overwrites the :attr:`client value<BaseSCIMClient.check_request_payload`.
-        :param check_response_payload: If set, overwrites the :attr:`client value<BaseSCIMClient.check_response_payload`.
+        :param check_request_payload: If set, overwrites :paramref:`BaseSCIMClient.check_request_payload`.
+        :param check_response_payload: If set, overwrites :paramref:`BaseSCIMClient.check_response_payload`.
         :param expected_status_codes: The list of expected status codes form the response.
             If :data:`None` any status code is accepted.
-        :param raise_scim_errors: If set, overwrites the :attr:`client value<BaseSCIMClient.raise_scim_errors`.
+        :param raise_scim_errors: If set, overwrites :paramref:`BaseSCIMClient.raise_scim_errors`.
         :param kwargs: Additional parameters passed to the underlying HTTP request library.
 
         :return:
@@ -616,11 +616,11 @@ def search(
         :param resource_models: Resource type or union of types expected
             to be read from the response.
         :param search_request: An object detailing the search query parameters.
-        :param check_request_payload: If set, overwrites the :attr:`client value<BaseSCIMClient.check_request_payload`.
-        :param check_response_payload: If set, overwrites the :attr:`client value<BaseSCIMClient.check_response_payload`.
+        :param check_request_payload: If set, overwrites :paramref:`BaseSCIMClient.check_request_payload`.
+        :param check_response_payload: If set, overwrites :paramref:`BaseSCIMClient.check_response_payload`.
         :param expected_status_codes: The list of expected status codes form the response.
             If :data:`None` any status code is accepted.
-        :param raise_scim_errors: If set, overwrites the :attr:`client value<BaseSCIMClient.raise_scim_errors`.
+        :param raise_scim_errors: If set, overwrites :paramref:`BaseSCIMClient.raise_scim_errors`.
         :param kwargs: Additional parameters passed to the underlying
             HTTP request library.
 
@@ -663,10 +663,10 @@ def delete(
 
         :param resource_model: The type of the resource to delete.
         :param id: The type id the resource to delete.
-        :param check_response_payload: If set, overwrites the :attr:`client value<BaseSCIMClient.check_response_payload`.
+        :param check_response_payload: If set, overwrites :paramref:`BaseSCIMClient.check_response_payload`.
         :param expected_status_codes: The list of expected status codes form the response.
             If :data:`None` any status code is accepted.
-        :param raise_scim_errors: If set, overwrites the :attr:`client value<BaseSCIMClient.raise_scim_errors`.
+        :param raise_scim_errors: If set, overwrites :paramref:`BaseSCIMClient.raise_scim_errors`.
         :param kwargs: Additional parameters passed to the underlying
             HTTP request library.
 
@@ -701,11 +701,11 @@ def replace(
 
         :param resource: The new resource to replace.
             If is a :data:`dict`, the resource type will be guessed from the schema.
-        :param check_request_payload: If set, overwrites the :attr:`client value<BaseSCIMClient.check_request_payload`.
-        :param check_response_payload: If set, overwrites the :attr:`client value<BaseSCIMClient.check_response_payload`.
+        :param check_request_payload: If set, overwrites :paramref:`BaseSCIMClient.check_request_payload`.
+        :param check_response_payload: If set, overwrites :paramref:`BaseSCIMClient.check_response_payload`.
         :param expected_status_codes: The list of expected status codes form the response.
             If :data:`None` any status code is accepted.
-        :param raise_scim_errors: If set, overwrites the :attr:`client value<BaseSCIMClient.raise_scim_errors`.
+        :param raise_scim_errors: If set, overwrites :paramref:`BaseSCIMClient.raise_scim_errors`.
         :param kwargs: Additional parameters passed to the underlying
             HTTP request library.
 
@@ -752,11 +752,11 @@ async def create(
 
         :param resource: The resource to create
             If is a :data:`dict`, the resource type will be guessed from the schema.
-        :param check_request_payload: If set, overwrites the :attr:`client value<BaseSCIMClient.check_request_payload`.
-        :param check_response_payload: If set, overwrites the :attr:`client value<BaseSCIMClient.check_response_payload`.
+        :param check_request_payload: If set, overwrites :paramref:`BaseSCIMClient.check_request_payload`.
+        :param check_response_payload: If set, overwrites :paramref:`BaseSCIMClient.check_response_payload`.
         :param expected_status_codes: The list of expected status codes form the response.
             If :data:`None` any status code is accepted.
-        :param raise_scim_errors: If set, overwrites the :attr:`client value<BaseSCIMClient.raise_scim_errors`.
+        :param raise_scim_errors: If set, overwrites :paramref:`BaseSCIMClient.raise_scim_errors`.
         :param kwargs: Additional parameters passed to the underlying HTTP request
             library.
 
@@ -804,11 +804,11 @@ async def query(
         :param resource_model: A :class:`~scim2_models.Resource` subtype or :data:`None`
         :param id: The SCIM id of an object to get, or :data:`None`
         :param search_request: An object detailing the search query parameters.
-        :param check_request_payload: If set, overwrites the :attr:`client value<BaseSCIMClient.check_request_payload`.
-        :param check_response_payload: If set, overwrites the :attr:`client value<BaseSCIMClient.check_response_payload`.
+        :param check_request_payload: If set, overwrites :paramref:`BaseSCIMClient.check_request_payload`.
+        :param check_response_payload: If set, overwrites :paramref:`BaseSCIMClient.check_response_payload`.
         :param expected_status_codes: The list of expected status codes form the response.
             If :data:`None` any status code is accepted.
-        :param raise_scim_errors: If set, overwrites the :attr:`client value<BaseSCIMClient.raise_scim_errors`.
+        :param raise_scim_errors: If set, overwrites :paramref:`BaseSCIMClient.raise_scim_errors`.
         :param kwargs: Additional parameters passed to the underlying HTTP request library.
 
         :return:
@@ -873,11 +873,11 @@ async def search(
         :param resource_models: Resource type or union of types expected
             to be read from the response.
         :param search_request: An object detailing the search query parameters.
-        :param check_request_payload: If set, overwrites the :attr:`client value<BaseSCIMClient.check_request_payload`.
-        :param check_response_payload: If set, overwrites the :attr:`client value<BaseSCIMClient.check_response_payload`.
+        :param check_request_payload: If set, overwrites :paramref:`BaseSCIMClient.check_request_payload`.
+        :param check_response_payload: If set, overwrites :paramref:`BaseSCIMClient.check_response_payload`.
         :param expected_status_codes: The list of expected status codes form the response.
             If :data:`None` any status code is accepted.
-        :param raise_scim_errors: If set, overwrites the :attr:`client value<BaseSCIMClient.raise_scim_errors`.
+        :param raise_scim_errors: If set, overwrites :paramref:`BaseSCIMClient.raise_scim_errors`.
         :param kwargs: Additional parameters passed to the underlying
             HTTP request library.
 
@@ -920,10 +920,10 @@ async def delete(
 
         :param resource_model: The type of the resource to delete.
         :param id: The type id the resource to delete.
-        :param check_response_payload: If set, overwrites the :attr:`client value<BaseSCIMClient.check_response_payload`.
+        :param check_response_payload: If set, overwrites :paramref:`BaseSCIMClient.check_response_payload`.
         :param expected_status_codes: The list of expected status codes form the response.
             If :data:`None` any status code is accepted.
-        :param raise_scim_errors: If set, overwrites the :attr:`client value<BaseSCIMClient.raise_scim_errors`.
+        :param raise_scim_errors: If set, overwrites :paramref:`BaseSCIMClient.raise_scim_errors`.
         :param kwargs: Additional parameters passed to the underlying
             HTTP request library.
 
@@ -958,11 +958,11 @@ async def replace(
 
         :param resource: The new resource to replace.
             If is a :data:`dict`, the resource type will be guessed from the schema.
-        :param check_request_payload: If set, overwrites the :attr:`client value<BaseSCIMClient.check_request_payload`.
-        :param check_response_payload: If set, overwrites the :attr:`client value<BaseSCIMClient.check_response_payload`.
+        :param check_request_payload: If set, overwrites :paramref:`BaseSCIMClient.check_request_payload`.
+        :param check_response_payload: If set, overwrites :paramref:`BaseSCIMClient.check_response_payload`.
         :param expected_status_codes: The list of expected status codes form the response.
             If :data:`None` any status code is accepted.
-        :param raise_scim_errors: If set, overwrites the :attr:`client value<BaseSCIMClient.raise_scim_errors`.
+        :param raise_scim_errors: If set, overwrites :paramref:`BaseSCIMClient.raise_scim_errors`.
         :param kwargs: Additional parameters passed to the underlying
             HTTP request library.