Add synthetics stepDetail.allowFailure and stepDetail.failure #2064
Conversation
api-clients-generation-pipeline
bot
requested a review
from a team
as a code owner
![datadog-datadog-prod-us1[bot]](https://avatars.githubusercontent.com/u/365230?s=60&v=4){kind=small}
| # @option opts [Boolean] :include_descendants Include child org cost in the response. Defaults to `true`. | ||
| # @return [Array<(MonthlyCostAttributionResponse, Integer, Hash)>] MonthlyCostAttributionResponse data, response status code and response headers | ||
| def get_monthly_cost_attribution_with_http_info(start_month, fields, opts = {}) | ||
| def get_monthly_cost_attribution_with_http_info(start_month, end_month, fields, opts = {}) |
There was a problem hiding this comment.
⚪ Code Quality Violation
Avoid using a hash as an optional parameter (...read more)
The rule "Avoid hash optional parameters" is a guideline that encourages developers to explicitly declare parameters instead of using a hash for optional parameters. This is because using a hash for optional parameters can make the code harder to understand and maintain. It can also lead to unexpected behavior if a developer accidentally includes a key in the hash that the method does not expect.
This rule is important because it promotes code readability and maintainability. It also helps prevent potential bugs that may occur due to unexpected keys in the optional hash. By explicitly declaring each parameter, developers can easily see what parameters a method expects, making the code easier to read and understand.
To adhere to this rule, instead of using a hash for optional parameters, explicitly declare each parameter in the method definition. For example, instead of using options = {} in the method definition, declare each parameter like name, email, age. This way, anyone reading the code can easily understand what parameters the method expects and in what order.
| # @see #get_monthly_cost_attribution_with_http_info | ||
| def get_monthly_cost_attribution(start_month, fields, opts = {}) | ||
| data, _status_code, _headers = get_monthly_cost_attribution_with_http_info(start_month, fields, opts) | ||
| def get_monthly_cost_attribution(start_month, end_month, fields, opts = {}) |
There was a problem hiding this comment.
⚪ Code Quality Violation
Avoid using a hash as an optional parameter (...read more)
The rule "Avoid hash optional parameters" is a guideline that encourages developers to explicitly declare parameters instead of using a hash for optional parameters. This is because using a hash for optional parameters can make the code harder to understand and maintain. It can also lead to unexpected behavior if a developer accidentally includes a key in the hash that the method does not expect.
This rule is important because it promotes code readability and maintainability. It also helps prevent potential bugs that may occur due to unexpected keys in the optional hash. By explicitly declaring each parameter, developers can easily see what parameters a method expects, making the code easier to read and understand.
To adhere to this rule, instead of using a hash for optional parameters, explicitly declare each parameter in the method definition. For example, instead of using options = {} in the method definition, declare each parameter like name, email, age. This way, anyone reading the code can easily understand what parameters the method expects and in what order.
api-clients-generation-pipeline
bot
force-pushed
the
datadog-api-spec/generated/3194
branch
from
51a12f2 to
ad3efa3
Compare
api-clients-generation-pipeline
bot
force-pushed
the
datadog-api-spec/generated/3194
branch
from
ad3efa3 to
a7d6f27
Compare
api-clients-generation-pipeline
bot
deleted the
datadog-api-spec/generated/3194
branch
Co-authored-by: ci.datadog-api-spec <[email protected]> 66ba7df
See DataDog/datadog-api-spec#3194
Test branch datadog-api-spec/test/damien.bernard/SYNTH-14462/add-allowfailure-and-failure-stepdetail