Struct shipcat_definitions::structs::metadata::Metadata[−][src]

pub struct Metadata {
Show fields
    pub repo: String,
    pub team: String,
    pub context: Option<Context>,
    pub squad: Option<String>,
    pub tribe: Option<String>,
    pub language: Option<Language>,
    pub gitTagTemplate: String,
    pub contacts: Vec<Contact>,
    pub maintainers: Vec<String>,
    pub support: Option<SlackChannel>,
    pub notifications: Option<SlackChannel>,
    pub runbook: Option<String>,
    pub description: Option<String>,
    pub docs: Option<String>,
    pub ped: Option<String>,
    pub testPlan: Option<String>,
    pub releasePlan: Option<String>,
    pub threatModel: Vec<String>,
    pub dpsia: Vec<String>,
    pub custom: BTreeMap<String, String>,

}
Expand description

Metadata for a service

Fields

repo: String

Git repository

team: String

Owning squad

context: Option<Context>

Context this resource belongs to

squad: Option<String>

Squad output parameter - not deserialized

tribe: Option<String>

Tribe output parameter - not deserialized

language: Option<Language>

Language the service is written in

gitTagTemplate: String

Release tagging scheme

Defaults to the version itself. Leading v tagging services can use “v{{ version }}” Monorepos that have multiple tags can use “{{ version }}-app”

contacts: Vec<Contact>

Contact person (legacy)

maintainers: Vec<String>

Maintainers - names of people in teams.yml

support: Option<SlackChannel>

Support channel - human interaction

notifications: Option<SlackChannel>

Notifications channel - automated messages

runbook: Option<String>

Runbook name in repo

description: Option<String>

Description of the service

docs: Option<String>

Canoncal documentation link

ped: Option<String>

Link to the Product Engineering Document for the service

testPlan: Option<String>

Link to the test plan for this service

releasePlan: Option<String>

Link to the release plan for this service

threatModel: Vec<String>

Document IDs of the threat models for this service

dpsia: Vec<String>

Link to any DPSIAs for this service

custom: BTreeMap<String, String>

Custom metadata, keys defined in the Config

Implementations

impl Metadata[src]

pub fn version_template(&self, ver: &str) -> Result<String>[src]

impl Metadata[src]

pub fn verify(
    &self,
    owners: &Owners,
    allowedCustomMetadata: &BTreeSet<String>
) -> Result<()>[src]

Trait Implementations

impl Clone for Metadata[src]

fn clone(&self) -> Metadata[src]

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl Debug for Metadata[src]

fn fmt(&self, f: &mut Formatter<'_>) -> Result[src]

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for Metadata[src]

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, [src]

Deserialize this value from the given Serde deserializer. Read more

impl Serialize for Metadata[src]

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, [src]

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations

impl RefUnwindSafe for Metadata

impl Send for Metadata

impl Sync for Metadata

impl Unpin for Metadata

impl UnwindSafe for Metadata

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized, [src]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T, U> Into<U> for T where
    U: From<T>, [src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> ToOwned for T where
    T: Clone, [src]

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)[src]

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

Performs the conversion.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>, [src]

pub fn vzip(self) -> V[src]

impl<T> DeserializeOwned for T where
    T: for<'de> Deserialize<'de>, [src]