Files
gitks/api/repo/create_webhook.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

72 lines
2.7 KiB
Rust

use actix_web::{web, HttpResponse};
use serde::Deserialize;
use utoipa::IntoParams;
use crate::api::response::{ApiResponse, ApiErrorResponse};
use crate::error::AppError;
use crate::models::repos::RepoWebhook;
use crate::service::repo::webhooks::CreateWebhookParams;
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,
}
/// 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)))
}