Skip to content

Remove unnecessary field in list stream column config #2317

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
Dec 12, 2024
Merged

Remove unnecessary field in list stream column config #2317

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.6.6",
"regenerated": "2024-12-12 14:27:18.166809",
"spec_repo_commit": "3ebe762b"
"regenerated": "2024-12-12 15:24:01.062659",
"spec_repo_commit": "222e1f81"
},
"v2": {
"apigentools_version": "1.6.6",
"regenerated": "2024-12-12 14:27:18.187622",
"spec_repo_commit": "3ebe762b"
"regenerated": "2024-12-12 15:24:01.081080",
"spec_repo_commit": "222e1f81"
}
}
}
5 changes: 0 additions & 5 deletions .generator/schemas/v1/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4654,11 +4654,6 @@ components:
description: Widget column field.
example: content
type: string
is_clustering_pattern_field_path:
description: Identifies the clustering pattern field column, usable only
with logs_pattern_stream.
example: true
type: boolean
width:
$ref: '#/components/schemas/ListStreamColumnWidth'
required:
Expand Down
1 change: 0 additions & 1 deletion examples/v1/dashboards/CreateDashboard_1039800684.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,6 @@
ListStreamColumn(
width=ListStreamColumnWidth.AUTO,
field="message",
is_clustering_pattern_field_path=True,
),
],
query=ListStreamQuery(
Expand Down
19 changes: 2 additions & 17 deletions src/datadog_api_client/v1/model/list_stream_column.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,11 @@
# Copyright 2019-Present Datadog, Inc.
from __future__ import annotations

from typing import Union, TYPE_CHECKING
from typing import TYPE_CHECKING

from datadog_api_client.model_utils import (
ModelNormal,
cached_property,
unset,
UnsetType,
)


Expand All @@ -24,37 +22,24 @@ def openapi_types(_):

return {
"field": (str,),
"is_clustering_pattern_field_path": (bool,),
"width": (ListStreamColumnWidth,),
}

attribute_map = {
"field": "field",
"is_clustering_pattern_field_path": "is_clustering_pattern_field_path",
"width": "width",
}

def __init__(
self_,
field: str,
width: ListStreamColumnWidth,
is_clustering_pattern_field_path: Union[bool, UnsetType] = unset,
**kwargs,
):
def __init__(self_, field: str, width: ListStreamColumnWidth, **kwargs):
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔴 Code Quality Violation

Suggested change
def __init__(self_, field: str, width: ListStreamColumnWidth, **kwargs):
def __init__(self, field: str, width: ListStreamColumnWidth, **kwargs):
first parameter of a class function should be self (...read more)

In a class method (that is not a class method nor a static method), the first argument must be self by convention.

Learn More

View in Datadog  Leave us feedback  Documentation

"""
Widget column.

:param field: Widget column field.
:type field: str

:param is_clustering_pattern_field_path: Identifies the clustering pattern field column, usable only with logs_pattern_stream.
:type is_clustering_pattern_field_path: bool, optional

:param width: Widget column width.
:type width: ListStreamColumnWidth
"""
if is_clustering_pattern_field_path is not unset:
kwargs["is_clustering_pattern_field_path"] = is_clustering_pattern_field_path
super().__init__(kwargs)

self_.field = field
Expand Down
2 changes: 1 addition & 1 deletion ..._scenarios/test_create_a_new_dashboard_with_logs_pattern_stream_list_stream_widget.frozen
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
2024-11-20T19:43:46.485Z
2024-12-11T19:18:02.796Z
12 changes: 6 additions & 6 deletions ...st_scenarios/test_create_a_new_dashboard_with_logs_pattern_stream_list_stream_widget.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
interactions:
- request:
body: '{"layout_type":"ordered","title":"Test-Create_a_new_dashboard_with_logs_pattern_stream_list_stream_widget-1732131826
with list_stream widget","widgets":[{"definition":{"requests":[{"columns":[{"field":"timestamp","width":"auto"},{"field":"message","is_clustering_pattern_field_path":true,"width":"auto"}],"query":{"clustering_pattern_field_path":"message","data_source":"logs_pattern_stream","group_by":[{"facet":"service"}],"query_string":""},"response_format":"event_list"}],"type":"list_stream"}}]}'
body: '{"layout_type":"ordered","title":"Test-Create_a_new_dashboard_with_logs_pattern_stream_list_stream_widget-1733944682
with list_stream widget","widgets":[{"definition":{"requests":[{"columns":[{"field":"timestamp","width":"auto"},{"field":"message","width":"auto"}],"query":{"clustering_pattern_field_path":"message","data_source":"logs_pattern_stream","group_by":[{"facet":"service"}],"query_string":""},"response_format":"event_list"}],"type":"list_stream"}}]}'
headers:
accept:
- application/json
Expand All @@ -11,9 +11,9 @@ interactions:
uri: https://api.datadoghq.com/api/v1/dashboard
response:
body:
string: '{"id":"r75-hd7-sd9","title":"Test-Create_a_new_dashboard_with_logs_pattern_stream_list_stream_widget-1732131826
string: '{"id":"fue-7tr-ubw","title":"Test-Create_a_new_dashboard_with_logs_pattern_stream_list_stream_widget-1733944682
with list_stream widget","description":null,"author_handle":"9919ec9b-ebc7-49ee-8dc8-03626e717cca","author_name":"CI
Account","layout_type":"ordered","url":"/dashboard/r75-hd7-sd9/test-createanewdashboardwithlogspatternstreamliststreamwidget-1732131826-with-li","is_read_only":false,"template_variables":null,"widgets":[{"definition":{"requests":[{"columns":[{"field":"timestamp","width":"auto"},{"field":"message","is_clustering_pattern_field_path":true,"width":"auto"}],"query":{"clustering_pattern_field_path":"message","data_source":"logs_pattern_stream","group_by":[{"facet":"service"}],"query_string":""},"response_format":"event_list"}],"type":"list_stream"},"id":6154246442450384}],"notify_list":null,"created_at":"2024-11-20T19:43:46.871965+00:00","modified_at":"2024-11-20T19:43:46.871965+00:00","restricted_roles":[]}
Account","layout_type":"ordered","url":"/dashboard/fue-7tr-ubw/test-createanewdashboardwithlogspatternstreamliststreamwidget-1733944682-with-li","is_read_only":false,"template_variables":null,"widgets":[{"definition":{"requests":[{"columns":[{"field":"timestamp","width":"auto"},{"field":"message","width":"auto"}],"query":{"clustering_pattern_field_path":"message","data_source":"logs_pattern_stream","group_by":[{"facet":"service"}],"query_string":""},"response_format":"event_list"}],"type":"list_stream"},"id":4674889262305585}],"notify_list":null,"created_at":"2024-12-11T19:18:03.039937+00:00","modified_at":"2024-12-11T19:18:03.039937+00:00","restricted_roles":[]}

'
headers:
Expand All @@ -28,10 +28,10 @@ interactions:
accept:
- application/json
method: DELETE
uri: https://api.datadoghq.com/api/v1/dashboard/r75-hd7-sd9
uri: https://api.datadoghq.com/api/v1/dashboard/fue-7tr-ubw
response:
body:
string: '{"deleted_dashboard_id":"r75-hd7-sd9"}
string: '{"deleted_dashboard_id":"fue-7tr-ubw"}

'
headers:
Expand Down
2 changes: 1 addition & 1 deletion tests/v1/features/dashboards.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -534,7 +534,7 @@ Feature: Dashboards
@team:DataDog/dashboards-backend
Scenario: Create a new dashboard with logs_pattern_stream list_stream widget
Given new "CreateDashboard" request
And body with value {"layout_type": "ordered", "title": "{{ unique }} with list_stream widget","widgets": [{"definition": {"type": "list_stream","requests": [{"columns":[{"width":"auto","field":"timestamp"},{"width":"auto","field":"message", "is_clustering_pattern_field_path": true}],"query":{"data_source":"logs_pattern_stream","query_string":"","clustering_pattern_field_path":"message","group_by":[{"facet":"service"}]}, "response_format":"event_list"}]}}]}
And body with value {"layout_type": "ordered", "title": "{{ unique }} with list_stream widget","widgets": [{"definition": {"type": "list_stream","requests": [{"columns":[{"width":"auto","field":"timestamp"},{"width":"auto","field":"message"}],"query":{"data_source":"logs_pattern_stream","query_string":"","clustering_pattern_field_path":"message","group_by":[{"facet":"service"}]}, "response_format":"event_list"}]}}]}
When the request is sent
Then the response status is 200 OK
And the response "widgets[0].definition.requests[0].query.data_source" is equal to "logs_pattern_stream"
Expand Down
Loading