Skip to content
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

Jump to bottom

Add param docs for endpoint management methods #462

Merged
merged 1 commit into from Aug 26, 2021
Merged

Add param docs for endpoint management methods #462

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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
30 changes: 23 additions & 7 deletions src/globus_sdk/services/transfer/client.py
View file
Open in desktop
Expand Up @@ -1355,9 +1355,7 @@ def task_skipped_errors(
>>> info["error_code"], info["source_path"]))
"""
task_id = utils.safe_stringify(task_id)
log.info(
"TransferClient.endpoint_manager_task_skipped_errors(%s, ...)", task_id
)
log.info("TransferClient.task_skipped_errors(%s, ...)", task_id)
resource_path = self.qjoin_path("task", task_id, "skipped_errors")
return IterableTransferResponse(
self.get(resource_path, query_params=query_params)
Expand All @@ -1375,9 +1373,12 @@ def endpoint_manager_monitored_endpoints(
self, query_params: Optional[Dict[str, Any]] = None
) -> IterableTransferResponse:
"""
``GET endpoint_manager/monitored_endpoints``

Get endpoints the current user is a monitor or manager on.

``GET endpoint_manager/monitored_endpoints``
:param query_params: Additional passthrough query parameters
:type query_params: dict, optional
"""
log.info(f"TransferClient.endpoint_manager_monitored_endpoints({query_params})")
path = self.qjoin_path("endpoint_manager", "monitored_endpoints")
Expand All @@ -1391,9 +1392,14 @@ def endpoint_manager_hosted_endpoint_list(
self, endpoint_id: UUIDLike, query_params: Optional[Dict[str, Any]] = None
) -> IterableTransferResponse:
"""
``GET /endpoint_manager/endpoint/<endpoint_id>/hosted_endpoint_list``

Get shared endpoints hosted on the given endpoint.

``GET /endpoint_manager/endpoint/<endpoint_id>/hosted_endpoint_list``
:param endpoint_id: The ID of the host endpoint
:type endpoint_id: str or UUID
:param query_params: Additional passthrough query parameters
:type query_params: dict, optional
"""
endpoint_id = utils.safe_stringify(endpoint_id)
log.info(f"TransferClient.endpoint_manager_hosted_endpoint_list({endpoint_id})")
Expand All @@ -1410,9 +1416,14 @@ def endpoint_manager_get_endpoint(
self, endpoint_id: UUIDLike, query_params: Optional[Dict[str, Any]] = None
) -> response.GlobusHTTPResponse:
"""
``GET /endpoint_manager/endpoint/<endpoint_id>``

Get endpoint details as an admin.

``GET /endpoint_manager/endpoint/<endpoint_id>``
:param endpoint_id: The ID of the endpoint
:type endpoint_id: str or UUID
:param query_params: Additional passthrough query parameters
:type query_params: dict, optional
"""
endpoint_id = utils.safe_stringify(endpoint_id)
log.info(f"TransferClient.endpoint_manager_get_endpoint({endpoint_id})")
Expand All @@ -1427,9 +1438,14 @@ def endpoint_manager_acl_list(
self, endpoint_id: UUIDLike, query_params: Optional[Dict[str, Any]] = None
) -> IterableTransferResponse:
"""
``GET endpoint_manager/endpoint/<endpoint_id>/access_list``

Get a list of access control rules on specified endpoint as an admin.

``GET endpoint_manager/endpoint/<endpoint_id>/access_list``
:param endpoint_id: The ID of the endpoint
:type endpoint_id: str or UUID
:param query_params: Additional passthrough query parameters
:type query_params: dict, optional
"""
endpoint_id = utils.safe_stringify(endpoint_id)
log.info(
Expand Down