Skip to content

Commit 6b9ed5a

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
api-clients-generation-pipeline[bot]
and
ci.datadog-api-spec
authored
Powerpack improve group_widget object (#1704)
Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent 0dae669 commit 6b9ed5a

23 files changed

+651
-207
lines changed

‎.apigentools-info

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
"spec_versions": {
55
"v1": {
66
"apigentools_version": "1.6.6",
7-
"regenerated": "2023-10-05 18:57:55.441668",
8-
"spec_repo_commit": "faa2c8d3"
7+
"regenerated": "2023-10-05 20:05:40.670859",
8+
"spec_repo_commit": "f7a95272"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2023-10-05 18:57:55.456179",
13-
"spec_repo_commit": "faa2c8d3"
12+
"regenerated": "2023-10-05 20:05:40.684801",
13+
"spec_repo_commit": "f7a95272"
1414
}
1515
}
1616
}

‎.generator/schemas/v2/openapi.yaml

Lines changed: 156 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -5482,24 +5482,6 @@ components:
54825482
type: string
54835483
x-enum-varnames:
54845484
- GCP_SERVICE_ACCOUNT
5485-
GetAllPowerpacksResponse:
5486-
description: Response object which includes all powerpack configurations.
5487-
properties:
5488-
data:
5489-
description: List of powerpack definitions.
5490-
items:
5491-
$ref: '#/components/schemas/PowerpackData'
5492-
type: array
5493-
included:
5494-
description: Array of objects related to the users.
5495-
items:
5496-
$ref: '#/components/schemas/User'
5497-
type: array
5498-
links:
5499-
$ref: '#/components/schemas/PowerpackResponseLinks'
5500-
meta:
5501-
$ref: '#/components/schemas/PowerpacksResponseMeta'
5502-
type: object
55035485
GetFindingResponse:
55045486
description: The expected response schema when getting a finding.
55055487
properties:
@@ -7677,6 +7659,24 @@ components:
76777659
- data
76787660
- meta
76797661
type: object
7662+
ListPowerpacksResponse:
7663+
description: Response object which includes all powerpack configurations.
7664+
properties:
7665+
data:
7666+
description: List of powerpack definitions.
7667+
items:
7668+
$ref: '#/components/schemas/PowerpackData'
7669+
type: array
7670+
included:
7671+
description: Array of objects related to the users.
7672+
items:
7673+
$ref: '#/components/schemas/User'
7674+
type: array
7675+
links:
7676+
$ref: '#/components/schemas/PowerpackResponseLinks'
7677+
meta:
7678+
$ref: '#/components/schemas/PowerpacksResponseMeta'
7679+
type: object
76807680
ListTeamsInclude:
76817681
description: Included related resources optionally requested.
76827682
enum:
@@ -10596,18 +10596,7 @@ components:
1059610596
example: Powerpack for ABC
1059710597
type: string
1059810598
group_widget:
10599-
additionalProperties: {}
10600-
description: Templated group of dashboard widgets for the powerpack.
10601-
example:
10602-
layout_type: ordered
10603-
tags:
10604-
- tag:foo1
10605-
type: group
10606-
widgets:
10607-
- definition:
10608-
content: example
10609-
type: note
10610-
type: object
10599+
$ref: '#/components/schemas/PowerpackGroupWidget'
1061110600
name:
1061210601
description: Name of the powerpack.
1061310602
example: Sample Powerpack
@@ -10649,6 +10638,141 @@ components:
1064910638
example: powerpack
1065010639
type: string
1065110640
type: object
10641+
PowerpackGroupWidget:
10642+
description: Powerpack group widget definition object.
10643+
properties:
10644+
definition:
10645+
$ref: '#/components/schemas/PowerpackGroupWidgetDefinition'
10646+
layout:
10647+
$ref: '#/components/schemas/PowerpackGroupWidgetLayout'
10648+
required:
10649+
- definition
10650+
type: object
10651+
PowerpackGroupWidgetDefinition:
10652+
description: Powerpack group widget object.
10653+
properties:
10654+
layout_type:
10655+
description: Layout type of widgets.
10656+
example: ordered
10657+
type: string
10658+
show_title:
10659+
description: Boolean indicating whether powerpack group title should be
10660+
visible or not.
10661+
example: true
10662+
type: boolean
10663+
title:
10664+
description: Name for the group widget.
10665+
example: Sample Powerpack
10666+
type: string
10667+
type:
10668+
description: Type of widget, must be group.
10669+
example: group
10670+
type: string
10671+
widgets:
10672+
description: Widgets inside the powerpack.
10673+
example:
10674+
- definition:
10675+
content: example
10676+
type: note
10677+
layout:
10678+
height: 5
10679+
width: 10
10680+
x: 0
10681+
y: 0
10682+
items:
10683+
$ref: '#/components/schemas/PowerpackInnerWidgets'
10684+
type: array
10685+
required:
10686+
- widgets
10687+
- layout_type
10688+
- type
10689+
type: object
10690+
PowerpackGroupWidgetLayout:
10691+
description: Powerpack group widget layout.
10692+
properties:
10693+
height:
10694+
description: The height of the widget. Should be a non-negative integer.
10695+
example: 0
10696+
format: int64
10697+
minimum: 0
10698+
type: integer
10699+
width:
10700+
description: The width of the widget. Should be a non-negative integer.
10701+
example: 0
10702+
format: int64
10703+
minimum: 0
10704+
type: integer
10705+
x:
10706+
description: The position of the widget on the x (horizontal) axis. Should
10707+
be a non-negative integer.
10708+
example: 0
10709+
format: int64
10710+
minimum: 0
10711+
type: integer
10712+
y:
10713+
description: The position of the widget on the y (vertical) axis. Should
10714+
be a non-negative integer.
10715+
example: 0
10716+
format: int64
10717+
minimum: 0
10718+
type: integer
10719+
required:
10720+
- x
10721+
- y
10722+
- width
10723+
- height
10724+
type: object
10725+
PowerpackInnerWidgetLayout:
10726+
description: Powerpack inner widget layout.
10727+
properties:
10728+
height:
10729+
description: The height of the widget. Should be a non-negative integer.
10730+
example: 0
10731+
format: int64
10732+
minimum: 0
10733+
type: integer
10734+
width:
10735+
description: The width of the widget. Should be a non-negative integer.
10736+
example: 0
10737+
format: int64
10738+
minimum: 0
10739+
type: integer
10740+
x:
10741+
description: The position of the widget on the x (horizontal) axis. Should
10742+
be a non-negative integer.
10743+
example: 0
10744+
format: int64
10745+
minimum: 0
10746+
type: integer
10747+
y:
10748+
description: The position of the widget on the y (vertical) axis. Should
10749+
be a non-negative integer.
10750+
example: 0
10751+
format: int64
10752+
minimum: 0
10753+
type: integer
10754+
required:
10755+
- x
10756+
- y
10757+
- width
10758+
- height
10759+
type: object
10760+
PowerpackInnerWidgets:
10761+
description: Powerpack group widget definition of individual widgets.
10762+
properties:
10763+
definition:
10764+
additionalProperties: {}
10765+
description: Information about widget.
10766+
example:
10767+
definition:
10768+
content: example
10769+
type: note
10770+
type: object
10771+
layout:
10772+
$ref: '#/components/schemas/PowerpackInnerWidgetLayout'
10773+
required:
10774+
- definition
10775+
type: object
1065210776
PowerpackRelationships:
1065310777
description: Powerpack relationship object.
1065410778
properties:
@@ -23570,13 +23694,13 @@ paths:
2357023694
/api/v2/powerpacks:
2357123695
get:
2357223696
description: Get a list of all powerpacks.
23573-
operationId: GetAllPowerpacks
23697+
operationId: ListPowerpacks
2357423698
responses:
2357523699
'200':
2357623700
content:
2357723701
application/json:
2357823702
schema:
23579-
$ref: '#/components/schemas/GetAllPowerpacksResponse'
23703+
$ref: '#/components/schemas/ListPowerpacksResponse'
2358023704
description: OK
2358123705
'429':
2358223706
$ref: '#/components/responses/TooManyRequestsResponse'

