Skip to content
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

Feat/13 add json schema #16

Merged
merged 25 commits into from
Feb 1, 2024
Merged

Feat/13 add json schema #16

merged 25 commits into from
Feb 1, 2024

Conversation

AlexAxthelm
Copy link
Contributor

Adds a JSON schema, validation logic to processing files, and metadata export

Closes #13
Closes #14

@AlexAxthelm AlexAxthelm marked this pull request as ready for review January 31, 2024 15:31
Copy link

github-actions bot commented Jan 31, 2024

Docker image from this PR (f0f153b) created

docker pull ghcr.io/rmi-pacta/workflow.portfolio.parsing:pr16

@AlexAxthelm
Copy link
Contributor Author

Note that as of acf0d8e, this is installing the GitHub version of jsonvalidate, which is required for the new api's json_schema, but is not available yet on CRAN.

Copy link
Member

@cjyetman cjyetman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

honestly, I'm totally lost with all this stuff, so just rubber stamping

@AlexAxthelm
Copy link
Contributor Author

Merging to unblock development, but opening an issue to improve documentation so that we're all comfortable with what's happening here

@AlexAxthelm AlexAxthelm merged commit 1b904ea into main Feb 1, 2024
6 checks passed
@AlexAxthelm AlexAxthelm deleted the feat/13-add-json-schema branch February 1, 2024 12:39
Along with portfolios (in a standardized `csv` format), the parser exports a metadata file about the parsed inputs, and the exported portfolio files.
The file is in JSON format, and validates against a [JSON Schema in this repository](inst/extdata/schema/parsedPortfolio_0-1-0.json).

The file is array of objects, with the highest level opbects in the array centered around the input files, with the exported files contained in an array with the `portfolio` key in each input file object.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo: "opbjects"

"package": "digest",
"version": "0.6.33"
},
// ... array elided
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what does "elided" mean?

@jdhoffa
Copy link
Member

jdhoffa commented Feb 1, 2024

Merged before I could comment, but some potential typos

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Export metadata to JSON file validate metadata output format
3 participants