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
73 lines
2.4 KiB
Rust
73 lines
2.4 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::RepoDeployKey;
|
|
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 {
|
|
/// Maximum number of deploy keys to return (default: 50, max: 100)
|
|
pub limit: Option<i64>,
|
|
/// Number of deploy keys to skip for pagination (default: 0)
|
|
pub offset: Option<i64>,
|
|
}
|
|
|
|
/// List deploy keys in a repository
|
|
///
|
|
/// Returns a paginated list of all deploy keys in the repository, sorted by creation date (newest first).
|
|
/// Includes deploy key metadata such as:
|
|
/// - Key title and fingerprint
|
|
/// - Read-only status
|
|
/// - Creator information
|
|
/// - Creation date and last used date
|
|
///
|
|
/// Requires Admin role or higher in the repository.
|
|
#[utoipa::path(
|
|
get,
|
|
path = "/api/v1/workspaces/{workspace_name}/repos/{repo_name}/deploy-keys",
|
|
tag = "Repos",
|
|
operation_id = "repoListDeployKeys",
|
|
params(PathParams, QueryParams),
|
|
responses(
|
|
(status = 200, description = "Deploy keys listed successfully. Returns an array of deploy key objects with metadata.", body = ApiResponse<Vec<RepoDeployKey>>),
|
|
(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 list_deploy_keys(
|
|
service: web::Data<AppService>,
|
|
session: Session,
|
|
path: web::Path<PathParams>,
|
|
query: web::Query<QueryParams>,
|
|
) -> Result<HttpResponse, AppError> {
|
|
let keys = service
|
|
.repo
|
|
.repo_deploy_keys(
|
|
&session,
|
|
&path.workspace_name,
|
|
&path.repo_name,
|
|
query.limit.unwrap_or(50),
|
|
query.offset.unwrap_or(0),
|
|
)
|
|
.await?;
|
|
|
|
Ok(HttpResponse::Ok().json(ApiResponse::new(keys)))
|
|
}
|