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

Change columns attribute type from string array to object array in APM stats query widget #107

Merged
merged 1 commit into from
Oct 6, 2020
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.2.0",
"regenerated": "2020-10-05 08:54:47.138698",
"spec_repo_commit": "3e66447"
"regenerated": "2020-10-06 08:32:17.762496",
"spec_repo_commit": "d9efdb7"
},
"v2": {
"apigentools_version": "1.2.0",
"regenerated": "2020-10-05 08:54:57.081213",
"spec_repo_commit": "3e66447"
"regenerated": "2020-10-06 08:32:27.968295",
"spec_repo_commit": "d9efdb7"
}
}
}
14 changes: 14 additions & 0 deletions docs/v1/ApmStatsQueryColumnType.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# ApmStatsQueryColumnType

Column properties.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | Column name. |
**alias** | **str** | A user-assigned alias for the column. | [optional]
**cell_display_mode** | [**TableWidgetCellDisplayMode**](TableWidgetCellDisplayMode.md) | | [optional]
**order** | [**WidgetSort**](WidgetSort.md) | | [optional]

[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)


2 changes: 1 addition & 1 deletion docs/v1/ApmStatsQueryDefinition.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Name | Type | Description | Notes
**primary_tag** | **str** | The organization's host group name and value. |
**row_type** | [**ApmStatsQueryRowType**](ApmStatsQueryRowType.md) | |
**service** | **str** | Service name. |
**columns** | **[str]** | Column names used by front end for display. | [optional]
**columns** | [**[ApmStatsQueryColumnType]**](ApmStatsQueryColumnType.md) | Column properties used by the front end for display. | [optional]
**resource** | **str** | Resource name. | [optional]

[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)
Expand Down
1 change: 1 addition & 0 deletions docs/v1/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,7 @@ Class | Method | HTTP request | Description
- [ApiKey](ApiKey.md)
- [ApiKeyListResponse](ApiKeyListResponse.md)
- [ApiKeyResponse](ApiKeyResponse.md)
- [ApmStatsQueryColumnType](ApmStatsQueryColumnType.md)
- [ApmStatsQueryDefinition](ApmStatsQueryDefinition.md)
- [ApmStatsQueryRowType](ApmStatsQueryRowType.md)
- [ApplicationKey](ApplicationKey.md)
Expand Down
184 changes: 184 additions & 0 deletions src/datadog_api_client/v1/model/apm_stats_query_column_type.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,184 @@
# coding: utf-8

# Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
# This product includes software developed at Datadog (https://www.datadoghq.com/).
# Copyright 2019-Present Datadog, Inc.


import re # noqa: F401
import sys # noqa: F401

import nulltype # noqa: F401

from datadog_api_client.v1.model_utils import ( # noqa: F401
ApiTypeError,
ModelComposed,
ModelNormal,
ModelSimple,
cached_property,
change_keys_js_to_python,
convert_js_args_to_python_args,
date,
datetime,
file_type,
none_type,
validate_get_composed_info,
)

def lazy_import():
from datadog_api_client.v1.model.table_widget_cell_display_mode import TableWidgetCellDisplayMode
from datadog_api_client.v1.model.widget_sort import WidgetSort
globals()['TableWidgetCellDisplayMode'] = TableWidgetCellDisplayMode
globals()['WidgetSort'] = WidgetSort


class ApmStatsQueryColumnType(ModelNormal):
"""NOTE: This class is auto generated by OpenAPI Generator.
Ref: https://openapi-generator.tech

Do not edit the class manually.

Attributes:
allowed_values (dict): The key is the tuple path to the attribute
and the for var_name this is (var_name,). The value is a dict
with a capitalized key describing the allowed value and an allowed
value. These dicts store the allowed enum values.
attribute_map (dict): The key is attribute name
and the value is json key in definition.
discriminator_value_class_map (dict): A dict to go from the discriminator
variable value to the discriminator class name.
validations (dict): The key is the tuple path to the attribute
and the for var_name this is (var_name,). The value is a dict
that stores validations for max_length, min_length, max_items,
min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
inclusive_minimum, and regex.
additional_properties_type (tuple): A tuple of classes accepted
as additional properties values.
"""

allowed_values = {
}

validations = {
}

additional_properties_type = None

_nullable = False

@cached_property
def openapi_types():
"""
This must be a method because a model may have properties that are
of type self, this must run after the class is loaded

Returns
openapi_types (dict): The key is attribute name
and the value is attribute type.
"""
lazy_import()
return {
'name': (str,), # noqa: E501
'alias': (str,), # noqa: E501
'cell_display_mode': (TableWidgetCellDisplayMode,), # noqa: E501
'order': (WidgetSort,), # noqa: E501
}

@cached_property
def discriminator():
return None


attribute_map = {
'name': 'name', # noqa: E501
'alias': 'alias', # noqa: E501
'cell_display_mode': 'cell_display_mode', # noqa: E501
'order': 'order', # noqa: E501
}

_composed_schemas = {}

required_properties = set([
'_data_store',
'_check_type',
'_spec_property_naming',
'_path_to_item',
'_configuration',
'_visited_composed_classes',
])

