Skip to content

Commit 8e49346

Browse files
jeremijeremi
committed
docs: publish registrar client authoring reference
Signed-off-by: Jeremi Joslin <jeremi@joslin.fr>
1 parent 5b12813 commit 8e49346

5 files changed

Lines changed: 452 additions & 46 deletions

File tree

‎docs/site/public/generated/configuration-reference-coverage.v1.json‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -39,11 +39,11 @@
3939
},
4040
"coverage": {
4141
"schema_count": 7,
42-
"path_count": 1801,
43-
"reference_count": 499,
42+
"path_count": 1803,
43+
"reference_count": 500,
4444
"by_schema": {
4545
"project": 220,
46-
"environment": 198,
46+
"environment": 200,
4747
"integration": 166,
4848
"fixture": 62,
4949
"entity": 35,
@@ -52,22 +52,22 @@
5252
},
5353
"by_path_kind": {
5454
"root": 7,
55-
"property": 1434,
55+
"property": 1435,
5656
"map_key": 26,
5757
"map_value": 49,
58-
"array_item": 178,
58+
"array_item": 179,
5959
"branch": 107
6060
},
6161
"by_sensitivity": {
6262
"public": 16,
6363
"internal": 1168,
64-
"sensitive": 399,
64+
"sensitive": 401,
6565
"secret_reference": 41,
6666
"redacted_fixture": 50,
6767
"structural": 127
6868
},
6969
"by_intent_source": {
70-
"schema_description": 515,
70+
"schema_description": 517,
7171
"reviewed_override": 261,
7272
"structural_taxonomy": 127,
7373
"reviewed_profile": 898
@@ -149,10 +149,10 @@
149149
"relay_vocabularies_open_map": 1
150150
}
151151
},
152-
"reviewed_intent_assignment_required_count": 1801,
153-
"reviewed_intent_assignment_covered_count": 1801,
154-
"distinct_reviewed_intent_count": 616,
152+
"reviewed_intent_assignment_required_count": 1803,
153+
"reviewed_intent_assignment_covered_count": 1803,
154+
"distinct_reviewed_intent_count": 617,
155155
"distinct_reviewed_intents_reused_count": 86,
156-
"reviewed_intent_assignments_using_reused_intent_count": 1271,
156+
"reviewed_intent_assignments_using_reused_intent_count": 1272,
157157
"missing_intent": []
158158
}

‎docs/site/public/generated/configuration-reference.v1.json‎

