grafana/pkg/kinds/playlist/crd/playlist.crd.yml
Ryan McKinley e70d623f90
Schemas: Generate CRDs for core kinds (#62641)
Co-authored-by: sam boyer <sdboyer@grafana.com>
2023-02-01 09:08:26 -08:00

83 lines
4.0 KiB
YAML

# Code generated - EDITING IS FUTILE. DO NOT EDIT.
#
# Generated by:
# kinds/gen.go
# Using jennies:
# YamlCRDJenny
#
# Run 'make gen-cue' from repository root to regenerate.
kind: CustomResourceDefinition
apiVersion: apiextensions.k8s.io/v1
metadata:
name: playlists.playlist.core.grafana.com
spec:
group: playlist.core.grafana.com
versions:
- name: v0-0alpha1
served: true
storage: true
schema:
openAPIV3Schema:
properties:
spec:
properties:
interval:
default: 5m
description: |-
Interval sets the time between switching views in a playlist.
FIXME: Is this based on a standardized format or what options are available? Can datemath be used?
type: string
items:
description: |-
The ordered list of items that the playlist will iterate over.
FIXME! This should not be optional, but changing it makes the godegen awkward
items:
properties:
title:
description: Title is an unused property -- it will be removed in the future
type: string
type:
description: Type of the item.
enum:
- dashboard_by_uid
- dashboard_by_id
- dashboard_by_tag
type: string
value:
description: |-
Value depends on type and describes the playlist item.
- dashboard_by_id: The value is an internal numerical identifier set by Grafana. This
is not portable as the numerical identifier is non-deterministic between different instances.
Will be replaced by dashboard_by_uid in the future. (deprecated)
- dashboard_by_tag: The value is a tag which is set on any number of dashboards. All
dashboards behind the tag will be added to the playlist.
- dashboard_by_uid: The value is the dashboard UID
type: string
required:
- type
- value
type: object
type: array
name:
description: Name of the playlist.
type: string
uid:
description: |-
Unique playlist identifier. Generated on creation, either by the
creator of the playlist of by the application.
type: string
required:
- uid
- name
- interval
type: object
required:
- spec
type: object
names:
kind: Playlist
plural: playlists
scope: Namespaced