382e74c798
**Spec:** - [x] Start writing - [x] Specify all layout endpoints - [x] Specify all endpoints for operations on keys - [x] Specify all endpoints for operations on key/bucket permissions - [x] Specify all endpoints for operations on buckets - [x] Specify all endpoints for operations on bucket aliases View rendered spec at <https://git.deuxfleurs.fr/Deuxfleurs/garage/src/branch/admin-api/doc/drafts/admin-api.md> **Code:** - [x] Refactor code for admin api to use common api code that was created for K2V **General endpoints:** - [x] Metrics - [x] GetClusterStatus - [x] ConnectClusterNodes - [x] GetClusterLayout - [x] UpdateClusterLayout - [x] ApplyClusterLayout - [x] RevertClusterLayout **Key-related endpoints:** - [x] ListKeys - [x] CreateKey - [x] ImportKey - [x] GetKeyInfo - [x] UpdateKey - [x] DeleteKey **Bucket-related endpoints:** - [x] ListBuckets - [x] CreateBucket - [x] GetBucketInfo - [x] DeleteBucket - [x] PutBucketWebsite - [x] DeleteBucketWebsite **Operations on key/bucket permissions:** - [x] BucketAllowKey - [x] BucketDenyKey **Operations on bucket aliases:** - [x] GlobalAliasBucket - [x] GlobalUnaliasBucket - [x] LocalAliasBucket - [x] LocalUnaliasBucket **And also:** - [x] Separate error type for the admin API (this PR includes a quite big refactoring of error handling) - [x] Add management of website access - [ ] Check that nothing is missing wrt what can be done using the CLI - [ ] Improve formatting of the spec - [x] Make sure everyone is cool with the API design Fix #231 Fix #295 Co-authored-by: Alex Auvolat <alex@adnab.me> Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/298 Co-authored-by: Alex <alex@adnab.me> Co-committed-by: Alex <alex@adnab.me>
58 lines
1.4 KiB
Rust
58 lines
1.4 KiB
Rust
use err_derive::Error;
|
|
use serde::{Deserialize, Serialize};
|
|
|
|
use garage_util::error::Error as GarageError;
|
|
|
|
#[derive(Debug, Error, Serialize, Deserialize)]
|
|
pub enum Error {
|
|
#[error(display = "Internal error: {}", _0)]
|
|
Internal(#[error(source)] GarageError),
|
|
|
|
#[error(display = "Bad request: {}", _0)]
|
|
BadRequest(String),
|
|
|
|
/// Bucket name is not valid according to AWS S3 specs
|
|
#[error(display = "Invalid bucket name: {}", _0)]
|
|
InvalidBucketName(String),
|
|
|
|
#[error(display = "Access key not found: {}", _0)]
|
|
NoSuchAccessKey(String),
|
|
|
|
#[error(display = "Bucket not found: {}", _0)]
|
|
NoSuchBucket(String),
|
|
}
|
|
|
|
impl From<netapp::error::Error> for Error {
|
|
fn from(e: netapp::error::Error) -> Self {
|
|
Error::Internal(GarageError::Netapp(e))
|
|
}
|
|
}
|
|
|
|
pub trait OkOrBadRequest {
|
|
type S;
|
|
fn ok_or_bad_request<M: AsRef<str>>(self, reason: M) -> Result<Self::S, Error>;
|
|
}
|
|
|
|
impl<T, E> OkOrBadRequest for Result<T, E>
|
|
where
|
|
E: std::fmt::Display,
|
|
{
|
|
type S = T;
|
|
fn ok_or_bad_request<M: AsRef<str>>(self, reason: M) -> Result<T, Error> {
|
|
match self {
|
|
Ok(x) => Ok(x),
|
|
Err(e) => Err(Error::BadRequest(format!("{}: {}", reason.as_ref(), e))),
|
|
}
|
|
}
|
|
}
|
|
|
|
impl<T> OkOrBadRequest for Option<T> {
|
|
type S = T;
|
|
fn ok_or_bad_request<M: AsRef<str>>(self, reason: M) -> Result<T, Error> {
|
|
match self {
|
|
Some(x) => Ok(x),
|
|
None => Err(Error::BadRequest(reason.as_ref().to_string())),
|
|
}
|
|
}
|
|
}
|