-
Notifications
You must be signed in to change notification settings - Fork 42
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
Add type and accepted values information #56
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice idea! Please see suggestions inline.
Also, I'm wondering if it wouldn't be better to specify the expected types with JSON-LD or JSON Schema syntax, instead of inventing our own.
eg, instead of
number|array<number>
something like this
"anyOf":[{"type":"number"},{"type":"array","items":{"type":"number"}}]
I guess it'll make things easier in validate-repos, if we can use a JSON-LD or JSON Schema library, instead of writing our own parser?
Fix usage of <pre> in several places
Clarify datatype of repo-type and add 'article' as possible value
I like the idea of using a schema instead. But that will mean we'll have to integrate a schema validator. Feel to close this pull request without merging. |
(Looking at this diff now, because the rebase somehow introduced spurious differences in the PR.) The reusing-a-syntax thing was a suggestion, @plehegar. Better to merge this as it is than abandon it altogether! |
Co-Authored-By: plehegar <[email protected]>
should be ok to merge now I think. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
See same inline comment.
Those annotations are intended to be used by validate-repo in the future. It will avoid having to change validate-repo when a new value is added for example for repo-type.