Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified ERD-with-fields.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion ERD-with-fields.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified ERD.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
41 changes: 20 additions & 21 deletions ERD.puml
Original file line number Diff line number Diff line change
Expand Up @@ -53,15 +53,15 @@ dataclass activity <<largeBold>> #B4E5D0 {
startDate
endDate
contributions[]?
rights?
location?
rights?
createdAt
!endif
}

dataclass evidence {
!if (SHOW_FIELDS == "true")
hypercert?
activity?
content
title
shortDescription?
Expand All @@ -70,9 +70,9 @@ dataclass evidence {
!endif
}

dataclass measurements {
dataclass measurement {
!if (SHOW_FIELDS == "true")
hypercert
activity
measurers[]
metric
value
Expand All @@ -84,23 +84,22 @@ dataclass measurements {
!endif
}

dataclass evaluations {
dataclass evaluation {
!if (SHOW_FIELDS == "true")
subject
summary
evaluators[]
evidence[]?
measurements[]?
location?
measurements[]?
createdAt
!endif
}

dataclass contributions {
dataclass contribution {
!if (SHOW_FIELDS == "true")
hypercert
role?
contributor[]
contributors[]
description?
startDate
endDate
Expand Down Expand Up @@ -146,20 +145,20 @@ protocol token <<largeBold>> #FFB6C1 {
!endif
}

activity::contributions --> contributions
activity::contributions -l-> contribution
activity::rights --> rights
activity::location --> location
evidence::hypercert --> activity
measurements::hypercert --> activity
measurements::location --> location
evaluations::evidence --> evidence
evaluations::measurements --> measurements
evaluations::subject --> activity
evaluations::location --> location
collection::claims --> activity
activity <-- token : tokenizes
contributor --> contributions : makes
contributor --> rights : has
evidence::activity --> activity
measurement::activity --> activity
measurement::location --> location
evaluation::evidence --> evidence
evaluation::measurements --> measurement
evaluation::subject --> activity
evaluation::location --> location
collection::claims -d-> activity
token -l-> activity : tokenizes
contribution::contributors --> contributor : made by
contributor -r-> rights : has

@enduml

2 changes: 1 addition & 1 deletion ERD.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ Hypercerts-specific lexicons for tracking impact work and claims.

| Property | Type | Required | Description | Comments |
| ------------------ | -------- | -------- | -------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| `hypercert` | `ref` | ❌ | A strong reference to the hypercert this evidence is for | The record referenced must conform with the lexicon `org.hypercerts.claim.activity` |
| `activity` | `ref` | ❌ | A strong reference to the activity this evidence is for | The record referenced must conform with the lexicon `org.hypercerts.claim.activity` |
| `content` | `union` | ✅ | A piece of evidence (URI or blobs) supporting a hypercert claim | |
| `title` | `string` | ✅ | Title to describe the nature of the evidence | |
| `shortDescription` | `string` | ❌ | Short description explaining what this evidence demonstrates or proves | |
Expand All @@ -197,7 +197,7 @@ Hypercerts-specific lexicons for tracking impact work and claims.

| Property | Type | Required | Description | Comments |
| ---------------------- | -------- | -------- | ----------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| `hypercert` | `ref` | ✅ | A strong reference to the hypercert that this measurement is for | The record referenced must conform with the lexicon `org.hypercerts.claim.activity` |
| `activity` | `ref` | ✅ | A strong reference to the activity that this measurement is for | The record referenced must conform with the lexicon `org.hypercerts.claim.activity` |
| `measurers` | `array` | ✅ | DIDs of the entity (or entities) that measured this data | |
| `metric` | `string` | ✅ | The metric being measured | |
| `value` | `string` | ✅ | The measured value | |
Expand Down
4 changes: 2 additions & 2 deletions lexicons/org/hypercerts/claim/evidence.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@
"type": "object",
"required": ["content", "title", "createdAt"],
"properties": {
"hypercert": {
"activity": {
"type": "ref",
"ref": "com.atproto.repo.strongRef",
"description": "A strong reference to the hypercert this evidence is for."
"description": "A strong reference to the activity this evidence is for. The record referenced must conform with the lexicon org.hypercerts.claim.activity"
},
"content": {
"type": "union",
Expand Down
6 changes: 3 additions & 3 deletions lexicons/org/hypercerts/claim/measurement.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@
"key": "tid",
"record": {
"type": "object",
"required": ["hypercert", "measurers", "metric", "value", "createdAt"],
"required": ["activity", "measurers", "metric", "value", "createdAt"],
"properties": {
"hypercert": {
"activity": {
"type": "ref",
"ref": "com.atproto.repo.strongRef",
"description": "A strong reference to the hypercert that this measurement is for. The record referenced must conform with the lexicon org.hypercerts.claim.activity"
"description": "A strong reference to the activity that this measurement is for. The record referenced must conform with the lexicon org.hypercerts.claim.activity"
},
"measurers": {
"type": "array",
Expand Down