Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
"spec_versions": {
"v1": {
"apigentools_version": "1.4.1.dev2",
"regenerated": "2021-02-12 09:26:55.873425",
"spec_repo_commit": "8d710e1"
"regenerated": "2021-02-12 15:10:48.012038",
"spec_repo_commit": "3ee9214"
},
"v2": {
"apigentools_version": "1.4.1.dev2",
"regenerated": "2021-02-12 09:27:08.683726",
"spec_repo_commit": "8d710e1"
"regenerated": "2021-02-12 15:11:01.972868",
"spec_repo_commit": "3ee9214"
}
}
}
94 changes: 94 additions & 0 deletions data/v1/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1747,6 +1747,99 @@ components:
items:
$ref: '#/components/schemas/GCPAccount'
type: array
GeomapWidgetDefinition:
description: This visualization displays a series of values by country on a
world map.
properties:
custom_links:
description: A list of custom links.
items:
$ref: '#/components/schemas/WidgetCustomLink'
type: array
requests:
description: 'Array of one request object to display in the widget. The
request must contain a `group-by` tag whose value is a country ISO code.


See the [Request JSON schema documentation](https://docs.datadoghq.com/dashboards/graphing_json/request_json)

for information about building the `REQUEST_SCHEMA`.'
example:
- rum_query: <METRIC_1>{<SCOPE_1>}
items:
$ref: '#/components/schemas/GeomapWidgetRequest'
maxItems: 1
minItems: 1
type: array
style:
description: The style to apply to the widget.
example:
palette: hostmap_blues
palette_flip: false
properties:
palette:
description: The color palette to apply to the widget.
example: hostmap_blues
type: string
palette_flip:
description: Whether to flip the palette tones.
example: false
type: boolean
required:
- palette
- palette_flip
type: object
time:
$ref: '#/components/schemas/WidgetTime'
title:
description: The title of your widget.
type: string
title_align:
$ref: '#/components/schemas/WidgetTextAlign'
title_size:
description: The size of the title.
type: string
type:
$ref: '#/components/schemas/GeomapWidgetDefinitionType'
view:
description: The view of the world that the map should render.
example:
focus: WORLD
properties:
focus:
description: The 2-letter ISO code of a country to focus the map on.
Or `WORLD`.
example: WORLD
type: string
required:
- focus
type: object
required:
- type
- requests
- style
- view
type: object
GeomapWidgetDefinitionType:
default: geomap
description: Type of the geomap widget.
enum:
- geomap
example: geomap
type: string
x-enum-varnames:
- GEOMAP
GeomapWidgetRequest:
description: An updated geomap widget.
properties:
log_query:
$ref: '#/components/schemas/LogQueryDefinition'
q:
description: The widget metrics query.
type: string
rum_query:
$ref: '#/components/schemas/LogQueryDefinition'
type: object
GraphSnapshot:
description: Object representing a graph snapshot.
properties:
Expand Down Expand Up @@ -9878,6 +9971,7 @@ components:
- $ref: '#/components/schemas/EventStreamWidgetDefinition'
- $ref: '#/components/schemas/EventTimelineWidgetDefinition'
- $ref: '#/components/schemas/FreeTextWidgetDefinition'
- $ref: '#/components/schemas/GeomapWidgetDefinition'
- $ref: '#/components/schemas/GroupWidgetDefinition'
- $ref: '#/components/schemas/HeatMapWidgetDefinition'
- $ref: '#/components/schemas/HostMapWidgetDefinition'
Expand Down
34 changes: 34 additions & 0 deletions docs/v1/GeomapWidgetDefinition.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# DatadogAPIClient::V1::GeomapWidgetDefinition

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **custom_links** | [**Array&lt;WidgetCustomLink&gt;**](WidgetCustomLink.md) | A list of custom links. | [optional] |
| **requests** | [**Array&lt;GeomapWidgetRequest&gt;**](GeomapWidgetRequest.md) | Array of one request object to display in the widget. The request must contain a &#x60;group-by&#x60; tag whose value is a country ISO code. See the [Request JSON schema documentation](https://docs.datadoghq.com/dashboards/graphing_json/request_json) for information about building the &#x60;REQUEST_SCHEMA&#x60;. | |
| **style** | [**GeomapWidgetDefinitionStyle**](GeomapWidgetDefinitionStyle.md) | | |
| **time** | [**WidgetTime**](WidgetTime.md) | | [optional] |
| **title** | **String** | The title of your widget. | [optional] |
| **title_align** | [**WidgetTextAlign**](WidgetTextAlign.md) | | [optional] |
| **title_size** | **String** | The size of the title. | [optional] |
| **type** | [**GeomapWidgetDefinitionType**](GeomapWidgetDefinitionType.md) | | [default to &#39;geomap&#39;] |
| **view** | [**GeomapWidgetDefinitionView**](GeomapWidgetDefinitionView.md) | | |

## Example

```ruby
require 'datadog_api_client/v1'

instance = DatadogAPIClient::V1::GeomapWidgetDefinition.new(
custom_links: null,
requests: [{&quot;rum_query&quot;:&quot;&lt;METRIC_1&gt;{&lt;SCOPE_1&gt;}&quot;}],
style: null,
time: null,
title: null,
title_align: null,
title_size: null,
type: null,
view: null
)
```

20 changes: 20 additions & 0 deletions docs/v1/GeomapWidgetDefinitionStyle.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# DatadogAPIClient::V1::GeomapWidgetDefinitionStyle

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **palette** | **String** | The color palette to apply to the widget. | |
| **palette_flip** | **Boolean** | Whether to flip the palette tones. | |

## Example

```ruby
require 'datadog_api_client/v1'

instance = DatadogAPIClient::V1::GeomapWidgetDefinitionStyle.new(
palette: hostmap_blues,
palette_flip: false
)
```

15 changes: 15 additions & 0 deletions docs/v1/GeomapWidgetDefinitionType.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# DatadogAPIClient::V1::GeomapWidgetDefinitionType

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |

## Example

```ruby
require 'datadog_api_client/v1'

instance = DatadogAPIClient::V1::GeomapWidgetDefinitionType.new()
```

18 changes: 18 additions & 0 deletions docs/v1/GeomapWidgetDefinitionView.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# DatadogAPIClient::V1::GeomapWidgetDefinitionView

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **focus** | **String** | The 2-letter ISO code of a country to focus the map on. Or &#x60;WORLD&#x60;. | |

## Example

```ruby
require 'datadog_api_client/v1'

instance = DatadogAPIClient::V1::GeomapWidgetDefinitionView.new(
focus: WORLD
)
```

22 changes: 22 additions & 0 deletions docs/v1/GeomapWidgetRequest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# DatadogAPIClient::V1::GeomapWidgetRequest

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **log_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] |
| **q** | **String** | The widget metrics query. | [optional] |
| **rum_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] |