Lines changed: 210 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -38,11 +38,11 @@
3838
},
3939
"coverage": {
4040
"schema_count": 7,
41-
"path_count": 1801,
42-
"reference_count": 499,
41+
"path_count": 1803,
42+
"reference_count": 500,
4343
"by_schema": {
4444
"project": 220,
45-
"environment": 198,
45+
"environment": 200,
4646
"integration": 166,
4747
"fixture": 62,
4848
"entity": 35,
@@ -51,22 +51,22 @@
5151
},
5252
"by_path_kind": {
5353
"root": 7,
54-
"property": 1434,
54+
"property": 1435,
5555
"map_key": 26,
5656
"map_value": 49,
57-
"array_item": 178,
57+
"array_item": 179,
5858
"branch": 107
5959
},
6060
"by_sensitivity": {
6161
"public": 16,
6262
"internal": 1168,
63-
"sensitive": 399,
63+
"sensitive": 401,
6464
"secret_reference": 41,
6565
"redacted_fixture": 50,
6666
"structural": 127
6767
},
6868
"by_intent_source": {
69-
"schema_description": 515,
69+
"schema_description": 517,
7070
"reviewed_override": 261,
7171
"structural_taxonomy": 127,
7272
"reviewed_profile": 898
@@ -26232,6 +26232,209 @@
2623226232
"pointer": "/$defs/relayResource"
2623326233
}
2623426234
},
26235+
{
26236+
"address": {
26237+
"schema": "environment",
26238+
"pointer": "/$defs/oid4vci/properties/registrar_clients",
26239+
"path_kind": "property"
26240+
},
26241+
"purpose": "Closed OIDC machine-client allow-list for registrar-created credential offers. Each client uses this authorization server and the Notary public base URL as its resource audience; citizen client classification remains separate.",
26242+
"purpose_source": "schema_description",
26243+
"semantic_owner": "deployment_security",
26244+
"human_owner": "security_maintainers",
26245+
"scope": "Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.",
26246+
"field_type": {
26247+
"schema_types": [
26248+
"array"
26249+
],
26250+
"composed": false
26251+
},
26252+
"requiredness": "optional",
26253+
"null_behavior": "rejected",
26254+
"empty_behavior": "not_applicable",
26255+
"default": {
26256+
"behavior": "schema_default",
26257+
"schema_value": []
26258+
},
26259+
"environment_behavior": "narrows_reviewed_authority",
26260+
"sensitivity": "sensitive",
26261+
"state": "environment_bound",
26262+
"products": [
26263+
"registryctl",
26264+
"relay",
26265+
"notary",
26266+
"editor",
26267+
"docs"
26268+
],
26269+
"availability": "published",
26270+
"stability": "experimental",
26271+
"validation_stages": [
26272+
"json_schema",
26273+
"rust_deserialization",
26274+
"cross_file_semantic",
26275+
"operator_preflight",
26276+
"product_build"
26277+
],
26278+
"diagnostic": "registryctl.authoring.environment.invalid",
26279+
"history_status": "not_verified",
26280+
"introduced_in": null,
26281+
"version_history": [],
26282+
"example": {
26283+
"guidance": "Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.",
26284+
"schema_examples_available": false,
26285+
"contains_country_values": false
26286+
},
26287+
"migration": "coordinate_deployment",
26288+
"migration_note": "Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.",
26289+
"consumers": [
26290+
"registryctl_authoring",
26291+
"registry_relay",
26292+
"registry_notary",
26293+
"editor_tooling",
26294+
"docs_generator"
26295+
],
26296+
"generated_artifacts": [
26297+
"editor_schemas",
26298+
"project_build",
26299+
"relay_config",
26300+
"notary_config",
26301+
"field_reference"
26302+
],
26303+
"review_classes": [
26304+
"contract",
26305+
"security",
26306+
"privacy",
26307+
"relay",
26308+
"notary",
26309+
"compatibility",
26310+
"documentation"
26311+
],
26312+
"semantic_rules": [
26313+
"knowledge_only",
26314+
"generated_docs_never_load_country_values",
26315+
"sensitive_operational_metadata"
26316+
],
26317+
"constraints": [
26318+
{
26319+
"keyword": "maxItems",
26320+
"value": 64
26321+
},
26322+
{
26323+
"keyword": "type",
26324+
"value": "array"
26325+
},
26326+
{
26327+
"keyword": "uniqueItems",
26328+
"value": true
26329+
}
26330+
]
26331+
},
26332+
{
26333+
"address": {
26334+
"schema": "environment",
26335+
"pointer": "/$defs/oid4vci/properties/registrar_clients/items",
26336+
"path_kind": "array_item"
26337+
},
26338+
"purpose": "Bounded visible-ASCII protocol token.",
26339+
"purpose_source": "schema_description",
26340+
"semantic_owner": "deployment_security",
26341+
"human_owner": "security_maintainers",
26342+
"scope": "Operator-owned deployment, trust, secret-reference, network, caller, state, and product availability bindings.",
26343+
"field_type": {
26344+
"schema_types": [
26345+
"string"
26346+
],
26347+
"local_reference": "#/$defs/token256",
26348+
"composed": false
26349+
},
26350+
"requiredness": "not_applicable",
26351+
"null_behavior": "rejected",
26352+
"empty_behavior": "rejected",
26353+
"default": {
26354+
"behavior": "no_schema_default"
26355+
},
26356+
"environment_behavior": "narrows_reviewed_authority",
26357+
"sensitivity": "sensitive",
26358+
"state": "environment_bound",
26359+
"products": [
26360+
"registryctl",
26361+
"relay",
26362+
"notary",
26363+
"editor",
26364+
"docs"
26365+
],
26366+
"availability": "published",
26367+
"stability": "experimental",
26368+
"validation_stages": [
26369+
"json_schema",
26370+
"rust_deserialization",
26371+
"cross_file_semantic",
26372+
"operator_preflight",
26373+
"product_build"
26374+
],
26375+
"diagnostic": "registryctl.authoring.environment.invalid",
26376+
"history_status": "not_verified",
26377+
"introduced_in": null,
26378+
"version_history": [],
26379+
"example": {
26380+
"guidance": "Use non-routable example origins and opaque example secret-reference names, never working credentials or private infrastructure details.",
26381+
"schema_examples_available": false,
26382+
"contains_country_values": false
26383+
},
26384+
"migration": "coordinate_deployment",
26385+
"migration_note": "Coordinate deployment and secret or trust rotation with the environment operator before activating a changed binding.",
26386+
"consumers": [
26387+
"registryctl_authoring",
26388+
"registry_relay",
26389+
"registry_notary",
26390+
"editor_tooling",
26391+
"docs_generator"
26392+
],
26393+
"generated_artifacts": [
26394+
"editor_schemas",
26395+
"project_build",
26396+
"relay_config",
26397+
"notary_config",
26398+
"field_reference"
26399+
],
26400+
"review_classes": [
26401+
"contract",
26402+
"security",
26403+
"privacy",
26404+
"relay",
26405+
"notary",
26406+
"compatibility",
26407+
"documentation"
26408+
],
26409+
"semantic_rules": [
26410+
"knowledge_only",
26411+
"generated_docs_never_load_country_values",
26412+
"sensitive_operational_metadata",
26413+
"array_items_share_element_contract"
26414+
],
26415+
"constraints": [
26416+
{
26417+
"keyword": "maxLength",
26418+
"value": 256
26419+
},
26420+
{
26421+
"keyword": "minLength",
26422+
"value": 1
26423+
},
26424+
{
26425+
"keyword": "pattern",
26426+
"value": "^[!-~]+$"
26427+
},
26428+
{
26429+
"keyword": "type",
26430+
"value": "string"
26431+
}
26432+
],
26433+
"local_reference": {
26434+
"schema": "environment",
26435+
"pointer": "/$defs/token256"
26436+
}
26437+
},
2623526438
{
2623626439
"address": {
2623726440
"schema": "environment",

‎docs/site/scripts/authoring-reference-docs.test.mjs‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,12 @@ test('committed internal and public reference artifacts are exact and complete',
2626
validateAuthoringReference(reference, coverage);
2727
assert.deepEqual(publicReference, reference);
2828
assert.deepEqual(publicCoverage, coverage);
29-
assert.equal(reference.fields.length, 1801);
30-
assert.equal(coverage.reviewed_intent_assignment_required_count, 1801);
31-
assert.equal(coverage.reviewed_intent_assignment_covered_count, 1801);
32-
assert.equal(coverage.distinct_reviewed_intent_count, 616);
29+
assert.equal(reference.fields.length, 1803);
30+
assert.equal(coverage.reviewed_intent_assignment_required_count, 1803);
31+
assert.equal(coverage.reviewed_intent_assignment_covered_count, 1803);
32+
assert.equal(coverage.distinct_reviewed_intent_count, 617);
3333
assert.equal(coverage.distinct_reviewed_intents_reused_count, 86);
34-
assert.equal(coverage.reviewed_intent_assignments_using_reused_intent_count, 1271);
34+
assert.equal(coverage.reviewed_intent_assignments_using_reused_intent_count, 1272);
3535
assert.deepEqual(reference.reference_baseline, {
3636
generator_lifecycle: 'unreleased',
3737
published_release: null,
@@ -51,7 +51,7 @@ test('committed internal and public reference artifacts are exact and complete',
5151
);
5252
assert.deepEqual(reference.coverage.by_schema, {
5353
project: 220,
54-
environment: 198,
54+
environment: 200,
5555
integration: 166,
5656
fixture: 62,
5757
entity: 35,
@@ -60,10 +60,10 @@ test('committed internal and public reference artifacts are exact and complete',
6060
});
6161
assert.deepEqual(reference.coverage.by_path_kind, {
6262
root: 7,
63-
property: 1434,
63+
property: 1435,
6464
map_key: 26,
6565
map_value: 49,
66-
array_item: 178,
66+
array_item: 179,
6767
branch: 107,
6868
});
6969
assert.equal(
@@ -74,10 +74,10 @@ test('committed internal and public reference artifacts are exact and complete',
7474
1120,
7575
);
7676
assert.equal(reference.fields.filter((field) => field.empty_behavior === 'allowed').length, 523);
77-
assert.equal(reference.fields.filter((field) => field.empty_behavior === 'rejected').length, 308);
77+
assert.equal(reference.fields.filter((field) => field.empty_behavior === 'rejected').length, 309);
7878
assert.equal(
7979
reference.fields.filter((field) => field.empty_behavior === 'not_applicable').length,
80-
970,
80+
971,
8181
);
8282
});
8383

0 commit comments

Comments
 (0)