Skip to content

Update the OpenAPI pipeline to run SHACL validations #58

@rduyme

Description

@rduyme

At the moment there is automatic validation of OpenAPI examples with the open api yaml.
https://github.com/skg-if/api/tree/main/openapi/ver/current/sample_data

ex:

{
    "@context": [
        "https://w3id.org/skg-if/context/1.1.0/skg-if.json", => data model context
        "https://w3id.org/skg-if/context/1.0.0/skg-if-api.json",
        {
            "@base": "https://w3id.org/skg-if/sandbox/my-skg-acronym/"
        }
    ],
    "@graph": [
        {
            "local_identifier": "http://example.com/skg-if/api/grants/6f368a3a-b1cf-498f-b2de-27135d1e0011",
            "identifiers": [
                {
                    "scheme": "doi",
                    "value": "https://doi.org/10.3030/101095129"
                }
            ],

This validation is done in github actions whenever we update a sample_data
or the yaml specifications (https://github.com/skg-if/api/blob/main/openapi/ver/current/skg-if-openapi.yaml)

@essepuntato Silvio requested we add SHACL validation for these sample_data examples

SHACL rules are defined here. https://github.com/skg-if/data-model/blob/main/README.md, we have a directory with rules for each data model version

This issue is about updating the https://github.com/skg-if/api github action/workflow to perform validation of openapi/ver/xxx/sample_data with version xxx SHACL rules.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions