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
77 lines
2.8 KiB
Rust
77 lines
2.8 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::RepoWebhook;
|
|
use crate::service::AppService;
|
|
use crate::service::repo::webhooks::CreateWebhookParams;
|
|
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 webhook in a repository
|
|
///
|
|
/// Creates a new webhook that receives HTTP POST notifications for repository events.
|
|
/// Requires Admin role or higher in the repository.
|
|
///
|
|
/// Parameters:
|
|
/// - url: Webhook endpoint URL (must be HTTPS in production)
|
|
/// - events: List of events to subscribe to (e.g., "push", "pull_request", "issue")
|
|
/// - secret: Optional secret for webhook signature verification
|
|
/// - active: Whether the webhook is active (default: true)
|
|
///
|
|
/// Effects:
|
|
/// - Webhook is created and starts receiving events
|
|
/// - Webhook deliveries are logged and can be retried on failure
|
|
///
|
|
/// Returns the created webhook with metadata including ID and configuration.
|
|
#[utoipa::path(
|
|
post,
|
|
path = "/api/v1/workspaces/{workspace_name}/repos/{repo_name}/webhooks",
|
|
tag = "Repos",
|
|
operation_id = "repoCreateWebhook",
|
|
params(PathParams),
|
|
request_body(
|
|
content = CreateWebhookParams,
|
|
description = "Webhook creation parameters",
|
|
content_type = "application/json"
|
|
),
|
|
responses(
|
|
(status = 201, description = "Webhook created successfully. Returns the newly created webhook with metadata.", body = ApiResponse<RepoWebhook>),
|
|
(status = 400, description = "Invalid parameters: invalid URL format or empty events list", 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 or workspace not found", body = ApiErrorResponse),
|
|
(status = 500, description = "Internal server error", body = ApiErrorResponse),
|
|
),
|
|
security(
|
|
("session_cookie" = [])
|
|
)
|
|
)]
|
|
pub async fn create_webhook(
|
|
service: web::Data<AppService>,
|
|
session: Session,
|
|
path: web::Path<PathParams>,
|
|
params: web::Json<CreateWebhookParams>,
|
|
) -> Result<HttpResponse, AppError> {
|
|
let webhook = service
|
|
.repo
|
|
.repo_create_webhook(
|
|
&session,
|
|
&path.workspace_name,
|
|
&path.repo_name,
|
|
params.into_inner(),
|
|
)
|
|
.await?;
|
|
|
|
Ok(HttpResponse::Created().json(ApiResponse::new(webhook)))
|
|
}
|