@convert_js_args_to_python_args
def __init__(self, name, *args, **kwargs): # noqa: E501
"""ApmStatsQueryColumnType - a model defined in OpenAPI

Args:
name (str): Column name.

Keyword Args:
_check_type (bool): if True, values for parameters in openapi_types
will be type checked and a TypeError will be
raised if the wrong type is input.
Defaults to True
_path_to_item (tuple/list): This is a list of keys or values to
drill down to the model in received_data
when deserializing a response
_spec_property_naming (bool): True if the variable names in the input data
are serialized names, as specified in the OpenAPI document.
False if the variable names in the input data
are pythonic names, e.g. snake case (default)
_configuration (Configuration): the instance to use when
deserializing a file_type parameter.
If passed, type conversion is attempted
If omitted no type conversion is done.
_visited_composed_classes (tuple): This stores a tuple of
classes that we have traveled through so that
if we see that class again we will not use its
discriminator again.
When traveling through a discriminator, the
composed schema that is
is traveled through is added to this set.
For example if Animal has a discriminator
petType and we pass in "Dog", and the class Dog
allOf includes Animal, we move through Animal
once using the discriminator, and pick Dog.
Then in Dog, we will make an instance of the
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
alias (str): A user-assigned alias for the column.. [optional] # noqa: E501
cell_display_mode (TableWidgetCellDisplayMode): [optional] # noqa: E501
order (WidgetSort): [optional] # noqa: E501
"""

_check_type = kwargs.pop('_check_type', True)
_spec_property_naming = kwargs.pop('_spec_property_naming', False)
_path_to_item = kwargs.pop('_path_to_item', ())
_configuration = kwargs.pop('_configuration', None)
_visited_composed_classes = kwargs.pop('_visited_composed_classes', ())

if args:
raise ApiTypeError(
"Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
args,
self.__class__.__name__,
),
path_to_item=_path_to_item,
valid_classes=(self.__class__,),
)

self._data_store = {}
self._check_type = _check_type
self._spec_property_naming = _spec_property_naming
self._path_to_item = _path_to_item
self._configuration = _configuration
self._visited_composed_classes = _visited_composed_classes + (self.__class__,)

self.name = name
for var_name, var_value in kwargs.items():
if var_name not in self.attribute_map and \
self._configuration is not None and \
self._configuration.discard_unknown_keys and \
self.additional_properties_type is None:
# discard variable.
continue
setattr(self, var_name, var_value)
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,9 @@
)

def lazy_import():
from datadog_api_client.v1.model.apm_stats_query_column_type import ApmStatsQueryColumnType
from datadog_api_client.v1.model.apm_stats_query_row_type import ApmStatsQueryRowType
globals()['ApmStatsQueryColumnType'] = ApmStatsQueryColumnType
globals()['ApmStatsQueryRowType'] = ApmStatsQueryRowType


Expand Down Expand Up @@ -81,7 +83,7 @@ def openapi_types():
'primary_tag': (str,), # noqa: E501
'row_type': (ApmStatsQueryRowType,), # noqa: E501
'service': (str,), # noqa: E501
'columns': ([str],), # noqa: E501
'columns': ([ApmStatsQueryColumnType],), # noqa: E501
'resource': (str,), # noqa: E501
}

Expand Down Expand Up @@ -153,7 +155,7 @@ def __init__(self, env, name, primary_tag, row_type, service, *args, **kwargs):
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
columns ([str]): Column names used by front end for display.. [optional] # noqa: E501
columns ([ApmStatsQueryColumnType]): Column properties used by the front end for display.. [optional] # noqa: E501
resource (str): Resource name.. [optional] # noqa: E501
"""

Expand Down
1 change: 1 addition & 0 deletions src/datadog_api_client/v1/models/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
from datadog_api_client.v1.model.api_key import ApiKey
from datadog_api_client.v1.model.api_key_list_response import ApiKeyListResponse
from datadog_api_client.v1.model.api_key_response import ApiKeyResponse
from datadog_api_client.v1.model.apm_stats_query_column_type import ApmStatsQueryColumnType
from datadog_api_client.v1.model.apm_stats_query_definition import ApmStatsQueryDefinition
from datadog_api_client.v1.model.apm_stats_query_row_type import ApmStatsQueryRowType
from datadog_api_client.v1.model.application_key import ApplicationKey
Expand Down
24 changes: 20 additions & 4 deletions src/datadog_api_client/v1/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -367,15 +367,31 @@ components:
api_key:
$ref: '#/components/schemas/ApiKey'
type: object
ApmStatsQueryColumnType:
description: Column properties.
properties:
alias:
description: A user-assigned alias for the column.
example: Requests
type: string
cell_display_mode:
$ref: '#/components/schemas/TableWidgetCellDisplayMode'
name:
description: Column name.
example: Reqs
type: string
order:
$ref: '#/components/schemas/WidgetSort'
required:
- name
type: object
ApmStatsQueryDefinition:
description: The APM stats query for table and distributions widgets.
properties:
columns:
description: Column names used by front end for display.
description: Column properties used by the front end for display.
items:
description: Column header.
example: MeanLatency
type: string
$ref: '#/components/schemas/ApmStatsQueryColumnType'
type: array
env:
description: Environment name.
Expand Down
36 changes: 36 additions & 0 deletions tests/v1/test_apm_stats_query_column_type.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# coding: utf-8

# Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
# This product includes software developed at Datadog (https://www.datadoghq.com/).
# Copyright 2019-Present Datadog, Inc.


import sys
import unittest

import datadog_api_client.v1
from datadog_api_client.v1.model.table_widget_cell_display_mode import TableWidgetCellDisplayMode
from datadog_api_client.v1.model.widget_sort import WidgetSort
globals()['TableWidgetCellDisplayMode'] = TableWidgetCellDisplayMode
globals()['WidgetSort'] = WidgetSort
from datadog_api_client.v1.model.apm_stats_query_column_type import ApmStatsQueryColumnType


class TestApmStatsQueryColumnType(unittest.TestCase):
"""ApmStatsQueryColumnType unit test stubs"""

def setUp(self):
pass

def tearDown(self):
pass

def testApmStatsQueryColumnType(self):
"""Test ApmStatsQueryColumnType"""
# FIXME: construct object with mandatory attributes with example values
# model = ApmStatsQueryColumnType() # noqa: E501
pass


if __name__ == '__main__':
unittest.main()