codama_nodes/generated/shared/display_skip.rs
1use serde::{Deserialize, Serialize};
2
3/// Whether a member should be hidden from the fallback display list.
4/// The interpolated sentence on `instructionDisplayNode` is governed separately — a member may be referenced there regardless of its skip value.
5#[derive(Debug, PartialEq, Eq, Clone, Copy, Serialize, Deserialize)]
6#[serde(rename_all = "camelCase")]
7pub enum DisplaySkip {
8 /// The member is never shown in the fallback list. Use for purely structural fields like discriminators.
9 Always,
10 /// The member is always shown in the fallback list. This is the default.
11 Never,
12 /// The member is shown only when its value was not already surfaced elsewhere through the provide/inject graph.
13 /// 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.
14 WhenInjected,
15}