Semantic metadata validation
Metadata objects describing a resource may be generated by multiple processes in the IT system and be of different metadata formats. These metadata objects may be parsed into a unified semantic graph over which validation rules may be applied. The semantic graph and a validation ruleset comprising one or more validation rules may be input into a validation engine. The validation engine may interpret the validation into logical assertions then apply them over the semantic graph. The validation engine may then generate a validation report indicating whether the graph is conformant. The validation report may include information about any validation failures that may have occurred and may be displayed to a user on a client device via a graphical user interface.
1 . A computer-implemented method, comprising:
receiving a metadata object relating to an Application Programming Interface (API) node within a business domain ontology;
parsing the received metadata object, the parsing including:
generating an intermediate semantic graph model relating to the API node based on the received metadata object, the intermediate semantic graph model labeled with a global identifier that identifies the API node and including a plurality of nodes, links, and properties; and
generating a source map from the metadata object that contains information relating each node, link and property of the intermediate semantic graph model to a specific syntactical location in the received metadata object;
identifying previously-generated intermediate semantic graph models that include a same global identifier;
combining the generated intermediate sematic graph model with the identified previously-generated intermediate semantic graph models by merging the nodes of the generated intermediate semantic graph model with related nodes of the previously-generated intermediate semantic graph models to generate a unified semantic graph model;
applying a validation profile that includes a validation rule for validating the API node associated with the metadata object over the unified semantic graph model, the validation profile further including metadata documenting a use case for the validation rule, including positive and negative code examples; and
generating a validation report indicating a violation status of the validation rule, and markdown documentation for the validation profile based on the applying.
2 . The computer-implemented method of claim 1 , wherein the validation rule is stored in a metadata format, and
wherein the validation rule has a severity level indicating a severity for a violation of the validation rule.
3 . The computer-implemented method of claim 2 , further comprising:
translating the validation rule into a logical assertion before applying the validation rule to the unified semantic graph model.
4 . The computer-implemented method of claim 1 , further comprising:
storing the source map as part of the intermediate semantic graph model.
5 . The computer-implemented method of claim 4 , further comprising:
applying a set of logical assertions to add new labels to nodes, properties, and links of the unified semantic graph model, wherein the new labels are semantic inferences that link related information from different metadata files of a plurality of metadata files.
6 . The computer-implemented method of claim 2 , wherein the validation report comprises one or more of:
a severity of the violation, a validation error message, an identifier of the violated validation rule, a unique global identifier of a failing node in the unified semantic graph model in which the violation occurred, or information identifying a syntactical location for the failing node in a corresponding metadata file.
7 . A system comprising:
a memory; and
at least one processor coupled to the memory and configured to:
receive a metadata object relating to an Application Programming Interface (API) node within a business domain ontology;
parse the received metadata object, the parsing including:
generating an intermediate semantic graph model relating to the API node based on the received metadata object, the intermediate semantic graph model labeled with a global identifier that identifies the API node and including a plurality of nodes, links, and properties; and
generating a source map from the metadata object that contains information relating each node, link, and property of the intermediate semantic graph model to a specific syntactical location in the received metadata object;
identify previously-generated intermediate semantic graph models that include a same global identifier;
combine the generated intermediate sematic graph model with the identified previously-generated intermediate semantic graph models by merging the nodes of the generated intermediate semantic graph model with related nodes of the previously-generated intermediate semantic graph models to generate a unified semantic graph model;
apply a validation profile that includes a validation rule for validating the API node associated with the metadata object over the unified semantic graph model, the validation profile further including metadata documenting a use case for the validation rule, including positive and negative code examples; and
generate a validation report indicating a violation status of the validation rule, and markdown documentation for the validation profile based on the applying.
8 . The system of claim 7 , wherein the validation rule is stored in a metadata format, and
wherein the validation rule has a severity level indicating a severity for a violation of the validation rule.
9 . The system of claim 7 , wherein the at least one processor is further configured to:
translate the validation rule into a logical assertion before applying the validation rule to the unified semantic graph model.
10 . The system of claim 7 , wherein the at least one processor is further configured to:
store the generated source map as part of the intermediate semantic graph model.
11 . The system of claim 7 , wherein the at least one processor is further configured to:
apply a set of logical assertions to add new labels to nodes, properties, and links of the unified semantic graph model, wherein the new labels are semantic inferences that link related information from different metadata files.
12 . The system of claim 8 , wherein the validation report comprises one or more of:
a severity of the violation, a validation error message, an identifier of the violated validation rule, a unique global identifier of a failing node in the unified semantic graph model in which the violation occurred, or information identifying a syntactical location for the failing node in a corresponding metadata file.
13 . A non-transitory computer-readable device having instructions stored thereon that, when executed by at least one computing device, cause the at least one computing device to perform operations comprising:
receiving a metadata object relating to an Application Programming Interface (API) node within a business domain ontology;
parsing the received metadata object, the parsing including:
generating an intermediate semantic graph model relating to the API node based on the received metadata object, the intermediate semantic graph model labeled with a global identifier that identifies the API node; and
generating a source map from the metadata object that contains information relating each node, link and property of the intermediate semantic graph model to a specific syntactical location in the received metadata object;
identifying previously-generated intermediate semantic graph models that include a same global identifier;
combining the generated intermediate sematic graph model with the identified previously-generated intermediate semantic graph models by merging the nodes of the generated intermediate semantic graph model with related nodes of the previously-generated intermediate semantic graph models to generate a unified semantic graph model;
applying a validation profile that includes a validation rule for validating the API node associated with the metadata object over the unified semantic graph model, the validation profile further including metadata documenting a use case for the validation rule, including positive and negative code examples; and
generating a validation report indicating a violation of the validation rule, and markdown documentation for the validation profile based on the applying.
14 . The non-transitory computer-readable device of claim 13 , wherein the validation rule is stored in a metadata format, and
wherein the validation rule has a severity level indicating a severity for a violation of the validation rule.
15 . The non-transitory computer-readable device of claim 13 , the operations further comprising:
translating the validation rule into a logical assertion before applying the validation rule to the unified semantic graph model.
16 . The non-transitory computer-readable device of claim 13 , further comprising:
storing the generated source map as part of the intermediate semantic graph model; and
applying a set of logical assertions to add new labels to nodes, properties, and links of the unified semantic graph model, wherein the new labels are semantic inferences that link related information from different metadata files.
17 . The non-transitory computer-readable device of claim 14 , wherein the validation report comprises one or more of:
a severity of the violation, a validation error message, an identifier of the violated validation rule, a unique global identifier of a failing node in the unified semantic graph model in which the violation occurred, or information identifying a syntactical location for the failing node in a corresponding metadata file.