Overview

Service Catalog uses service definition schemas to store and display metadata about your services. These schemas follow the JSON Schema specification, so you can validate your metadata as you edit it. This validation is important, because a mistake in a service definition file could cause you to create a service with invalid data or introduce an error into the metadata of an existing service.

To prevent this, there are two ways for you to validate your service definition files:

Create the service definition in-app

To validate your service definition file in-app:

1. Navigate to the Service Catalog Setup & Config page.
2. Click Create a New Entry.
3. Select the Code tab.
4. Paste the schema content.

Built-in validation mechanisms prevent you from sending incorrect metadata into Service Catalog.

Validate with an IDE extension

The Datadog service definition schema is available in the open source JSON Schema Store, where many IDEs can automatically retrieve it. With it, your IDE validates the data as you edit the file, provided file name is service.datadog.yaml. Validation messages allow you to correct issues before sending data to the Service Catalog.

Further reading

Additional helpful documentation, links, and articles:

Datadog Service CatalogDOCUMENTATION Service Definition APIDOCUMENTATION Service Definition SchemaSOURCE CODE Manage Service Catalog entries with the Service Definition JSON SchemaBLOG