latest--api.schema

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

Schema for API entities

All of

1. Latest Entity.schema Latest Entity.schema
2. object object
apiVersion enum
Values: "v3"
kind enum
Values: "api"
metadata object
extensions object
spec object
6 nested properties
interface object

The API definition

One of: variant, variant
2 nested properties
fileRef string

The reference to the API definition file

Examples: "https://github.com/testrepo/openapi.yaml"
format=uri
definition object

The API definition

format=openapi
lifecycle string

The lifecycle state of the component.

Examples: "experimental", "production", "deprecated"
minLength=1
tier string

The importance of the component

Examples: "1", "High"
minLength=1
type string

The type of API

Examples: "openapi", "graphql", "rest", "grpc"
implementedBy string[]

Services which implemented the API

Examples: "service:apiService"
componentOf string[]

A list of components the API is a part of

Examples: "system:my-example-system", "service:myapp"
integrations Latest Integrations.schema
datadog object

Datadog product integrations for the API entity

4 nested properties
pipelines Latest Datadog Pipelines.schema
events Latest Datadog Events.schema
logs Latest Datadog Logs.schema
codeLocations Latest Datadog Code Locations.schema