‎docs/datadog_api_client.v2.model.rst

Lines changed: 42 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2157,13 +2157,6 @@ gcpsts\_service\_accounts\_response
21572157
:members:
21582158
:show-inheritance:
21592159

2160-
get\_all\_powerpacks\_response
2161-
------------------------------
2162-
2163-
.. automodule:: datadog_api_client.v2.model.get_all_powerpacks_response
2164-
:members:
2165-
:show-inheritance:
2166-
21672160
get\_finding\_response
21682161
----------------------
21692162

@@ -3200,6 +3193,13 @@ list\_findings\_response
32003193
:members:
32013194
:show-inheritance:
32023195

3196+
list\_powerpacks\_response
3197+
--------------------------
3198+
3199+
.. automodule:: datadog_api_client.v2.model.list_powerpacks_response
3200+
:members:
3201+
:show-inheritance:
3202+
32033203
list\_teams\_include
32043204
--------------------
32053205

@@ -4635,6 +4635,41 @@ powerpack\_data
46354635
:members:
46364636
:show-inheritance:
46374637

4638+
powerpack\_group\_widget
4639+
------------------------
4640+
4641+
.. automodule:: datadog_api_client.v2.model.powerpack_group_widget
4642+
:members:
4643+
:show-inheritance:
4644+
4645+
powerpack\_group\_widget\_definition
4646+
------------------------------------
4647+
4648+
.. automodule:: datadog_api_client.v2.model.powerpack_group_widget_definition
4649+
:members:
4650+
:show-inheritance:
4651+
4652+
powerpack\_group\_widget\_layout
4653+
--------------------------------
4654+
4655+
.. automodule:: datadog_api_client.v2.model.powerpack_group_widget_layout
4656+
:members:
4657+
:show-inheritance:
4658+
4659+
powerpack\_inner\_widget\_layout
4660+
--------------------------------
4661+
4662+
.. automodule:: datadog_api_client.v2.model.powerpack_inner_widget_layout
4663+
:members:
4664+
:show-inheritance:
4665+
4666+
powerpack\_inner\_widgets
4667+
-------------------------
4668+
4669+
.. automodule:: datadog_api_client.v2.model.powerpack_inner_widgets
4670+
:members:
4671+
:show-inheritance:
4672+
46384673
powerpack\_relationships
46394674
------------------------
46404675

