Skip to content

Commit 430094b

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
[error-tracking] List possible includes in API doc (#2775)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent ad8eac5 commit 430094b

File tree

2 files changed

+5
-4
lines changed

2 files changed

+5
-4
lines changed

.generator/schemas/v2/openapi.yaml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -449,7 +449,7 @@ components:
449449
type: string
450450
GetIssueIncludeQueryParameter:
451451
description: Comma-separated list of relationship objects that should be included
452-
in the response.
452+
in the response. Possible values are `assignee`, `case`, and `team_owners`.
453453
explode: false
454454
in: query
455455
name: include
@@ -996,7 +996,8 @@ components:
996996
$ref: '#/components/schemas/ServiceDefinitionSchemaVersions'
997997
SearchIssuesIncludeQueryParameter:
998998
description: Comma-separated list of relationship objects that should be included
999-
in the response.
999+
in the response. Possible values are `issue`, `issue.assignee`, `issue.case`,
1000+
and `issue.team_owners`.
10001001
explode: false
10011002
in: query
10021003
name: include

lib/datadog_api_client/v2/api/error_tracking_api.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ def get_issue(issue_id, opts = {})
102102
#
103103
# @param issue_id [String] The identifier of the issue.
104104
# @param opts [Hash] the optional parameters
105-
# @option opts [Array<GetIssueIncludeQueryParameterItem>] :include Comma-separated list of relationship objects that should be included in the response.
105+
# @option opts [Array<GetIssueIncludeQueryParameterItem>] :include Comma-separated list of relationship objects that should be included in the response. Possible values are `assignee`, `case`, and `team_owners`.
106106
# @return [Array<(IssueResponse, Integer, Hash)>] IssueResponse data, response status code and response headers
107107
def get_issue_with_http_info(issue_id, opts = {})
108108

@@ -169,7 +169,7 @@ def search_issues(body, opts = {})
169169
#
170170
# @param body [IssuesSearchRequest] Search issues request payload.
171171
# @param opts [Hash] the optional parameters
172-
# @option opts [Array<SearchIssuesIncludeQueryParameterItem>] :include Comma-separated list of relationship objects that should be included in the response.
172+
# @option opts [Array<SearchIssuesIncludeQueryParameterItem>] :include Comma-separated list of relationship objects that should be included in the response. Possible values are `issue`, `issue.assignee`, `issue.case`, and `issue.team_owners`.
173173
# @return [Array<(IssuesSearchResponse, Integer, Hash)>] IssuesSearchResponse data, response status code and response headers
174174
def search_issues_with_http_info(body, opts = {})
175175

0 commit comments

Comments
 (0)