Skip to content

Return correct object in GetBrowserTest endpoint #281

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
merged 1 commit into from
Apr 2, 2021
Merged

Return correct object in GetBrowserTest endpoint #281

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.4.1.dev6",
"regenerated": "2021-04-02 07:58:16.461272",
"spec_repo_commit": "1a655b7"
"regenerated": "2021-04-02 09:24:10.451056",
"spec_repo_commit": "cc1654e"
},
"v2": {
"apigentools_version": "1.4.1.dev6",
"regenerated": "2021-04-02 07:58:30.476557",
"spec_repo_commit": "1a655b7"
"regenerated": "2021-04-02 09:24:25.098751",
"spec_repo_commit": "cc1654e"
}
}
}
2 changes: 1 addition & 1 deletion data/v1/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16735,7 +16735,7 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/SyntheticsTestDetails'
$ref: '#/components/schemas/SyntheticsBrowserTest'
description: OK
'403':
content:
Expand Down
8 changes: 4 additions & 4 deletions docs/v1/SyntheticsAPI.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -788,7 +788,7 @@ end

## get_browser_test

> <SyntheticsTestDetails> get_browser_test(public_id)
> <SyntheticsBrowserTest> get_browser_test(public_id)

Get a test configuration (browser)

Expand All @@ -814,15 +814,15 @@ end

This returns an Array which contains the response data, status code and headers.

> <Array(<SyntheticsTestDetails>, Integer, Hash)> get_browser_test_with_http_info(public_id)
> <Array(<SyntheticsBrowserTest>, Integer, Hash)> get_browser_test_with_http_info(public_id)

```ruby
begin
# Get a test configuration (browser)
data, status_code, headers = api_instance.get_browser_test_with_http_info(public_id)
p status_code # => 2xx
p headers # => { ... }
p data # => <SyntheticsTestDetails>
p data # => <SyntheticsBrowserTest>
rescue DatadogAPIClient::V1::APIError => e
puts "Error when calling SyntheticsAPI->get_browser_test_with_http_info: #{e}"
end
Expand All @@ -836,7 +836,7 @@ end

### Return type

[**SyntheticsTestDetails**](SyntheticsTestDetails.md)
[**SyntheticsBrowserTest**](SyntheticsBrowserTest.md)

### Authorization

Expand Down
6 changes: 3 additions & 3 deletions lib/datadog_api_client/v1/api/synthetics_api.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -937,7 +937,7 @@ def get_api_test_result_with_http_info(public_id, result_id, opts = {})
# Get the detailed configuration (including steps) associated with a Synthetic browser test.
# @param public_id [String] The public ID of the test to get details from.
# @param [Hash] opts the optional parameters
# @return [SyntheticsTestDetails]
# @return [SyntheticsBrowserTest]
def get_browser_test(public_id, opts = {})
data, _status_code, _headers = get_browser_test_with_http_info(public_id, opts)
data
Expand All @@ -947,7 +947,7 @@ def get_browser_test(public_id, opts = {})
# Get the detailed configuration (including steps) associated with a Synthetic browser test.
# @param public_id [String] The public ID of the test to get details from.
# @param [Hash] opts the optional parameters
# @return [Array<(SyntheticsTestDetails, Integer, Hash)>] SyntheticsTestDetails data, response status code and response headers
# @return [Array<(SyntheticsBrowserTest, Integer, Hash)>] SyntheticsBrowserTest data, response status code and response headers
def get_browser_test_with_http_info(public_id, opts = {})

if @api_client.config.unstable_operations.has_key?(:get_browser_test)
Expand Down Expand Up @@ -984,7 +984,7 @@ def get_browser_test_with_http_info(public_id, opts = {})
post_body = opts[:debug_body]

# return_type
return_type = opts[:debug_return_type] || 'SyntheticsTestDetails'
return_type = opts[:debug_return_type] || 'SyntheticsBrowserTest'

# auth_names
auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]
Expand Down