‎examples/v2/powerpack/CreatePowerpack.py

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,20 +7,34 @@
77
from datadog_api_client.v2.model.powerpack import Powerpack
88
from datadog_api_client.v2.model.powerpack_attributes import PowerpackAttributes
99
from datadog_api_client.v2.model.powerpack_data import PowerpackData
10+
from datadog_api_client.v2.model.powerpack_group_widget import PowerpackGroupWidget
11+
from datadog_api_client.v2.model.powerpack_group_widget_definition import PowerpackGroupWidgetDefinition
12+
from datadog_api_client.v2.model.powerpack_group_widget_layout import PowerpackGroupWidgetLayout
13+
from datadog_api_client.v2.model.powerpack_inner_widgets import PowerpackInnerWidgets
1014
from datadog_api_client.v2.model.powerpack_template_variable import PowerpackTemplateVariable
1115

1216
body = Powerpack(
1317
data=PowerpackData(
1418
attributes=PowerpackAttributes(
1519
description="Sample powerpack",
16-
group_widget=dict(
17-
[
18-
(
19-
"definition",
20-
"{'layout_type': 'ordered', 'show_title': True, 'title': 'Sample Powerpack', 'type': 'group', 'widgets': [{'definition': {'content': 'test', 'type': 'note'}}]}",
21-
),
22-
("layout", "{'height': 3, 'width': 12, 'x': 0, 'y': 0}"),
23-
]
20+
group_widget=PowerpackGroupWidget(
21+
definition=PowerpackGroupWidgetDefinition(
22+
layout_type="ordered",
23+
show_title=True,
24+
title="Sample Powerpack",
25+
type="group",
26+
widgets=[
27+
PowerpackInnerWidgets(
28+
definition=dict([("content", "test"), ("type", "note")]),
29+
),
30+
],
31+
),
32+
layout=PowerpackGroupWidgetLayout(
33+
height=3,
34+
width=12,
35+
x=0,
36+
y=0,
37+
),
2438
),
2539
name="Sample Powerpack",
2640
tags=[

‎examples/v2/powerpack/GetAllPowerpacks.py renamed to ‎examples/v2/powerpack/ListPowerpacks.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,6 @@
88
configuration = Configuration()
99
with ApiClient(configuration) as api_client:
1010
api_instance = PowerpackApi(api_client)
11-
response = api_instance.get_all_powerpacks()
11+
response = api_instance.list_powerpacks()
1212

1313
print(response)

0 commit comments

Comments
 (0)