Skip to content

Commit 5bf5aa9

Browse files
authored
Merge pull request #1384 from jorwoods/jorwoods/deprecated-docs
docs: reflect deprecated removals and updates
2 parents 998a3ba + 8f63907 commit 5bf5aa9

File tree

1 file changed

+6
-8
lines changed

1 file changed

+6
-8
lines changed

docs/api-ref.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2061,9 +2061,9 @@ Name | Description
20612061
```
20622062

20632063

2064-
#### projects.update_permission
2064+
#### projects.update_permissions
20652065
```py
2066-
projects.update_permission(item, rules)
2066+
projects.update_permissions(item, rules)
20672067
```
20682068

20692069
Add project permissions for a user or group.
@@ -2096,7 +2096,7 @@ Name | Description
20962096
capabilities=project_capabilities
20972097
)
20982098

2099-
server.projects.update_permission(project_item, [project_rules])
2099+
server.projects.update_permissions(project_item, [project_rules])
21002100
```
21012101

21022102

@@ -5336,7 +5336,7 @@ print(workbook.name)
53365336
#### workbooks.publish
53375337

53385338
```py
5339-
workbooks.publish(workbook_item, file_path, publish_mode, connections, skip_connection_check, as_job, hidden_views)
5339+
workbooks.publish(workbook_item, file_path, publish_mode, connections, skip_connection_check, as_job)
53405340
```
53415341

53425342
Publish a workbook to the specified site.
@@ -5360,10 +5360,8 @@ Name | Description
53605360
`file` | The file path or file object of the workbook to publish. When providing a file object, you must also specifiy the name of the workbook in your instance of the `workbook_item``workbook_item` , as the name cannot be derived from the file name.
53615361
`mode` | Specifies whether you are publishing a new workbook (`CreateNew`) or overwriting an existing workbook (`Overwrite`). You cannot appending workbooks. You can also use the publish mode attributes, for example: `TSC.Server.PublishMode.Overwrite`.
53625362
`connections` | List of `ConnectionItems` objects for the connections created within the workbook.
5363-
`connection_credentials` | (Optional) The credentials (if required) to connect to the workbook's data source. The `ConnectionCredentials` object contains the authentication information for the data source (user name and password, and whether the credentials are embedded or OAuth is used). **Deprecated since API server version 2.3.**
53645363
`skip_connection_check` | (Optional) Set to `True` to skip connection check at time of upload. Publishing will succeed but unchecked connection issues may result in a non-functioning workbook. Defaults to `False`.
53655364
`as_job` | (Optional) Set to `True` to run the upload as a job (asynchronous upload). If set to `True` a job will start to perform the publishing process and a `Job` object is returned. Defaults to `False`.
5366-
`hidden_views` | (Optional) List of string names of views that need to be hidden when the workbook is published.
53675365

53685366

53695367

@@ -5783,7 +5781,7 @@ None. The preview image is added to the view.
57835781
#### workbooks.update_connection
57845782

57855783
```py
5786-
workbooks.update_conn(workbook_item, connection_item)
5784+
workbooks.update_connection(workbook_item, connection_item)
57875785
```
57885786

57895787
Updates a workbook connection information (server address, server port, user name, and password).
@@ -5821,7 +5819,7 @@ connection.username = 'USERNAME'
58215819
connection.password = 'PASSWORD'
58225820

58235821
# call the update method
5824-
server.workbooks.update_conn(workbook, connection)
5822+
server.workbooks.update_connection(workbook, connection)
58255823
```
58265824

58275825
<br>

0 commit comments

Comments
 (0)