Skip to content

chore(spec): add missing descriptions [observability-pipelines] #3589

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
api-clients-generation-pipeline wants to merge 1 commit into
base: master
Choose a base branch
from
Open

chore(spec): add missing descriptions [observability-pipelines] #3589

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 66 additions & 2 deletions .generator/schemas/v2/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7145,6 +7145,8 @@ components:
example:
- processor-id
items:
description: The ID of a component whose output is used as input for this
destination.
type: string
type: array
type:
Expand Down Expand Up @@ -39884,6 +39886,8 @@ components:
example:
- filter-processor
items:
description: The ID of a component whose output is used as input for this
destination.
type: string
type: array
table:
Expand Down Expand Up @@ -41857,6 +41861,8 @@ components:
example:
- filter-processor
items:
description: The ID of a component whose output is used as input for this
destination.
type: string
type: array
type:
Expand Down Expand Up @@ -41936,6 +41942,8 @@ components:
example:
- datadog-agent-source
items:
description: The ID of a component whose output is used as input for this
destination.
type: string
type: array
key_prefix:
Expand Down Expand Up @@ -42068,6 +42076,8 @@ components:
example:
- filter-processor
items:
description: The ID of a component whose output is used as input for this
destination.
type: string
type: array
region:
Expand Down Expand Up @@ -42167,6 +42177,8 @@ components:
example:
- filter-processor
items:
description: The ID of a component whose output is used as input for this
destination.
type: string
type: array
type:
Expand Down Expand Up @@ -42342,6 +42354,7 @@ components:
example:
- datadog-agent-source
items:
description: The ID of a component whose output is used as input.
type: string
type: array
processors:
Expand Down Expand Up @@ -42442,6 +42455,8 @@ components:
example:
- filter-processor
items:
description: The ID of a component whose output is used as input for this
destination.
type: string
type: array
tls:
Expand Down Expand Up @@ -42670,6 +42685,8 @@ components:
example:
- filter-processor
items:
description: The ID of a component whose output is used as input for this
destination.
type: string
type: array
routes:
Expand Down Expand Up @@ -42741,6 +42758,8 @@ components:
example:
- metric-tags-processor
items:
description: The ID of a component whose output is used as input for this
destination.
type: string
type: array
type:
Expand Down Expand Up @@ -42794,6 +42813,7 @@ components:
- service
- version
items:
description: A Datadog tag key to include or exclude.
type: string
type: array
mode:
Expand Down Expand Up @@ -42872,6 +42892,7 @@ components:
- log.message
- log.error
items:
description: A log field path to evaluate for duplicate values.
type: string
type: array
id:
Expand Down Expand Up @@ -42978,6 +42999,8 @@ components:
example:
- filter-processor
items:
description: The ID of a component whose output is used as input for this
destination.
type: string
type: array
type:
Expand Down Expand Up @@ -43244,6 +43267,7 @@ components:
description: List of column names to include from the reference table. If
not provided, all columns are included.
items:
description: The name of a column to include from the reference table.
type: string
type: array
key_field:
Expand Down Expand Up @@ -43464,6 +43488,7 @@ components:
- service
- env
items:
description: A log field name used to group the metric series.
type: string
type: array
include:
Expand Down Expand Up @@ -43567,6 +43592,8 @@ components:
example:
- parse-json-processor
items:
description: The ID of a component whose output is used as input for this
destination.
type: string
type: array
log_type:
Expand Down Expand Up @@ -43631,6 +43658,8 @@ components:
example:
- datadog-agent-source
items:
description: The ID of a component whose output is used as input for this
destination.
type: string
type: array
key_prefix:
Expand Down Expand Up @@ -43724,6 +43753,8 @@ components:
example:
- filter-processor
items:
description: The ID of a component whose output is used as input for this
destination.
type: string
type: array
project:
Expand Down Expand Up @@ -43841,6 +43872,8 @@ components:
example:
- filter-processor
items:
description: The ID of a component whose output is used as input for this
destination.
type: string
type: array
password_key:
Expand Down Expand Up @@ -44102,6 +44135,8 @@ components:
example:
- filter-processor
items:
description: The ID of a component whose output is used as input for this
destination.
type: string
type: array
key_field:
Expand Down Expand Up @@ -44276,6 +44311,7 @@ components:
- topic1
- topic2
items:
description: A Kafka topic name to subscribe to.
type: string
type: array
type:
Expand Down Expand Up @@ -44437,6 +44473,7 @@ components:
- service
- version
items:
description: A metric tag key to include or exclude based on the action.
type: string
type: array
mode:
Expand Down Expand Up @@ -44502,6 +44539,8 @@ components:
example:
- parse-json-processor
items:
description: The ID of a component whose output is used as input for this
destination.
type: string
type: array
license_key_key:
Expand Down Expand Up @@ -44710,6 +44749,7 @@ components:
example:
- container
items:
description: The name of an OCSF profile to apply to the event.
type: string
type: array
version:
Expand Down Expand Up @@ -44779,6 +44819,8 @@ components:
example:
- filter-processor
items:
description: The ID of a component whose output is used as input for this
destination.
type: string
type: array
type:
Expand Down Expand Up @@ -44821,7 +44863,7 @@ components:
Protocol (OTLP) over gRPC and HTTP.


