-
Notifications
You must be signed in to change notification settings - Fork 10
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
DCTAP JSON and YAML outputs #100
Comments
JSON Schema can be used to validate YAML documents, https://json-schema-everywhere.github.io/yaml |
As a reminder, we have defined the DCTAP elements as:
shape and statement_template are included in the vocabulary documentation, but are not table column headers. |
I played around with both the JSON and YAML using the idea of adding explicit I'll look at JSON schema - but may fail there as well. |
If we keep the hierarchical representation then we would maybe need to do similar to what Tom did for DC-TAP-Python and have a default shape for when none was specified in the TAP. Alternatively, if we take the |
@philbarker I've been working from the dctap output so the default shape is there. I'm not sure I'm reading your comment right, so perhaps we need to chat? |
@kcoyle that's fine, but it is a change from what we say about the TAP, which as you posted above can have "zero or more shapes" I don't think the YAML/JSON can have zero shapes, but it is in accordance with the comment. |
@philbarker ah, yes. There is a difference from the table when it's output. I think the default shape came about because it worked that way in Tom's program. I removed the default shape from one JSON file and it validates.
I can even remove the
All of this confirms to me that we need to think some more about output and what will be most useful for folks down the line. |
@kcoyle that is indeed valid JSON, but I think you would need different JSON-Schema for the different options (this is the limit of my JSON-Schema knowledge so I may be wrong) so yes, we do need to think some more about what will be more useful. |
@philbarker I'm playing around with JSON schema (there are some sites that translate from JSON to schema as a way to get started). I can make the shape optional, but I'm still trying out various options. I'll be back. |
At the February 1 2024 meeting we agreed that we would look at the JSON (and YAML) outputs and make sure that they have a structure we can agree on. A follow-up will be to create a JSON schema (does YAML have schemas?) that can facilitate consistent interpretations of DCTAP into common serializations.
The text was updated successfully, but these errors were encountered: