garage-sdk/garage-admin-sdk-python
5
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Merge pull request 'update garage as of 2025-03-05 (fix globalAlias in GetBucketInfo)' (#2) from update-20250305 into main

Browse source 
Reviewed-on: #2
This commit is contained in:
Alex 2025-03-05 09:31:37 +00:00
commit b3e9b7a3d0
3 changed files with 10 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
.openapi-generator/FILES
View file

@ -96,5 +96,4 @@ setup.cfg
setup.py
test-requirements.txt
test/__init__.py
test/test_get_health200_response.py
tox.ini

8
docs/BucketApi.md
View file

@ -535,7 +535,7 @@ Name | Type | Description | Notes
Get a bucket
Given a bucket identifier (`id`) or a global alias (`alias`), get its information. It includes its aliases, its web configuration, keys that have some permissions on it, some statistics (number of objects, size), number of dangling multipart uploads, and its quotas (if any).
Given a bucket identifier (`id`) or a global alias (`globalAlias`), get its information. It includes its aliases, its web configuration, keys that have some permissions on it, some statistics (number of objects, size), number of dangling multipart uploads, and its quotas (if any).
### Example
@ -568,13 +568,13 @@ with garage_admin_sdk.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = bucket_api.BucketApi(api_client)
id = "b4018dc61b27ccb5c64ec1b24f53454bbbd180697c758c4d47a22a8921864a87" # str | The exact bucket identifier, a 32 bytes hexadecimal string. Incompatible with `alias`. (optional)
alias = "my_documents" # str | The exact global alias of one of the existing buckets. Incompatible with `id`. (optional)
global_alias = "my_documents" # str | The exact global alias of one of the existing buckets. Incompatible with `id`. (optional)
# example passing only required values which don't have defaults set
# and optional values
try:
# Get a bucket
api_response = api_instance.get_bucket_info(id=id, alias=alias)
api_response = api_instance.get_bucket_info(id=id, global_alias=global_alias)
pprint(api_response)
except garage_admin_sdk.ApiException as e:
print("Exception when calling BucketApi->get_bucket_info: %s\n" % e)
@ -586,7 +586,7 @@ with garage_admin_sdk.ApiClient(configuration) as api_client:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **str**| The exact bucket identifier, a 32 bytes hexadecimal string. Incompatible with `alias`. | [optional]
**alias** | **str**| The exact global alias of one of the existing buckets. Incompatible with `id`. | [optional]
**global_alias** | **str**| The exact global alias of one of the existing buckets. Incompatible with `id`. | [optional]
### Return type

12
garage_admin_sdk/api/bucket_api.py
View file

@ -378,7 +378,7 @@ class BucketApi(object):
params_map={
'all': [
'id',
'alias',
'global_alias',
],
'required': [],
'nullable': [
@ -396,16 +396,16 @@ class BucketApi(object):
'openapi_types': {
'id':
(str,),
'alias':
'global_alias':
(str,),
},
'attribute_map': {
'id': 'id',
'alias': 'alias',
'global_alias': 'globalAlias',
},
'location_map': {
'id': 'query',
'alias': 'query',
'global_alias': 'query',
},
'collection_format_map': {
}
@ -1157,7 +1157,7 @@ class BucketApi(object):
):
"""Get a bucket # noqa: E501
Given a bucket identifier (`id`) or a global alias (`alias`), get its information. It includes its aliases, its web configuration, keys that have some permissions on it, some statistics (number of objects, size), number of dangling multipart uploads, and its quotas (if any). # noqa: E501
Given a bucket identifier (`id`) or a global alias (`globalAlias`), get its information. It includes its aliases, its web configuration, keys that have some permissions on it, some statistics (number of objects, size), number of dangling multipart uploads, and its quotas (if any). # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@ -1167,7 +1167,7 @@ class BucketApi(object):
Keyword Args:
id (str): The exact bucket identifier, a 32 bytes hexadecimal string. Incompatible with `alias`. . [optional]
alias (str): The exact global alias of one of the existing buckets. Incompatible with `id`. . [optional]
global_alias (str): The exact global alias of one of the existing buckets. Incompatible with `id`. . [optional]
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
_preload_content (bool): if False, the urllib3.HTTPResponse object