Skip to content

Commit 74a7c4b

Browse files
committed
Update readme with sample queries
Signed-off-by: steve lasker <stevenlasker@hotmail.com>
1 parent b48dca2 commit 74a7c4b

File tree

2 files changed

+21
-2
lines changed

2 files changed

+21
-2
lines changed

README.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,16 +53,18 @@ See [Signed Statement Issuance and Registration](https://datatracker.ietf.org/do
5353
**Required** The name of the issuer, set to `CTW_Claims:iss`.
5454
See [Signed Statement Envelope](https://datatracker.ietf.org/doc/html/draft-ietf-scitt-architecture#name-signed-statement-envelope).
5555

56-
## Example usage
56+
## Example Usage
5757

58-
The following example shows a minimal implementation.
58+
The following example shows a minimal implementation for registering SCITT Signed Statements.
5959

6060
Three GitHub Action Secrets are used:
6161

6262
- `secrets.DATATRAILS_CLIENT_ID`
6363
- `secrets.DATATRAILS_CLIENT_SECRET`
6464
- `secrets.SIGNING_KEY`
6565

66+
### Registering Signed Statements
67+
6668
Sample github `action.yaml`
6769

6870
```yaml
@@ -128,6 +130,20 @@ jobs:
128130
rm ./signingkey.pem
129131
```
130132
133+
### Querying DataTrails Events
134+
135+
Registered SCITT Statements are available as [DataTrails Events][datatrails-events].
136+
137+
> **NOTE**: As the [SCITT Reference API][scrapi] queries mature, additional DataTrails SCITT Query APIs will be made available.
138+
139+
Using the `SUBJECT` from above, query all DataTrails Events (SCITT Registered Statements).
140+
141+
```bash
142+
SUBJECT="synsation.io/myproduct-v1.0"
143+
curl https://app.datatrails.ai/archivist/v2/publicassets/-/events?event_attributes.subject=$SUBJECT \
144+
| jq
145+
```
146+
131147
## Testing Action Updates
132148

133149
To test incremental changes to this github action:
@@ -142,3 +158,6 @@ To test incremental changes to this github action:
142158
uses: synsation-corp/scitt-action@featurebranch
143159
uses: synsation-corp/scitt-action@5b861ed4722787835cdd5e9d86efc698974f1131
144160
```
161+
162+
[datatrails-events]: https://docs.datatrails.ai/developers/api-reference/events-api/
163+
[scrapi]: https://datatracker.ietf.org/doc/draft-ietf-scitt-scrapi/

assets/SCITT-Action.png

162 KB
Loading

0 commit comments

Comments
 (0)