Skip to main content
Version: v0.35.0

Regis Well-Known Metadata

Title: Regis Well-Known Metadata

Typeobject
Additional propertiesAny type: allowed

Description: Standard metadata fields recognized by regis across all playbooks.

PropertyPatternTypeDeprecatedDefinitionTitle/Description
- ciNoobjectNo-Continuous-integration context for the analysis run.
- NoobjectNo--

1. Optional Property ci

Typeobject
Additional propertiesAny type: allowed

Description: Continuous-integration context for the analysis run.

PropertyPatternTypeDeprecatedDefinitionTitle/Description
- platformNoenum (of string)No-CI platform running the analysis
- jobNoobjectNo--
- NoobjectNo--

1.1. Optional Property platform

Typeenum (of string)

Description: CI platform running the analysis

Must be one of:

  • "github"
  • "gitlab"

1.2. Optional Property job

Typeobject
Additional propertiesAny type: allowed
PropertyPatternTypeDeprecatedDefinitionTitle/Description
- idNostringNo-Unique identifier of the CI job
- urlNostringNo-URL to the CI job run
- NoobjectNo--

1.2.1. Optional Property id

Typestring

Description: Unique identifier of the CI job

1.2.2. Optional Property url

Typestring
Formaturi

Description: URL to the CI job run


Generated using json-schema-for-humans on 2026-06-08 at 18:23:58 +0000

  • 1. Optional Property ci
    • 1.1. Optional Property platform
    • 1.2. Optional Property job