Skip to content
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

Reorder incident search parameters #2267

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Reorder incident search parameters #2267

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-02-27 14:00:46.919597",
"spec_repo_commit": "240ec82d"
"regenerated": "2025-02-27 18:57:37.012718",
"spec_repo_commit": "a1563afb"
},
"v2": {
"apigentools_version": "1.6.6",
"regenerated": "2025-02-27 14:00:46.936060",
"spec_repo_commit": "240ec82d"
"regenerated": "2025-02-27 18:57:37.027994",
"spec_repo_commit": "a1563afb"
}
}
}
2 changes: 1 addition & 1 deletion .generator/schemas/v2/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37787,8 +37787,8 @@ paths:
description: Search for incidents matching a certain query.
operationId: SearchIncidents
parameters:
- $ref: '#/components/parameters/IncidentSearchIncludeQueryParameter'
- $ref: '#/components/parameters/IncidentSearchQueryQueryParameter'
- $ref: '#/components/parameters/IncidentSearchIncludeQueryParameter'
- $ref: '#/components/parameters/IncidentSearchSortQueryParameter'
- $ref: '#/components/parameters/PageSize'
- $ref: '#/components/parameters/PageOffset'
Expand Down
2 changes: 1 addition & 1 deletion features/scenarios_model_mapping.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1334,8 +1334,8 @@
"body" => "IncidentTypePatchRequest",
},
"v2.SearchIncidents" => {
"include" => "IncidentRelatedObject",
"query" => "String",
"include" => "IncidentRelatedObject",
"sort" => "IncidentSearchSortOrder",
"page_size" => "Integer",
"page_offset" => "Integer",
Expand Down
8 changes: 4 additions & 4 deletions lib/datadog_api_client/v2/api/incidents_api.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1323,14 +1323,14 @@ def search_incidents_with_http_info(query, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: IncidentsAPI.search_incidents ...'
end
allowable_values = ['users', 'attachments']
if @api_client.config.client_side_validation && opts[:'include'] && !allowable_values.include?(opts[:'include'])
fail ArgumentError, "invalid value for \"include\", must be one of #{allowable_values}"
end
# verify the required parameter 'query' is set
if @api_client.config.client_side_validation && query.nil?
fail ArgumentError, "Missing the required parameter 'query' when calling IncidentsAPI.search_incidents"
end
allowable_values = ['users', 'attachments']
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚪ Code Quality Violation

Suggested change
allowable_values = ['users', 'attachments']
allowable_values = %w[users attachments]
Consider using the %w syntax instead (...read more)

The rule "Prefer %w to the literal array syntax" is a Ruby style guideline that encourages the use of %w notation instead of the traditional array syntax when defining arrays of strings. This rule is part of the Ruby community's efforts to promote readability and simplicity in Ruby code.

This rule is important because it helps to keep the code concise and easy to read. The %w notation allows you to define an array of strings without having to use quotes and commas. This can make the code cleaner and easier to understand, especially when dealing with large arrays.

To follow this rule, replace the traditional array syntax with the %w notation. For example, instead of writing ['foo', 'bar', 'baz'], you should write %w[foo bar baz]. This will create the same array, but in a more readable and concise way. By following this rule, you can help to make your Ruby code cleaner and easier to understand.

View in Datadog  Leave us feedback  Documentation

if @api_client.config.client_side_validation && opts[:'include'] && !allowable_values.include?(opts[:'include'])
fail ArgumentError, "invalid value for \"include\", must be one of #{allowable_values}"
end
allowable_values = ['created', '-created']
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
Expand Down
Loading