Skip to content

Commit

Permalink
Add run workflow widget to dashboard schema (#1309)
Browse files Browse the repository at this point in the history
* Regenerate client from commit 0563dbc3 of spec repo

* pre-commit fixes

---------

Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
Co-authored-by: skarimo <40482491+skarimo@users.noreply.github.com> 2362296
  • Loading branch information
skarimo and ci.datadog-api-spec committed Feb 1, 2023
1 parent e70419c commit bb153ab
Show file tree
Hide file tree
Showing 8 changed files with 203 additions and 5 deletions.
21 changes: 21 additions & 0 deletions _sources/datadog_api_client.v1.model.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2570,6 +2570,27 @@ response\_meta\_attributes
:members:
:show-inheritance:

run\_workflow\_widget\_definition
---------------------------------

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

run\_workflow\_widget\_definition\_type
---------------------------------------

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

run\_workflow\_widget\_input
----------------------------

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

scatter\_plot\_request
----------------------

Expand Down
12 changes: 12 additions & 0 deletions datadog_api_client.html
Original file line number Diff line number Diff line change
Expand Up @@ -2633,6 +2633,18 @@ <h1 id="datadog-api-client--page-root">datadog_api_client<a class="headerlink" h
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v1.model.html#datadog_api_client.v1.model.response_meta_attributes.ResponseMetaAttributes"><code class="docutils literal notranslate"><span class="pre">ResponseMetaAttributes</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v1.model.html#module-datadog_api_client.v1.model.run_workflow_widget_definition">run_workflow_widget_definition</a><ul>
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v1.model.html#datadog_api_client.v1.model.run_workflow_widget_definition.RunWorkflowWidgetDefinition"><code class="docutils literal notranslate"><span class="pre">RunWorkflowWidgetDefinition</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v1.model.html#module-datadog_api_client.v1.model.run_workflow_widget_definition_type">run_workflow_widget_definition_type</a><ul>
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v1.model.html#datadog_api_client.v1.model.run_workflow_widget_definition_type.RunWorkflowWidgetDefinitionType"><code class="docutils literal notranslate"><span class="pre">RunWorkflowWidgetDefinitionType</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v1.model.html#module-datadog_api_client.v1.model.run_workflow_widget_input">run_workflow_widget_input</a><ul>
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v1.model.html#datadog_api_client.v1.model.run_workflow_widget_input.RunWorkflowWidgetInput"><code class="docutils literal notranslate"><span class="pre">RunWorkflowWidgetInput</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v1.model.html#module-datadog_api_client.v1.model.scatter_plot_request">scatter_plot_request</a><ul>
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v1.model.html#datadog_api_client.v1.model.scatter_plot_request.ScatterPlotRequest"><code class="docutils literal notranslate"><span class="pre">ScatterPlotRequest</span></code></a></li>
</ul>
Expand Down
12 changes: 12 additions & 0 deletions datadog_api_client.v1.html
Original file line number Diff line number Diff line change
Expand Up @@ -2543,6 +2543,18 @@ <h1 id="datadog-api-client-v1--page-root">datadog_api_client.v1<a class="headerl
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v1.model.html#datadog_api_client.v1.model.response_meta_attributes.ResponseMetaAttributes"><code class="docutils literal notranslate"><span class="pre">ResponseMetaAttributes</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="datadog_api_client.v1.model.html#module-datadog_api_client.v1.model.run_workflow_widget_definition">run_workflow_widget_definition</a><ul>
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v1.model.html#datadog_api_client.v1.model.run_workflow_widget_definition.RunWorkflowWidgetDefinition"><code class="docutils literal notranslate"><span class="pre">RunWorkflowWidgetDefinition</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="datadog_api_client.v1.model.html#module-datadog_api_client.v1.model.run_workflow_widget_definition_type">run_workflow_widget_definition_type</a><ul>
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v1.model.html#datadog_api_client.v1.model.run_workflow_widget_definition_type.RunWorkflowWidgetDefinitionType"><code class="docutils literal notranslate"><span class="pre">RunWorkflowWidgetDefinitionType</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="datadog_api_client.v1.model.html#module-datadog_api_client.v1.model.run_workflow_widget_input">run_workflow_widget_input</a><ul>
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v1.model.html#datadog_api_client.v1.model.run_workflow_widget_input.RunWorkflowWidgetInput"><code class="docutils literal notranslate"><span class="pre">RunWorkflowWidgetInput</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="datadog_api_client.v1.model.html#module-datadog_api_client.v1.model.scatter_plot_request">scatter_plot_request</a><ul>
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v1.model.html#datadog_api_client.v1.model.scatter_plot_request.ScatterPlotRequest"><code class="docutils literal notranslate"><span class="pre">ScatterPlotRequest</span></code></a></li>
</ul>
Expand Down
105 changes: 105 additions & 0 deletions datadog_api_client.v1.model.html
Original file line number Diff line number Diff line change
Expand Up @@ -2445,6 +2445,24 @@
</li></ul>
</nav>
</li>
<li class="md-nav__item"><a href="#module-datadog_api_client.v1.model.run_workflow_widget_definition" class="md-nav__link">run_workflow_widget_definition</a><nav class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item"><a href="#datadog_api_client.v1.model.run_workflow_widget_definition.RunWorkflowWidgetDefinition" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">RunWorkflowWidgetDefinition</span></code></a>
</li></ul>
</nav>
</li>
<li class="md-nav__item"><a href="#module-datadog_api_client.v1.model.run_workflow_widget_definition_type" class="md-nav__link">run_workflow_widget_definition_type</a><nav class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item"><a href="#datadog_api_client.v1.model.run_workflow_widget_definition_type.RunWorkflowWidgetDefinitionType" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">RunWorkflowWidgetDefinitionType</span></code></a>
</li></ul>
</nav>
</li>
<li class="md-nav__item"><a href="#module-datadog_api_client.v1.model.run_workflow_widget_input" class="md-nav__link">run_workflow_widget_input</a><nav class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item"><a href="#datadog_api_client.v1.model.run_workflow_widget_input.RunWorkflowWidgetInput" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">RunWorkflowWidgetInput</span></code></a>
</li></ul>
</nav>
</li>
<li class="md-nav__item"><a href="#module-datadog_api_client.v1.model.scatter_plot_request" class="md-nav__link">scatter_plot_request</a><nav class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item"><a href="#datadog_api_client.v1.model.scatter_plot_request.ScatterPlotRequest" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">ScatterPlotRequest</span></code></a>
Expand Down Expand Up @@ -7516,6 +7534,24 @@
</li></ul>
</nav>
</li>
<li class="md-nav__item"><a href="#module-datadog_api_client.v1.model.run_workflow_widget_definition" class="md-nav__link">run_workflow_widget_definition</a><nav class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item"><a href="#datadog_api_client.v1.model.run_workflow_widget_definition.RunWorkflowWidgetDefinition" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">RunWorkflowWidgetDefinition</span></code></a>
</li></ul>
</nav>
</li>
<li class="md-nav__item"><a href="#module-datadog_api_client.v1.model.run_workflow_widget_definition_type" class="md-nav__link">run_workflow_widget_definition_type</a><nav class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item"><a href="#datadog_api_client.v1.model.run_workflow_widget_definition_type.RunWorkflowWidgetDefinitionType" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">RunWorkflowWidgetDefinitionType</span></code></a>
</li></ul>
</nav>
</li>
<li class="md-nav__item"><a href="#module-datadog_api_client.v1.model.run_workflow_widget_input" class="md-nav__link">run_workflow_widget_input</a><nav class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item"><a href="#datadog_api_client.v1.model.run_workflow_widget_input.RunWorkflowWidgetInput" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">RunWorkflowWidgetInput</span></code></a>
</li></ul>
</nav>
</li>
<li class="md-nav__item"><a href="#module-datadog_api_client.v1.model.scatter_plot_request" class="md-nav__link">scatter_plot_request</a><nav class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item"><a href="#datadog_api_client.v1.model.scatter_plot_request.ScatterPlotRequest" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">ScatterPlotRequest</span></code></a>
Expand Down Expand Up @@ -18102,6 +18138,73 @@ <h1 id="datadog-api-client-v1-model--page-root">datadog_api_client.v1.model<a cl
</dl>
</dd></dl>
</section>
<section id="module-datadog_api_client.v1.model.run_workflow_widget_definition">
<span id="run-workflow-widget-definition"></span><h2 id="module-datadog_api_client.v1.model.run_workflow_widget_definition">run_workflow_widget_definition<a class="headerlink" href="#module-datadog_api_client.v1.model.run_workflow_widget_definition" title="Permalink to this heading">¶</a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="datadog_api_client.v1.model.run_workflow_widget_definition.RunWorkflowWidgetDefinition">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">RunWorkflowWidgetDefinition</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datadog_api_client.v1.model.run_workflow_widget_definition.RunWorkflowWidgetDefinition" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="datadog_api_client.html#datadog_api_client.model_utils.ModelNormal" title="datadog_api_client.model_utils.ModelNormal"><code class="xref py py-class docutils literal notranslate"><span class="pre">ModelNormal</span></code></a></p>
<p>Run workflow is widget that allows you to run a workflow from a dashboard.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>custom_links</strong> (<em>[</em><a class="reference internal" href="#datadog_api_client.v1.model.widget_custom_link.WidgetCustomLink" title="datadog_api_client.v1.model.widget_custom_link.WidgetCustomLink"><em>WidgetCustomLink</em></a><em>]</em><em>, </em><em>optional</em>) – List of custom links.</p></li>
<li><p><strong>inputs</strong> (<em>[</em><a class="reference internal" href="#datadog_api_client.v1.model.run_workflow_widget_input.RunWorkflowWidgetInput" title="datadog_api_client.v1.model.run_workflow_widget_input.RunWorkflowWidgetInput"><em>RunWorkflowWidgetInput</em></a><em>]</em><em>, </em><em>optional</em>) – Array of workflow inputs to map to dashboard template variables.</p></li>
<li><p><strong>time</strong> (<a class="reference internal" href="#datadog_api_client.v1.model.widget_time.WidgetTime" title="datadog_api_client.v1.model.widget_time.WidgetTime"><em>WidgetTime</em></a><em>, </em><em>optional</em>) – Time setting for the widget.</p></li>
<li><p><strong>title</strong> (<em>str</em><em>, </em><em>optional</em>) – Title of your widget.</p></li>
<li><p><strong>title_align</strong> (<a class="reference internal" href="#datadog_api_client.v1.model.widget_text_align.WidgetTextAlign" title="datadog_api_client.v1.model.widget_text_align.WidgetTextAlign"><em>WidgetTextAlign</em></a><em>, </em><em>optional</em>) – How to align the text on the widget.</p></li>
<li><p><strong>title_size</strong> (<em>str</em><em>, </em><em>optional</em>) – Size of the title.</p></li>
<li><p><strong>type</strong> (<a class="reference internal" href="#datadog_api_client.v1.model.run_workflow_widget_definition_type.RunWorkflowWidgetDefinitionType" title="datadog_api_client.v1.model.run_workflow_widget_definition_type.RunWorkflowWidgetDefinitionType"><em>RunWorkflowWidgetDefinitionType</em></a>) – Type of the run workflow widget.</p></li>
<li><p><strong>workflow_id</strong> (<em>str</em>) – Workflow id.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</section>
<section id="module-datadog_api_client.v1.model.run_workflow_widget_definition_type">
<span id="run-workflow-widget-definition-type"></span><h2 id="module-datadog_api_client.v1.model.run_workflow_widget_definition_type">run_workflow_widget_definition_type<a class="headerlink" href="#module-datadog_api_client.v1.model.run_workflow_widget_definition_type" title="Permalink to this heading">¶</a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="datadog_api_client.v1.model.run_workflow_widget_definition_type.RunWorkflowWidgetDefinitionType">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">RunWorkflowWidgetDefinitionType</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datadog_api_client.v1.model.run_workflow_widget_definition_type.RunWorkflowWidgetDefinitionType" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="datadog_api_client.html#datadog_api_client.model_utils.ModelSimple" title="datadog_api_client.model_utils.ModelSimple"><code class="xref py py-class docutils literal notranslate"><span class="pre">ModelSimple</span></code></a></p>
<p>Type of the run workflow widget.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>value</strong> (<em>str</em>) – If omitted defaults to “run_workflow”. Must be one of [“run_workflow”].</p></li>
<li><p><strong>_check_type</strong> (<em>bool</em>) – 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.</p></li>
<li><p><strong>_path_to_item</strong> (<em>tuple/list</em>) – This is a list of keys or values to drill down to
the model in received_data when deserializing a response.</p></li>
<li><p><strong>_spec_property_naming</strong> (<em>bool</em>) – 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).</p></li>
<li><p><strong>_configuration</strong> (<a class="reference internal" href="datadog_api_client.html#datadog_api_client.configuration.Configuration" title="datadog_api_client.configuration.Configuration"><em>Configuration</em></a>) – The instance to use when deserializing a
file_type parameter. If passed, type conversion is attempted If omitted no
type conversion is done.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</section>
<section id="module-datadog_api_client.v1.model.run_workflow_widget_input">
<span id="run-workflow-widget-input"></span><h2 id="module-datadog_api_client.v1.model.run_workflow_widget_input">run_workflow_widget_input<a class="headerlink" href="#module-datadog_api_client.v1.model.run_workflow_widget_input" title="Permalink to this heading">¶</a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="datadog_api_client.v1.model.run_workflow_widget_input.RunWorkflowWidgetInput">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">RunWorkflowWidgetInput</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datadog_api_client.v1.model.run_workflow_widget_input.RunWorkflowWidgetInput" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="datadog_api_client.html#datadog_api_client.model_utils.ModelNormal" title="datadog_api_client.model_utils.ModelNormal"><code class="xref py py-class docutils literal notranslate"><span class="pre">ModelNormal</span></code></a></p>
<p>Object to map a dashboard template variable to a workflow input.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> (<em>str</em>) – Name of the workflow input.</p></li>
<li><p><strong>value</strong> (<em>str</em>) – Dashboard template variable. Can be suffixed with ‘.value’ or ‘.key’.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</section>
<section id="module-datadog_api_client.v1.model.scatter_plot_request">
<span id="scatter-plot-request"></span><h2 id="module-datadog_api_client.v1.model.scatter_plot_request">scatter_plot_request<a class="headerlink" href="#module-datadog_api_client.v1.model.scatter_plot_request" title="Permalink to this heading">¶</a></h2>
<dl class="py class">
Expand Down Expand Up @@ -26560,6 +26663,8 @@ <h1 id="datadog-api-client-v1-model--page-root">datadog_api_client.v1.model<a cl
<li><p><strong>autoscale</strong> (<em>bool</em><em>, </em><em>optional</em>) – Whether to use auto-scaling or not.</p></li>
<li><p><strong>custom_unit</strong> (<em>str</em><em>, </em><em>optional</em>) – Display a unit of your choice on the widget.</p></li>
<li><p><strong>timeseries_background</strong> (<a class="reference internal" href="#datadog_api_client.v1.model.timeseries_background.TimeseriesBackground" title="datadog_api_client.v1.model.timeseries_background.TimeseriesBackground"><em>TimeseriesBackground</em></a><em>, </em><em>optional</em>) – Set a timeseries on the widget background.</p></li>
<li><p><strong>inputs</strong> (<em>[</em><a class="reference internal" href="#datadog_api_client.v1.model.run_workflow_widget_input.RunWorkflowWidgetInput" title="datadog_api_client.v1.model.run_workflow_widget_input.RunWorkflowWidgetInput"><em>RunWorkflowWidgetInput</em></a><em>]</em><em>, </em><em>optional</em>) – Array of workflow inputs to map to dashboard template variables.</p></li>
<li><p><strong>workflow_id</strong> (<em>str</em>) – Workflow id.</p></li>
<li><p><strong>color_by_groups</strong> (<em>[</em><em>str</em><em>]</em><em>, </em><em>optional</em>) – List of groups used for colors.</p></li>
<li><p><strong>global_time_target</strong> (<em>str</em><em>, </em><em>optional</em>) – Defined global time target.</p></li>
<li><p><strong>show_error_budget</strong> (<em>bool</em><em>, </em><em>optional</em>) – Defined error budget.</p></li>
Expand Down
Loading

0 comments on commit bb153ab

Please sign in to comment.