Skip to content

Commit f6ecee2

Browse files
committed
doc: various improvements
1 parent 2b8db90 commit f6ecee2

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

doc/tutorial.rst

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -17,27 +17,27 @@ In addition to your SCIM server root endpoint, you will probably want to provide
1717
from scim2_client.engines.httpx import SyncSCIMClient
1818
1919
client = Client(base_url="https://auth.example/scim/v2", headers={"Authorization": "Bearer foobar"})
20-
scim = SyncSCIMClient(client, resource_types=(User[EnterpriseUser], Group))
20+
scim = SyncSCIMClient(client, resource_models=(User[EnterpriseUser], Group))
2121
22-
You need to give to indicate to :class:`~scim2_client.SCIMClient` all the different :class:`~scim2_models.Resource` types that you will need to manipulate with the :code:`resource_types` parameter.
22+
You need to give to indicate to :class:`~scim2_client.BaseSCIMClient` all the different :class:`~scim2_models.Resource` types that you will need to manipulate with the :code:`resource_models` parameter.
2323
This is needed so scim2-client will be able to guess which resource type to instante when an arbitrary payload is met.
2424

2525
.. todo::
2626

2727
We plan to implement the automatic discovery of SCIM server resources,
28-
so they can dynamically be used without explicitly passing them with the :code:`resource_types` parameter.
28+
so they can dynamically be used without explicitly passing them with the :code:`resource_models` parameter.
2929

3030
Performing actions
3131
==================
3232

3333
scim2-client allows your application to interact with a SCIM server as described in :rfc:`RFC7644 §3 <7644#section-3>`, so you can read and manage the resources.
3434
The following actions are available:
3535

36-
- :meth:`~scim2_client.BaseSCIMClient.create`
37-
- :meth:`~scim2_client.BaseSCIMClient.query`
38-
- :meth:`~scim2_client.BaseSCIMClient.replace`
39-
- :meth:`~scim2_client.BaseSCIMClient.delete`
40-
- :meth:`~scim2_client.BaseSCIMClient.search`
36+
- :meth:`~scim2_client.BaseSyncSCIMClient.create`
37+
- :meth:`~scim2_client.BaseSyncSCIMClient.query`
38+
- :meth:`~scim2_client.BaseSyncSCIMClient.replace`
39+
- :meth:`~scim2_client.BaseSyncSCIMClient.delete`
40+
- :meth:`~scim2_client.BaseSyncSCIMClient.search`
4141

4242
Have a look at the :doc:`reference` to see usage examples and the exhaustive set of parameters, but generally it looks like this:
4343

@@ -64,16 +64,16 @@ By default, the data passed to the :class:`SCIM client <scim2_client.BaseSCIMCli
6464
However sometimes you want to accept invalid inputs and outputs.
6565
To achieve this, all the methods provide the following parameters, all are :data:`True` by default:
6666

67-
- :code:`check_request_payload`:
67+
- :paramref:`~scim2_client.BaseSCIMClient.check_request_payload`:
6868
If :data:`True` (the default) a :class:`~pydantic.ValidationError` will be raised if the input does not respect the SCIM standard.
6969
If :data:`False`, input is expected to be a :data:`dict` that will be passed as-is in the request.
70-
- :code:`check_response_payload`:
70+
- :paramref:`~scim2_client.BaseSCIMClient.check_response_payload`:
7171
If :data:`True` (the default) a :class:`~pydantic.ValidationError` will be raised if the server response does not respect the SCIM standard.
7272
If :data:`False` the server response is returned as-is.
7373
- :code:`expected_status_codes`: The list of expected status codes in the response.
7474
If :data:`None` any status code is accepted.
7575
If an unexpected status code is returned, a :class:`~scim2_client.errors.UnexpectedStatusCode` exception is raised.
76-
- :code:`raise_scim_errors`: If :data:`True` (the default) and the server returned an :class:`~scim2_models.Error` object, a :class:`~scim2_client.SCIMResponseErrorObject` exception will be raised.
76+
- :paramref:`~scim2_client.BaseSCIMClient.raise_scim_errors`: If :data:`True` (the default) and the server returned an :class:`~scim2_models.Error` object, a :class:`~scim2_client.SCIMResponseErrorObject` exception will be raised.
7777
If :data:`False` the error object is returned.
7878

7979

0 commit comments

Comments
 (0)