Files
appks/api/repo/set_branch_protection.rs
T
zhenyi 7368ba676c feat(api): add comprehensive repository management API endpoints
- Introduce new repo module with complete repository functionality
- Add endpoints for repository CRUD operations (create, get, update, archive, delete)
- Implement branch management with create, list, delete and protection features
- Add tag management with create, list and delete operations
- Include release management with create, update and delete capabilities
- Support repository forking with sync functionality
- Implement starring and watching mechanisms for repositories
- Add member management with roles and invitations
- Provide deploy key management for CI/CD integration
- Create webhook management for external integrations
- Implement branch protection rules with approval requirements
- Add commit status and comment functionality for code reviews
- Include merge checking logic for pull requests
- Register all new endpoints in OpenAPI documentation
- Configure routes to handle new repository-specific paths
2026-06-07 19:19:53 +08:00

78 lines
2.6 KiB
Rust

use actix_web::{web, HttpResponse};
use serde::Deserialize;
use utoipa::{IntoParams, ToSchema};
use crate::api::response::{ApiResponse, ApiErrorResponse};
use crate::error::AppError;
use crate::service::AppService;
use crate::session::Session;
#[derive(Debug, Deserialize, IntoParams)]
pub struct PathParams {
/// Workspace name (unique identifier)
pub workspace_name: String,
/// Repository name (unique within the workspace)
pub repo_name: String,
/// Branch ID (UUID)
pub branch_id: uuid::Uuid,
}
#[derive(Debug, Deserialize, ToSchema)]
pub struct SetBranchProtectionParams {
/// Whether to enable branch protection
pub protected: bool,
}
/// Set branch protection
///
/// Enables or disables protection for a specific branch.
/// Requires Admin role or higher in the repository.
///
/// Effects:
/// - When enabled: prevents force pushes and branch deletion
/// - When disabled: allows force pushes and branch deletion
///
/// Returns success message on completion.
#[utoipa::path(
put,
path = "/api/v1/workspaces/{workspace_name}/repos/{repo_name}/branches/{branch_id}/protection",
tag = "Repos",
operation_id = "repoSetBranchProtection",
params(PathParams),
request_body(
content = SetBranchProtectionParams,
description = "Branch protection parameters",
content_type = "application/json"
),
responses(
(status = 200, description = "Branch protection rules set successfully.", body = ApiResponse<String>),
(status = 400, description = "Invalid parameters: negative approvals count or conflicting protection settings", body = ApiErrorResponse),
(status = 401, description = "Authentication required or session expired", body = ApiErrorResponse),
(status = 403, description = "Insufficient permissions (requires Admin role or higher)", body = ApiErrorResponse),
(status = 404, description = "Repository, workspace, or branch not found", body = ApiErrorResponse),
(status = 500, description = "Internal server error", body = ApiErrorResponse),
),
security(
("session_cookie" = [])
)
)]
pub async fn set_branch_protection(
service: web::Data<AppService>,
session: Session,
path: web::Path<PathParams>,
params: web::Json<SetBranchProtectionParams>,
) -> Result<HttpResponse, AppError> {
service
.repo
.repo_set_branch_protection(
&session,
&path.workspace_name,
&path.repo_name,
path.branch_id,
params.protected,
)
.await?;
Ok(HttpResponse::Ok().json(ApiResponse::new("Branch protection rules set successfully".to_string())))
}