Skip to content

controllers/krate/owners: Add request body to OpenAPI docs #12320

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 1 commit into from
Nov 13, 2025
+60 −1
Merged

controllers/krate/owners: Add request body to OpenAPI docs #12320

Show file tree
Hide file tree
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion src/controllers/krate/owners.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,7 @@ pub struct ModifyResponse {
put,
path = "/api/v1/crates/{name}/owners",
params(CratePath),
request_body = inline(ChangeOwnersRequest),
security(
("api_token" = []),
("cookie" = []),
Expand All @@ -140,6 +141,7 @@ pub async fn add_owners(
delete,
path = "/api/v1/crates/{name}/owners",
params(CratePath),
request_body = inline(ChangeOwnersRequest),
security(
("api_token" = []),
("cookie" = []),
Expand All @@ -156,8 +158,13 @@ pub async fn remove_owners(
modify_owners(app, path.name, parts, body, false).await
}

#[derive(Deserialize)]
#[derive(Deserialize, utoipa::ToSchema)]
pub struct ChangeOwnersRequest {
/// List of owner login names to add or remove.
///
/// For users, use just the username (e.g., `"octocat"`).
/// For GitHub teams, use the format `github:org:team` (e.g., `"github:rust-lang:owners"`).
#[schema(example = json!(["octocat", "github:rust-lang:owners"]))]
#[serde(alias = "users")]
owners: Vec<String>,
}
Expand Down
52 changes: 52 additions & 0 deletions src/tests/snapshots/integration__openapi__openapi_snapshot-2.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2590,6 +2590,32 @@ expression: response.json()
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"owners": {
"description": "List of owner login names to add or remove.\n\nFor users, use just the username (e.g., `\"octocat\"`).\nFor GitHub teams, use the format `github:org:team` (e.g., `\"github:rust-lang:owners\"`).",
"example": [
"octocat",
"github:rust-lang:owners"
],
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"owners"
],
"type": "object"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
Expand Down Expand Up @@ -2684,6 +2710,32 @@ expression: response.json()
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"owners": {
"description": "List of owner login names to add or remove.\n\nFor users, use just the username (e.g., `\"octocat\"`).\nFor GitHub teams, use the format `github:org:team` (e.g., `\"github:rust-lang:owners\"`).",
"example": [
"octocat",
"github:rust-lang:owners"
],
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"owners"
],
"type": "object"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
Expand Down