refactor!: use schema:ItemList consistently for regen:approvedMethodologies #40

wgwz · 2023-02-07T23:04:45Z

Description

Closes: #33

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

provided a link to the relevant issue or specification
reviewed "Files changed" and left comments if necessary

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

confirmed all author checklist items have been addressed
reviewed code correctness and readability
reviewed documentation is accurate
manually tested (if applicable)

wgwz · 2023-02-21T14:56:09Z

In addition to needing some reviews, we are waiting to merge this because it will require updating credit classes on-chain.

blushi · 2023-02-27T08:30:53Z

jsonld/credit-classes/C02-city-forest-credits-class.jsonld

    }
+  ],
+  "regen:approvedMethodologiesURL": {


As discussed together as second option, what about using ItemList instead? Then we can define some schema:url directly on it instead of creating our ownregen:approvedMethodologiesURL
I believe it'd look cleaner

sounds good to me, i'll push a commit making that change

one thing to note is that we will need to make updates in the bridge service for this change, since it changes the format of the regen:approvedMethodologies field. toucan projects use that field and so we'll need to update that there.

updates to the bridge service would be located around here:

https://github.com/rnd-inc/toucan-bridge-service/blob/928af587a7fc03f9cd427699861b94f6fc7ace74/metadata/regen_project.go#L55-L68

https://github.com/rnd-inc/toucan-bridge-service/blob/928af587a7fc03f9cd427699861b94f6fc7ace74/metadata/regen_project.go#L67

yeah I can create an issue to address that on the bridge side once this is merged, we'll need to update the front-end too since it assumesregen:approvedMethodologies to be a @list for now (which is why the approved methodologies are not displayed on the credit class page cc/ @clevinson ) and set up txs to update credit classes cc/ @S4mmyb

blushi · 2023-03-01T11:00:44Z

@wgwz could you update the PR title, now that we're going for schema:ItemList rather than dash:ListShape? thanks

wgwz · 2023-03-01T18:53:09Z

ops/C03/credit-class-metadata/C03-Toucan-TCO2-class.jsonld

@@ -42,332 +36,285 @@
    "Carbon Removals"
  ],
  "regen:approvedMethodologies": {
-    "@type": "schema:BreadcrumbList",
+    "@type": "schema:ItemList",


@blushi just wanted to point the adjustments to C03 credit class. it's just to conform the approvedMethodologies to schema:ItemList.

wgwz · 2023-03-01T18:54:37Z

shacl/credit-classes/C03-toucan-tco2-class.ttl

-    sh:minCount 1 ;
-    sh:maxCount 1 ;
-  ] ;
+  sh:property regen:ApprovedMethodologiesPropertyShape ;


@blushi some more adjustments for the C03 credit class here. we're using the same property shape for all instances of regen:approvedMethodologies

blushi

looks good, pre-approving, just a few comments

jsonld/C03/project-metadata/C03-project-full-example.jsonld

jsonld/credit-classes/C01-verified-carbon-standard-class.jsonld

blushi · 2023-03-02T09:54:01Z

shacl/credit-classes/C02-city-forest-credits-class.ttl

+  # TODO: eventually this should set on most of our shapes
+  #       this will help us catch missing fields


should we create an issue to address that?

What's the blocker on adding this?

nothing really blocking it, it probably would just involve a little bit of clean-up and i'd prefer to handle it separately from this

ryanchristo

LGTM. Just a couple questions.

ryanchristo · 2023-03-09T17:36:07Z

jsonld/credit-classes/C01-verified-carbon-standard-class.jsonld

+    "schema:url": {
+      "@type": "schema:URL"
+    },


The expected value of schema:url is URL. I don't think need this in the same way we don't need schema:name and schema:description with type Text in the context. Is there another reason for including this?

schema:name and schema:description are different.
we used to use schema:Text for fields like that.
but then we decided to move away from schema:Text.
when we were using schema:Text we had to be explicit about those types.
just like we need to be explicit about the type here.
the reason we no longer need a type specified for schema:name and schema:description is that we agreed they can be xsd:string types instead.
when JSON-LD documents are parsed, JSON string values are implicitly assumed to be of the xsd:string type.
because we do want "schema:url" to be interpreted as a URL type and not an xsd:string, we need to add that type info in the context.
otherwise schema:url would also be implicitly assumed to be an xsd:string value

ryanchristo · 2023-03-09T18:38:33Z

