8000 docs: docstrings for user item and endpoint (#1485) · TrimPeachu/server-client-python@1b64987 · GitHub
[go: up one dir, main page]
Skip to content

Commit 1b64987

Browse files
jorwoodsjorwoods
authored
docs: docstrings for user item and endpoint (tableau#1485)
* docs: docstrings for user item and endpoint * docs: add serverresponseerror details --------- Co-authored-by: Jordan Woods <13803242+jorwoods@users.noreply.github.com>
1 parent 89e1ddf commit 1b64987

File tree

2 files changed

+377
-0
lines changed

2 files changed

+377
-0
lines changed

‎tableauserverclient/models/user_item.py

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,34 @@
1919

2020

2121
class UserItem:
22+
"""
23+
The UserItem class contains the members or attributes for the view
24+
resources on Tableau Server. The UserItem class defines the information you
25+
can request or query from Tableau Server. The class attributes correspond
26+
to the attributes of a server request or response payload.
27+
28+
29+
Parameters
30+
----------
31+
name: str
32+
The name of the user.
33+
34+
site_role: str
35+
The role of the user on the site.
36+
37+
auth_setting: str
38+
Required attribute for Tableau Cloud. How the user autenticates to the
39+
server.
40+
"""
41+
2242
tag_name: str = "user"
2343

2444
class Roles:
45+
"""
46+
The Roles class contains the possible roles for a user on Tableau
47+
Server.
48+
"""
49+
2550
Interactor = "Interactor"
2651
Publisher = "Publisher"
2752
ServerAdministrator = "ServerAdministrator"
@@ -43,6 +68,11 @@ class Roles:
4368
SupportUser = "SupportUser"
4469

4570
class Auth:
71+
"""
72+
The Auth class contains the possible authentication settings for a user
73+
on Tableau Cloud.
74+
"""
75+
4676
OpenID = "OpenID"
4777
SAML = "SAML"
4878
TableauIDWithMFA = "TableauIDWithMFA"

0 commit comments

Comments
 (0)
0