Merge pull request 'fix(openapi): use query params, not path params for Update & Delete Bucket' (#1139) from milas/garage:milas/fix-openapi-v2-params into main-v2

Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/1139
This commit is contained in:
Alex
2025-09-04 07:23:45 +00:00
3 changed files with 9 additions and 12 deletions
+2 -4
View File
@@ -471,8 +471,7 @@
"parameters": [ "parameters": [
{ {
"name": "id", "name": "id",
"in": "path", "in": "query",
"description": "ID of the bucket to delete",
"required": true, "required": true,
"schema": { "schema": {
"type": "string" "type": "string"
@@ -1601,8 +1600,7 @@
"parameters": [ "parameters": [
{ {
"name": "id", "name": "id",
"in": "path", "in": "query",
"description": "ID of the bucket to update",
"required": true, "required": true,
"schema": { "schema": {
"type": "string" "type": "string"
+5 -2
View File
@@ -891,9 +891,11 @@ pub struct CreateBucketLocalAlias {
// ---- UpdateBucket ---- // ---- UpdateBucket ----
#[derive(Debug, Clone, Serialize, Deserialize)] #[derive(Debug, Clone, Serialize, Deserialize, IntoParams)]
#[into_params(parameter_in = Query)]
pub struct UpdateBucketRequest { pub struct UpdateBucketRequest {
pub id: String, pub id: String,
#[param(ignore = true)]
pub body: UpdateBucketRequestBody, pub body: UpdateBucketRequestBody,
} }
@@ -917,7 +919,8 @@ pub struct UpdateBucketWebsiteAccess {
// ---- DeleteBucket ---- // ---- DeleteBucket ----
#[derive(Debug, Clone, Serialize, Deserialize)] #[derive(Debug, Clone, Serialize, Deserialize, IntoParams)]
#[into_params(parameter_in = Query)]
pub struct DeleteBucketRequest { pub struct DeleteBucketRequest {
pub id: String, pub id: String,
} }
+2 -6
View File
@@ -478,9 +478,7 @@ In `quotas`: new values of `maxSize` and `maxObjects` must both be specified, or
to remove the quotas. An absent value will be considered the same as a `null`. It is not possible to remove the quotas. An absent value will be considered the same as a `null`. It is not possible
to change only one of the two quotas. to change only one of the two quotas.
", ",
params( params(UpdateBucketRequest),
("id" = String, description = "ID of the bucket to update"),
),
request_body = UpdateBucketRequestBody, request_body = UpdateBucketRequestBody,
responses( responses(
(status = 200, description = "Bucket has been updated", body = UpdateBucketResponse), (status = 200, description = "Bucket has been updated", body = UpdateBucketResponse),
@@ -498,9 +496,7 @@ Deletes a storage bucket. A bucket cannot be deleted if it is not empty.
**Warning:** this will delete all aliases associated with the bucket! **Warning:** this will delete all aliases associated with the bucket!
", ",
params( params(DeleteBucketRequest),
("id" = String, description = "ID of the bucket to delete"),
),
responses( responses(
(status = 200, description = "Bucket has been deleted"), (status = 200, description = "Bucket has been deleted"),
(status = 400, description = "Bucket is not empty"), (status = 400, description = "Bucket is not empty"),