Skip to content

[docs] Add connection-credentials element to connection #1177

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jacalata merged 1 commit into from
Feb 14, 2023
Merged

[docs] Add connection-credentials element to connection #1177

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions docs/api-ref.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,11 +227,12 @@ Name | Description
`datasource_name` | The name of the data source.
`id` | The identifier of the connection.
`connection_type` | The type of connection.
`username` | The username for the connection.
`password` | The password used for the connection.
`embed_password` | (Boolean) Determines whether to embed the password (`True`) for the workbook or data source connection or not (`False`).
`username` | The username for the connection. (see ConnectionCredentials)
`password` | The password used for the connection. (see ConnectionCredentials)
`embed_password` | (Boolean) Determines whether to embed the password (`True`) for the workbook or data source connection or not (`False`). (see ConnectionCredentials)
`server_address` | The server address for the connection.
`server_port` | The port used for the connection.
`connection_credentials` | The Connection Credentials object containing authentication details for the connection. Replaces username/password/embed_password when publishing a flow, document or workbook file in the request body.

Source file: models/connection_item.py

Expand Down