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
80 lines
3.2 KiB
Rust
80 lines
3.2 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::RepoCommitStatus;
|
|
use crate::service::AppService;
|
|
use crate::service::repo::commit_status::CreateCommitStatusParams;
|
|
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,
|
|
}
|
|
|
|
/// Create a commit status
|
|
///
|
|
/// Creates a new status check for a specific commit, typically used by CI/CD systems.
|
|
/// Requires Write role or higher in the repository.
|
|
///
|
|
/// Parameters:
|
|
/// - commit_sha: Commit SHA to attach the status to (must exist in repository)
|
|
/// - state: Status state ("pending", "success", "failure", "error")
|
|
/// - context: Status context name (e.g., "ci/build", "ci/test") - must be unique per commit
|
|
/// - description: Human-readable description of the status (optional, max 500 characters)
|
|
/// - target_url: URL with detailed information about the status (optional)
|
|
///
|
|
/// Effects:
|
|
/// - Status is attached to the commit
|
|
/// - Can be used by branch protection rules to enforce status checks
|
|
/// - Multiple statuses can exist for the same commit with different contexts
|
|
///
|
|
/// Returns the created status with metadata including ID and timestamps.
|
|
#[utoipa::path(
|
|
post,
|
|
path = "/api/v1/workspaces/{workspace_name}/repos/{repo_name}/statuses",
|
|
tag = "Repos",
|
|
operation_id = "repoCreateCommitStatus",
|
|
params(PathParams),
|
|
request_body(
|
|
content = CreateCommitStatusParams,
|
|
description = "Commit status creation parameters",
|
|
content_type = "application/json"
|
|
),
|
|
responses(
|
|
(status = 201, description = "Commit status created successfully. Returns the newly created status with metadata.", body = ApiResponse<RepoCommitStatus>),
|
|
(status = 400, description = "Invalid parameters: invalid state, context too long, or commit doesn't exist", body = ApiErrorResponse),
|
|
(status = 401, description = "Authentication required or session expired", body = ApiErrorResponse),
|
|
(status = 403, description = "Insufficient permissions (requires Write role or higher)", body = ApiErrorResponse),
|
|
(status = 404, description = "Repository, workspace, or commit not found", body = ApiErrorResponse),
|
|
(status = 409, description = "Status with this context already exists for this commit (use update instead)", body = ApiErrorResponse),
|
|
(status = 500, description = "Internal server error", body = ApiErrorResponse),
|
|
),
|
|
security(
|
|
("session_cookie" = [])
|
|
)
|
|
)]
|
|
pub async fn create_commit_status(
|
|
service: web::Data<AppService>,
|
|
session: Session,
|
|
path: web::Path<PathParams>,
|
|
params: web::Json<CreateCommitStatusParams>,
|
|
) -> Result<HttpResponse, AppError> {
|
|
let status = service
|
|
.repo
|
|
.repo_create_commit_status(
|
|
&session,
|
|
&path.workspace_name,
|
|
&path.repo_name,
|
|
params.into_inner(),
|
|
)
|
|
.await?;
|
|
|
|
Ok(HttpResponse::Created().json(ApiResponse::new(status)))
|
|
}
|