Skip to content

Add back array models for compatibility #1499

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 4 commits into from
Jun 1, 2023
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
7 changes: 7 additions & 0 deletions .generator/src/generator/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ def cli(specs, output):
models_j2 = env.get_template("models.j2")
init_j2 = env.get_template("init.j2")
configuration_j2 = env.get_template("configuration.j2")
compat_j2 = env.get_template("compat.j2")

extra_files = {
"api_client.py": env.get_template("api_client.j2"),
Expand Down Expand Up @@ -140,3 +141,9 @@ def cli(specs, output):
filename = top_package / "configuration.py"
with filename.open("w") as fp:
fp.write(configuration_j2.render(specs=all_specs, apis=all_apis))

with (pathlib.Path(__file__).parent / "compat-files").open() as fp:
for compat_file in fp:
compat_file, compat_model = compat_file.strip().split(":")
with top_package.joinpath(compat_file).open("w") as model_fp:
model_fp.write(compat_j2.render(model=compat_model))
41 changes: 41 additions & 0 deletions .generator/src/generator/compat-files
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
v1/model/agent_check.py:AgentCheck
v1/model/azure_account_list_response.py:AzureAccountListResponse
v1/model/dashboard_bulk_action_data_list.py:DashboardBulkActionDataList
v1/model/distribution_point.py:DistributionPoint
v1/model/distribution_point_data.py:DistributionPointData
v1/model/gcp_account_list_response.py:GCPAccountListResponse
v1/model/http_log.py:HTTPLog
v1/model/logs_pipeline_list.py:LogsPipelineList
v1/model/monitor_search_count.py:MonitorSearchCount
v1/model/notify_end_states.py:NotifyEndStates
v1/model/notify_end_types.py:NotifyEndTypes
v1/model/point.py:Point
v1/model/service_checks.py:ServiceChecks
v1/model/shared_dashboard_invites_data_list.py:SharedDashboardInvitesDataList
v1/model/slack_integration_channels.py:SlackIntegrationChannels
v1/model/synthetics_restricted_roles.py:SyntheticsRestrictedRoles
v1/model/usage_attribution_aggregates.py:UsageAttributionAggregates
v2/model/ci_app_aggregate_bucket_value_timeseries.py:CIAppAggregateBucketValueTimeseries
v2/model/events_query_group_bys.py:EventsQueryGroupBys
v2/model/finding_tags.py:FindingTags
v2/model/group_tags.py:GroupTags
v2/model/http_log.py:HTTPLog
v2/model/incident_todo_assignee_array.py:IncidentTodoAssigneeArray
v2/model/list_findings_data.py:ListFindingsData
v2/model/logs_aggregate_bucket_value_timeseries.py:LogsAggregateBucketValueTimeseries
v2/model/metric_bulk_tag_config_email_list.py:MetricBulkTagConfigEmailList
v2/model/metric_bulk_tag_config_tag_name_list.py:MetricBulkTagConfigTagNameList
v2/model/metric_custom_aggregations.py:MetricCustomAggregations
v2/model/metric_suggested_aggregations.py:MetricSuggestedAggregations
v2/model/rum_aggregate_bucket_value_timeseries.py:RUMAggregateBucketValueTimeseries
v2/model/scalar_formula_request_queries.py:ScalarFormulaRequestQueries
v2/model/security_monitoring_signal_incident_ids.py:SecurityMonitoringSignalIncidentIds
v2/model/sensitive_data_scanner_get_config_included_array.py:SensitiveDataScannerGetConfigIncludedArray
v2/model/sensitive_data_scanner_standard_patterns_response.py:SensitiveDataScannerStandardPatternsResponse
v2/model/tags_event_attribute.py:TagsEventAttribute
v2/model/team_permission_setting_values.py:TeamPermissionSettingValues
v2/model/timeseries_formula_request_queries.py:TimeseriesFormulaRequestQueries
v2/model/timeseries_response_series_list.py:TimeseriesResponseSeriesList
v2/model/timeseries_response_times.py:TimeseriesResponseTimes
v2/model/timeseries_response_values.py:TimeseriesResponseValues
v2/model/timeseries_response_values_list.py:TimeseriesResponseValuesList
12 changes: 12 additions & 0 deletions .generator/src/generator/templates/compat.j2
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
import warnings

warnings.warn("{{ model }} is deprecated and doesn't do anything. It will be removed in a future version.")


class {{ model }}:
"""Deprecated, please don't use."""

def __new__(cls, *args, **kwargs):
if not args:
raise TypeError("Only support a single argument")
return args[0]
119 changes: 119 additions & 0 deletions docs/datadog_api_client.v1.model.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,13 @@ add\_signal\_to\_incident\_request
:members:
:show-inheritance:

agent\_check
------------

.. automodule:: datadog_api_client.v1.model.agent_check
:members:
:show-inheritance:

alert\_graph\_widget\_definition
--------------------------------

Expand Down Expand Up @@ -239,6 +246,13 @@ azure\_account
:members:
:show-inheritance:

azure\_account\_list\_response
------------------------------

.. automodule:: datadog_api_client.v1.model.azure_account_list_response
:members:
:show-inheritance:

cancel\_downtimes\_by\_scope\_request
-------------------------------------

Expand Down Expand Up @@ -344,6 +358,13 @@ dashboard\_bulk\_action\_data
:members:
:show-inheritance:

dashboard\_bulk\_action\_data\_list
-----------------------------------

.. automodule:: datadog_api_client.v1.model.dashboard_bulk_action_data_list
:members:
:show-inheritance:

dashboard\_bulk\_delete\_request
--------------------------------

Expand Down Expand Up @@ -491,6 +512,20 @@ deleted\_monitor
:members:
:show-inheritance:

distribution\_point
-------------------

.. automodule:: datadog_api_client.v1.model.distribution_point
:members:
:show-inheritance:

distribution\_point\_data
-------------------------

.. automodule:: datadog_api_client.v1.model.distribution_point_data
:members:
:show-inheritance:

distribution\_points\_content\_encoding
---------------------------------------

Expand Down Expand Up @@ -918,6 +953,13 @@ gcp\_account
:members:
:show-inheritance:

gcp\_account\_list\_response
----------------------------

.. automodule:: datadog_api_client.v1.model.gcp_account_list_response
:members:
:show-inheritance:

geomap\_widget\_definition
--------------------------

Expand Down Expand Up @@ -1128,6 +1170,13 @@ hourly\_usage\_attribution\_usage\_type
:members:
:show-inheritance:

http\_log
---------

.. automodule:: datadog_api_client.v1.model.http_log
:members:
:show-inheritance:

http\_log\_error
----------------

Expand Down Expand Up @@ -1639,6 +1688,13 @@ logs\_pipeline
:members:
:show-inheritance:

logs\_pipeline\_list
--------------------

.. automodule:: datadog_api_client.v1.model.logs_pipeline_list
:members:
:show-inheritance:

logs\_pipeline\_processor
-------------------------

Expand Down Expand Up @@ -1989,6 +2045,13 @@ monitor\_renotify\_status\_type
:members:
:show-inheritance:

monitor\_search\_count
----------------------

.. automodule:: datadog_api_client.v1.model.monitor_search_count
:members:
:show-inheritance:

monitor\_search\_count\_item
----------------------------

Expand Down Expand Up @@ -2437,13 +2500,27 @@ notify\_end\_state
:members:
:show-inheritance:

notify\_end\_states
-------------------

.. automodule:: datadog_api_client.v1.model.notify_end_states
:members:
:show-inheritance:

notify\_end\_type
-----------------

.. automodule:: datadog_api_client.v1.model.notify_end_type
:members:
:show-inheritance:

notify\_end\_types
------------------

.. automodule:: datadog_api_client.v1.model.notify_end_types
:members:
:show-inheritance:

on\_missing\_data\_option
-------------------------

Expand Down Expand Up @@ -2570,6 +2647,13 @@ pagination
:members:
:show-inheritance:

point
-----

.. automodule:: datadog_api_client.v1.model.point
:members:
:show-inheritance:

process\_query\_definition
--------------------------

Expand Down Expand Up @@ -2829,6 +2913,13 @@ service\_check\_status
:members:
:show-inheritance:

service\_checks
---------------

.. automodule:: datadog_api_client.v1.model.service_checks
:members:
:show-inheritance:

service\_level\_objective
-------------------------

Expand Down Expand Up @@ -2906,6 +2997,13 @@ shared\_dashboard\_invites\_data
:members:
:show-inheritance:

shared\_dashboard\_invites\_data\_list
--------------------------------------

.. automodule:: datadog_api_client.v1.model.shared_dashboard_invites_data_list
:members:
:show-inheritance:

shared\_dashboard\_invites\_data\_object
----------------------------------------

Expand Down Expand Up @@ -2990,6 +3088,13 @@ slack\_integration\_channel\_display
:members:
:show-inheritance:

slack\_integration\_channels
----------------------------

.. automodule:: datadog_api_client.v1.model.slack_integration_channels
:members:
:show-inheritance:

slo\_bulk\_delete
-----------------

Expand Down Expand Up @@ -4061,6 +4166,13 @@ synthetics\_private\_location\_secrets\_config\_decryption
:members:
:show-inheritance:

synthetics\_restricted\_roles
-----------------------------

.. automodule:: datadog_api_client.v1.model.synthetics_restricted_roles
:members:
:show-inheritance:

synthetics\_ssl\_certificate
----------------------------

Expand Down Expand Up @@ -4558,6 +4670,13 @@ usage\_analyzed\_logs\_response
:members:
:show-inheritance:

usage\_attribution\_aggregates
------------------------------

.. automodule:: datadog_api_client.v1.model.usage_attribution_aggregates
:members:
:show-inheritance:

usage\_attribution\_aggregates\_body
------------------------------------

Expand Down
Loading