Skip to content

Commit bb711bc

Browse files
committed
docs: use definitions from rfc 9865 in docstrings
1 parent 6771299 commit bb711bc

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

‎scim2_models/resources/service_provider_config.py‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -58,24 +58,24 @@ class DefaultPaginationMethod(ExtensibleStringEnum):
5858
index = "index"
5959

6060
cursor: Annotated[bool | None, Mutability.read_only, Required.true] = None
61-
"""A Boolean value specifying whether or not the operation is supported."""
61+
"""A Boolean value specifying support of cursor-based pagination."""
6262

6363
index: Annotated[bool | None, Mutability.read_only, Required.true] = None
64-
"""A Boolean value specifying whether or not the operation is supported."""
64+
"""A Boolean value specifying support of index-based pagination."""
6565

6666
default_pagination_method: Annotated[
6767
DefaultPaginationMethod | None, Mutability.read_only
6868
] = None
69-
"""A string value specifying the default pagination method"""
69+
"""A string value specifying the type of pagination that the service provider defaults to when the client has not specified which method it wishes to use. Possible values are "cursor" and "index"."""
7070

7171
default_page_size: Annotated[int | None, Mutability.read_only] = None
72-
"""An integer value specifying the default page size."""
72+
"""Positive integer value specifying the default number of results returned in a page when a count is not specified in the query."""
7373

7474
max_page_size: Annotated[int | None, Mutability.read_only] = None
75-
"""An integer value specifying the maximum page size."""
75+
"""Positive integer specifying the maximum number of results returned in a page regardless of what is specified for the count in a query. The maximum number of results returned may be further restricted by other criteria."""
7676

7777
cursor_timeout: Annotated[int | None, Mutability.read_only] = None
78-
"""An integer value specifying the cursor timeout in seconds."""
78+
"""Positive integer specifying the minimum number of seconds that a cursor is valid between page requests. Clients waiting too long between cursor pagination requests may receive an invalid cursor error response. No value being specified may mean that there is no cursor timeout or that the cursor timeout is not a static duration."""
7979

8080

8181
class AuthenticationScheme(ComplexAttribute):

0 commit comments

Comments
 (0)