CAT-FR-SF-04 Align arc42 with upload-path simplification#46
Merged
Conversation
* docs(CAT-FR-SF-04): drop deploy-time validation gates from arc42 Removes references to the deploy-time verification.schema and verification.require-base-class properties from the architecture chapters. The upload path runs no forced validation; schema validation is on-demand only via POST /assets/validate (CAT-FR-CO-05). Base-class compliance is now opt-in per request via requireBaseClass on POST /verification. Also renames CredentialVerificationStrategy → CredentialIngestionStrategy in narrative, class diagrams, and runtime sequences to mirror the code. Chapters touched: 05 building-block view, 06 runtime view, 07 deployment view, 09 architecture decisions, 12 glossary. AC-7 (arc42 portion) * docs: drop schema row from ADR 3 verification flag table ADR 3 listed schema among the deploy-time verification toggles, but schema is no longer one — it has moved entirely to the on-demand validation path (POST /assets/validate). Updates the prose accordingly and removes the internal story-ID reference. * update documentation readme references * docs(arc42): replace asset upload config table with wiki pointer
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
🚀 Summary
Brings the architecture documentation in line with the upload-path simplification on the catalogue side. The verification toggle matrix collapses: the two deploy-time gates that used to fire implicitly on upload (SHACL validation, base-class compliance) are gone. The remaining knobs are envelope semantics and signature verification, which actually carry security value. The credential ingestion strategy is also renamed in narrative, class diagrams, and runtime sequences to reflect that it no longer performs gating — it ingests.
The change keeps the docs honest with the implementation; readers will no longer be misled into believing that a
schema=trueorrequire-base-class=truedeployment exists.This change is part of the Enhancement of XFSC Federated Catalogue. Details can be found here (permalink):
https://github.com/eclipse-xfsc/docs/blob/f3c6e6b6fbcc87732a1dfe83f060fa58a9a97873/federated-catalogue/src/docs/CAT%20Enhancement/CAT_Enhancement_Specifications%20v1.0.pdf
✅ What's Changed
🧪 How to Test
CredentialIngestionStrategyand thatverifyCredential/ingestsignatures no longer carry averifySchemaparameter.verifySchemareference is the unrelatedSchemaStore.verifySchema(ContentAccessor)utility — that's expected.🔍 Related Issues
Closes #
Related to #
📸 Screenshots (if applicable)
Reviewers may want to render the arc42 HTML output before/after to compare diagrams visually.
📋 Checklist