.hdm-metadata.yml

Type: object

Schema for validating HDM metadata YAML files

 No Additional Properties
Example:

{
    "schema": {
        "name": "hdm-metadata",
        "version": 1
    },
    "responsible": {
        "persons": [
            "max.mustermann@heidelberg.com"
        ],
        "teams": [
            "Build Infastructure"
        ]
    },
    "gitlab": {
        "project_id": 16,
        "project_url": "https://gitlab.prinect-lounge.com/BLD/BLD-GradleLibrary",
        "topics": [
            "Responsible max.mustermann@heidelberg.com",
            "Team Build Infastructure",
            "Product n/a",
            "Jira Domain n/a",
            "Distribution n/a"
        ]
    },
    "sonarqube": {
        "project_key": "BLD:GradleLibrary"
    }
}

root schema
Type: object
No Additional Properties

root schema name
Type: const

The schema name must be 'hdm-metadata'

Specific value: "hdm-metadata"

root schema version
Type: integer

The schema version number

Value must be greater or equal to 1

root responsible
Type: object
No Additional Properties

root responsible persons
Type: array of string

List of responsible persons (at least one required)

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root responsible persons persons items
Type: stringFormat: email

Valid email address

Must match regular expression: ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$

root responsible teams
Type: array of string

List of responsible teams (optional)

 No Additional Items

Each item of this array must be:

root responsible teams teams items
Type: string

Must be at least 1 characters long

root gitlab
Type: object

Optional GitLab-specific metadata.

 No Additional Properties

root gitlab project_id
Type: integer

GitLab project ID.

Value must be greater or equal to 1

root gitlab project_url
Type: stringFormat: uri

Optional GitLab project URL.

Must be at least 1 characters long

root gitlab topics
Type: array of string

Optional list of GitLab repository topics.

 No Additional Items

Each item of this array must be:

root gitlab topics topics items
Type: string

Must be at least 1 characters long

root sonarqube
Type: object

Optional SonarQube-specific metadata.

 No Additional Properties

root sonarqube project_key
Type: string

Optional SonarQube project key.

Must be at least 1 characters long