Skip to content

Update namespace documentation #938

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ahouseholder merged 8 commits into from
Sep 10, 2025
Merged

Update namespace documentation #938

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
efd8d88
add `invalid` and `x_invalid` as RESERVED namespaces.
ahouseholder Sep 9, 2025
55ce12b
fix #907 add reserved ns warning to docs
ahouseholder Sep 9, 2025
f229a41
resolves #908 - add explanation of `example`, `test`, and similar res…
ahouseholder Sep 9, 2025
067b19b
refactor NIST-based decision point into its own namespace & fragment
ahouseholder Sep 9, 2025
483d129
clean up namespace extension diagram for readability
ahouseholder Sep 9, 2025
25913b7
minor edits
ahouseholder Sep 9, 2025
bd88d20
copy edit
ahouseholder Sep 9, 2025
e78c84a
copy edit
ahouseholder Sep 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 17 additions & 17 deletions data/json/decision_points/basic/probability_scale_in_5_weighted_levels_ascending_1_0_0.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,35 +1,35 @@
{
"namespace": "basic",
"key": "P_5X",
"key": "P_5W",
"version": "1.0.0",
"name": "Probability Scale in 5 weighted levels, ascending",
"definition": "A probability scale with finer resolution at both extremes, based on NIST SP 800-30 Rev. 1 Appendix G",
"definition": "A probability scale with higher resolution as probability increases",
"schemaVersion": "2.0.0",
"values": [
{
"key": "VL",
"name": "Very Low",
"definition": "0% <= Probability < 5%. Highly unlikely."
"key": "P0_30",
"name": "Less than 30%",
"definition": "Probability < 0.3"
},
{
"key": "L",
"name": "Low",
"definition": "5% <= Probability < 21%. Unlikely."
"key": "P30_55",
"name": "30% to 55%",
"definition": "0.3 <= Probability < 0.55"
},
{
"key": "M",
"name": "Moderate",
"definition": "21% <= Probability < 80%. Somewhat likely."
"key": "P55_75",
"name": "55% to 75%",
"definition": "0.55 <= Probability < 0.75"
},
{
"key": "H",
"name": "High",
"definition": "80% <= Probability < 96%. Highly likely."
"key": "P75_90",
"name": "75% to 90%",
"definition": "0.75 <= Probability < 0.9"
},
{
"key": "VH",
"name": "Very High",
"definition": "96% <= Probability <= 100%. Almost certain."
"key": "P90_100",
"name": "Greater than 90%",
"definition": "0.9 <= Probability <= 1.0"
}
]
}
35 changes: 35 additions & 0 deletions ...n/decision_points/nist_800_30/probability_scale_in_5_weighted_levels_ascending_1_0_0.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
{
"namespace": "nist#800-30",
"key": "P_5X",
"version": "1.0.0",
"name": "Probability Scale in 5 weighted levels, ascending",
"definition": "A probability scale with finer resolution at both extremes, based on NIST SP 800-30 Rev. 1 Appendix G",
"schemaVersion": "2.0.0",
"values": [
{
"key": "VL",
"name": "Very Low",
"definition": "0% <= Probability < 5%. Highly unlikely."
},
{
"key": "L",
"name": "Low",
"definition": "5% <= Probability < 21%. Unlikely."
},
{
"key": "M",
"name": "Moderate",
"definition": "21% <= Probability < 80%. Somewhat likely."
},
{
"key": "H",
"name": "High",
"definition": "80% <= Probability < 96%. Highly likely."
},
{
"key": "VH",
"name": "Very High",
"definition": "96% <= Probability <= 100%. Almost certain."
}
]
}
145 changes: 75 additions & 70 deletions data/json/ssvc_object_registry.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -289,76 +289,6 @@
}
}
},
"P_5X": {
"key": "P_5X",
"versions": {
"1.0.0": {
"version": "1.0.0",
"obj": {
"namespace": "basic",
"key": "P_5X",
"version": "1.0.0",
"name": "Probability Scale in 5 weighted levels, ascending",
"definition": "A probability scale with finer resolution at both extremes, based on NIST SP 800-30 Rev. 1 Appendix G",
"schemaVersion": "2.0.0",
"values": [
{
"key": "VL",
"name": "Very Low",
"definition": "0% <= Probability < 5%. Highly unlikely."
},
{
"key": "L",
"name": "Low",
"definition": "5% <= Probability < 21%. Unlikely."
},
{
"key": "M",
"name": "Moderate",
"definition": "21% <= Probability < 80%. Somewhat likely."
},
{
"key": "H",
"name": "High",
"definition": "80% <= Probability < 96%. Highly likely."
},
{
"key": "VH",
"name": "Very High",
"definition": "96% <= Probability <= 100%. Almost certain."
}
]
},
"values": {
"VL": {
"key": "VL",
"name": "Very Low",
"definition": "0% <= Probability < 5%. Highly unlikely."
},
"L": {
"key": "L",
"name": "Low",
"definition": "5% <= Probability < 21%. Unlikely."
},
"M": {
"key": "M",
"name": "Moderate",
"definition": "21% <= Probability < 80%. Somewhat likely."
},
"H": {
"key": "H",
"name": "High",
"definition": "80% <= Probability < 96%. Highly likely."
},
"VH": {
"key": "VH",
"name": "Very High",
"definition": "96% <= Probability <= 100%. Almost certain."
}
}
}
}
},
"P_2A": {
"key": "P_2A",
"versions": {
Expand Down Expand Up @@ -5986,6 +5916,81 @@
}
}
},
"nist#800-30": {
"namespace": "nist#800-30",
"keys": {
"P_5X": {
"key": "P_5X",
"versions": {
"1.0.0": {
"version": "1.0.0",
"obj": {
"namespace": "nist#800-30",
"key": "P_5X",
"version": "1.0.0",
"name": "Probability Scale in 5 weighted levels, ascending",
"definition": "A probability scale with finer resolution at both extremes, based on NIST SP 800-30 Rev. 1 Appendix G",
"schemaVersion": "2.0.0",
"values": [
{
"key": "VL",
"name": "Very Low",
"definition": "0% <= Probability < 5%. Highly unlikely."
},
{
"key": "L",
"name": "Low",
"definition": "5% <= Probability < 21%. Unlikely."
},
{
"key": "M",
"name": "Moderate",
"definition": "21% <= Probability < 80%. Somewhat likely."
},
{
"key": "H",
"name": "High",
"definition": "80% <= Probability < 96%. Highly likely."
},
{
"key": "VH",
"name": "Very High",
"definition": "96% <= Probability <= 100%. Almost certain."
}
]
},
"values": {
"VL": {
"key": "VL",
"name": "Very Low",
"definition": "0% <= Probability < 5%. Highly unlikely."
},
"L": {
"key": "L",
"name": "Low",
"definition": "5% <= Probability < 21%. Unlikely."
},
"M": {
"key": "M",
"name": "Moderate",
"definition": "21% <= Probability < 80%. Somewhat likely."
},
"H": {
"key": "H",
"name": "High",
"definition": "80% <= Probability < 96%. Highly likely."
},
"VH": {
"key": "VH",
"name": "Very High",
"definition": "96% <= Probability <= 100%. Almost certain."
}
}
}
}
}
}
},
"ssvc": {
"namespace": "ssvc",
"keys": {
Expand Down
Loading