uncefact / spec-untp

UN Transparency Protocol
https://uncefact.github.io/spec-untp/
GNU General Public License v3.0
16 stars 17 forks source link

Enhance Jargon.sh UML Diagrams to Indicate Required Fields #215

Open ashleythedeveloper opened 2 hours ago

ashleythedeveloper commented 2 hours ago

Impacted sections

Issue Description

As a Business Analyst, I want the UNTP UML diagrams in Jargon.sh to clearly indicate which fields are required for each Object type, So that I can more easily perform data mapping and credential building without needing to reference technical schema files.

Acceptance Criteria:

I don't feel this is the right place for this ticket, but I need to store it somewhere to track this issue/visibility.

ashleythedeveloper commented 2 hours ago

I've reached out to Alastair from Jargon to begin the conversation.

colugo commented 2 hours ago

Hi @ashleythedeveloper I made this change in Jargon a little while ago, and it's now live. Next time those domains are changed and released, jargon's webhook will provide new diagrams to the github actions script.

image

Here's a link to one of the domains that shows what this looks like:

https://jargon.sh/user/unece/DigitalProductPassport/v/working/artefacts/diagram/render.svg?light=true