shacl/credit-classes/C02-city-forest-credits-class.ttl

+  # TODO: eventually this should set on most of our shapes
+  #       this will help us catch missing fields


What's the blocker on adding this?

wgwz requested a review from blushi February 7, 2023 23:04

wgwz mentioned this pull request Feb 7, 2023

feat: add C03 credit class to standards #38

Merged

6 tasks

Base automatically changed from kyle/1420-project-metadata-separation to main February 8, 2023 14:47

wgwz force-pushed the kyle/33-simplify-lists branch from 27d6841 to 15865d7 Compare February 8, 2023 15:38

blushi reviewed Feb 27, 2023

View reviewed changes

blushi requested a review from S4mmyb February 28, 2023 08:25

blushi mentioned this pull request Mar 1, 2023

Handle missing fields in TCO2 regen-network/rnd-dev-team#1570

Closed

blushi requested a review from clevinson March 1, 2023 11:04

wgwz changed the title ~~refactor!: use dash:ListShape instead of schema:BreadcrumbList~~ refactor!: use schema:ItemList instead of dash:ListShape and schema:BreadcrumbList Mar 1, 2023

wgwz changed the title ~~refactor!: use schema:ItemList instead of dash:ListShape and schema:BreadcrumbList~~ refactor!: use schema:ItemList consistently for regen:approvedMethodologies Mar 1, 2023

wgwz added 2 commits March 1, 2023 13:30

refactor!: use dash:ListShape instead of schema:BreadcrumbList

d4e461d

feat: use schema:ItemList for regen:approvedMethodologies

688e706

wgwz force-pushed the kyle/33-simplify-lists branch from ebe7e2e to 4b78ace Compare March 1, 2023 18:43

wgwz added 2 commits March 1, 2023 13:47

fix: use schema:ItemList in C03 credit class

4e30e84

fix: remove an unused field

a797aab

wgwz force-pushed the kyle/33-simplify-lists branch from 4b78ace to a797aab Compare March 1, 2023 18:49

wgwz commented Mar 1, 2023

View reviewed changes

blushi approved these changes Mar 2, 2023

View reviewed changes

blushi mentioned this pull request Mar 9, 2023

fix: Handle missing fields on TCO2 credit class page regen-network/regen-web#1817

Merged

10 tasks

ryanchristo reviewed Mar 9, 2023

View reviewed changes

wgwz mentioned this pull request Mar 10, 2023

refactor: update regen prefix to be dereferencable and on a subdomain #43

Merged

6 tasks

wgwz merged commit 3a209f0 into main Mar 13, 2023

wgwz deleted the kyle/33-simplify-lists branch March 13, 2023 18:41

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor!: use schema:ItemList consistently for regen:approvedMethodologies #40

refactor!: use schema:ItemList consistently for regen:approvedMethodologies #40

wgwz commented Feb 7, 2023 •

edited by blushi

Loading

wgwz commented Feb 21, 2023

blushi Feb 27, 2023

wgwz Feb 27, 2023

wgwz Feb 27, 2023 •

edited

Loading

blushi Feb 28, 2023 •

edited

Loading

blushi commented Mar 1, 2023

wgwz Mar 1, 2023

wgwz Mar 1, 2023

blushi left a comment

blushi Mar 2, 2023

wgwz Mar 2, 2023

ryanchristo Mar 9, 2023

wgwz Mar 9, 2023

ryanchristo left a comment •

edited

Loading

ryanchristo Mar 9, 2023

wgwz Mar 9, 2023

ryanchristo Mar 9, 2023

		# TODO: eventually this should set on most of our shapes
		# this will help us catch missing fields

refactor!: use schema:ItemList consistently for regen:approvedMethodologies #40

refactor!: use schema:ItemList consistently for regen:approvedMethodologies #40

Conversation

wgwz commented Feb 7, 2023 • edited by blushi Loading

Description

Author Checklist

Reviewers Checklist

wgwz commented Feb 21, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wgwz Feb 27, 2023 • edited Loading

Choose a reason for hiding this comment

blushi Feb 28, 2023 • edited Loading

Choose a reason for hiding this comment

blushi commented Mar 1, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

blushi left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ryanchristo left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wgwz commented Feb 7, 2023 •

edited by blushi

Loading

wgwz Feb 27, 2023 •

edited

Loading

blushi Feb 28, 2023 •

edited

Loading

ryanchristo left a comment •

edited

Loading