Skip to content
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.

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

Powerpack improve group_widget object #1704

Merged
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.6.6",
"regenerated": "2023-10-05 18:57:55.441668",
"spec_repo_commit": "faa2c8d3"
"regenerated": "2023-10-05 20:05:40.670859",
"spec_repo_commit": "f7a95272"
},
"v2": {
"apigentools_version": "1.6.6",
"regenerated": "2023-10-05 18:57:55.456179",
"spec_repo_commit": "faa2c8d3"
"regenerated": "2023-10-05 20:05:40.684801",
"spec_repo_commit": "f7a95272"
}
}
}
188 changes: 156 additions & 32 deletions .generator/schemas/v2/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5482,24 +5482,6 @@ components:
type: string
x-enum-varnames:
- GCP_SERVICE_ACCOUNT
GetAllPowerpacksResponse:
description: Response object which includes all powerpack configurations.
properties:
data:
description: List of powerpack definitions.
items:
$ref: '#/components/schemas/PowerpackData'
type: array
included:
description: Array of objects related to the users.
items:
$ref: '#/components/schemas/User'
type: array
links:
$ref: '#/components/schemas/PowerpackResponseLinks'
meta:
$ref: '#/components/schemas/PowerpacksResponseMeta'
type: object
GetFindingResponse:
description: The expected response schema when getting a finding.
properties:
Expand Down Expand Up @@ -7677,6 +7659,24 @@ components:
- data
- meta
type: object
ListPowerpacksResponse:
description: Response object which includes all powerpack configurations.
properties:
data:
description: List of powerpack definitions.
items:
$ref: '#/components/schemas/PowerpackData'
type: array
included:
description: Array of objects related to the users.
items:
$ref: '#/components/schemas/User'
type: array
links:
$ref: '#/components/schemas/PowerpackResponseLinks'
meta:
$ref: '#/components/schemas/PowerpacksResponseMeta'
type: object
ListTeamsInclude:
description: Included related resources optionally requested.
enum:
Expand Down Expand Up @@ -10596,18 +10596,7 @@ components:
example: Powerpack for ABC
type: string
group_widget:
additionalProperties: {}
description: Templated group of dashboard widgets for the powerpack.
example:
layout_type: ordered
tags:
- tag:foo1
type: group
widgets:
- definition:
content: example
type: note
type: object
$ref: '#/components/schemas/PowerpackGroupWidget'
name:
description: Name of the powerpack.
example: Sample Powerpack
Expand Down Expand Up @@ -10649,6 +10638,141 @@ components:
example: powerpack
type: string
type: object
PowerpackGroupWidget:
description: Powerpack group widget definition object.
properties:
definition:
$ref: '#/components/schemas/PowerpackGroupWidgetDefinition'
layout:
$ref: '#/components/schemas/PowerpackGroupWidgetLayout'
required:
- definition
type: object
PowerpackGroupWidgetDefinition:
description: Powerpack group widget object.
properties:
layout_type:
description: Layout type of widgets.
example: ordered
type: string
show_title:
description: Boolean indicating whether powerpack group title should be
visible or not.
example: true
type: boolean
title:
description: Name for the group widget.
example: Sample Powerpack
type: string
type:
description: Type of widget, must be group.
example: group
type: string
widgets:
description: Widgets inside the powerpack.
example:
- definition:
content: example
type: note
layout:
height: 5
width: 10
x: 0
y: 0
items:
$ref: '#/components/schemas/PowerpackInnerWidgets'
type: array
required:
- widgets
- layout_type
- type
type: object
PowerpackGroupWidgetLayout:
description: Powerpack group widget layout.
properties:
height:
description: The height of the widget. Should be a non-negative integer.
example: 0
format: int64
minimum: 0
type: integer
width:
description: The width of the widget. Should be a non-negative integer.
example: 0
format: int64
minimum: 0
type: integer
x:
description: The position of the widget on the x (horizontal) axis. Should
be a non-negative integer.
example: 0
format: int64
minimum: 0
type: integer
y:
description: The position of the widget on the y (vertical) axis. Should
be a non-negative integer.
example: 0
format: int64
minimum: 0
type: integer
required:
- x
- y
- width
- height
type: object
PowerpackInnerWidgetLayout:
description: Powerpack inner widget layout.
properties:
height:
description: The height of the widget. Should be a non-negative integer.
example: 0
format: int64
minimum: 0
type: integer
width:
description: The width of the widget. Should be a non-negative integer.
example: 0
format: int64
minimum: 0
type: integer
x:
description: The position of the widget on the x (horizontal) axis. Should
be a non-negative integer.
example: 0
format: int64
minimum: 0
type: integer
y:
description: The position of the widget on the y (vertical) axis. Should
be a non-negative integer.
example: 0
format: int64
minimum: 0
type: integer
required:
- x
- y
- width
- height
type: object
PowerpackInnerWidgets:
description: Powerpack group widget definition of individual widgets.
properties:
definition:
additionalProperties: {}
description: Information about widget.
example:
definition:
content: example
type: note
type: object
layout:
$ref: '#/components/schemas/PowerpackInnerWidgetLayout'
required:
- definition
type: object
PowerpackRelationships:
description: Powerpack relationship object.
properties:
Expand Down Expand Up @@ -23570,13 +23694,13 @@ paths:
/api/v2/powerpacks:
get:
description: Get a list of all powerpacks.
operationId: GetAllPowerpacks
operationId: ListPowerpacks
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetAllPowerpacksResponse'
$ref: '#/components/schemas/ListPowerpacksResponse'
description: OK
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
Expand Down
49 changes: 42 additions & 7 deletions docs/datadog_api_client.v2.model.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2157,13 +2157,6 @@ gcpsts\_service\_accounts\_response
:members:
:show-inheritance:

get\_all\_powerpacks\_response
------------------------------

.. automodule:: datadog_api_client.v2.model.get_all_powerpacks_response
:members:
:show-inheritance:

get\_finding\_response
----------------------

Expand Down Expand Up @@ -3200,6 +3193,13 @@ list\_findings\_response
:members:
:show-inheritance:

list\_powerpacks\_response
--------------------------

.. automodule:: datadog_api_client.v2.model.list_powerpacks_response
:members:
:show-inheritance:

list\_teams\_include
--------------------

Expand Down Expand Up @@ -4635,6 +4635,41 @@ powerpack\_data
:members:
:show-inheritance:

powerpack\_group\_widget
------------------------

.. automodule:: datadog_api_client.v2.model.powerpack_group_widget
:members:
:show-inheritance:

powerpack\_group\_widget\_definition
------------------------------------

.. automodule:: datadog_api_client.v2.model.powerpack_group_widget_definition
:members:
:show-inheritance:

powerpack\_group\_widget\_layout
--------------------------------

.. automodule:: datadog_api_client.v2.model.powerpack_group_widget_layout
:members:
:show-inheritance:

powerpack\_inner\_widget\_layout
--------------------------------

.. automodule:: datadog_api_client.v2.model.powerpack_inner_widget_layout
:members:
:show-inheritance:

powerpack\_inner\_widgets
-------------------------

.. automodule:: datadog_api_client.v2.model.powerpack_inner_widgets
:members:
:show-inheritance:

powerpack\_relationships
------------------------

Expand Down
30 changes: 22 additions & 8 deletions examples/v2/powerpack/CreatePowerpack.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,34 @@
from datadog_api_client.v2.model.powerpack import Powerpack
from datadog_api_client.v2.model.powerpack_attributes import PowerpackAttributes
from datadog_api_client.v2.model.powerpack_data import PowerpackData
from datadog_api_client.v2.model.powerpack_group_widget import PowerpackGroupWidget
from datadog_api_client.v2.model.powerpack_group_widget_definition import PowerpackGroupWidgetDefinition
from datadog_api_client.v2.model.powerpack_group_widget_layout import PowerpackGroupWidgetLayout
from datadog_api_client.v2.model.powerpack_inner_widgets import PowerpackInnerWidgets
from datadog_api_client.v2.model.powerpack_template_variable import PowerpackTemplateVariable

body = Powerpack(
data=PowerpackData(
attributes=PowerpackAttributes(
description="Sample powerpack",
group_widget=dict(
[
(
"definition",
"{'layout_type': 'ordered', 'show_title': True, 'title': 'Sample Powerpack', 'type': 'group', 'widgets': [{'definition': {'content': 'test', 'type': 'note'}}]}",
),
("layout", "{'height': 3, 'width': 12, 'x': 0, 'y': 0}"),
]
group_widget=PowerpackGroupWidget(
definition=PowerpackGroupWidgetDefinition(
layout_type="ordered",
show_title=True,
title="Sample Powerpack",
type="group",
widgets=[
PowerpackInnerWidgets(
definition=dict([("content", "test"), ("type", "note")]),
),
],
),
layout=PowerpackGroupWidgetLayout(
height=3,
width=12,
x=0,
y=0,
),
),
name="Sample Powerpack",
tags=[
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@
configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = PowerpackApi(api_client)
response = api_instance.get_all_powerpacks()
response = api_instance.list_powerpacks()

print(response)
Loading
Loading