@@ -141,95 +141,27 @@ After adding the config file, only implementations in `localConfig.cjs` will run
141
141
142
142
### Tags
143
143
144
- Please Note:
145
-
146
- 1 . Tags serve as identifiers to determine which test suites to run on your
147
- issuers and verifiers. The first issuer/verifier found with a specific
148
- tag from your list will be run against the test suite, while subsequent issuers
149
- and verifiers bearing the same tag won't. This applies to most of the test
150
- suites associated with this implementations repository listed below.
151
-
152
- For instance, if you have added the tag ` vc-api ` to all your issuers and
153
- verifiers to run them with vc api issuer and verifier test suites, only the
154
- first match will be used in the test suites. In the sample configuration below,
155
- only the issuer and verifier with the IDs
156
- https://product.example.com/issuers/z1AEwLo7tZ3TrsPgRcgLJqQvR and
157
- https://product.example.com/verifiers/z1AEwLo7tZ3TrsPgRcgLJqQvR will be selected.
158
- Therefore, please avoid adding duplicate tags.
159
-
160
- Example
161
- ``` js
162
- // Only the first match https://product.example.com/issuers/z1AEwLo7tZ3TrsPgRcgLJqQvR
163
- // and https://product.example.com/verifiers/z1AEwLo7tZ3TrsPgRcgLJqQvR will be
164
- // run against the VC API issuer and verifier test suites.
165
- {
166
- " issuers" : [{
167
- " id" : " https://product.example.com/issuers/z1AEwLo7tZ3TrsPgRcgLJqQvR" ,
168
- " endpoint" : " https://product.example.com/issuers/z1AEwLo7tZ3TrsPgRcgLJqQvR/credentials/issue" ,
169
- " tags" : [" vc-api" ]
170
- }, {
171
- " id" : " https://product.example.com/issuers/z4Rq7N1lT6zVwFgXk8JYdCcKpU" ,
172
- " endpoint" : " https://product.example.com/issuers/z4Rq7N1lT6zVwFgXk8JYdCcKpU/credentials/issue" ,
173
- " tags" : [" vc-api" ]
174
- }],
175
- " verifiers" : [{
176
- " id" : " https://product.example.com/verifiers/z1AEwLo7tZ3TrsPgRcgLJqQvR" ,
177
- " endpoint" : " https://product.example.com/verifiers/z1AEwLo7tZ3TrsPgRcgLJqQvR/credentials/verify" ,
178
- " tags" : [" vc-api" ]
179
- }, {
180
- " id" : " https://product.example.com/verifiers/z4Rq7N1lT6zVwFgXk8JYdCcKpU" ,
181
- " endpoint" : " https://product.example.com/verifiers/z4Rq7N1lT6zVwFgXk8JYdCcKpU/credentials/verify" ,
182
- " tags" : [" vc-api" ]
183
- }]
184
- }
185
- ```
144
+ Tags tell the test suites which implementations' endpoints to run the test suites against.
186
145
187
- 2 . If you want your issuer or verifier to run against multiple test suites, you
188
- can assign multiple tags to them, eliminating the need for redundant entries.
189
- For instance, if an issuer with the ID
190
- https://product.example.com/issuers/z1AEwLo7tZ3TrsPgRcgLJqQvR can be run with
191
- both the VC Bitstring Status List and VC API test suites, a single entry with
192
- multiple tags can be used. This consolidated entry, containing tags for
193
- both VC API and VC Bitstring Status List test suites, ensures that the issuer and
194
- the verifier will be run against both test suites. Here is an example of how to
195
- structure the entry:
196
-
197
- For Example:
198
- ``` js
199
- {
200
- " issuers" : [{
201
- " id" : " https://product.example.com/issuers/z4Rq7N1lT6zVwFgXk8JYdCcKpU" ,
202
- " endpoint" : " https://product.example.com/issuers/z4Rq7N1lT6zVwFgXk8JYdCcKpU/credentials/issue" ,
203
- " tags" : [" vc-api" , " BitstringStatusList" , " Suspension" ]
204
- }],
205
- " verifiers" : [{
206
- " id" : " https://product.example.com/verifiers/z4Rq7N1lT6zVwFgXk8JYdCcKpU" ,
207
- " endpoint" : " https://product.example.com/verifiers/z4Rq7N1lT6zVwFgXk8JYdCcKpU/credentials/verify" ,
208
- " tags" : [" vc-api" ]
209
- }]
210
- }
211
- ```
146
+ * ` vc-api ` - This tag will run the
147
+ [ VC API Issuer test suite] ( https://github.com/w3c-ccg/vc-api-issuer-test-suite )
148
+ on an ` issuer ` endpoint and the
149
+ [ VC API Verifier test suite] ( https://github.com/w3c-ccg/vc-api-verifier-test-suite )
150
+ on a ` verifier ` endpoint.
212
151
213
- #### VC API Issuer and Verifier Test Suites
214
-
215
- * ` vc-api ` - This tag will run the [ vc-api-issuer tests] ( https://github.com/w3c-ccg/vc-api-issuer-test-suite )
216
- on your issuer and the [ vc-api-verifier tests] ( https://github.com/w3c-ccg/vc-api-verifier-test-suite )
217
- on your verifier.
218
-
219
- NOTE: Currently the vc api verifier test suite uses ` Ed25519Signature2020 ` as
152
+ NOTE: Currently the VC API Verifier test suite uses ` Ed25519Signature2020 ` as
220
153
the default signature for the mock VCs that are sent to the verifiers since it
221
- is most widely implemented. So, the verifier you add for ` vc-api ` must support
154
+ is widely implemented. So, the verifier you add for ` vc-api ` must support
222
155
verification of VCs with ` Ed25519Signature2020 ` signature to pass verification
223
156
tests.
224
157
225
158
As of 2023, ` Ed25519Signature2018 ` is no longer supported, so please update
226
159
your existing implementations to use ` Ed25519Signature2020 ` if you were
227
160
previously using ` Ed25519Signature2018 ` .
228
161
229
- #### DID Key Test Suite
230
-
231
- * ` did-key ` - This tag will run the [ DID Key Test Suite] ( https://github.com/w3c-ccg/did-key-test-suite )
232
- on your DID resolver endpoint.
162
+ * ` did-key ` - This tag will run the
163
+ [ DID Key Test Suite] ( https://github.com/w3c-ccg/did-key-test-suite )
164
+ on a DID resolver endpoint.
233
165
234
166
## Contribute
235
167
0 commit comments