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

1033 convert appd schema to json #1035

Merged
merged 10 commits into from
Jul 26, 2023

Conversation

kriswest
Copy link
Contributor

resolves #1033
builds on PR #1034

Converts the AppD schema file from YAML to JSON Schema (where the tooling is a little better and ensuring that we use one schema format across FDC3, where there are already other examples of JSON Schema use for contexts, bridging and bridging asyncAPI).

Updates were applied to to package scripts and the website to use the updated encoding.

kriswest added 4 commits July 24, 2023 13:09
…prove test

- the details field of the appD schema is using `oneOf` to combine subschemas, however, this requires them to be distinct and non-verlapping. This should be `anyOf` instead as this prevents validation errors when the element conforms to multiple subschemas.
- commas were removed from email fields in the fdc3-workbench example as these fail validation
- The test was improved by adding multiple examples and providing better output from it.
@kriswest kriswest requested review from a team July 24, 2023 12:45
@netlify
Copy link

netlify bot commented Jul 24, 2023

Deploy Preview for fdc3 ready!

Name Link
🔨 Latest commit b638adc
🔍 Latest deploy log https://app.netlify.com/sites/fdc3/deploys/64bfa347e60a920008fe0b89
😎 Deploy Preview https://deploy-preview-1035--fdc3.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@WatsonCIQ
Copy link
Contributor

Works for me 👍

Copy link
Contributor

@hughtroeger hughtroeger left a comment

Choose a reason for hiding this comment

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

Comments are about double spaces. Was a little unsure about all the newlines in the description fields. Some clearly delineate mini paragraphs, but some occur mid sentence and some have trailing newlines while others do not. Anyway all whitespace issues, content looks good.

src/app-directory/specification/appd.schema.json Outdated Show resolved Hide resolved
src/app-directory/specification/appd.schema.json Outdated Show resolved Hide resolved
src/app-directory/specification/appd.schema.json Outdated Show resolved Hide resolved
src/app-directory/specification/appd.schema.json Outdated Show resolved Hide resolved
src/app-directory/specification/appd.schema.json Outdated Show resolved Hide resolved
src/app-directory/specification/appd.schema.json Outdated Show resolved Hide resolved
src/app-directory/specification/appd.schema.json Outdated Show resolved Hide resolved
kriswest and others added 4 commits July 24, 2023 17:58
@kriswest
Copy link
Contributor Author

Comments are about double spaces. Was a little unsure about all the newlines in the description fields. Some clearly delineate mini paragraphs, but some occur mid sentence and some have trailing newlines while others do not. Anyway all whitespace issues, content looks good.

I suspect all of these were existing in the YAML file, which is an awkward format unless you're really used to it. A good reason to convert to JSON Schema! Edit: checked and yes double spacing and line breaks were in YAML.

Interestingly none were rendered. This is because all the copy is encoded in markdown, so single line breaks and double spaces are meaningless and drop out. However, double linebreaks or those connected to other markdown syntax (e.g. bulleted lists) did have meaning. All should now be correct.

Preview: https://deploy-preview-1035--fdc3.netlify.app/schemas/next/app-directory.html

@kriswest kriswest marked this pull request as ready for review July 24, 2023 17:15
@kriswest kriswest mentioned this pull request Jul 25, 2023
14 tasks
@kriswest kriswest merged commit d98220e into finos:master Jul 26, 2023
@kriswest kriswest deleted the 1033-convert-appd-schema-to-json branch July 26, 2023 09:56
@bingenito bingenito mentioned this pull request Nov 6, 2023
18 tasks
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.

App Directory schema contains errors
4 participants