Skip to content

Commit 5fd6e64

Browse files
committed
update README with json-ld validation error section
1 parent de36cd4 commit 5fd6e64

File tree

1 file changed

+30
-2
lines changed

1 file changed

+30
-2
lines changed

README.md

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,6 @@ This package exports two methods:
7272
* credential - The W3C Verifiable Credential to be verified.
7373
* knownDidRegistries - a list of issuer DIDs in which to lookup signing DIDs
7474

75-
7675
#### result
7776

7877
The typescript definitions for the result can be found [here](./src/types/result.ts)
@@ -279,7 +278,6 @@ But can't retrieve (from the network) any one of:
279278

280279
* the revocation status
281280
* an issuer registry from our list of trusted issuers
282-
* the issuer's DID document
283281

284282
which are needed to verify the revocation status and issuer identity.
285283

@@ -650,6 +648,36 @@ The proof property is missing, likely because the credential hasn't been signed:
650648
}
651649
```
652650

651+
<b><i>jsonld.ValidationError</i></b>
652+
653+
An error was returnd by the json-ld parser. This is often a safe-mode error, and in particular
654+
is often that a property has been included for which there is no definition in the context.
655+
656+
Another common error here is an @type property that contains a value that is 'relative', meaning
657+
that it cannot be resolved to an absolute IRI (which it must be according to the spec).
658+
659+
A example (just the errors section) of a relative @type reference.
660+
661+
```json
662+
{ "errors": [{
663+
"name": "jsonld.ValidationError",
664+
"details": {
665+
"event": {
666+
"type": [
667+
"JsonLdEvent"
668+
],
669+
"code": "relative @type reference",
670+
"level": "warning",
671+
"message": "Relative @type reference found.",
672+
"details": {
673+
"type": "StatusList2021Entry"
674+
}
675+
}
676+
},
677+
"message": "Safe mode validation error.",
678+
"stack": "jsonld.ValidationError: Safe mode validation error....etc. removed for brevity."
679+
}]}
680+
```
653681

654682
<b>other problem</b>
655683

0 commit comments

Comments
 (0)