8000 Fix a couple of headings and correct spelling of req_options (#683) · tableau/server-client-python@0123139 · GitHub
[go: up one dir, main page]

Skip to content

Commit 0123139

Browse files
authored
Fix a couple of headings and correct spelling of req_options (#683)
1 parent 2dd6ec8 commit 0123139

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

docs/api-ref.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ Source file: server/endpoint/auth_endpoint.py
7979
<br>
8080
<br>
8181

82-
#### auth.sign in
82+
#### auth.sign_in
8383

8484
```py
8585
auth.sign_in(auth_req)
@@ -122,7 +122,7 @@ server.auth.sign_in(tableau_auth)
122122
<br>
123123

124124

125-
#### auth.sign out
125+
#### auth.sign_out
126126

127127
```py
128128
auth.sign_out()
@@ -367,7 +367,7 @@ REST API: [Query Datasources](https://help.tableau.com/current/api/rest_api/en-u
367367

368368
Name | Description
369369
:--- | :---
370-
`req_option` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific data source, you could specify the name of the project or its id.
370+
`req_options` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific data source, you could specify the name of the project or its id.
371371

372372

373373
**Returns**
@@ -949,7 +949,7 @@ REST API: [Get Users on Site](https://help.tableau.com/current/api/rest_api/en-u
949949

950950
Name | Description
951951
:--- | :---
952-
`req_option` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific group, you could specify the name of the group or the group id.
952+
`req_options` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific group, you could specify the name of the group or the group id.
953953

954954

955955
**Returns**
@@ -1850,7 +1850,7 @@ REST API: [Query Schedules](https://help.tableau.com/current/api/rest_api/en-us/
18501850

18511851
Name | Description
18521852
:--- | :---
1853-
`req_options` | (Optional) To filter the return items, you can specify request options. See Requests and .
1853+
`req_options` | (Optional) Additional request options to send to the endpoint.
18541854

18551855
#### schedule.update
18561856

@@ -2663,7 +2663,7 @@ REST API: [Query Subscriptions](https://help.tableau.com/current/api/rest_api/en
26632663

26642664
Name | Description
26652665
:--- | : ---
2666-
`req_option` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific subscription, you could specify the subject of the subscription or the id of the subscription.
2666+
`req_options` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific subscription, you could specify the subject of the subscription or the id of the subscription.
26672667

26682668

26692669
**Returns**
@@ -2839,7 +2839,7 @@ REST API: [Get Users on Site](https://help.tableau.com/current/api/rest_api/en-u
28392839

28402840
Name | Description
28412841
:--- | : ---
2842-
`req_option` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific user, you could specify the name of the user or the user's id.
2842+
`req_options` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific user, you could specify the name of the user or the user's id.
28432843

28442844

28452845
**Returns**
@@ -3164,7 +3164,7 @@ This endpoint is available with REST API version 2.0 and up.
31643164

31653165
Name | Description
31663166
:--- | :---
3167-
`req_option` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific view, you could specify the name of the view or its ID.
3167+
`req_options` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific view, you could specify the name of the view or its ID.
31683168
`usage` | (Optional) If true (`usage=True`) returns the usage statistics for the views. The default is `usage=False`.
31693169

31703170

@@ -3492,7 +3492,7 @@ REST API: [Query Workbooks for Site](https://help.tableau.com/current/api/rest_a
34923492

34933493
Name | Description
34943494
:--- | :---
3495-
`req_option` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific workbook, you could specify the name of the workbook or the name of the owner. See [Filter and Sort](filter-sort)
3495+
`req_options` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific workbook, you could specify the name of the workbook or the name of the owner. See [Filter and Sort](filter-sort)
34963496

34973497

34983498
**Returns**

0 commit comments

Comments
 (0)
0