New APIs: Update multiple connections in a single workbook/datasource #1638
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jorwoods
suggested changes
Jul 15, 2025
|
|
||
| @api(version="3.26") | ||
| def update_connections( | ||
| self, datasource_item: DatasourceItem, connection_luids: list[str], authentication_type: str, username: Optional[str] = None, password: Optional[str] = None, embed_password: Optional[bool] = None |
Contributor
There was a problem hiding this comment.
It changes the username, password, embed, and auth type setting uniformly across all of the listed connections?
The type for connection_luids should actually be Iterable[str] since the only criteria is that it can be looped over.
Comment on lines
354
to
379
| from xml.etree.ElementTree import Element, SubElement, tostring | ||
|
|
||
| url = f"{self.baseurl}/{datasource_item.id}/connections" | ||
| print("Method URL:", url) | ||
|
|
||
| ts_request = Element("tsRequest") | ||
|
|
||
| # <connectionLuids> | ||
| conn_luids_elem = SubElement(ts_request, "connectionLuids") | ||
| for luid in connection_luids: | ||
| SubElement(conn_luids_elem, "connectionLuid").text = luid | ||
|
|
||
| # <connection> | ||
| connection_elem = SubElement(ts_request, "connection") | ||
| connection_elem.set("authenticationType", authentication_type) | ||
|
|
||
| if username: | ||
| connection_elem.set("userName", username) | ||
|
|
||
| if password: | ||
| connection_elem.set("password", password) | ||
|
|
||
| if embed_password is not None: | ||
| connection_elem.set("embedPassword", str(embed_password).lower()) | ||
|
|
||
| request_body = tostring(ts_request) |
Contributor
There was a problem hiding this comment.
The XML payload generation is typically done in the request_factory.py. Can this be moved?
|
|
||
| # Update workbook_connections | ||
| @api(version="3.26") | ||
| def update_connections(self, workbook_item: WorkbookItem, connection_luids: list[str], authentication_type: str, username: Optional[str] = None, password: Optional[str] = None, embed_password: Optional[bool] = None |
Contributor
There was a problem hiding this comment.
Same comments as the datasource function signature.
Comment on lines
360
to
384
| from xml.etree.ElementTree import Element, SubElement, tostring | ||
|
|
||
| url = f"{self.baseurl}/{workbook_item.id}/connections" | ||
|
|
||
| ts_request = Element("tsRequest") | ||
|
|
||
| # <connectionLuids> | ||
| conn_luids_elem = SubElement(ts_request, "connectionLuids") | ||
| for luid in connection_luids: | ||
| SubElement(conn_luids_elem, "connectionLuid").text = luid | ||
|
|
||
| # <connection> | ||
| connection_elem = SubElement(ts_request, "connection") | ||
| connection_elem.set("authenticationType", authentication_type) | ||
|
|
||
| if username: | ||
| connection_elem.set("userName", username) | ||
|
|
||
| if password: | ||
| connection_elem.set("password", password) | ||
|
|
||
| if embed_password is not None: | ||
| connection_elem.set("embedPassword", str(embed_password).lower()) | ||
|
|
||
| request_body = tostring(ts_request) |
Contributor
There was a problem hiding this comment.
Same as datasource, this belongs in request factory
Also correct the type hints to clarify that it accepts any Iterable.
Contributor
|
@vchavatapalli thanks for adding this. For a better trail for the record, could you update this PR title & description to explain which are the new APIs you're adding? Also, make sure to run |
Contributor
Author
chore: refactor XML payload into RequestFactory
jorwoods
approved these changes
Jul 21, 2025
bcantoni
changed the title
bcantoni
approved these changes
Jul 21, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This are new API's coming up in next release
Attaching our test document for more details:
https://salesforce.quip.com/gQy6AHWU1Utt