Skip to content

Add metadata property with pagination info to SLOList endpoint response #414

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

Merged
merged 1 commit into from
Apr 29, 2021
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.dev6",
"regenerated": "2021-04-28 12:51:12.917294",
"spec_repo_commit": "93dbed8"
"regenerated": "2021-04-29 09:18:19.213192",
"spec_repo_commit": "ac83bf0"
},
"v2": {
"apigentools_version": "1.4.1.dev6",
"regenerated": "2021-04-28 12:51:40.774917",
"spec_repo_commit": "93dbed8"
"regenerated": "2021-04-29 09:18:42.357253",
"spec_repo_commit": "ac83bf0"
}
}
}
2 changes: 2 additions & 0 deletions docs/v1/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -548,6 +548,8 @@ Class | Method | HTTP request | Description
- [SLOHistoryResponseError](SLOHistoryResponseError.md)
- [SLOHistorySLIData](SLOHistorySLIData.md)
- [SLOListResponse](SLOListResponse.md)
- [SLOListResponseMetadata](SLOListResponseMetadata.md)
- [SLOListResponseMetadataPage](SLOListResponseMetadataPage.md)
- [SLOResponse](SLOResponse.md)
- [SLOThreshold](SLOThreshold.md)
- [SLOTimeframe](SLOTimeframe.md)
Expand Down
1 change: 1 addition & 0 deletions docs/v1/SLOListResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**data** | [**[ServiceLevelObjective]**](ServiceLevelObjective.md) | An array of service level objective objects. | [optional]
**errors** | **[str]** | An array of error messages. Each endpoint documents how/whether this field is used. | [optional]
**metadata** | [**SLOListResponseMetadata**](SLOListResponseMetadata.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)

Expand Down
12 changes: 12 additions & 0 deletions docs/v1/SLOListResponseMetadata.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# SLOListResponseMetadata

The metadata object containing additional information about the list of SLOs.

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**page** | [**SLOListResponseMetadataPage**](SLOListResponseMetadataPage.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)


13 changes: 13 additions & 0 deletions docs/v1/SLOListResponseMetadataPage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# SLOListResponseMetadataPage

The object containing information about the pages of the list of SLOs.

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**total_count** | **int** | The total number of resources that could be retrieved ignoring the parameters and filters in the request. | [optional]
**total_filtered_count** | **int** | The total number of resources that match the parameters and filters in the request. This attribute can be used by a client to determine the total number of pages. | [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)


5 changes: 5 additions & 0 deletions src/datadog_api_client/v1/model/slo_list_response.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,9 @@

def lazy_import():
from datadog_api_client.v1.model.service_level_objective import ServiceLevelObjective
from datadog_api_client.v1.model.slo_list_response_metadata import SLOListResponseMetadata

globals()["SLOListResponseMetadata"] = SLOListResponseMetadata
globals()["ServiceLevelObjective"] = ServiceLevelObjective


Expand Down Expand Up @@ -74,6 +76,7 @@ def openapi_types():
return {
"data": ([ServiceLevelObjective],), # noqa: E501
"errors": ([str],), # noqa: E501
"metadata": (SLOListResponseMetadata,), # noqa: E501
}

@cached_property
Expand All @@ -83,6 +86,7 @@ def discriminator():
attribute_map = {
"data": "data", # noqa: E501
"errors": "errors", # noqa: E501
"metadata": "metadata", # noqa: E501
}

_composed_schemas = {}
Expand Down Expand Up @@ -135,6 +139,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
_visited_composed_classes = (Animal,)
data ([ServiceLevelObjective]): An array of service level objective objects.. [optional] # noqa: E501
errors ([str]): An array of error messages. Each endpoint documents how/whether this field is used.. [optional] # noqa: E501
metadata (SLOListResponseMetadata): [optional] # noqa: E501
"""

_check_type = kwargs.pop("_check_type", True)
Expand Down
170 changes: 170 additions & 0 deletions src/datadog_api_client/v1/model/slo_list_response_metadata.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,170 @@
# 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

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.slo_list_response_metadata_page import SLOListResponseMetadataPage

globals()["SLOListResponseMetadataPage"] = SLOListResponseMetadataPage


class SLOListResponseMetadata(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 {
"page": (SLOListResponseMetadataPage,), # noqa: E501
}

@cached_property
def discriminator():
return None

attribute_map = {
"page": "page", # 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, *args, **kwargs): # noqa: E501
"""SLOListResponseMetadata - a model defined in OpenAPI

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,)
page (SLOListResponseMetadataPage): [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__,)

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)
Loading