Skip to content

Commit af97617

Browse files
authored
Blueprint CS appendix (webuild-consortium#123)
* Add ADR appendix * Find ADR entries from adr/README.md * Add CS appendix * Find CS entries from conformance-specs/README.md * Add Conformance Specifications header
1 parent c04cfe8 commit af97617

2 files changed

Lines changed: 47 additions & 0 deletions

File tree

blueprint/appendix-cs.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Appendix F: Conformance Specifications (CS)
2+
3+
## About
4+
5+
The Conformance Specifications define how WE BUILD participants implement wallet interfaces and communication protocols between issuers, wallets, and relying parties (RPs).
6+
They ensure interoperability and conformance by translating ADR decisions into precise implementation requirements.
7+
8+
The ITB will be based on the CS as a starting point. The test suites in the ITB are relying predominantly on the CS.
9+
10+
## Contributing
11+
12+
The Architecture group define the CS, with help from all implementing participants (wallets, issuers and verifiers). For members of the consortium, find more information on the CS processes are held on [open social - Architecture Group](https://portal.webuildconsortium.eu/group/architecture).
13+
14+
## CS Process Summary for WE BUILD Large Scale Pilots (LSPs)
15+
16+
Conformance Specifications (CS) progress through the following process towards the Large Scale Pilots (LSPs):
17+
18+
![CS Process and Roles](https://github.com/webuild-consortium/wp4-architecture/blob/main/images/WPRoles.png)
19+
20+
### Approved CSs
21+
22+
| **CS #** | **CS Title** |
23+
| -------- | ------------------------------------|
24+
| CS-001 | Credential Issuance - v1.0 |
25+
| CS-002 | Credential Presentation - v1.0 |
26+
| | |
27+
28+
### CSs Under Development
29+
30+
| **CS #** | **CS Title** |
31+
| -------- | ------------ |
32+
| | |
33+
34+
## Conformance Specifications

blueprint/build.sh

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,10 @@ function extract_last_parenthesis() {
2929
grep --color=none '.md)$' | rev | cut -d ')' -f 2 | cut -d '(' -f 1 | rev
3030
}
3131

32+
function extract_last_parenthesis_in_line() {
33+
grep --color=none '.md)' | rev | cut -d ')' -f 2 | cut -d '(' -f 1 | rev
34+
}
35+
3236
export GEM_HOME="$HOME/gems"
3337
export PATH="$HOME/gems/bin:$PATH"
3438
export CHROME_DEVEL_SANDBOX=$(realpath -m chrome/linux-145.0.7632.46/chrome-linux64/chrome_sandbox)
@@ -87,6 +91,15 @@ for ADR in $(cat ../adr/README.md | extract_last_parenthesis); do
8791
cat ../adr/${ADR} | indent_headers | indent_headers >> main.md
8892
done
8993

94+
# CS appendix, gathers all conformance specifications
95+
echo >> main.md
96+
cat appendix-cs.md >> main.md
97+
for CS in $(cat ../conformance-specs/README.md | extract_last_parenthesis_in_line); do
98+
echo "Adding CS: ${CS}"
99+
echo >> main.md
100+
cat ../conformance-specs/${CS} | indent_headers | indent_headers >> main.md
101+
done
102+
90103
echo "Running kramdoc..."
91104
kramdoc --auto-ids --heading-offset 1 main.md -o main.adoc
92105

0 commit comments

Comments
 (0)