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

JSON schema for the Native Libraries Support repository #90

Merged
76 changes: 76 additions & 0 deletions library-and-framework-support-schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
{
dnestoro marked this conversation as resolved.
Show resolved Hide resolved
"$schema": "https://json-schema.org/draft/2019-09/schema",
"$id": "This will be populated with actual link once uploaded",
dnestoro marked this conversation as resolved.
Show resolved Hide resolved
"title": "Schema for the supported libraries list JSON",
dnestoro marked this conversation as resolved.
Show resolved Hide resolved
"type": "array",
"default": [],
"items": {
"type": "object",
"required": [
"artifact",
"minimal_version",
"metadata_locations",
"test_level"
],
"properties": {
"artifact": {
"type": "string",
"default": "",
"title": "The name of the artifact"
},
"description": {
"type": "string",
"default": "",
"title": "Short text that says what the library or framework can do"
dnestoro marked this conversation as resolved.
Show resolved Hide resolved
},
"minimal_version": {
"type": "string",
"default": "",
"title": "Minimal version for which this entry applies"
},
"maximal_version": {
"type": "string",
"default": "",
"title": "Maximal version for which this entry applies",
"description": "If not defined, it is assumed to be supported for all versions starting from the minimum_version"
},
"metadata_location": {
"type": "array",
"default": [],
"items": {
"type": "string",
"default": ""
},
"title": "Web URLs of provided metadata"
},
"test_level": {
"type": "string",
"enum": [
"Untested",
"Partially tested",
"Fully tested"
],
"default": "Untested",
"title": "Library level of testing"
},
"support_level": {
"type": "string",
"enum": [
"Unsupported",
fniephaus marked this conversation as resolved.
Show resolved Hide resolved
"Community Supported",
"Supported"
],
"default": "Unsupported",
"title": "Metadata support level"
}
}
},
"examples": [
{
"artifact": "netty",
"minimal_version": "4.1",
"metadata_location": "https://github.com/netty/netty/tree/main/common/src/main/resources/META-INF/native-image",
"support_level": "Community Supported"
}
]
}