diff --git a/ERD-with-fields.png b/ERD-with-fields.png index 90dc0d5e..66f15e1a 100644 Binary files a/ERD-with-fields.png and b/ERD-with-fields.png differ diff --git a/ERD-with-fields.svg b/ERD-with-fields.svg index fd0b895f..2a264431 100644 --- a/ERD-with-fields.svg +++ b/ERD-with-fields.svg @@ -1 +1 @@ -Hypercert ERDHypercert ERDcontributorDID or name/pseudonymactivitytitleshortDescriptiondescription?image?workScope?startDateendDatecontributions[]?rights?location?createdAtevidencehypercert?contenttitleshortDescription?description?createdAtmeasurementshypercertmeasurers[]metricvaluemeasurementMethodTypemeasurementMethodURIevidenceURI[]?location?createdAtevaluationssubjectsummaryevaluators[]evidence[]?measurements[]?location?createdAtcontributionshypercertrole?contributor[]description?startDateendDatecreatedAtlocationlpVersionsrslocationTypelocationname?description?createdAtrightsrightsNamerightsTyperightsDescriptionattachmentcreatedAtcollectiontitleshortDescription?coverPhoto?claims[]createdAttoken(on-chain only)tokenizesmakeshas \ No newline at end of file +Hypercert ERDHypercert ERDcontributorDID or name/pseudonymactivitytitleshortDescriptiondescription?image?workScope?startDateendDatecontributions[]?location?rights?createdAtevidenceactivity?contenttitleshortDescription?description?createdAtmeasurementactivitymeasurers[]metricvaluemeasurementMethodTypemeasurementMethodURIevidenceURI[]?location?createdAtevaluationsubjectsummaryevaluators[]evidence[]?location?measurements[]?createdAtcontributionrole?contributors[]description?startDateendDatecreatedAtlocationlpVersionsrslocationTypelocationname?description?createdAtrightsrightsNamerightsTyperightsDescriptionattachmentcreatedAtcollectiontitleshortDescription?coverPhoto?claims[]createdAttoken(on-chain only)tokenizesmade byhas \ No newline at end of file diff --git a/ERD.png b/ERD.png index f17a052d..d3596840 100644 Binary files a/ERD.png and b/ERD.png differ diff --git a/ERD.puml b/ERD.puml index a136d4f4..e9fb9b7e 100644 --- a/ERD.puml +++ b/ERD.puml @@ -53,15 +53,15 @@ dataclass activity <> #B4E5D0 { startDate endDate contributions[]? - rights? location? + rights? createdAt !endif } dataclass evidence { !if (SHOW_FIELDS == "true") - hypercert? + activity? content title shortDescription? @@ -70,9 +70,9 @@ dataclass evidence { !endif } -dataclass measurements { +dataclass measurement { !if (SHOW_FIELDS == "true") - hypercert + activity measurers[] metric value @@ -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 @@ -146,20 +145,20 @@ protocol token <> #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 diff --git a/ERD.svg b/ERD.svg index 2fed43ef..18aeb57d 100644 --- a/ERD.svg +++ b/ERD.svg @@ -1 +1 @@ -Hypercert ERDHypercert ERDcontributoractivityevidencemeasurementsevaluationscontributionslocationrightscollectiontokentokenizesmakeshas \ No newline at end of file +Hypercert ERDHypercert ERDcontributoractivityevidencemeasurementevaluationcontributionlocationrightscollectiontokentokenizesmade byhas \ No newline at end of file diff --git a/README.md b/README.md index cfb1d69a..28483052 100644 --- a/README.md +++ b/README.md @@ -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 | | @@ -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 | | diff --git a/lexicons/org/hypercerts/claim/evidence.json b/lexicons/org/hypercerts/claim/evidence.json index adabdc86..f5e12d08 100644 --- a/lexicons/org/hypercerts/claim/evidence.json +++ b/lexicons/org/hypercerts/claim/evidence.json @@ -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", diff --git a/lexicons/org/hypercerts/claim/measurement.json b/lexicons/org/hypercerts/claim/measurement.json index 40240235..0380f92a 100644 --- a/lexicons/org/hypercerts/claim/measurement.json +++ b/lexicons/org/hypercerts/claim/measurement.json @@ -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",