Skip to content

Deprecate options from logs aggregate API public spec #2776

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

Merged
api-clients-generation-pipeline merged 1 commit into from
Mar 28, 2025
Merged

Deprecate options from logs aggregate API public spec #2776

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
8 changes: 4 additions & 4 deletions .apigentools-info
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
"spec_versions": {
"v1": {
"apigentools_version": "1.6.6",
"regenerated": "2025-03-28 15:07:41.004258",
"spec_repo_commit": "3f3e8eaf"
"regenerated": "2025-03-28 19:42:58.001817",
"spec_repo_commit": "1d2132af"
},
"v2": {
"apigentools_version": "1.6.6",
"regenerated": "2025-03-28 15:07:41.026638",
"spec_repo_commit": "3f3e8eaf"
"regenerated": "2025-03-28 19:42:58.026085",
"spec_repo_commit": "1d2132af"
}
}
}
4 changes: 2 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 @@ -19109,10 +19109,10 @@ components:
type: string
type: object
LogsQueryOptions:
deprecated: true
description: 'Global query options that are used during the query.

Note: you should supply either timezone or time offset, but not both. Otherwise,
the query will fail.'
Note: These fields are currently deprecated and do not affect the query results.'
properties:
timeOffset:
description: The time offset (in seconds) to apply to the query.
Expand Down
7 changes: 5 additions & 2 deletions src/main/java/com/datadog/api/client/v2/model/LogsAggregateRequest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,18 +140,21 @@ public LogsAggregateRequest options(LogsQueryOptions options) {
}

/**
* Global query options that are used during the query. Note: you should supply either timezone or
* time offset, but not both. Otherwise, the query will fail.
* Global query options that are used during the query. Note: These fields are currently
* deprecated and do not affect the query results.
*
* @return options
* @deprecated
*/
@Deprecated
@jakarta.annotation.Nullable
@JsonProperty(JSON_PROPERTY_OPTIONS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public LogsQueryOptions getOptions() {
return options;
}

@Deprecated
public void setOptions(LogsQueryOptions options) {
this.options = options;
}
Expand Down
7 changes: 5 additions & 2 deletions src/main/java/com/datadog/api/client/v2/model/LogsListRequest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,18 +68,21 @@ public LogsListRequest options(LogsQueryOptions options) {
}

/**
* Global query options that are used during the query. Note: you should supply either timezone or
* time offset, but not both. Otherwise, the query will fail.
* Global query options that are used during the query. Note: These fields are currently
* deprecated and do not affect the query results.
*
* @return options
* @deprecated
*/
@Deprecated
@jakarta.annotation.Nullable
@JsonProperty(JSON_PROPERTY_OPTIONS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public LogsQueryOptions getOptions() {
return options;
}

@Deprecated
public void setOptions(LogsQueryOptions options) {
this.options = options;
}
Expand Down
7 changes: 5 additions & 2 deletions src/main/java/com/datadog/api/client/v2/model/LogsQueryOptions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,12 @@
import java.util.Objects;

/**
* Global query options that are used during the query. Note: you should supply either timezone or
* time offset, but not both. Otherwise, the query will fail.
* Global query options that are used during the query. Note: These fields are currently deprecated
* and do not affect the query results.
*
* @deprecated
*/
@Deprecated
@JsonPropertyOrder({
LogsQueryOptions.JSON_PROPERTY_TIME_OFFSET,
LogsQueryOptions.JSON_PROPERTY_TIMEZONE
Expand Down