8000 Remove redundant text around request options for populate_csv and pop… · shiv-io/server-client-python@6f85676 · GitHub
[go: up one dir, main page]
Skip to content

Commit 6f85676

Browse files
bcantonibcantoni
committed
Remove redundant text around request options for populate_csv and populate_pdf methods
1 parent 24e9149 commit 6f85676

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

‎docs/api-ref.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3365,7 +3365,7 @@ This endpoint is available with REST API version 2.7 and up.
33653365
Name | description
33663366
:--- | :---
33673367
`view_item` | Specifies the view to populate.
3368-
`req_options` | (Optional) You can pass in request options to specify the maximum age of the CSV cached on the server. The maximum CSV cache time is the value of `maxage` in minutes, and must be an integer between 1 and 240. A value of zero will cause the minimum cache time of 1 minute. A value of -1 will cache CSV files for the time configured in server settings. You can also specify view filters to be applied when the data is generated. See [CSVRequestOptions class](#csvrequestoptions-class) for more details.
3368+
`req_options` | (Optional) You can pass in request options to specify the maximum age of the CSV cached on the server. See [CSVRequestOptions class](#csvrequestoptions-class) for more details.
33693369

33703370
**Exceptions**
33713371

@@ -3381,9 +3381,9 @@ None. The CSV data is added to the `view_item` and can be accessed by its `csv`
33813381
```py
33823382
# Sign in, get view, etc.
33833383

3384-
# Populate and save the CSV data as 'view_csv.csv'
3384+
# Populate and save the CSV data in a file
33853385
server.views.populate_csv(view_item)
3386-
with open('./view_csv.csv', 'wb') as f:
3386+
with open('./view_data.csv', 'wb') as f:
33873387
# Perform byte join on the CSV data
33883388
f.write(b''.join(view_item.csv))
33893389
```
@@ -3413,7 +3413,7 @@ This endpoint is available with REST API version 2.7 and up.
34133413
Name | description
34143414
:--- | :---
34153415
`view_item` | Specifies the view to populate.
3416-
`req_options` | (Optional) You can pass in request options to specify the page type and orientation of the PDF content, as well as the maximum age of the PDF rendered on the server. If not specified, PDF content will have default page type and orientation. The maximum PDF cache time is the value of `maxage` in minutes, and must be an integer between 1 and 240. A value of zero will cause the minimum cache time of 1 minute. A value of -1 will cache PDF files for the time configured in server settings. You can also specify view filters to be applied when the PDF is generated. See [PDFRequestOptions class](#pdfrequestoptions-class) for more details.
3416+
`req_options` | (Optional) You can pass in request options to specify the page type and orientation of the PDF content, as well as the maximum age of the PDF rendered on the server. See [PDFRequestOptions class](#pdfrequestoptions-class) for more details.
34173417

34183418
**Exceptions**
34193419

@@ -4125,7 +4125,7 @@ This endpoint is available with REST API version 3.4 and up.
41254125
Name | description
41264126
:--- | :---
41274127
`workbook_item` | Specifies the workbook to populate.
4128-
`req_options` | (Optional) You can pass in request options to specify the page type and orientation of the PDF content, as well as the maximum age of the PDF rendered on the server. If not specified, PDF content will have default page type and orientation. The maximum PDF cache time is the value of `maxage` in minutes, and must be an integer between 1 and 240. A value of zero will cause the minimum cache time of 1 minute. A value of -1 will cache PDF files for the time configured in server settings. See [PDFRequestOptions class](#pdfrequestoptions-class) for more details.
4128+
`req_options` | (Optional) You can pass in request options to specify the page type and orientation of the PDF content, as well as the maximum age of the PDF rendered on the server. See [PDFRequestOptions class](#pdfrequestoptions-class) for more details.
41294129

41304130
**Exceptions**
41314131

0 commit comments

Comments
 (0)
0