## Example

```ruby
require 'datadog_api_client/v1'

instance = DatadogAPIClient::V1::GeomapWidgetRequest.new(
log_query: null,
q: null,
rum_query: null
)
```

5 changes: 5 additions & 0 deletions docs/v1/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -338,6 +338,11 @@ Class | Method | HTTP request | Description
- [DatadogAPIClient::V1::FreeTextWidgetDefinition](FreeTextWidgetDefinition.md)
- [DatadogAPIClient::V1::FreeTextWidgetDefinitionType](FreeTextWidgetDefinitionType.md)
- [DatadogAPIClient::V1::GCPAccount](GCPAccount.md)
- [DatadogAPIClient::V1::GeomapWidgetDefinition](GeomapWidgetDefinition.md)
- [DatadogAPIClient::V1::GeomapWidgetDefinitionStyle](GeomapWidgetDefinitionStyle.md)
- [DatadogAPIClient::V1::GeomapWidgetDefinitionType](GeomapWidgetDefinitionType.md)
- [DatadogAPIClient::V1::GeomapWidgetDefinitionView](GeomapWidgetDefinitionView.md)
- [DatadogAPIClient::V1::GeomapWidgetRequest](GeomapWidgetRequest.md)
- [DatadogAPIClient::V1::GraphSnapshot](GraphSnapshot.md)
- [DatadogAPIClient::V1::GroupWidgetDefinition](GroupWidgetDefinition.md)
- [DatadogAPIClient::V1::GroupWidgetDefinitionType](GroupWidgetDefinitionType.md)
Expand Down
2 changes: 2 additions & 0 deletions docs/v1/WidgetDefinition.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ DatadogAPIClient::V1::WidgetDefinition.openapi_one_of
# :'EventStreamWidgetDefinition',
# :'EventTimelineWidgetDefinition',
# :'FreeTextWidgetDefinition',
# :'GeomapWidgetDefinition',
# :'GroupWidgetDefinition',
# :'HeatMapWidgetDefinition',
# :'HostMapWidgetDefinition',
Expand Down Expand Up @@ -73,6 +74,7 @@ DatadogAPIClient::V1::WidgetDefinition.build(data_that_doesnt_match)
- `EventStreamWidgetDefinition`
- `EventTimelineWidgetDefinition`
- `FreeTextWidgetDefinition`
- `GeomapWidgetDefinition`
- `GroupWidgetDefinition`
- `HeatMapWidgetDefinition`
- `HostMapWidgetDefinition`
Expand Down
5 changes: 5 additions & 0 deletions lib/datadog_api_client/v1.rb
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,11 @@
require 'datadog_api_client/v1/models/free_text_widget_definition'
require 'datadog_api_client/v1/models/free_text_widget_definition_type'
require 'datadog_api_client/v1/models/gcp_account'
require 'datadog_api_client/v1/models/geomap_widget_definition'
require 'datadog_api_client/v1/models/geomap_widget_definition_style'
require 'datadog_api_client/v1/models/geomap_widget_definition_type'
require 'datadog_api_client/v1/models/geomap_widget_definition_view'
require 'datadog_api_client/v1/models/geomap_widget_request'
require 'datadog_api_client/v1/models/graph_snapshot'
require 'datadog_api_client/v1/models/group_widget_definition'
require 'datadog_api_client/v1/models/group_widget_definition_type'
Expand Down
Loading