auxon-sdk 2.3.0

A collection of clients, servers, protocols, and general API types for interacting with the APIs that are used throughout Auxon's suite of tools
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

//! An HTTP server template that can be used to serve mutators to Deviant.

use std::collections::BTreeMap;

#[cfg(feature = "mutator_server")]
pub mod server;

use crate::api::{AttrKey, AttrVal};
use uuid::Uuid;

/// Mutator representation for HTTP
#[derive(serde::Serialize, serde::Deserialize, Clone, Debug)]
#[cfg_attr(feature = "mutator_server", derive(utoipa::ToSchema))]
pub struct Mutator {
    /// HTTP-server local identifier for the mutator.
    #[cfg_attr(feature = "mutator_server", schema(example = "abc123"))]
    pub mutator_correlation_id: String,

    /// Mutator's attributes
    #[cfg_attr(feature = "mutator_server", schema())]
    pub attributes: BTreeMap<AttrKey, AttrVal>,
}

/// Mutation request representation for HTTP
#[derive(serde::Serialize, serde::Deserialize, Clone)]
#[cfg_attr(feature = "mutator_server", derive(utoipa::ToSchema))]
pub struct Mutation {
    #[cfg_attr(feature = "mutator_server", schema())]
    pub mutation: Uuid,

    /// Mutation parameters
    #[cfg_attr(feature = "mutator_server", schema())]
    pub params: BTreeMap<AttrKey, AttrVal>,
}

pub type GetAllMutatorsResponse = Vec<Mutator>;

pub const MUTATOR_API_KEY_HEADER: &str = "mutator_apikey";
pub const MUTATOR_API_CONTROL_HEADER: &str = "x-auxon-mutation-control";