Skip to content

Add template_variables to Notebook API spec #3725

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

Open
api-clients-generation-pipeline wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add template_variables to Notebook API spec #3725

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
63 changes: 63 additions & 0 deletions .generator/schemas/v1/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10354,6 +10354,16 @@ components:
type: string
status:
$ref: '#/components/schemas/NotebookStatus'
template_variables:
description: List of template variables for this notebook.
example:
- available_values: []
default: '*'
name: host
prefix: host
items:
$ref: '#/components/schemas/NotebookTemplateVariable'
type: array
time:
$ref: '#/components/schemas/NotebookGlobalTime'
required:
Expand Down Expand Up @@ -10657,6 +10667,39 @@ components:
type: string
x-enum-varnames:
- PUBLISHED
NotebookTemplateVariable:
description: Template variable for a notebook.
properties:
available_values:
description: The list of values that the template variable drop-down is
limited to.
example:
- my-host
- host1
- host2
items:
description: Template variable value.
type: string
nullable: true
type: array
default:
description: The default value for the template variable.
example: '*'
nullable: true
type: string
name:
description: The name of the variable.
example: host
type: string
prefix:
description: The tag prefix associated with the variable. Only tags with
this prefix appear in the variable drop-down.
example: host
nullable: true
type: string
required:
- name
type: object
NotebookTimeseriesCellAttributes:
description: The attributes of a notebook `timeseries` cell.
properties:
Expand Down Expand Up @@ -10760,6 +10803,16 @@ components:
type: string
status:
$ref: '#/components/schemas/NotebookStatus'
template_variables:
description: List of template variables for this notebook.
example:
- available_values: []
default: '*'
name: host
prefix: host
items:
$ref: '#/components/schemas/NotebookTemplateVariable'
type: array
time:
$ref: '#/components/schemas/NotebookGlobalTime'
required:
Expand Down Expand Up @@ -10836,6 +10889,16 @@ components:
type: string
status:
$ref: '#/components/schemas/NotebookStatus'
template_variables:
description: List of template variables for this notebook.
example:
- available_values: []
default: '*'
name: host
prefix: host
items:
$ref: '#/components/schemas/NotebookTemplateVariable'
type: array
time:
$ref: '#/components/schemas/NotebookGlobalTime'
required:
Expand Down
97 changes: 0 additions & 97 deletions .generator/schemas/v2/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32179,53 +32179,6 @@ components:
type: string
type: array
type: object
Integration:
description: Integration resource object.
properties:
attributes:
$ref: '#/components/schemas/IntegrationAttributes'
id:
description: The unique identifier of the integration.
example: calico
type: string
links:
$ref: '#/components/schemas/IntegrationLinks'
type:
$ref: '#/components/schemas/IntegrationType'
required:
- type
- id
- attributes
type: object
IntegrationAttributes:
description: Attributes for an integration.
properties:
categories:
description: List of categories associated with the integration.
example:
- Category::Kubernetes
- Category::Log Collection
items:
type: string
type: array
description:
description: A description of the integration.
example: Calico is a networking and network security solution for containers.
type: string
installed:
description: Whether the integration is installed.
example: true
type: boolean
title:
description: The name of the integration.
example: calico
type: string
required:
- title
- description
- categories
- installed
type: object
IntegrationIncident:
description: Incident integration settings
properties:
Expand Down Expand Up @@ -32331,14 +32284,6 @@ components:
value:
$ref: '#/components/schemas/AnyValue'
type: object
IntegrationLinks:
description: Links for the integration resource.
properties:
self:
description: Link to the integration resource.
example: /integrations?integrationId=calico
type: string
type: object
IntegrationMonitor:
description: Monitor integration settings
properties:
Expand Down Expand Up @@ -32440,15 +32385,6 @@ components:
type: string
type: object
type: object
IntegrationType:
default: integration
description: Integration resource type.
enum:
- integration
example: integration
type: string
x-enum-varnames:
- INTEGRATION
InterfaceAttributes:
description: The interface attributes
properties:
Expand Down Expand Up @@ -34840,17 +34776,6 @@ components:
- data
- meta
type: object
ListIntegrationsResponse:
description: Response containing information about multiple integrations.
properties:
data:
description: Array of integration objects.
items:
$ref: '#/components/schemas/Integration'
type: array
required:
- data
type: object
ListInterfaceTagsResponse:
description: Response for listing interface tags.
properties:
Expand Down Expand Up @@ -84280,24 +84205,6 @@ paths:
x-unstable: '**Note**: This endpoint is in public beta and is subject to change.

