codama-nodes 0.10.0

Node specifications and helpers for the Codama standard
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

use serde::{Deserialize, Serialize};

/// Whether a member should be hidden from the fallback display list.
/// The interpolated sentence on `instructionDisplayNode` is governed separately — a member may be referenced there regardless of its skip value.
#[derive(Debug, PartialEq, Eq, Clone, Copy, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub enum DisplaySkip {
    /// The member is never shown in the fallback list. Use for purely structural fields like discriminators.
    Always,
    /// The member is always shown in the fallback list. This is the default.
    Never,
    /// The member is shown only when its value was not already surfaced elsewhere through the provide/inject graph.
    /// When the value was pulled via injection, the member is hidden as redundant; when nothing surfaced it, the member appears under its label as a backup.
    WhenInjected,
}