jsonschema-schema 0.2.0

Typed Rust representation of JSON Schema draft 2020-12
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
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138

use alloc::collections::BTreeMap;

use serde::{Deserialize, Serialize};
use serde_json::Value;

/// [Taplo] JSON Schema extension (`x-taplo`).
///
/// Controls editor behavior in the Taplo TOML language server: documentation
/// text, completion links, hidden fields, and plugins. Serialized as a
/// single nested JSON object under the `x-taplo` key.
///
/// Compatible with [`taplo-common`'s `SchemaExt`][taplo-ext].
///
/// # Example
///
/// ```json
/// {
///   "x-taplo": {
///     "hidden": true,
///     "docs": { "main": "Override description" },
///     "links": { "key": "https://example.com" }
///   }
/// }
/// ```
///
/// [Taplo]: https://taplo.tamasfe.dev
/// [taplo-ext]: https://github.com/tamasfe/taplo/blob/main/crates/taplo-common/src/schema/ext.rs
#[derive(
    Debug, Default, Clone, Serialize, Deserialize, PartialEq, Eq, Hash, schemars::JsonSchema,
)]
#[serde(rename_all = "camelCase")]
pub struct TaploSchemaExt {
    /// When `true`, the property is hidden from completion suggestions.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub hidden: Option<bool>,

    /// Navigation link targets shown as clickable references in the editor.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub links: Option<ExtLinks>,

    /// Documentation text overrides for hover popups and completion details.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub docs: Option<ExtDocs>,

    /// Keys to insert when creating a new table from this schema.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub init_keys: Option<Vec<String>>,

    /// Taplo plugin names to activate when this schema is in use.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub plugins: Vec<String>,
    #[serde(flatten)]
    pub extra: BTreeMap<String, Value>,
}

/// Documentation text overrides for [Taplo](TaploSchemaExt) hover and
/// completion.
///
/// Each field replaces the corresponding auto-generated documentation
/// that Taplo would otherwise derive from the schema.
#[derive(
    Debug, Default, Clone, Serialize, Deserialize, PartialEq, Eq, Hash, schemars::JsonSchema,
)]
#[serde(rename_all = "camelCase")]
pub struct ExtDocs {
    /// Primary documentation text, replacing the schema `description`.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub main: Option<String>,

    /// Documentation for the `const` value.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub const_value: Option<String>,

    /// Documentation for the `default` value.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub default_value: Option<String>,

    /// Per-enum-value documentation strings (positional, matching the
    /// `enum` array). `None` entries leave the default text unchanged.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub enum_values: Option<Vec<Option<String>>>,
}

/// Link targets for [Taplo](TaploSchemaExt) navigation.
///
/// Provides clickable URLs in the editor for the property key and
/// individual enum values.
#[derive(
    Debug, Default, Clone, Serialize, Deserialize, PartialEq, Eq, Hash, schemars::JsonSchema,
)]
#[serde(rename_all = "camelCase")]
pub struct ExtLinks {
    /// URL to navigate to when clicking the property key.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub key: Option<String>,

    /// Per-enum-value link URLs (positional, matching the `enum` array).
    /// `None` entries have no link.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub enum_values: Option<Vec<Option<String>>>,
}

/// [Taplo] schema catalog metadata (`x-taplo-info`).
///
/// Embeds file-association patterns, authorship, and version information
/// directly inside a schema file. Used by Taplo's built-in catalog to
/// match schemas to TOML files without a separate catalog entry.
///
/// Compatible with [`taplo-common`'s `SchemaExtraInfo`][taplo-info].
///
/// # Example
///
/// ```json
/// {
///   "x-taplo-info": {
///     "authors": ["Alice (https://example.com)"],
///     "version": "1.0.0",
///     "patterns": ["^pyproject\\.toml$"]
///   }
/// }
/// ```
///
/// [Taplo]: https://taplo.tamasfe.dev
/// [taplo-info]: https://github.com/tamasfe/taplo/blob/main/crates/taplo-common/src/schema/ext.rs
#[derive(Debug, Default, Clone, PartialEq, Eq, Serialize, Deserialize, schemars::JsonSchema)]
pub struct TaploInfoSchemaExt {
    /// Schema author credits, typically `"Name (url)"`.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub authors: Vec<String>,

    /// Semver version of the schema or the tool it describes.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub version: Option<String>,

    /// Regex patterns matching file paths this schema applies to.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub patterns: Vec<String>,
}