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.
10 changes: 8 additions & 2 deletions ERD.puml
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ dataclass activity <<largeBold>> #B4E5D0 {

dataclass evidence {
!if (SHOW_FIELDS == "true")
hypercert
content
title
shortDescription
Expand All @@ -78,6 +79,7 @@ dataclass measurements {
value
measurementMethodURI
evidenceURI[]
location
createdAt
!endif
}
Expand All @@ -88,6 +90,7 @@ dataclass evaluations {
evaluators[]
evaluations[]
summary
location
createdAt
!endif
}
Expand Down Expand Up @@ -145,15 +148,18 @@ activity::evidence --> evidence
activity::contributions --> contributions
activity::rights --> rights
activity::location --> location
evidence::hypercert --> activity
measurements::hypercert --> activity
measurements::location --> location
evaluations::subject --> evidence
evaluations::subject --> measurements
evaluations::subject --> activity
evaluations::location --> location
contributions::hypercert --> activity
collection::claims --> activity
activity <-- token : tokenizes
contributor --> contributions : make
contributor --> rights : have
contributor --> contributions : makes
contributor --> 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.
31 changes: 17 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,13 +144,14 @@ Hypercerts-specific lexicons for tracking impact work and claims.

#### Properties

| Property | Type | Required | Description | Comments |
| ------------- | -------- | -------- | -------------------------------------------------------------------------- | ----------------------------------------------- |
| `subject` | `ref` | ✅ | A strong reference to the evaluated claim | (e.g measurement, hypercert, contribution, etc) |
| `evaluators` | `array` | ✅ | DIDs of the evaluators | |
| `evaluations` | `array` | ❌ | Evaluation data (URIs or blobs) containing detailed reports or methodology | |
| `summary` | `string` | ✅ | Brief evaluation summary | |
| `createdAt` | `string` | ✅ | Client-declared timestamp when this record was originally created | |
| Property | Type | Required | Description | Comments |
| ------------- | -------- | -------- | -------------------------------------------------------------------------- | -------------------------------------------------------------- |
| `subject` | `ref` | ✅ | A strong reference to the evaluated claim | (e.g measurement, hypercert, contribution, etc) |
| `evaluators` | `array` | ✅ | DIDs of the evaluators | |
| `evaluations` | `array` | ❌ | Evaluation data (URIs or blobs) containing detailed reports or methodology | |
| `summary` | `string` | ✅ | Brief evaluation summary | |
| `location` | `ref` | ❌ | An optional reference for georeferenced evaluations | References must conform to `app.certified.location` |
| `createdAt` | `string` | ✅ | Client-declared timestamp when this record was originally created | |

---

Expand All @@ -164,13 +165,14 @@ Hypercerts-specific lexicons for tracking impact work and claims.

#### Properties

| Property | Type | Required | Description | Comments |
| ------------------ | -------- | -------- | -------------------------------------------------------------------------- | -------- |
| `content` | `union` | ✅ | A piece of evidence (URI or blobs) supporting a hypercert claim | |
| `title` | `string` | ❌ | Optional title to describe the nature of the evidence | |
| `shortDescription` | `string` | ✅ | Short description explaining what this evidence demonstrates or proves | |
| `description` | `string` | ❌ | Optional longer description describing the impact claim evidence. | |
| `createdAt` | `string` | ✅ | Client-declared timestamp when this hypercert claim was originally created | |
| 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` |
| `content` | `union` | ✅ | A piece of evidence (URI or blobs) supporting a hypercert claim | |
| `title` | `string` | ❌ | Optional title to describe the nature of the evidence | |
| `shortDescription` | `string` | ✅ | Short description explaining what this evidence demonstrates or proves | |
| `description` | `string` | ❌ | Optional longer description describing the impact claim evidence. | |
| `createdAt` | `string` | ✅ | Client-declared timestamp when this hypercert claim was originally created | |

---

Expand All @@ -192,6 +194,7 @@ Hypercerts-specific lexicons for tracking impact work and claims.
| `value` | `string` | ✅ | The measured value | |
| `measurementMethodURI` | `string` | ❌ | URI to methodology documentation, standard protocol, or measurement procedure | |
| `evidenceURI` | `array` | ❌ | URIs to supporting evidence or data | |
| `location` | `ref` | ❌ | A strong reference to the location where the measurement was taken | References must conform to `app.certified.location` |
| `createdAt` | `string` | ✅ | Client-declared timestamp when this record was originally created | |

---
Expand Down
5 changes: 5 additions & 0 deletions lexicons/org/hypercerts/claim/evaluation.json
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,11 @@
"maxLength": 5000,
"maxGraphemes": 1000
},
"location": {
"type": "ref",
"ref": "com.atproto.repo.strongRef",
"description": "An optional reference for georeferenced evaluations. The record referenced must conform with the lexicon app.certified.location."
},
"createdAt": {
"type": "string",
"format": "datetime",
Expand Down
5 changes: 5 additions & 0 deletions lexicons/org/hypercerts/claim/evidence.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,11 @@
"type": "object",
"required": ["content", "shortDescription", "createdAt"],
"properties": {
"hypercert": {
"type": "ref",
"ref": "com.atproto.repo.strongRef",
"description": "A strong reference to the hypercert this evidence is for."
},
"content": {
"type": "union",
"refs": [
Expand Down
5 changes: 5 additions & 0 deletions lexicons/org/hypercerts/claim/measurement.json
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,11 @@
},
"maxLength": 50
},
"location": {
"type": "ref",
"ref": "com.atproto.repo.strongRef",
"description": "A strong reference to the location where the measurement was taken. The record referenced must conform with the lexicon app.certified.location"
},
"createdAt": {
"type": "string",
"format": "datetime",
Expand Down