If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
/api/v2/integrations:
get:
operationId: ListIntegrations
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ListIntegrationsResponse'
description: Successful Response.
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
security:
- apiKeyAuth: []
appKeyAuth: []
summary: List Integrations
tags:
- Integrations
/api/v2/integrations/cloudflare/accounts:
get:
description: List Cloudflare accounts.
Expand Down Expand Up @@ -106381,10 +106288,6 @@ tags:
and todos. See the [Incident Management page](https://docs.datadoghq.com/service_management/incident_management/)
for more information.
name: Incidents
- description: 'The Integrations API is used to list available integrations

and retrieve information about their installation status.'
name: Integrations
- description: Manage your Jira Integration. Atlassian Jira is a project management
and issue tracking tool for teams to coordinate work and handle tasks efficiently.
name: Jira Integration
Expand Down
47 changes: 41 additions & 6 deletions api/datadogV1/model_notebook_create_data_attributes.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ type NotebookCreateDataAttributes struct {
Name string `json:"name"`
// Publication status of the notebook. For now, always "published".
Status *NotebookStatus `json:"status,omitempty"`
// List of template variables for this notebook.
TemplateVariables []NotebookTemplateVariable `json:"template_variables,omitempty"`
// Notebook global timeframe.
Time NotebookGlobalTime `json:"time"`
// UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct
Expand Down Expand Up @@ -153,6 +155,34 @@ func (o *NotebookCreateDataAttributes) SetStatus(v NotebookStatus) {
o.Status = &v
}

// GetTemplateVariables returns the TemplateVariables field value if set, zero value otherwise.
func (o *NotebookCreateDataAttributes) GetTemplateVariables() []NotebookTemplateVariable {
if o == nil || o.TemplateVariables == nil {
var ret []NotebookTemplateVariable
return ret
}
return o.TemplateVariables
}

// GetTemplateVariablesOk returns a tuple with the TemplateVariables field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *NotebookCreateDataAttributes) GetTemplateVariablesOk() (*[]NotebookTemplateVariable, bool) {
if o == nil || o.TemplateVariables == nil {
return nil, false
}
return &o.TemplateVariables, true
}

// HasTemplateVariables returns a boolean if a field has been set.
func (o *NotebookCreateDataAttributes) HasTemplateVariables() bool {
return o != nil && o.TemplateVariables != nil
}

// SetTemplateVariables gets a reference to the given []NotebookTemplateVariable and assigns it to the TemplateVariables field.
func (o *NotebookCreateDataAttributes) SetTemplateVariables(v []NotebookTemplateVariable) {
o.TemplateVariables = v
}

// GetTime returns the Time field value.
func (o *NotebookCreateDataAttributes) GetTime() NotebookGlobalTime {
if o == nil {
Expand Down Expand Up @@ -190,6 +220,9 @@ func (o NotebookCreateDataAttributes) MarshalJSON() ([]byte, error) {
if o.Status != nil {
toSerialize["status"] = o.Status
}
if o.TemplateVariables != nil {
toSerialize["template_variables"] = o.TemplateVariables
}
toSerialize["time"] = o.Time

for key, value := range o.AdditionalProperties {
Expand All @@ -201,11 +234,12 @@ func (o NotebookCreateDataAttributes) MarshalJSON() ([]byte, error) {
// UnmarshalJSON deserializes the given payload.
func (o *NotebookCreateDataAttributes) UnmarshalJSON(bytes []byte) (err error) {
all := struct {
Cells *[]NotebookCellCreateRequest `json:"cells"`
Metadata *NotebookMetadata `json:"metadata,omitempty"`
Name *string `json:"name"`
Status *NotebookStatus `json:"status,omitempty"`
Time *NotebookGlobalTime `json:"time"`
Cells *[]NotebookCellCreateRequest `json:"cells"`
Metadata *NotebookMetadata `json:"metadata,omitempty"`
Name *string `json:"name"`
Status *NotebookStatus `json:"status,omitempty"`
TemplateVariables []NotebookTemplateVariable `json:"template_variables,omitempty"`
Time *NotebookGlobalTime `json:"time"`
}{}
if err = datadog.Unmarshal(bytes, &all); err != nil {
return datadog.Unmarshal(bytes, &o.UnparsedObject)
Expand All @@ -221,7 +255,7 @@ func (o *NotebookCreateDataAttributes) UnmarshalJSON(bytes []byte) (err error) {
}
additionalProperties := make(map[string]interface{})
if err = datadog.Unmarshal(bytes, &additionalProperties); err == nil {
datadog.DeleteKeys(additionalProperties, &[]string{"cells", "metadata", "name", "status", "time"})
datadog.DeleteKeys(additionalProperties, &[]string{"cells", "metadata", "name", "status", "template_variables", "time"})
} else {
return err
}
Expand All @@ -238,6 +272,7 @@ func (o *NotebookCreateDataAttributes) UnmarshalJSON(bytes []byte) (err error) {
} else {
o.Status = all.Status
}
o.TemplateVariables = all.TemplateVariables
o.Time = *all.Time

if len(additionalProperties) > 0 {
Expand Down
Loading
Loading