Skip to content

[Storage] Fix docs for list_blobs and walk_blobs #26836

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
merged 2 commits into from
Oct 17, 2022
Merged

[Storage] Fix docs for list_blobs and walk_blobs #26836

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bbdac8e
Fix docs type for `list_blobs.include` again
jalauzon-msft Oct 14, 2022
acd3d80
Also fix `walk_blobs`
jalauzon-msft Oct 14, 2022
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
10 changes: 6 additions & 4 deletions sdk/storage/azure-storage-blob/azure/storage/blob/_container_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -762,7 +762,7 @@ def list_blobs(self, name_starts_with=None, include=None, **kwargs):
Specifies one or more additional datasets to include in the response.
Options include: 'snapshots', 'metadata', 'uncommittedblobs', 'copy', 'deleted', 'deletedwithversions',
'tags', 'versions', 'immutabilitypolicy', 'legalhold'.
:paramtype include: list[str] or str
:type include: list[str] or str
:keyword int timeout:
The timeout parameter is expressed in seconds.
:returns: An iterable (auto-paging) response of BlobProperties.
Expand Down Expand Up @@ -831,7 +831,7 @@ def list_blob_names(self, **kwargs: Any) -> ItemPaged[str]:
@distributed_trace
def walk_blobs(
self, name_starts_with=None, # type: Optional[str]
include=None, # type: Optional[Any]
include=None, # type: Optional[Union[List[str], str]]
delimiter="/", # type: str
**kwargs # type: Optional[Any]
):
Expand All @@ -844,9 +844,11 @@ def walk_blobs(
:param str name_starts_with:
Filters the results to return only blobs whose names
begin with the specified prefix.
:param list[str] include:
:param include:
Specifies one or more additional datasets to include in the response.
Options include: 'snapshots', 'metadata', 'uncommittedblobs', 'copy', 'deleted'.
Options include: 'snapshots', 'metadata', 'uncommittedblobs', 'copy', 'deleted', 'deletedwithversions',
'tags', 'versions', 'immutabilitypolicy', 'legalhold'.
:type include: list[str] or str
:param str delimiter:
When the request includes this parameter, the operation returns a BlobPrefix
element in the response body that acts as a placeholder for all blobs whose
Expand Down
12 changes: 7 additions & 5 deletions sdk/storage/azure-storage-blob/azure/storage/blob/aio/_container_client_async.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -617,8 +617,8 @@ def list_blobs(self, name_starts_with=None, include=None, **kwargs):
:param include:
Specifies one or more additional datasets to include in the response.
Options include: 'snapshots', 'metadata', 'uncommittedblobs', 'copy', 'deleted', 'deletedwithversions',
'tags', 'versions'.
:paramtype include: list[str] or str
'tags', 'versions', 'immutabilitypolicy', 'legalhold'.
:type include: list[str] or str
:keyword int timeout:
The timeout parameter is expressed in seconds.
:returns: An iterable (auto-paging) response of BlobProperties.
Expand Down Expand Up @@ -690,7 +690,7 @@ def list_blob_names(self, **kwargs: Any) -> AsyncItemPaged[str]:
@distributed_trace
def walk_blobs(
self, name_starts_with=None, # type: Optional[str]
include=None, # type: Optional[Any]
include=None, # type: Optional[Union[List[str], str]]
delimiter="/", # type: str
**kwargs # type: Optional[Any]
):
Expand All @@ -703,9 +703,11 @@ def walk_blobs(
:param str name_starts_with:
Filters the results to return only blobs whose names
begin with the specified prefix.
:param list[str] include:
:param include:
Specifies one or more additional datasets to include in the response.
Options include: 'snapshots', 'metadata', 'uncommittedblobs', 'copy', 'deleted'.
Options include: 'snapshots', 'metadata', 'uncommittedblobs', 'copy', 'deleted', 'deletedwithversions',
'tags', 'versions', 'immutabilitypolicy', 'legalhold'.
:type include: list[str] or str
:param str delimiter:
When the request includes this parameter, the operation returns a BlobPrefix
element in the response body that acts as a placeholder for all blobs whose
Expand Down