Skip to content

Commit 73cf04c

Browse files
wesbiggsWes Biggs
and
Wes Biggs
authored
Documentation fixes for #266 (#267)
Fix link to ApplicationContext details; change example to show as self-signed with did:key; fix link in top-level README. n.b. This doesn't close #266, just plucks some low-hanging fruit. Co-authored-by: Wes Biggs <[email protected]>
1 parent 046273e commit 73cf04c

File tree

3 files changed

+9
-6
lines changed

3 files changed

+9
-6
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ Documentation is written in [CommonMark Markdown](https://rust-lang.github.io/md
7474
- [Node.js v20+](https://nodejs.org)
7575

7676
#### Local Development
77-
- Build the signed-request-generator: follow the "Development" and "Build" steps in [`tools/signed-request-generator/README.md`].
77+
- Build the signed-request-generator: follow the "Development" and "Build" steps in `[tools/signed-request-generator/README.md]`.
7878
- Copy the new Generator to the docs directory: `rm -Rf docs/src/Generator && cp -a tools/signed-request-generator/build docs/src/Generator`
7979
- `cd ../../docs`
8080
- Serve the HTML locally and watch for changes: `mdbook serve` or `mdbook serve -p <port, default 3000>`

docs/src/DataStructures/ApplicationContext.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,10 @@ The `credentialSubject` field should contain an object with the following fields
1616
- `id`: Your provider identifier, expressed as a DID.
1717
- `application`: A JSON object containing the following keys:
1818
- `name`: A map of one or more language tags to human-readable string values. Language tags should follow [BCP-47/RFC-5646](https://www.rfc-editor.org/rfc/rfc5646.html) (as used in the HTTP `Content-Language` header). A content language key of `"*"` indicates a wildcard or default value, as in HTTP.
19-
- `logo`: A map of one or more language tags (as above) to objects containing a `url` property. The URL should resolve to an image in the PNG format. The recommended maximum image width for optimal client compatibility is 200 pixels.
19+
- `logo`: A map of one or more language tags (as above) to objects containing a `url` property. The URL should resolve to an image in the PNG format. The recommended image size is 250 x 100 pixels.
20+
21+
The credential SHOULD be signed by a trusted `issuer`.
22+
The issuer MAY be the provider's control key, expressed in `did:key` syntax.
2023

2124
### Example
2225

@@ -32,14 +35,14 @@ This application context credential describes a hypothetical app called "My Soci
3235
"ApplicationContextCredential",
3336
"VerifiableCredential"
3437
],
35-
"issuer": "did:web:frequencyaccess.com",
38+
"issuer": "did:key:z6MkofWExWkUvTZeXb9TmLta5mBT6Qtj58es5Fqg1L5BCWQD",
3639
"validFrom": "2025-02-12T21:28:08.289+0000",
3740
"credentialSchema": {
3841
"type": "JsonSchema",
3942
"id": "https://schemas.frequencyaccess.com/ApplicationContextCredential/bciqe2bsnuaqg7zy3gqjmwha2q5h2bybvr6log2jsb5kjn2hos6irrlq.json"
4043
},
4144
"credentialSubject": {
42-
"id": "did:dsnp:123456",
45+
"id": "did:key:z6MkofWExWkUvTZeXb9TmLta5mBT6Qtj58es5Fqg1L5BCWQD",
4346
"application": {
4447
"name": {
4548
"en": "My Social App",
@@ -54,7 +57,7 @@ This application context credential describes a hypothetical app called "My Soci
5457
},
5558
"proof": {
5659
"type": "DataIntegrityProof",
57-
"verificationMethod": "did:web:frequencyaccess.com#z6MkofWExWkUvTZeXb9TmLta5mBT6Qtj58es5Fqg1L5BCWQD",
60+
"verificationMethod": "did:key:z6MkofWExWkUvTZeXb9TmLta5mBT6Qtj58es5Fqg1L5BCWQD#z6MkofWExWkUvTZeXb9TmLta5mBT6Qtj58es5Fqg1L5BCWQD",
5861
"cryptosuite": "eddsa-rdfc-2022",
5962
"proofPurpose": "assertionMethod",
6063
"proofValue": "z4jArnPwuwYxLnbBirLanpkcyBpmQwmyn5f3PdTYnxhpy48qpgvHHav6warjizjvtLMg6j3FK3BqbR2nuyT2UTSWC"

docs/src/SignatureGeneration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ Note that any delegations that are granted by the user will apply to all applica
118118
The application context credential is a JSON-formatted verifiable credential that MAY be signed by a credential issuer.
119119
If you are integrating with Frequency Access, your application context details will be created as part of the provisioning process.
120120

121-
For detailed information on the credential schema and properties, see the [full specification and example](./DataStructures/ApplicationContext.md).
121+
For detailed information on the credential schema and properties, see the [full specification and example](./DataStructures/All.html#application-context).
122122

123123
### Example Using TypeScript/JavaScript
124124

0 commit comments

Comments
 (0)