**Supported pipeline types:** logs, metrics'
**Supported pipeline types:** logs'
properties:
grpc_address_key:
description: Environment variable name containing the gRPC server address
Expand Down Expand Up @@ -44851,7 +44893,6 @@ components:
type: object
x-pipeline-types:
- logs
- metrics
ObservabilityPipelineOpentelemetrySourceType:
default: opentelemetry
description: The source type. The value should always be `opentelemetry`.
Expand Down Expand Up @@ -45161,6 +45202,7 @@ components:
Quotas are tracked independently by unique combinations of these field
values.
items:
description: The name of a log field used to partition quota enforcement.
type: string
type: array
too_many_buckets_action:
Expand Down Expand Up @@ -45267,6 +45309,7 @@ components:
- log.user.id
- log.device.id
items:
description: A log field path used to group events for aggregation.
type: string
type: array
id:
Expand Down Expand Up @@ -45366,6 +45409,7 @@ components:
- field1
- field2
items:
description: The name of a field to remove from the log event.
type: string
type: array
id:
Expand Down Expand Up @@ -45494,6 +45538,8 @@ components:
example:
- filter-processor
items:
description: The ID of a component whose output is used as input for this
destination.
type: string
type: array
keepalive:
Expand Down Expand Up @@ -45582,6 +45628,7 @@ components:
- service
- host
items:
description: A log field name used to group events for independent sampling.
type: string
minItems: 1
type: array
Expand Down Expand Up @@ -45815,6 +45862,8 @@ components:
- card
- account
items:
description: A keyword string that reinforces detection when found near
the sensitive pattern.
type: string
type: array
proximity:
Expand Down Expand Up @@ -45895,6 +45944,8 @@ components:
- pii
- ccn
items:
description: A tag string used to classify and filter this sensitive data
rule.
type: string
type: array
required:
Expand Down Expand Up @@ -45974,6 +46025,8 @@ components:
example:
- ''
items:
description: A log field path to include or exclude from sensitive data
scanning.
type: string
type: array
required:
Expand Down Expand Up @@ -46006,6 +46059,8 @@ components:
example:
- filter-processor
items:
description: The ID of a component whose output is used as input for this
destination.
type: string
type: array
region:
Expand Down Expand Up @@ -46076,6 +46131,8 @@ components:
example:
- filter-processor
items:
description: The ID of a component whose output is used as input for this
destination.
type: string
type: array
mode:
Expand Down Expand Up @@ -46468,6 +46525,8 @@ components:
example:
- filter-processor
items:
description: The ID of a component whose output is used as input for this
destination.
type: string
type: array
sourcetype:
Expand Down Expand Up @@ -46626,6 +46685,8 @@ components:
example:
- filter-processor
items:
description: The ID of a component whose output is used as input for this
destination.
type: string
type: array
type:
Expand Down Expand Up @@ -46731,6 +46792,8 @@ components:
example:
- filter-processor
items:
description: The ID of a component whose output is used as input for this
destination.
type: string
type: array
keepalive:
Expand Down Expand Up @@ -46828,6 +46891,7 @@ components:
example:
- log.user.id
items:
description: A log field name used to group events for independent throttling.
type: string
type: array
id:
Expand Down
Loading
Loading