Skip to content

compliance_tool: Avoid shipping schema files directly #533

@hpoeche

Description

@hpoeche

The compliance_tool needs the metamodel schema files for JSON and XML, which are published in the admin-shell-io/aas-specs-metamodel under the CC-BY-4.0 license. It is not conform for us to ship these files (in compliance_tool/aas_compliance_tool/schemas) under MIT license.

I therefore suggest to remove these files from our repository and introduce two mutually exclusive options to the cli interface:

  • --schema-path: This option can be used by users to provide a path to a directory that contains the schema files. The user is required to download the schemas himself. This allows for a offline usage of the aas_compliance_tool.
  • --download-schema: If this option is chosen the compliance_tool downloads the schema files automatically from the source respoitory (similar to the CI runs) and caches them in a local directory for later runs. This provides a better user experience, if the tool is used to quickly check files.

We can discuss if any of the two options should be a default or if we require the user to actively choose.

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