Skip to content

Update JSON schema to move Annotations to an array directly under the Document #26

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.

Sign up for GitHub

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

Closed
goneall wants to merge 2 commits into from
Closed

Update JSON schema to move Annotations to an array directly under the Document #26

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5077c4a
Update JSON schema to move Annotations to an array directly under the…
goneall Aug 21, 2021
c2b0cde
Merge branch 'master' into jsonannotations
goneall Aug 21, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 17 additions & 2 deletions src/main/java/org/spdx/tools/schema/OwlToJsonSchema.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@
*/
public class OwlToJsonSchema extends AbstractOwlRdfConverter {

private static final String PROP_SPDXREF = "SPDXREF"; //TODO - move this constant to SpdxConstant class
// JSON Schema string constants
private static final String JSON_TYPE_STRING = "string";
private static final String JSON_TYPE_BOOLEAN = "boolean";
Expand All @@ -67,6 +68,7 @@ public class OwlToJsonSchema extends AbstractOwlRdfConverter {

private static final String SCHEMA_VERSION_URI = "http://json-schema.org/draft-07/schema#";
private static final String RELATIONSHIP_TYPE = SpdxConstants.SPDX_NAMESPACE + SpdxConstants.CLASS_RELATIONSHIP;
private static final String ANNOTATION_TYPE = SpdxConstants.SPDX_NAMESPACE + SpdxConstants.CLASS_ANNOTATION;
static ObjectMapper jsonMapper = new ObjectMapper().enable(SerializationFeature.INDENT_OUTPUT);
private static final Set<String> USES_SPDXIDS;

Expand Down Expand Up @@ -121,9 +123,14 @@ public ObjectNode convertToJsonSchema() {
OntClass snippetClass = model.getOntClass(SpdxConstants.SPDX_NAMESPACE + SpdxConstants.CLASS_SPDX_SNIPPET);
Objects.requireNonNull(snippetClass, "Missing SPDX Snippet class in OWL document");
properties.set("snippets", toArrayPropertySchema(snippetClass, 0));
OntClass relationshipClass = model.getOntClass(SpdxConstants.SPDX_NAMESPACE + SpdxConstants.CLASS_RELATIONSHIP);
// Add in the relationship class to the top level
OntClass relationshipClass = model.getOntClass(RELATIONSHIP_TYPE);
Objects.requireNonNull(relationshipClass, "Missing SPDX Relationship class in OWL document");
properties.set("relationships", toArrayPropertySchema(relationshipClass, 0));
// Add in the annotation class to the top level
OntClass annotationClass = model.getOntClass(ANNOTATION_TYPE);
Objects.requireNonNull(annotationClass, "Missing SPDX Annotation class in OWL document");
properties.set("annotations", toArrayPropertySchema(annotationClass, 0));
root.set("properties", properties);
root.set("required", required);
return root;
Expand Down Expand Up @@ -172,6 +179,12 @@ private ObjectNode ontClassToJsonSchema(OntClass ontClass) {
"Id to which the SPDX element is related"));
required.add(SpdxConstants.PROP_SPDX_ELEMENTID);
}
if (ontClass.getLocalName().equals(SpdxConstants.CLASS_ANNOTATION)) {
// Need to add in the SPDX ID
properties.set(PROP_SPDXREF, createSimpleTypeSchema(JSON_TYPE_STRING,
"Id for the SPDX element which has the annotation"));
required.add(PROP_SPDXREF);
}
addClassProperties(ontClass, properties, required);
if (properties.size() > 0) {
retval.set("properties", properties);
Expand Down Expand Up @@ -220,7 +233,9 @@ private void addClassProperties(OntClass spdxClass, ObjectNode jsonSchemaPropert
}
PropertyRestrictions restrictions = getPropertyRestrictions(spdxClass, property);
Objects.requireNonNull(restrictions.getTypeUri(), "Missing type for property "+property.getLocalName());
if (restrictions.getTypeUri().equals(RELATIONSHIP_TYPE)) {
if (restrictions.getTypeUri().equals(RELATIONSHIP_TYPE) ||
restrictions.getTypeUri().equals(ANNOTATION_TYPE)) {
// These are included in the outside document are are not properties of the element for the JSON serialization
continue;
}
if (restrictions.isListProperty()) {
Expand Down