zhenyi
4028f0d943
- Reordered actix-web imports to standardize import order - Reordered crate module imports to follow alphabetical ordering - Updated function calls to use multi-line formatting for better readability - Standardized blank lines around documentation comments - Applied consistent formatting to response handling methods - Normalized import organization across all repository-related API files - Improved code consistency and maintainability through standardized formatting - Applied formatting updates to all repository endpoint implementations
67 lines
2.3 KiB
Rust
67 lines
2.3 KiB
Rust
use actix_web::{HttpResponse, web};
|
|
use serde::Deserialize;
|
|
use utoipa::IntoParams;
|
|
|
|
use crate::api::response::{ApiErrorResponse, ApiResponse};
|
|
use crate::error::AppError;
|
|
use crate::models::repos::BranchProtectionRule;
|
|
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,
|
|
}
|
|
|
|
#[derive(Debug, Deserialize, IntoParams)]
|
|
pub struct QueryParams {
|
|
/// Branch name to check against protection rules
|
|
pub branch_name: String,
|
|
}
|
|
|
|
/// Match a branch name against protection rules
|
|
///
|
|
/// Checks if a branch name matches any protection rule in the repository.
|
|
/// Requires read access to the repository.
|
|
///
|
|
/// Returns the matching protection rule if found, or null if no rules match.
|
|
/// Useful for determining what protections apply to a specific branch before performing operations.
|
|
#[utoipa::path(
|
|
get,
|
|
path = "/api/v1/workspaces/{workspace_name}/repos/{repo_name}/protection/match",
|
|
tag = "Repos",
|
|
operation_id = "repoMatchProtection",
|
|
params(PathParams, QueryParams),
|
|
responses(
|
|
(status = 200, description = "Branch protection check completed. Returns matching protection rule or null if no rules match.", body = ApiResponse<Option<BranchProtectionRule>>),
|
|
(status = 401, description = "Authentication required or session expired", body = ApiErrorResponse),
|
|
(status = 403, description = "Insufficient permissions to access this repository", body = ApiErrorResponse),
|
|
(status = 404, description = "Repository or workspace not found", body = ApiErrorResponse),
|
|
(status = 500, description = "Internal server error", body = ApiErrorResponse),
|
|
),
|
|
security(
|
|
("session_cookie" = [])
|
|
)
|
|
)]
|
|
pub async fn match_protection(
|
|
service: web::Data<AppService>,
|
|
session: Session,
|
|
path: web::Path<PathParams>,
|
|
query: web::Query<QueryParams>,
|
|
) -> Result<HttpResponse, AppError> {
|
|
let rule = service
|
|
.repo
|
|
.repo_match_protection(
|
|
&session,
|
|
&path.workspace_name,
|
|
&path.repo_name,
|
|
&query.branch_name,
|
|
)
|
|
.await?;
|
|
|
|
Ok(HttpResponse::Ok().json(ApiResponse::new(rule)))
|
|
}
|