Skip to content

Commit 60ef9f0

Browse files
[Storage] Fix docs for list_blobs and walk_blobs (#26836)
1 parent 8f9e770 commit 60ef9f0

File tree

2 files changed

+13
-9
lines changed

2 files changed

+13
-9
lines changed

sdk/storage/azure-storage-blob/azure/storage/blob/_container_client.py

+6-4
Original file line numberDiff line numberDiff line change
@@ -762,7 +762,7 @@ def list_blobs(self, name_starts_with=None, include=None, **kwargs):
762762
Specifies one or more additional datasets to include in the response.
763763
Options include: 'snapshots', 'metadata', 'uncommittedblobs', 'copy', 'deleted', 'deletedwithversions',
764764
'tags', 'versions', 'immutabilitypolicy', 'legalhold'.
765-
:paramtype include: list[str] or str
765+
:type include: list[str] or str
766766
:keyword int timeout:
767767
The timeout parameter is expressed in seconds.
768768
:returns: An iterable (auto-paging) response of BlobProperties.
@@ -831,7 +831,7 @@ def list_blob_names(self, **kwargs: Any) -> ItemPaged[str]:
831831
@distributed_trace
832832
def walk_blobs(
833833
self, name_starts_with=None, # type: Optional[str]
834-
include=None, # type: Optional[Any]
834+
include=None, # type: Optional[Union[List[str], str]]
835835
delimiter="/", # type: str
836836
**kwargs # type: Optional[Any]
837837
):
@@ -844,9 +844,11 @@ def walk_blobs(
844844
:param str name_starts_with:
845845
Filters the results to return only blobs whose names
846846
begin with the specified prefix.
847-
:param list[str] include:
847+
:param include:
848848
Specifies one or more additional datasets to include in the response.
849-
Options include: 'snapshots', 'metadata', 'uncommittedblobs', 'copy', 'deleted'.
849+
Options include: 'snapshots', 'metadata', 'uncommittedblobs', 'copy', 'deleted', 'deletedwithversions',
850+
'tags', 'versions', 'immutabilitypolicy', 'legalhold'.
851+
:type include: list[str] or str
850852
:param str delimiter:
851853
When the request includes this parameter, the operation returns a BlobPrefix
852854
element in the response body that acts as a placeholder for all blobs whose

sdk/storage/azure-storage-blob/azure/storage/blob/aio/_container_client_async.py

+7-5
Original file line numberDiff line numberDiff line change
@@ -617,8 +617,8 @@ def list_blobs(self, name_starts_with=None, include=None, **kwargs):
617617
:param include:
618618
Specifies one or more additional datasets to include in the response.
619619
Options include: 'snapshots', 'metadata', 'uncommittedblobs', 'copy', 'deleted', 'deletedwithversions',
620-
'tags', 'versions'.
621-
:paramtype include: list[str] or str
620+
'tags', 'versions', 'immutabilitypolicy', 'legalhold'.
621+
:type include: list[str] or str
622622
:keyword int timeout:
623623
The timeout parameter is expressed in seconds.
624624
:returns: An iterable (auto-paging) response of BlobProperties.
@@ -690,7 +690,7 @@ def list_blob_names(self, **kwargs: Any) -> AsyncItemPaged[str]:
690690
@distributed_trace
691691
def walk_blobs(
692692
self, name_starts_with=None, # type: Optional[str]
693-
include=None, # type: Optional[Any]
693+
include=None, # type: Optional[Union[List[str], str]]
694694
delimiter="/", # type: str
695695
**kwargs # type: Optional[Any]
696696
):
@@ -703,9 +703,11 @@ def walk_blobs(
703703
:param str name_starts_with:
704704
Filters the results to return only blobs whose names
705705
begin with the specified prefix.
706-
:param list[str] include:
706+
:param include:
707707
Specifies one or more additional datasets to include in the response.
708-
Options include: 'snapshots', 'metadata', 'uncommittedblobs', 'copy', 'deleted'.
708+
Options include: 'snapshots', 'metadata', 'uncommittedblobs', 'copy', 'deleted', 'deletedwithversions',
709+
'tags', 'versions', 'immutabilitypolicy', 'legalhold'.
710+
:type include: list[str] or str
709711
:param str delimiter:
710712
When the request includes this parameter, the operation returns a BlobPrefix
711713
element in the response body that acts as a placeholder for all blobs whose

0 commit comments

Comments
 (0)