latest--schema

shared
Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/datadog-software-catalog/_shared/latest--schema.json
Parent schema datadog-software-catalog
Type: object

A service definition for providing additional service metadata and integrations v2

Properties

schema-version string required

Schema version being used

Default: "v2"
Values: "v2"
Examples: "v2"
dd-service string required

Unique identifier of the service. Must be unique across all services, and is used to match with a service in Datadog

Examples: "my-service"
minLength=1
team string

Team that owns the service

Examples: "my-team"
minLength=1
dd-team string

Experimental feature. A Team handle that matches a Team in the Datadog Teams product.

Examples: "my-team"
minLength=1pattern=[^A-Z ]+
contacts contact[]

A list of contacts related to the services.

repos repo[]

A list of code repositories related to the services.

docs doc[]

A list of documentations related to the services.

tags string[]

A set of custom tags

Examples: ["my:tag"]
integrations object

Third party integrations that Datadog supports

2 nested properties
pagerduty string

pagerduty service url for the service

Examples: "https://my-org.pagerduty.com/service-directory/PMyService"
pattern=^(https?://)?[a-zA-Z0-9_\-.]+\.pagerduty\.com/service-directory/(P[a-zA-Z0-9_\-]+)/?$
opsgenie object

Opsgenie integration for the service

2 nested properties
service-url string required

Opsgenie Service URL

Examples: "https://www.opsgenies.com/service/123e4567-e89b-12d3-a456-426614174000"
pattern=^(https?://)?[a-zA-Z0-9_\-.]+\.opsgenie\.com/service/([a-zA-Z0-9_\-]+)/?$
region string

Opsgenie Instance Region

Values: "US" "EU"
Examples: "US", "EU"
extensions object

Custom extensions

Definitions

contact object
type string required

Contact type

Values: "email" "slack" "microsoft-teams"
Examples: "email", "slack", "microsoft-teams"
contact string required

Contact value

Examples: "[email protected]", "https://my-org.slack.com/archives/my-channel"
name string

Contact name

Examples: "Oncall Slack", "Team Email"
minLength=2
doc object
name string required

Doc name

Examples: "Architecture", "RFC", "Design"
minLength=1
url string required

Doc url

Examples: "https://gdrive/mydoc"
format=uri
provider string

Doc provider

Examples: "google drive", "figma"
minLength=1
repo object
name string required

Repo name

Examples: "Source Code"
minLength=1
url string required

Repo url

Examples: "https://github.com/DataDog/schema"
format=uri
provider string

Repo provider

Examples: "Github"
minLength=1