From ff10a10f2fb7880410ac63da80ffc16fd1337fb0 Mon Sep 17 00:00:00 2001 From: mikaello <2505178+mikaello@users.noreply.github.com> Date: Tue, 5 Mar 2024 14:22:32 +0000 Subject: [PATCH] chore: update deps --- .gitignore | 1 + jsonnetfile.lock.json | 58 +- vendor/crdsonnet | 1 - vendor/doc-util | 1 - .../crdsonnet/crdsonnet/dynamic.libsonnet | 143 - .../crdsonnet/example/example_schema.json | 52 - .../crdsonnet/crdsonnet/crdsonnet/example/jso | 18 - .../crdsonnet/example/json_schema.libsonnet | 18 - .../example/json_schema_simple.libsonnet | 9 - .../example/json_schema_static.libsonnet | 9 - .../json_schema_static_output.libsonnet | 22 - .../example/json_schema_very_simple.libsonnet | 14 - .../json_schema_very_simple_static.libsonnet | 16 - ...json_schema_very_simple_validate.libsonnet | 18 - ...hema_very_simple_validate.libsonnet.output | 12 - .../crdsonnet/crdsonnet/helpers.libsonnet | 96 - .../crdsonnet/crdsonnet/jsonnetfile.json | 33 - .../crdsonnet/crdsonnet/main.libsonnet | 205 -- .../crdsonnet/crdsonnet/objectmeta.json | 141 - .../crdsonnet/crdsonnet/parser.libsonnet | 132 - .../crdsonnet/crdsonnet/processor.libsonnet | 87 - .../crdsonnet/crdsonnet/render.libsonnet | 207 -- .../crdsonnet/crdsonnet/resolver.libsonnet | 116 - .../crdsonnet/crdsonnet/schemadb.libsonnet | 44 - .../crdsonnet/crdsonnet/static.libsonnet | 131 - .../crdsonnet/validate-libsonnet/.gitignore | 2 - .../crdsonnet/validate-libsonnet/LICENSE | 201 -- .../crdsonnet/validate-libsonnet/Makefile | 3 - .../crdsonnet/validate-libsonnet/README.md | 212 -- .../example/fromdocstring.jsonnet | 22 - .../example/fromdocstring.jsonnet.output | 22 - .../example/jsonnetfile.json | 23 - .../example/samplechecks.jsonnet | 9 - .../validate-libsonnet/example/simple.jsonnet | 9 - .../example/simple.jsonnet.output | 8 - .../validate-libsonnet/jsonnetfile.json | 15 - .../validate-libsonnet/main.libsonnet | 178 -- .../validate-libsonnet/validate.libsonnet | 327 -- .../gen/grafonnet-latest/jsonnetfile.json | 15 - .../gen/grafonnet-latest/main.libsonnet | 1 - .../gen/grafonnet-v10.0.0/docs.libsonnet | 3 - .../gen/grafonnet-v10.0.0/docs/README.md | 29 - .../docs/grafonnet/dashboard/annotation.md | 217 -- .../docs/grafonnet/dashboard/index.md | 366 --- .../docs/grafonnet/dashboard/link.md | 134 - .../docs/grafonnet/dashboard/variable.md | 780 ----- .../docs/grafonnet/librarypanel.md | 256 -- .../panel/alertGroups/fieldOverride.md | 194 -- .../docs/grafonnet/panel/alertGroups/index.md | 497 ---- .../docs/grafonnet/panel/alertGroups/link.md | 109 - .../panel/alertGroups/thresholdStep.md | 47 - .../panel/alertGroups/transformation.md | 76 - .../panel/alertGroups/valueMapping.md | 365 --- .../panel/annotationsList/fieldOverride.md | 194 -- .../grafonnet/panel/annotationsList/index.md | 569 ---- .../grafonnet/panel/annotationsList/link.md | 109 - .../panel/annotationsList/thresholdStep.md | 47 - .../panel/annotationsList/transformation.md | 76 - .../panel/annotationsList/valueMapping.md | 365 --- .../grafonnet/panel/barChart/fieldOverride.md | 194 -- .../docs/grafonnet/panel/barChart/index.md | 1030 ------- .../docs/grafonnet/panel/barChart/link.md | 109 - .../grafonnet/panel/barChart/thresholdStep.md | 47 - .../panel/barChart/transformation.md | 76 - .../grafonnet/panel/barChart/valueMapping.md | 365 --- .../grafonnet/panel/barGauge/fieldOverride.md | 194 -- .../docs/grafonnet/panel/barGauge/index.md | 638 ---- .../docs/grafonnet/panel/barGauge/link.md | 109 - .../grafonnet/panel/barGauge/thresholdStep.md | 47 - .../panel/barGauge/transformation.md | 76 - .../grafonnet/panel/barGauge/valueMapping.md | 365 --- .../panel/candlestick/fieldOverride.md | 194 -- .../docs/grafonnet/panel/candlestick/index.md | 466 --- .../docs/grafonnet/panel/candlestick/link.md | 109 - .../panel/candlestick/thresholdStep.md | 47 - .../panel/candlestick/transformation.md | 76 - .../panel/candlestick/valueMapping.md | 365 --- .../grafonnet/panel/canvas/fieldOverride.md | 194 -- .../docs/grafonnet/panel/canvas/index.md | 466 --- .../docs/grafonnet/panel/canvas/link.md | 109 - .../grafonnet/panel/canvas/thresholdStep.md | 47 - .../grafonnet/panel/canvas/transformation.md | 76 - .../grafonnet/panel/canvas/valueMapping.md | 365 --- .../panel/dashboardList/fieldOverride.md | 194 -- .../grafonnet/panel/dashboardList/index.md | 569 ---- .../grafonnet/panel/dashboardList/link.md | 109 - .../panel/dashboardList/thresholdStep.md | 47 - .../panel/dashboardList/transformation.md | 76 - .../panel/dashboardList/valueMapping.md | 365 --- .../grafonnet/panel/datagrid/fieldOverride.md | 194 -- .../docs/grafonnet/panel/datagrid/index.md | 479 --- .../docs/grafonnet/panel/datagrid/link.md | 109 - .../grafonnet/panel/datagrid/thresholdStep.md | 47 - .../panel/datagrid/transformation.md | 76 - .../grafonnet/panel/datagrid/valueMapping.md | 365 --- .../grafonnet/panel/debug/fieldOverride.md | 194 -- .../docs/grafonnet/panel/debug/index.md | 530 ---- .../docs/grafonnet/panel/debug/link.md | 109 - .../grafonnet/panel/debug/thresholdStep.md | 47 - .../grafonnet/panel/debug/transformation.md | 76 - .../grafonnet/panel/debug/valueMapping.md | 365 --- .../grafonnet/panel/gauge/fieldOverride.md | 194 -- .../docs/grafonnet/panel/gauge/index.md | 606 ---- .../docs/grafonnet/panel/gauge/link.md | 109 - .../grafonnet/panel/gauge/thresholdStep.md | 47 - .../grafonnet/panel/gauge/transformation.md | 76 - .../grafonnet/panel/gauge/valueMapping.md | 365 --- .../grafonnet/panel/geomap/fieldOverride.md | 194 -- .../docs/grafonnet/panel/geomap/index.md | 1030 ------- .../docs/grafonnet/panel/geomap/link.md | 109 - .../grafonnet/panel/geomap/thresholdStep.md | 47 - .../grafonnet/panel/geomap/transformation.md | 76 - .../grafonnet/panel/geomap/valueMapping.md | 365 --- .../grafonnet/panel/heatmap/fieldOverride.md | 194 -- .../docs/grafonnet/panel/heatmap/index.md | 1420 --------- .../docs/grafonnet/panel/heatmap/link.md | 109 - .../grafonnet/panel/heatmap/thresholdStep.md | 47 - .../grafonnet/panel/heatmap/transformation.md | 76 - .../grafonnet/panel/heatmap/valueMapping.md | 365 --- .../panel/histogram/fieldOverride.md | 194 -- .../docs/grafonnet/panel/histogram/index.md | 874 ------ .../docs/grafonnet/panel/histogram/link.md | 109 - .../panel/histogram/thresholdStep.md | 47 - .../panel/histogram/transformation.md | 76 - .../grafonnet/panel/histogram/valueMapping.md | 365 --- .../docs/grafonnet/panel/index.md | 33 - .../grafonnet/panel/logs/fieldOverride.md | 194 -- .../docs/grafonnet/panel/logs/index.md | 546 ---- .../docs/grafonnet/panel/logs/link.md | 109 - .../grafonnet/panel/logs/thresholdStep.md | 47 - .../grafonnet/panel/logs/transformation.md | 76 - .../docs/grafonnet/panel/logs/valueMapping.md | 365 --- .../grafonnet/panel/news/fieldOverride.md | 194 -- .../docs/grafonnet/panel/news/index.md | 488 --- .../docs/grafonnet/panel/news/link.md | 109 - .../grafonnet/panel/news/thresholdStep.md | 47 - .../grafonnet/panel/news/transformation.md | 76 - .../docs/grafonnet/panel/news/valueMapping.md | 365 --- .../panel/nodeGraph/fieldOverride.md | 194 -- .../docs/grafonnet/panel/nodeGraph/index.md | 590 ---- .../docs/grafonnet/panel/nodeGraph/link.md | 109 - .../panel/nodeGraph/thresholdStep.md | 47 - .../panel/nodeGraph/transformation.md | 76 - .../grafonnet/panel/nodeGraph/valueMapping.md | 365 --- .../grafonnet/panel/pieChart/fieldOverride.md | 194 -- .../docs/grafonnet/panel/pieChart/index.md | 857 ------ .../docs/grafonnet/panel/pieChart/link.md | 109 - .../grafonnet/panel/pieChart/thresholdStep.md | 47 - .../panel/pieChart/transformation.md | 76 - .../grafonnet/panel/pieChart/valueMapping.md | 365 --- .../docs/grafonnet/panel/row.md | 187 -- .../grafonnet/panel/stat/fieldOverride.md | 194 -- .../docs/grafonnet/panel/stat/index.md | 632 ---- .../docs/grafonnet/panel/stat/link.md | 109 - .../grafonnet/panel/stat/thresholdStep.md | 47 - .../grafonnet/panel/stat/transformation.md | 76 - .../docs/grafonnet/panel/stat/valueMapping.md | 365 --- .../panel/stateTimeline/fieldOverride.md | 194 -- .../grafonnet/panel/stateTimeline/index.md | 764 ----- .../grafonnet/panel/stateTimeline/link.md | 109 - .../panel/stateTimeline/thresholdStep.md | 47 - .../panel/stateTimeline/transformation.md | 76 - .../panel/stateTimeline/valueMapping.md | 365 --- .../panel/statusHistory/fieldOverride.md | 194 -- .../grafonnet/panel/statusHistory/index.md | 755 ----- .../grafonnet/panel/statusHistory/link.md | 109 - .../panel/statusHistory/thresholdStep.md | 47 - .../panel/statusHistory/transformation.md | 76 - .../panel/statusHistory/valueMapping.md | 365 --- .../grafonnet/panel/table/fieldOverride.md | 194 -- .../docs/grafonnet/panel/table/index.md | 653 ---- .../docs/grafonnet/panel/table/link.md | 109 - .../grafonnet/panel/table/thresholdStep.md | 47 - .../grafonnet/panel/table/transformation.md | 76 - .../grafonnet/panel/table/valueMapping.md | 365 --- .../grafonnet/panel/text/fieldOverride.md | 194 -- .../docs/grafonnet/panel/text/index.md | 541 ---- .../docs/grafonnet/panel/text/link.md | 109 - .../grafonnet/panel/text/thresholdStep.md | 47 - .../grafonnet/panel/text/transformation.md | 76 - .../docs/grafonnet/panel/text/valueMapping.md | 365 --- .../panel/timeSeries/fieldOverride.md | 194 -- .../docs/grafonnet/panel/timeSeries/index.md | 1141 ------- .../docs/grafonnet/panel/timeSeries/link.md | 109 - .../panel/timeSeries/thresholdStep.md | 47 - .../panel/timeSeries/transformation.md | 76 - .../panel/timeSeries/valueMapping.md | 365 --- .../grafonnet/panel/trend/fieldOverride.md | 194 -- .../docs/grafonnet/panel/trend/index.md | 1132 ------- .../docs/grafonnet/panel/trend/link.md | 109 - .../grafonnet/panel/trend/thresholdStep.md | 47 - .../grafonnet/panel/trend/transformation.md | 76 - .../grafonnet/panel/trend/valueMapping.md | 365 --- .../grafonnet/panel/xyChart/fieldOverride.md | 194 -- .../docs/grafonnet/panel/xyChart/index.md | 1207 -------- .../docs/grafonnet/panel/xyChart/link.md | 109 - .../grafonnet/panel/xyChart/thresholdStep.md | 47 - .../grafonnet/panel/xyChart/transformation.md | 76 - .../grafonnet/panel/xyChart/valueMapping.md | 365 --- .../docs/grafonnet/playlist.md | 97 - .../docs/grafonnet/preferences.md | 85 - .../docs/grafonnet/publicdashboard.md | 62 - .../docs/grafonnet/query/azureMonitor.md | 1294 -------- .../docs/grafonnet/query/cloudWatch.md | 1082 ------- .../docs/grafonnet/query/elasticsearch.md | 2620 ----------------- .../docs/grafonnet/query/grafanaPyroscope.md | 97 - .../docs/grafonnet/query/index.md | 16 - .../docs/grafonnet/query/loki.md | 123 - .../docs/grafonnet/query/parca.md | 70 - .../docs/grafonnet/query/prometheus.md | 134 - .../docs/grafonnet/query/tempo.md | 217 -- .../docs/grafonnet/query/testData.md | 619 ---- .../docs/grafonnet/serviceaccount.md | 120 - .../grafonnet-v10.0.0/docs/grafonnet/team.md | 82 - .../grafonnet-v10.0.0/docs/grafonnet/util.md | 82 - .../gen/grafonnet-v10.0.0/grafana-version | 1 - .../gen/grafonnet-v10.0.0/jsonnetfile.json | 24 - .../gen/grafonnet-v10.0.0/main.libsonnet | 4 - .../gen/grafonnet-v10.0.0/schemas.libsonnet | 1 - .../grafonnet-base/helpers.libsonnet | 173 -- .../grafonnet/grafonnet-base/jsonnetfile.json | 15 - .../grafonnet/grafonnet-base/main.libsonnet | 346 --- .../grafonnet-base/util/dashboard.libsonnet | 56 - .../grafonnet-base/util/grid.libsonnet | 134 - .../grafonnet-base/util/main.libsonnet | 9 - .../grafonnet-base/util/panel.libsonnet | 51 - .../grafonnet-base/util/string.libsonnet | 27 - .../veneer/annotation.libsonnet | 12 - .../grafonnet-base/veneer/core.libsonnet | 313 -- .../grafonnet-base/veneer/link.libsonnet | 65 - .../grafonnet-base/veneer/main.libsonnet | 6 - .../grafonnet-base/veneer/panel.libsonnet | 226 -- .../grafonnet-base/veneer/query.libsonnet | 90 - .../grafonnet-base/veneer/row.libsonnet | 12 - .../grafonnet-base/veneer/variable.libsonnet | 459 --- .../grok/jsonnet/v10.0.0/imports.libsonnet | 50 - .../panelcfg/x/alertgroups_types_gen.json | 43 - .../panelcfg/x/annotationslist_types_gen.json | 82 - .../dataquery/x/azuremonitor_types_gen.json | 711 ----- .../panelcfg/x/barchart_types_gen.json | 505 ---- .../panelcfg/x/bargauge_types_gen.json | 172 -- .../dataquery/x/cloudwatch_types_gen.json | 632 ---- .../panelcfg/x/dashboardlist_types_gen.json | 78 - .../panelcfg/x/datagrid_types_gen.json | 35 - .../debug/panelcfg/x/debug_types_gen.json | 97 - .../dataquery/x/elasticsearch_types_gen.json | 1756 ----------- .../gauge/panelcfg/x/gauge_types_gen.json | 133 - .../geomap/panelcfg/x/geomap_types_gen.json | 349 --- .../x/grafanapyroscope_types_gen.json | 86 - .../heatmap/panelcfg/x/heatmap_types_gen.json | 853 ------ .../panelcfg/x/histogram_types_gen.json | 340 --- .../logs/panelcfg/x/logs_types_gen.json | 78 - .../loki/dataquery/x/loki_types_gen.json | 116 - .../news/panelcfg/x/news_types_gen.json | 34 - .../panelcfg/x/nodegraph_types_gen.json | 130 - .../parca/dataquery/x/parca_types_gen.json | 73 - .../panelcfg/x/piechart_types_gen.json | 388 --- .../dataquery/x/prometheus_types_gen.json | 100 - .../stat/panelcfg/x/stat_types_gen.json | 185 -- .../panelcfg/x/statetimeline_types_gen.json | 298 -- .../panelcfg/x/statushistory_types_gen.json | 281 -- .../table/panelcfg/x/table_types_gen.json | 205 -- .../tempo/dataquery/x/tempo_types_gen.json | 163 - .../dataquery/x/testdata_types_gen.json | 360 --- .../text/panelcfg/x/text_types_gen.json | 135 - .../panelcfg/x/timeseries_types_gen.json | 557 ---- .../trend/panelcfg/x/trend_types_gen.json | 528 ---- .../xychart/panelcfg/x/xychart_types_gen.json | 622 ---- .../core/dashboard/x/dashboard_types_gen.json | 1630 ---------- .../x/librarypanel_types_gen.json | 298 -- .../core/playlist/x/playlist_types_gen.json | 243 -- .../preferences/x/preferences_types_gen.json | 224 -- .../x/publicdashboard_types_gen.json | 222 -- .../x/serviceaccount_types_gen.json | 259 -- .../kinds/core/team/x/team_types_gen.json | 239 -- .../jsonnet-libs/docsonnet/doc-util/README.md | 231 -- .../docsonnet/doc-util/main.libsonnet | 218 -- .../docsonnet/doc-util/render.libsonnet | 401 --- vendor/github.com/jsonnet-libs/xtd/.gitignore | 3 - vendor/github.com/jsonnet-libs/xtd/LICENSE | 201 -- vendor/github.com/jsonnet-libs/xtd/Makefile | 16 - vendor/github.com/jsonnet-libs/xtd/README.md | 19 - .../jsonnet-libs/xtd/aggregate.libsonnet | 104 - .../jsonnet-libs/xtd/array.libsonnet | 37 - .../jsonnet-libs/xtd/ascii.libsonnet | 39 - .../jsonnet-libs/xtd/camelcase.libsonnet | 80 - .../jsonnet-libs/xtd/date.libsonnet | 58 - .../jsonnet-libs/xtd/docs/.gitignore | 2 - .../github.com/jsonnet-libs/xtd/docs/Gemfile | 2 - .../jsonnet-libs/xtd/docs/README.md | 27 - .../jsonnet-libs/xtd/docs/_config.yml | 2 - .../jsonnet-libs/xtd/docs/aggregate.md | 74 - .../github.com/jsonnet-libs/xtd/docs/array.md | 25 - .../github.com/jsonnet-libs/xtd/docs/ascii.md | 43 - .../jsonnet-libs/xtd/docs/camelcase.md | 29 - .../github.com/jsonnet-libs/xtd/docs/date.md | 45 - .../jsonnet-libs/xtd/docs/inspect.md | 64 - .../jsonnet-libs/xtd/docs/jsonpath.md | 53 - .../jsonnet-libs/xtd/docs/string.md | 26 - .../github.com/jsonnet-libs/xtd/docs/url.md | 34 - .../jsonnet-libs/xtd/inspect.libsonnet | 146 - .../jsonnet-libs/xtd/jsonpath.libsonnet | 142 - .../jsonnet-libs/xtd/main.libsonnet | 24 - .../jsonnet-libs/xtd/string.libsonnet | 35 - .../jsonnet-libs/xtd/test/array_test.jsonnet | 83 - .../xtd/test/camelcase_test.jsonnet | 137 - .../jsonnet-libs/xtd/test/date_test.jsonnet | 131 - .../xtd/test/inspect_test.jsonnet | 152 - .../jsonnet-libs/xtd/test/jsonnetfile.json | 15 - .../xtd/test/jsonpath_test.jsonnet | 305 -- .../jsonnet-libs/xtd/test/url_test.jsonnet | 75 - .../github.com/jsonnet-libs/xtd/url.libsonnet | 21 - vendor/grafonnet-base | 1 - vendor/grafonnet-latest | 1 - vendor/grafonnet-v10.0.0 | 1 - vendor/v10.0.0 | 1 - vendor/validate-libsonnet | 1 - vendor/xtd | 1 - 318 files changed, 10 insertions(+), 68100 deletions(-) create mode 100644 .gitignore delete mode 120000 vendor/crdsonnet delete mode 120000 vendor/doc-util delete mode 100644 vendor/github.com/crdsonnet/crdsonnet/crdsonnet/dynamic.libsonnet delete mode 100644 vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/example_schema.json delete mode 100644 vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/jso delete mode 100644 vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/json_schema.libsonnet delete mode 100644 vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/json_schema_simple.libsonnet delete mode 100644 vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/json_schema_static.libsonnet delete mode 100644 vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/json_schema_static_output.libsonnet delete mode 100644 vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/json_schema_very_simple.libsonnet delete mode 100644 vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/json_schema_very_simple_static.libsonnet delete mode 100644 vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/json_schema_very_simple_validate.libsonnet delete mode 100644 vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/json_schema_very_simple_validate.libsonnet.output delete mode 100644 vendor/github.com/crdsonnet/crdsonnet/crdsonnet/helpers.libsonnet delete mode 100644 vendor/github.com/crdsonnet/crdsonnet/crdsonnet/jsonnetfile.json delete mode 100644 vendor/github.com/crdsonnet/crdsonnet/crdsonnet/main.libsonnet delete mode 100644 vendor/github.com/crdsonnet/crdsonnet/crdsonnet/objectmeta.json delete mode 100644 vendor/github.com/crdsonnet/crdsonnet/crdsonnet/parser.libsonnet delete mode 100644 vendor/github.com/crdsonnet/crdsonnet/crdsonnet/processor.libsonnet delete mode 100644 vendor/github.com/crdsonnet/crdsonnet/crdsonnet/render.libsonnet delete mode 100644 vendor/github.com/crdsonnet/crdsonnet/crdsonnet/resolver.libsonnet delete mode 100644 vendor/github.com/crdsonnet/crdsonnet/crdsonnet/schemadb.libsonnet delete mode 100644 vendor/github.com/crdsonnet/crdsonnet/crdsonnet/static.libsonnet delete mode 100644 vendor/github.com/crdsonnet/validate-libsonnet/.gitignore delete mode 100644 vendor/github.com/crdsonnet/validate-libsonnet/LICENSE delete mode 100644 vendor/github.com/crdsonnet/validate-libsonnet/Makefile delete mode 100644 vendor/github.com/crdsonnet/validate-libsonnet/README.md delete mode 100644 vendor/github.com/crdsonnet/validate-libsonnet/example/fromdocstring.jsonnet delete mode 100644 vendor/github.com/crdsonnet/validate-libsonnet/example/fromdocstring.jsonnet.output delete mode 100644 vendor/github.com/crdsonnet/validate-libsonnet/example/jsonnetfile.json delete mode 100644 vendor/github.com/crdsonnet/validate-libsonnet/example/samplechecks.jsonnet delete mode 100644 vendor/github.com/crdsonnet/validate-libsonnet/example/simple.jsonnet delete mode 100644 vendor/github.com/crdsonnet/validate-libsonnet/example/simple.jsonnet.output delete mode 100644 vendor/github.com/crdsonnet/validate-libsonnet/jsonnetfile.json delete mode 100644 vendor/github.com/crdsonnet/validate-libsonnet/main.libsonnet delete mode 100644 vendor/github.com/crdsonnet/validate-libsonnet/validate.libsonnet delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-latest/jsonnetfile.json delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-latest/main.libsonnet delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs.libsonnet delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/README.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/dashboard/annotation.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/dashboard/index.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/dashboard/link.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/dashboard/variable.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/librarypanel.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/alertGroups/fieldOverride.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/alertGroups/index.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/alertGroups/link.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/alertGroups/thresholdStep.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/alertGroups/transformation.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/alertGroups/valueMapping.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/annotationsList/fieldOverride.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/annotationsList/index.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/annotationsList/link.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/annotationsList/thresholdStep.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/annotationsList/transformation.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/annotationsList/valueMapping.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barChart/fieldOverride.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barChart/index.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barChart/link.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barChart/thresholdStep.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barChart/transformation.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barChart/valueMapping.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barGauge/fieldOverride.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barGauge/index.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barGauge/link.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barGauge/thresholdStep.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barGauge/transformation.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barGauge/valueMapping.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/candlestick/fieldOverride.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/candlestick/index.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/candlestick/link.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/candlestick/thresholdStep.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/candlestick/transformation.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/candlestick/valueMapping.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/canvas/fieldOverride.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/canvas/index.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/canvas/link.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/canvas/thresholdStep.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/canvas/transformation.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/canvas/valueMapping.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/dashboardList/fieldOverride.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/dashboardList/index.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/dashboardList/link.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/dashboardList/thresholdStep.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/dashboardList/transformation.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/dashboardList/valueMapping.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/datagrid/fieldOverride.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/datagrid/index.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/datagrid/link.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/datagrid/thresholdStep.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/datagrid/transformation.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/datagrid/valueMapping.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/debug/fieldOverride.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/debug/index.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/debug/link.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/debug/thresholdStep.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/debug/transformation.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/debug/valueMapping.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/gauge/fieldOverride.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/gauge/index.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/gauge/link.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/gauge/thresholdStep.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/gauge/transformation.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/gauge/valueMapping.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/geomap/fieldOverride.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/geomap/index.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/geomap/link.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/geomap/thresholdStep.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/geomap/transformation.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/geomap/valueMapping.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/heatmap/fieldOverride.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/heatmap/index.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/heatmap/link.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/heatmap/thresholdStep.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/heatmap/transformation.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/heatmap/valueMapping.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/histogram/fieldOverride.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/histogram/index.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/histogram/link.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/histogram/thresholdStep.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/histogram/transformation.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/histogram/valueMapping.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/index.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/logs/fieldOverride.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/logs/index.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/logs/link.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/logs/thresholdStep.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/logs/transformation.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/logs/valueMapping.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/news/fieldOverride.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/news/index.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/news/link.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/news/thresholdStep.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/news/transformation.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/news/valueMapping.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/nodeGraph/fieldOverride.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/nodeGraph/index.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/nodeGraph/link.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/nodeGraph/thresholdStep.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/nodeGraph/transformation.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/nodeGraph/valueMapping.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/pieChart/fieldOverride.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/pieChart/index.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/pieChart/link.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/pieChart/thresholdStep.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/pieChart/transformation.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/pieChart/valueMapping.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/row.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stat/fieldOverride.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stat/index.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stat/link.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stat/thresholdStep.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stat/transformation.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stat/valueMapping.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stateTimeline/fieldOverride.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stateTimeline/index.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stateTimeline/link.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stateTimeline/thresholdStep.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stateTimeline/transformation.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stateTimeline/valueMapping.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/statusHistory/fieldOverride.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/statusHistory/index.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/statusHistory/link.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/statusHistory/thresholdStep.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/statusHistory/transformation.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/statusHistory/valueMapping.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/table/fieldOverride.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/table/index.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/table/link.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/table/thresholdStep.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/table/transformation.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/table/valueMapping.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/text/fieldOverride.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/text/index.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/text/link.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/text/thresholdStep.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/text/transformation.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/text/valueMapping.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/timeSeries/fieldOverride.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/timeSeries/index.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/timeSeries/link.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/timeSeries/thresholdStep.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/timeSeries/transformation.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/timeSeries/valueMapping.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/trend/fieldOverride.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/trend/index.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/trend/link.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/trend/thresholdStep.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/trend/transformation.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/trend/valueMapping.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/xyChart/fieldOverride.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/xyChart/index.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/xyChart/link.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/xyChart/thresholdStep.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/xyChart/transformation.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/xyChart/valueMapping.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/playlist.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/preferences.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/publicdashboard.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/azureMonitor.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/cloudWatch.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/elasticsearch.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/grafanaPyroscope.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/index.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/loki.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/parca.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/prometheus.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/tempo.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/testData.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/serviceaccount.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/team.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/util.md delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/grafana-version delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/jsonnetfile.json delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/main.libsonnet delete mode 100644 vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/schemas.libsonnet delete mode 100644 vendor/github.com/grafana/grafonnet/grafonnet-base/helpers.libsonnet delete mode 100644 vendor/github.com/grafana/grafonnet/grafonnet-base/jsonnetfile.json delete mode 100644 vendor/github.com/grafana/grafonnet/grafonnet-base/main.libsonnet delete mode 100644 vendor/github.com/grafana/grafonnet/grafonnet-base/util/dashboard.libsonnet delete mode 100644 vendor/github.com/grafana/grafonnet/grafonnet-base/util/grid.libsonnet delete mode 100644 vendor/github.com/grafana/grafonnet/grafonnet-base/util/main.libsonnet delete mode 100644 vendor/github.com/grafana/grafonnet/grafonnet-base/util/panel.libsonnet delete mode 100644 vendor/github.com/grafana/grafonnet/grafonnet-base/util/string.libsonnet delete mode 100644 vendor/github.com/grafana/grafonnet/grafonnet-base/veneer/annotation.libsonnet delete mode 100644 vendor/github.com/grafana/grafonnet/grafonnet-base/veneer/core.libsonnet delete mode 100644 vendor/github.com/grafana/grafonnet/grafonnet-base/veneer/link.libsonnet delete mode 100644 vendor/github.com/grafana/grafonnet/grafonnet-base/veneer/main.libsonnet delete mode 100644 vendor/github.com/grafana/grafonnet/grafonnet-base/veneer/panel.libsonnet delete mode 100644 vendor/github.com/grafana/grafonnet/grafonnet-base/veneer/query.libsonnet delete mode 100644 vendor/github.com/grafana/grafonnet/grafonnet-base/veneer/row.libsonnet delete mode 100644 vendor/github.com/grafana/grafonnet/grafonnet-base/veneer/variable.libsonnet delete mode 100644 vendor/github.com/grafana/grok/jsonnet/v10.0.0/imports.libsonnet delete mode 100644 vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/alertgroups/panelcfg/x/alertgroups_types_gen.json delete mode 100644 vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/annotationslist/panelcfg/x/annotationslist_types_gen.json delete mode 100644 vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/azuremonitor/dataquery/x/azuremonitor_types_gen.json delete mode 100644 vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/barchart/panelcfg/x/barchart_types_gen.json delete mode 100644 vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/bargauge/panelcfg/x/bargauge_types_gen.json delete mode 100644 vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/cloudwatch/dataquery/x/cloudwatch_types_gen.json delete mode 100644 vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/dashboardlist/panelcfg/x/dashboardlist_types_gen.json delete mode 100644 vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/datagrid/panelcfg/x/datagrid_types_gen.json delete mode 100644 vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/debug/panelcfg/x/debug_types_gen.json delete mode 100644 vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/elasticsearch/dataquery/x/elasticsearch_types_gen.json delete mode 100644 vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/gauge/panelcfg/x/gauge_types_gen.json delete mode 100644 vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/geomap/panelcfg/x/geomap_types_gen.json delete mode 100644 vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/grafanapyroscope/dataquery/x/grafanapyroscope_types_gen.json delete mode 100644 vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/heatmap/panelcfg/x/heatmap_types_gen.json delete mode 100644 vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/histogram/panelcfg/x/histogram_types_gen.json delete mode 100644 vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/logs/panelcfg/x/logs_types_gen.json delete mode 100644 vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/loki/dataquery/x/loki_types_gen.json delete mode 100644 vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/news/panelcfg/x/news_types_gen.json delete mode 100644 vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/nodegraph/panelcfg/x/nodegraph_types_gen.json delete mode 100644 vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/parca/dataquery/x/parca_types_gen.json delete mode 100644 vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/piechart/panelcfg/x/piechart_types_gen.json delete mode 100644 vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/prometheus/dataquery/x/prometheus_types_gen.json delete mode 100644 vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/stat/panelcfg/x/stat_types_gen.json delete mode 100644 vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/statetimeline/panelcfg/x/statetimeline_types_gen.json delete mode 100644 vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/statushistory/panelcfg/x/statushistory_types_gen.json delete mode 100644 vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/table/panelcfg/x/table_types_gen.json delete mode 100644 vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/tempo/dataquery/x/tempo_types_gen.json delete mode 100644 vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/testdata/dataquery/x/testdata_types_gen.json delete mode 100644 vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/text/panelcfg/x/text_types_gen.json delete mode 100644 vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/timeseries/panelcfg/x/timeseries_types_gen.json delete mode 100644 vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/trend/panelcfg/x/trend_types_gen.json delete mode 100644 vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/xychart/panelcfg/x/xychart_types_gen.json delete mode 100644 vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/core/dashboard/x/dashboard_types_gen.json delete mode 100644 vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/core/librarypanel/x/librarypanel_types_gen.json delete mode 100644 vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/core/playlist/x/playlist_types_gen.json delete mode 100644 vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/core/preferences/x/preferences_types_gen.json delete mode 100644 vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/core/publicdashboard/x/publicdashboard_types_gen.json delete mode 100644 vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/core/serviceaccount/x/serviceaccount_types_gen.json delete mode 100644 vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/core/team/x/team_types_gen.json delete mode 100644 vendor/github.com/jsonnet-libs/docsonnet/doc-util/README.md delete mode 100644 vendor/github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet delete mode 100644 vendor/github.com/jsonnet-libs/docsonnet/doc-util/render.libsonnet delete mode 100644 vendor/github.com/jsonnet-libs/xtd/.gitignore delete mode 100644 vendor/github.com/jsonnet-libs/xtd/LICENSE delete mode 100644 vendor/github.com/jsonnet-libs/xtd/Makefile delete mode 100644 vendor/github.com/jsonnet-libs/xtd/README.md delete mode 100644 vendor/github.com/jsonnet-libs/xtd/aggregate.libsonnet delete mode 100644 vendor/github.com/jsonnet-libs/xtd/array.libsonnet delete mode 100644 vendor/github.com/jsonnet-libs/xtd/ascii.libsonnet delete mode 100644 vendor/github.com/jsonnet-libs/xtd/camelcase.libsonnet delete mode 100644 vendor/github.com/jsonnet-libs/xtd/date.libsonnet delete mode 100644 vendor/github.com/jsonnet-libs/xtd/docs/.gitignore delete mode 100644 vendor/github.com/jsonnet-libs/xtd/docs/Gemfile delete mode 100644 vendor/github.com/jsonnet-libs/xtd/docs/README.md delete mode 100644 vendor/github.com/jsonnet-libs/xtd/docs/_config.yml delete mode 100644 vendor/github.com/jsonnet-libs/xtd/docs/aggregate.md delete mode 100644 vendor/github.com/jsonnet-libs/xtd/docs/array.md delete mode 100644 vendor/github.com/jsonnet-libs/xtd/docs/ascii.md delete mode 100644 vendor/github.com/jsonnet-libs/xtd/docs/camelcase.md delete mode 100644 vendor/github.com/jsonnet-libs/xtd/docs/date.md delete mode 100644 vendor/github.com/jsonnet-libs/xtd/docs/inspect.md delete mode 100644 vendor/github.com/jsonnet-libs/xtd/docs/jsonpath.md delete mode 100644 vendor/github.com/jsonnet-libs/xtd/docs/string.md delete mode 100644 vendor/github.com/jsonnet-libs/xtd/docs/url.md delete mode 100644 vendor/github.com/jsonnet-libs/xtd/inspect.libsonnet delete mode 100644 vendor/github.com/jsonnet-libs/xtd/jsonpath.libsonnet delete mode 100644 vendor/github.com/jsonnet-libs/xtd/main.libsonnet delete mode 100644 vendor/github.com/jsonnet-libs/xtd/string.libsonnet delete mode 100644 vendor/github.com/jsonnet-libs/xtd/test/array_test.jsonnet delete mode 100644 vendor/github.com/jsonnet-libs/xtd/test/camelcase_test.jsonnet delete mode 100644 vendor/github.com/jsonnet-libs/xtd/test/date_test.jsonnet delete mode 100644 vendor/github.com/jsonnet-libs/xtd/test/inspect_test.jsonnet delete mode 100644 vendor/github.com/jsonnet-libs/xtd/test/jsonnetfile.json delete mode 100644 vendor/github.com/jsonnet-libs/xtd/test/jsonpath_test.jsonnet delete mode 100644 vendor/github.com/jsonnet-libs/xtd/test/url_test.jsonnet delete mode 100644 vendor/github.com/jsonnet-libs/xtd/url.libsonnet delete mode 120000 vendor/grafonnet-base delete mode 120000 vendor/grafonnet-latest delete mode 120000 vendor/grafonnet-v10.0.0 delete mode 120000 vendor/v10.0.0 delete mode 120000 vendor/validate-libsonnet delete mode 120000 vendor/xtd diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..22d0d82 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +vendor diff --git a/jsonnetfile.lock.json b/jsonnetfile.lock.json index 5062d7d..5e1df11 100644 --- a/jsonnetfile.lock.json +++ b/jsonnetfile.lock.json @@ -1,26 +1,6 @@ { "version": 1, "dependencies": [ - { - "source": { - "git": { - "remote": "https://github.com/crdsonnet/crdsonnet.git", - "subdir": "crdsonnet" - } - }, - "version": "3dab27c8c9119eb14ecc19592240caf5f7330d23", - "sum": "Vh6Wo/7IIyIkmDE2XAJfWZDlTHClRrdMa9CCBPrcF1U=" - }, - { - "source": { - "git": { - "remote": "https://github.com/crdsonnet/validate-libsonnet.git", - "subdir": "" - } - }, - "version": "a78ca15fbfece3110c4807d1f059132ece01d97b", - "sum": "qYLH56MqvmgxE4YMNeTbuJ1XSsCpl1sumHN5x8IQv2I=" - }, { "source": { "git": { @@ -28,38 +8,18 @@ "subdir": "gen/grafonnet-latest" } }, - "version": "441b95e5a16ee5e511d54beb5f07e9b05f2bb5a2", - "sum": "sVzVlSLbxPkAurwO19YERigLMmRfVsViMcWC0gkTTqU=" + "version": "fe65a22df6d3a897729fff47cff599805a2c5710", + "sum": "mDHkB1avJU5IqvwCsXPmPt8pSiGjupLVqx3zCgFKzbw=" }, { "source": { "git": { "remote": "https://github.com/grafana/grafonnet.git", - "subdir": "gen/grafonnet-v10.0.0" - } - }, - "version": "441b95e5a16ee5e511d54beb5f07e9b05f2bb5a2", - "sum": "Lv5DM6d93sW3q2v9l5A6V0Etnnrzy5t19uYTEjO77Ag=" - }, - { - "source": { - "git": { - "remote": "https://github.com/grafana/grafonnet.git", - "subdir": "grafonnet-base" - } - }, - "version": "441b95e5a16ee5e511d54beb5f07e9b05f2bb5a2", - "sum": "5zmj5Vn/cKhKrD+jA5BfLliR4t74upkM4PfnuJC5t4M=" - }, - { - "source": { - "git": { - "remote": "https://github.com/grafana/grok.git", - "subdir": "jsonnet/v10.0.0" + "subdir": "gen/grafonnet-v10.2.0" } }, - "version": "8a4d53df8dc53b005a22125bc199366787dd271a", - "sum": "cpxEEjeaQMUYA938vuVie3s5SSRv+O9IWwL9F1m44Qk=" + "version": "fe65a22df6d3a897729fff47cff599805a2c5710", + "sum": "9xwtVj7WmdsFWoQ5CTcvDBKEgIPnAF9DsD6dnKl3M/U=" }, { "source": { @@ -68,8 +28,8 @@ "subdir": "doc-util" } }, - "version": "7c865ec0606f2b68c0f6b2721f101e6a99cd2593", - "sum": "zjjufxN4yAIevldYEERiZEp27vK0BJKj1VvZcVtWiOo=" + "version": "6ac6c69685b8c29c54515448eaca583da2d88150", + "sum": "BrAL/k23jq+xy9oA7TWIhUx07dsA/QLm3g7ktCwe//U=" }, { "source": { @@ -78,8 +38,8 @@ "subdir": "" } }, - "version": "d1929c3c1728274424a21a617f1b82095685d640", - "sum": "DHqlMNfQH/eCWHbHD2Ouc/bH00AwTkCS86z6cgzQ7UI=" + "version": "fc2e57a8839902ed4ba6cab5a99d642500f7102b", + "sum": "43waffw1QzvpY4rKcWoo3L7Vpee+DCYexwLDd5cPG0M=" } ], "legacyImports": false diff --git a/vendor/crdsonnet b/vendor/crdsonnet deleted file mode 120000 index b4ffe1b..0000000 --- a/vendor/crdsonnet +++ /dev/null @@ -1 +0,0 @@ -github.com/crdsonnet/crdsonnet/crdsonnet \ No newline at end of file diff --git a/vendor/doc-util b/vendor/doc-util deleted file mode 120000 index dcfde67..0000000 --- a/vendor/doc-util +++ /dev/null @@ -1 +0,0 @@ -github.com/jsonnet-libs/docsonnet/doc-util \ No newline at end of file diff --git a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/dynamic.libsonnet b/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/dynamic.libsonnet deleted file mode 100644 index 8bb1642..0000000 --- a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/dynamic.libsonnet +++ /dev/null @@ -1,143 +0,0 @@ -local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; -{ - local this = self, - - nilvalue:: {}, - - validate(schema, value):: true, - - nestInParents(name, parents, object):: - std.foldr( - function(p, acc) - if p == name - then acc - else { [p]+: acc } - , - parents, - object - ), - - functionName(name):: - local underscores = std.set(std.findSubstr('_', name)); - local n = std.join('', [ - if std.setMember(i - 1, underscores) - then std.asciiUpper(name[i]) - else name[i] - for i in std.range(0, std.length(name) - 1) - if !std.setMember(i, underscores) - ]); - 'with' + std.asciiUpper(n[0]) + n[1:], - - functionHelp(functionName, schema):: { - ['#%s' % functionName]:: - d.fn( - help=(if 'description' in schema - then schema.description - else ''), - args=( - if 'const' in schema - then [] - else [ - d.arg( - 'value', - type=( - if 'type' in schema - then schema.type - else 'string' - ), - default=( - if 'default' in schema - then schema.default - else null - ), - enums=( - if 'enum' in schema - then schema.enum - else null - ) - ), - ] - ) - ), - }, - - withFunction(schema):: - this.functionHelp(this.functionName(schema._name), schema) - + (if 'default' in schema - then { - [this.functionName(schema._name)](value=schema.default): - assert this.validate(schema, value); - this.nestInParents(schema._name, schema._parents, { [schema._name]: value }), - } - else { - [this.functionName(schema._name)](value): - assert this.validate(schema, value); - this.nestInParents(schema._name, schema._parents, { [schema._name]: value }), - }), - - withConstant(schema):: - this.functionHelp(this.functionName(schema._name), schema) - + { - [this.functionName(schema._name)](): - this.nestInParents(schema._name, schema._parents, { [schema._name]: schema.const }), - }, - - withBoolean(schema):: - this.functionHelp(this.functionName(schema._name), schema) - + { - [this.functionName(schema._name)](value=true): - assert this.validate(schema, value); - this.nestInParents(schema._name, schema._parents, { [schema._name]: value }), - }, - - mixinFunction(schema):: - this.functionHelp(this.functionName(schema._name) + 'Mixin', schema) - + { - [this.functionName(schema._name) + 'Mixin'](value): - assert this.validate(schema, value); - this.nestInParents(schema._name, schema._parents, { [schema._name]+: value }), - }, - - arrayFunctions(schema):: - this.functionHelp(this.functionName(schema._name), schema) - + this.functionHelp(this.functionName(schema._name) + 'Mixin', schema) - + { - [this.functionName(schema._name)](value): - assert this.validate(schema, value); - this.nestInParents( - schema._name, - schema._parents, - this.named(schema._name, if std.isArray(value) then value else [value]) - ), - - [this.functionName(schema._name) + 'Mixin'](value): - assert this.validate(schema, value); - this.nestInParents( - schema._name, - schema._parents, - this.named(schema._name, if std.isArray(value) then value else [value]) - ), - }, - - named(name, object):: - { - [name]+: object, - }, - - toObject(object):: - object, - - newFunction(parents):: - this.nestInParents( - 'new', - parents, - { - new(name): - self.withApiVersion() - + self.withKind() - + self.metadata.withName(name), - }, - ), -} - -// vim: foldmethod=indent diff --git a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/example_schema.json b/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/example_schema.json deleted file mode 100644 index 11fee86..0000000 --- a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/example_schema.json +++ /dev/null @@ -1,52 +0,0 @@ -{ - "$defs": { - "address": { - "properties": { - "street_address": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "country": { - "default": "United States of America", - "enum": [ - "United States of America", - "Canada" - ] - } - }, - "required": [ - "street_address", - "city", - "state" - ], - "type": "object" - } - }, - "$id": "https://example.com/schemas/customer", - "properties": { - "first_name": { - "type": "string" - }, - "last_name": { - "type": "string" - }, - "shipping_address": { - "$ref": "#/$defs/address" - }, - "billing_address": { - "$ref": "#/$defs/address" - } - }, - "required": [ - "first_name", - "last_name", - "shipping_address", - "billing_address" - ], - "type": "object" -} diff --git a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/jso b/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/jso deleted file mode 100644 index e4d7419..0000000 --- a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/jso +++ /dev/null @@ -1,18 +0,0 @@ -local crdsonnet = import '../main.libsonnet'; - -local schema = import './example_schema.json'; - -local lib = crdsonnet.schema.render('customer', schema); -local c = lib.customer; - -local shippingAddress = - local address = c.shipping_address; - address.withStreetAddress('12 Church Lane') - + address.withCity('West York') - + address.withState('Dobberton') - + address.withCountry(); - -c.withFirstName('John') -+ c.withLastName('Doe') -+ shippingAddress -+ c.withBillingAddress(shippingAddress.shipping_address) diff --git a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/json_schema.libsonnet b/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/json_schema.libsonnet deleted file mode 100644 index e4d7419..0000000 --- a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/json_schema.libsonnet +++ /dev/null @@ -1,18 +0,0 @@ -local crdsonnet = import '../main.libsonnet'; - -local schema = import './example_schema.json'; - -local lib = crdsonnet.schema.render('customer', schema); -local c = lib.customer; - -local shippingAddress = - local address = c.shipping_address; - address.withStreetAddress('12 Church Lane') - + address.withCity('West York') - + address.withState('Dobberton') - + address.withCountry(); - -c.withFirstName('John') -+ c.withLastName('Doe') -+ shippingAddress -+ c.withBillingAddress(shippingAddress.shipping_address) diff --git a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/json_schema_simple.libsonnet b/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/json_schema_simple.libsonnet deleted file mode 100644 index 9d06334..0000000 --- a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/json_schema_simple.libsonnet +++ /dev/null @@ -1,9 +0,0 @@ -local crdsonnet = import '../main.libsonnet'; - -local schema = import './example_schema.json'; - -local lib = crdsonnet.schema.render('customer', schema); -local c = lib.customer; - -c.withFirstName('John') -+ c.withLastName('Doe') diff --git a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/json_schema_static.libsonnet b/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/json_schema_static.libsonnet deleted file mode 100644 index ec6006e..0000000 --- a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/json_schema_static.libsonnet +++ /dev/null @@ -1,9 +0,0 @@ -local crdsonnet = import '../main.libsonnet'; - -local schema = import './example_schema.json'; - -local staticProcessor = - crdsonnet.processor.new() - + crdsonnet.processor.withRenderEngineType('static'); - -crdsonnet.schema.render('customer', schema, staticProcessor) diff --git a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/json_schema_static_output.libsonnet b/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/json_schema_static_output.libsonnet deleted file mode 100644 index 79c210a..0000000 --- a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/json_schema_static_output.libsonnet +++ /dev/null @@ -1,22 +0,0 @@ -{ - customer+: { - withBillingAddress(value): { billing_address: value }, - withBillingAddressMixin(value): { billing_address+: value }, - billing_address+: { - withCity(value): { billing_address+: { city: value } }, - withCountry(value='United States of America'): { billing_address+: { country: value } }, - withState(value): { billing_address+: { state: value } }, - withStreetAddress(value): { billing_address+: { street_address: value } }, - }, - withFirstName(value): { first_name: value }, - withLastName(value): { last_name: value }, - withShippingAddress(value): { shipping_address: value }, - withShippingAddressMixin(value): { shipping_address+: value }, - shipping_address+: { - withCity(value): { shipping_address+: { city: value } }, - withCountry(value='United States of America'): { shipping_address+: { country: value } }, - withState(value): { shipping_address+: { state: value } }, - withStreetAddress(value): { shipping_address+: { street_address: value } }, - }, - }, -} diff --git a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/json_schema_very_simple.libsonnet b/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/json_schema_very_simple.libsonnet deleted file mode 100644 index 0f673ac..0000000 --- a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/json_schema_very_simple.libsonnet +++ /dev/null @@ -1,14 +0,0 @@ -local crdsonnet = import '../main.libsonnet'; - -local schema = { - type: 'object', - properties: { - name: { - type: 'string', - }, - }, -}; - -local lib = crdsonnet.schema.render('person', schema); - -lib.person.withName('John') diff --git a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/json_schema_very_simple_static.libsonnet b/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/json_schema_very_simple_static.libsonnet deleted file mode 100644 index f418c56..0000000 --- a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/json_schema_very_simple_static.libsonnet +++ /dev/null @@ -1,16 +0,0 @@ -local crdsonnet = import '../main.libsonnet'; - -local schema = { - type: 'object', - properties: { - name: { - type: 'string', - }, - }, -}; - -local staticProcessor = - crdsonnet.processor.new() - + crdsonnet.processor.withRenderEngineType('static'); - -crdsonnet.schema.render('person', schema, staticProcessor) diff --git a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/json_schema_very_simple_validate.libsonnet b/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/json_schema_very_simple_validate.libsonnet deleted file mode 100644 index 0afa132..0000000 --- a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/json_schema_very_simple_validate.libsonnet +++ /dev/null @@ -1,18 +0,0 @@ -local crdsonnet = import '../main.libsonnet'; - -local schema = { - type: 'object', - properties: { - name: { - type: 'string', - }, - }, -}; - -local validateProcessor = - crdsonnet.processor.new() - + crdsonnet.processor.withValidation(); - -local lib = crdsonnet.schema.render('person', schema, validateProcessor); - -lib.person.withName(100) // invalid input diff --git a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/json_schema_very_simple_validate.libsonnet.output b/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/json_schema_very_simple_validate.libsonnet.output deleted file mode 100644 index 13a7c61..0000000 --- a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/example/json_schema_very_simple_validate.libsonnet.output +++ /dev/null @@ -1,12 +0,0 @@ -TRACE: vendor/github.com/crdsonnet/validate-libsonnet/main.libsonnet:94 -Invalid parameters: - Parameter name is invalid: - Value 100 MUST match schema: - { - "type": "string" - } -RUNTIME ERROR: Assertion failed - dynamic.libsonnet:(74:12)-(75:88) - example/json_schema_very_simple_validate.libsonnet:18:1-25 $ - During evaluation - diff --git a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/helpers.libsonnet b/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/helpers.libsonnet deleted file mode 100644 index 8b39e83..0000000 --- a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/helpers.libsonnet +++ /dev/null @@ -1,96 +0,0 @@ -local xtd = import 'github.com/jsonnet-libs/xtd/main.libsonnet'; - -{ - camelCaseKind(kind): - local s = xtd.camelcase.split(kind); - std.asciiLower(s[0]) + std.join('', s[1:]), - - getGroupKey(group, suffix): - // If no dedicated API group, then use 'nogroup' key for consistency - if suffix == group - then 'nogroup' - else std.split(std.strReplace( - group, - '.' + suffix, - '' - ), '.')[0], - - metadataRefSchemaDB: { - 'https://objectmeta/schema': import 'objectmeta.json', - }, - - properties: { - withMetadataRef(): { - // foldStart - properties+: { - metadata+: { - '$ref': 'https://objectmeta/schema#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta', - }, - }, - }, - // foldEnd - - withGroupVersionKind(group, version, kind): { - // foldStart - properties+: { - apiVersion+: { - const: - if group == '' - then version - else group - + '/' - + version, - }, - kind+: { - const: kind, - }, - }, - }, - // foldEnd - - withCompositeResource(): { - // foldStart - properties+: { - spec+: { - properties+: { - compositionRef: { - properties: { name: { type: 'string' } }, - required: ['name'], - type: 'object', - }, - compositionRevisionRef: { - properties: { name: { type: 'string' } }, - required: ['name'], - type: 'object', - }, - compositionSelector: { - properties: { - matchLabels: { - additionalProperties: { type: 'string' }, - type: 'object', - }, - }, - required: ['matchLabels'], - type: 'object', - }, - compositionUpdatePolicy: { - enum: [ - 'Automatic', - 'Manual', - ], - type: 'string', - }, - writeConnectionSecretToRef: { - properties: { name: { type: 'string' } }, - required: ['name'], - type: 'object', - }, - }, - }, - }, - }, - // foldEnd - }, -} - -// vim: foldmethod=marker foldmarker=foldStart,foldEnd foldlevel=0 diff --git a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/jsonnetfile.json b/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/jsonnetfile.json deleted file mode 100644 index 881998e..0000000 --- a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/jsonnetfile.json +++ /dev/null @@ -1,33 +0,0 @@ -{ - "version": 1, - "dependencies": [ - { - "source": { - "git": { - "remote": "https://github.com/crdsonnet/validate-libsonnet.git", - "subdir": "" - } - }, - "version": "master" - }, - { - "source": { - "git": { - "remote": "https://github.com/jsonnet-libs/docsonnet.git", - "subdir": "doc-util" - } - }, - "version": "master" - }, - { - "source": { - "git": { - "remote": "https://github.com/jsonnet-libs/xtd.git", - "subdir": "" - } - }, - "version": "master" - } - ], - "legacyImports": true -} diff --git a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/main.libsonnet b/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/main.libsonnet deleted file mode 100644 index f531d31..0000000 --- a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/main.libsonnet +++ /dev/null @@ -1,205 +0,0 @@ -local helpers = import './helpers.libsonnet'; -local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; - -{ - '#': - d.package.new( - 'crdsonnet', - 'https://github.com/crdsonnet/crdsonnet/crdsonnet', - 'Generate a *runtime* Jsonnet library directly from JSON Schemas, CRDs or OpenAPI components.', - std.thisFile, - 'master', - ) - + d.package.withUsageTemplate( - '%(json_schema_simple)s' % { - json_schema_simple: std.strReplace( - importstr './example/json_schema_simple.libsonnet', - '../main.libsonnet', - 'github.com/crdsonnet/crdsonnet/crdsonnet/main.libsonnet', - ), - } - ), - - local root = self, - schemaDB: import './schemadb.libsonnet', - renderEngine: import './render.libsonnet', - processor: import './processor.libsonnet', - - schema: { - '#render': d.fn( - '`render` returns a library for a `schema`.', - args=[ - d.arg('name', d.T.string), - d.arg('schema', d.T.object), - d.arg('processor', d.T.object, default='processor.new()'), - ], - ), - render( - name, - schema, - processor=root.processor.new(), - ): - processor.render(name, schema), - }, - - crd: { - local this = self, - '#render': d.fn( - '`render` returns a library for a `definition`.', - args=[ - d.arg('definition', d.T.object), - d.arg('groupSuffix', d.T.string), - d.arg('processor', d.T.object, default='processor.new()'), - ], - ), - render( - definition, - groupSuffix, - processor=root.processor.new(), - ): - local _processor = - processor - + root.processor.withSchemaDB(helpers.metadataRefSchemaDB); - local renderEngine = _processor.renderEngine; - local grouping = helpers.getGroupKey(definition.spec.group, groupSuffix); - local name = helpers.camelCaseKind(this.getKind(definition)); - std.foldl( - function(acc, version) - local schema = this.getSchemaForVersion(definition, version); - acc - + renderEngine.toObject( - renderEngine.nestInParents( - [grouping, version.name], - _processor.render(name, schema) - ) - ) - + renderEngine.newFunction( - [grouping, version.name, name] - ) - , - definition.spec.versions, - renderEngine.nilvalue, - ), - getKind(definition): - definition.spec.names.kind, - getSchemaForVersion(definition, version): - version.schema.openAPIV3Schema - + helpers.properties.withMetadataRef() - + helpers.properties.withGroupVersionKind( - definition.spec.group, - version.name, - this.getKind(definition) - ), - }, - - // XRD: Crossplane CompositeResourceDefinition - // XRDs are very similar to CRDs, processing them requires slightly different behavior. - xrd: - self.crd - + { - getKind(definition): - if std.objectHas(definition.spec, 'claimNames') - then definition.spec.claimNames.kind - else definition.spec.names.kind, - getSchemaForVersion(definition, version): - super.getSchemaForVersion(definition, version) - + helpers.properties.withCompositeResource(), - }, - - openapi: { - '#render': d.fn( - '`render` returns a library for a `component` in an OpenAPI `schema`.', - args=[ - d.arg('name', d.T.string), - d.arg('component', d.T.object), - d.arg('schema', d.T.object), - d.arg('processor', d.T.object, default='processor.new()'), - ], - ), - render( - name, - component, - schema, - processor=root.processor.new(), - ): - local extendSchema = - std.mergePatch( - schema, - component - + (if 'x-kubernetes-group-version-kind' in component - then - // not sure why this is a list, grabbing the first item - local gvk = component['x-kubernetes-group-version-kind'][0]; - helpers.properties.withGroupVersionKind(gvk.group, gvk.version, gvk.kind) - else {}) - ); - processor.render(name, extendSchema) - + (if 'x-kubernetes-group-version-kind' in component - then processor.renderEngine.newFunction([name]) - else processor.renderEngine.nilvalue), - }, -} - -// Legacy API endpoints -// These endpoints aren't very flexible and require more arguments to add features, this is an anti-pattern. They have been reimplemented to use above modular setup as an example and to verify the modular pattern works. These functions are covered by unit tests. -+ { - local root = self, - local defaultRender = 'dynamic', - - fromSchema(name, schema, schemaDB={}, render=defaultRender): - if name == '' - then error "name can't be an empty string" - else - local _processor = - root.processor.new() - + root.processor.withSchemaDB(schemaDB) - + root.processor.withRenderEngineType(render); - self.schema.render(name, schema, _processor), - - fromCRD(definition, groupSuffix, schemaDB={}, render=defaultRender): - local _processor = - root.processor.new() - + root.processor.withSchemaDB(schemaDB) - + root.processor.withRenderEngineType(render); - self.crd.render(definition, groupSuffix, _processor), - - // XRD: Crossplane CompositeResourceDefinition - fromXRD(definition, groupSuffix, schemaDB={}, render=defaultRender): - local _processor = - root.processor.new() - + root.processor.withSchemaDB(schemaDB) - + root.processor.withRenderEngineType(render); - self.xrd.render(definition, groupSuffix, _processor), - - fromOpenAPI(name, component, schema, schemaDB={}, render=defaultRender): - if name == '' - then error "name can't be an empty string" - else - local _processor = - root.processor.new() - + root.processor.withSchemaDB(schemaDB) - + root.processor.withRenderEngineType(render); - self.openapi.render(name, component, schema, _processor), - - // expects schema as rendered by `kubectl get --raw /openapi/v2` - fromKubernetesOpenAPI(schema, render=defaultRender): - local _processor = - root.processor.new() - + root.processor.withRenderEngineType(render); - local renderEngine = _processor.renderEngine; - std.foldl( - function(acc, d) - local items = std.reverse(std.split(d, '.')); - local component = schema.definitions[d]; - local name = helpers.camelCaseKind(items[0]); - acc - + renderEngine.toObject( - renderEngine.nestInParents( - [items[2], items[1]], - self.fromOpenAPI(name, component, schema, render=render), - ) - ), - std.objectFields(schema.definitions), - renderEngine.nilvalue - ), -} diff --git a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/objectmeta.json b/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/objectmeta.json deleted file mode 100644 index 04ad407..0000000 --- a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/objectmeta.json +++ /dev/null @@ -1,141 +0,0 @@ -{ - "definitions": { - "io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta": { - "description": "ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.", - "properties": { - "annotations": { - "additionalProperties": { - "type": "string" - }, - "description": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations", - "type": "object" - }, - "clusterName": { - "description": "The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.", - "type": "string" - }, - "creationTimestamp": { - "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time", - "description": "CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.\n\nPopulated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata" - }, - "deletionGracePeriodSeconds": { - "description": "Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.", - "format": "int64", - "type": "integer" - }, - "deletionTimestamp": { - "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time", - "description": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.\n\nPopulated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata" - }, - "finalizers": { - "description": "Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.", - "items": { - "type": "string" - }, - "type": "array", - "x-kubernetes-patch-strategy": "merge" - }, - "generateName": { - "description": "GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency", - "type": "string" - }, - "generation": { - "description": "A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.", - "format": "int64", - "type": "integer" - }, - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels", - "type": "object" - }, - "managedFields": { - "description": "ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \"ci-cd\". The set of fields is always in the version that the workflow used when modifying the object.", - "items": { - "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry" - }, - "type": "array" - }, - "name": { - "description": "Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names", - "type": "string" - }, - "namespace": { - "description": "Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces", - "type": "string" - }, - "ownerReferences": { - "description": "List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.", - "items": { - "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference" - }, - "type": "array", - "x-kubernetes-patch-merge-key": "uid", - "x-kubernetes-patch-strategy": "merge" - }, - "resourceVersion": { - "description": "An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency", - "type": "string" - }, - "selfLink": { - "description": "SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.", - "type": "string" - }, - "uid": { - "description": "UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids", - "type": "string" - } - }, - "type": "object" - }, - "io.k8s.apimachinery.pkg.apis.meta.v1.Time": { - "description": "Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.", - "format": "date-time", - "type": "string" - }, - "io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference": { - "description": "OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field.", - "properties": { - "apiVersion": { - "description": "API version of the referent.", - "type": "string" - }, - "blockOwnerDeletion": { - "description": "If true, AND if the owner has the \"foregroundDeletion\" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs \"delete\" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.", - "type": "boolean" - }, - "controller": { - "description": "If true, this reference points to the managing controller.", - "type": "boolean" - }, - "kind": { - "description": "Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", - "type": "string" - }, - "name": { - "description": "Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names", - "type": "string" - }, - "uid": { - "description": "UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids", - "type": "string" - } - }, - "required": [ - "apiVersion", - "kind", - "name", - "uid" - ], - "type": "object", - "x-kubernetes-map-type": "atomic" - } - }, - "info": { - "title": "Kubernetes", - "version": "unversioned" - }, - "swagger": "2.0" -} diff --git a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/parser.libsonnet b/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/parser.libsonnet deleted file mode 100644 index 1a2bb79..0000000 --- a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/parser.libsonnet +++ /dev/null @@ -1,132 +0,0 @@ -local resolver = import './resolver.libsonnet'; -{ - local this = self, - - resolveRef: resolver.resolve, - - getRefName(ref): std.reverse(std.split(ref, '/'))[0], - - parseSchema(key, schema, currentSchema, schemaDB={}, parents=[]): - // foldStart - if std.isBoolean(schema) - then { [key]+: schema } - else if !std.isObject(schema) - then error 'Schema is not an object or boolean' - else - local schemaToParse = - resolver.resolveRef( - schema, - currentSchema, - schemaDB - ); - - // shortcut to make it more readable below - // requires the parseSchema* functions to have the same signature - local parse(k, f) = - (if k in schemaToParse - then - local parsed = f( - key, - schemaToParse[k], - currentSchema, - schemaDB, - parents, - ); - if parsed != null - then { [k]: parsed } - else {} - else {}); - - { - [key]+: - schemaToParse - + parse('properties', this.parseSchemaMap) - + parse('patternProperties', this.parseSchemaMap) - + parse('items', this.parseSchemaItems) - + parse('then', this.parseSchemaSingle) - + parse('else', this.parseSchemaSingle) - + parse('prefixItems', this.parseSchemaList) - + parse('allOf', this.parseSchemaList) - + parse('anyOf', this.parseSchemaList) - + parse('oneOf', this.parseSchemaList) - + { _parents:: parents }, - } - , - // foldEnd - - parseSchemaItems(key, schema, currentSchema, schemaDB, parents): - self.parseSchemaSingle(key, schema, currentSchema, schemaDB, []), - - parseSchemaSingle(key, schema, currentSchema, schemaDB, parents): - // foldStart - local i = - if std.length(parents) > 0 - then std.length(parents) - 1 - else 0; - - local parsed = - this.parseSchema( - key, - schema, - currentSchema, - schemaDB, - parents[0:i] - ); - if parsed != null - then - if std.isObject(parsed[key]) - then parsed[key] + { _name:: key } - else parsed[key] - else {}, - // foldEnd - - parseSchemaMap(key, map, currentSchema, schemaDB, parents): - // foldStart - std.foldl( - function(acc, k) - acc - + this.parseSchema( - k, - map[k], - currentSchema, - schemaDB, - parents + [k], - ) - + { [k]+: { _name:: k } }, - std.objectFields(map), - {} - ), - // foldEnd - - parseSchemaList(key, list, currentSchema, schemaDB, parents): - // foldStart - [ - local parsed = - this.parseSchema( - key, - item, - currentSchema, - schemaDB, - parents, - )[key]; - - // Due to the nature of list items in JSON they don't have a key we can use as - // a name. However we can deduct the name from $ref or use $anchor if those are - // available. The name can later be used to create proper functions. - local name = - if std.isObject(item) - && '$anchor' in item - then item['$anchor'] - else if std.isObject(item) - && '$ref' in item - then this.getRefName(item['$ref']) - else ''; - - // Because order may matter (for example for prefixItems), we return a list. - parsed + { [if name != '' then '_name']:: name } - for item in list - ], - // foldEnd -} - -// vim: foldmethod=marker foldmarker=foldStart,foldEnd foldlevel=0 diff --git a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/processor.libsonnet b/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/processor.libsonnet deleted file mode 100644 index 391cba2..0000000 --- a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/processor.libsonnet +++ /dev/null @@ -1,87 +0,0 @@ -local parser = import './parser.libsonnet'; -local renderEngine = import './render.libsonnet'; -local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; - -{ - '#': d.package.newSub( - 'processor', - ||| - `processor` provides an interface to configure the parser and render engine, returns a parser() and render() function. - ||| - ), - - '#new': d.fn( - ||| - `new` initializes the processor with sane defaults, returning a parser() and render() function. - |||, - ), - new(): { - schemaDB: {}, - renderEngine: renderEngine.new('dynamic'), - parse(name, schema): - parser.parseSchema( - name, - schema, - schema, - self.schemaDB - ) + { [name]+: { _name: name } }, - render(name, schema): - local parsedSchema = self.parse(name, schema); - self.renderEngine.render(parsedSchema[name]), - }, - '#withSchemaDB': d.fn( - ||| - `withSchemaDB` adds additional schema databases. These can be created with `crdsonnet.schemaDB`. - |||, - args=[d.arg('db', d.T.object)], - ), - withSchemaDB(db): { - schemaDB+: db, - }, - '#withRenderEngine': d.fn( - ||| - `withRenderEngine` configures an alternative render engine. This can be created with `crdsonnet.renderEngine`. - |||, - args=[d.arg('engine', d.T.object)], - ), - withRenderEngine(engine): { - renderEngine: engine, - }, - '#withRenderEngineType': d.fn( - ||| - `withRenderEngineType` is a shortcut to configure an alternative render engine type. - |||, - args=[d.arg('engineType', d.T.string, enums=['dynamic', 'static'])], - ), - withRenderEngineType(engineType): - self.withRenderEngine(renderEngine.new(engineType)), - '#withValidation': d.fn( - ||| - `withValidation` turns on schema validation for render engine 'dynamic'. The `with*()` functions will validate the inputs against the given schema. - - NOTE: This uses validate-libsonnet, it can validate the most common JSON Schema attributes however some features are not yet implemented, most notably it is missing support for features that require regular expressions (not supported in Jsonnet yet). - - Example: - - ```jsonnet - %(example)s - ``` - - Output: - - ```console - %(output)s - ``` - ||| % { - example: std.strReplace( - importstr './example/json_schema_very_simple_validate.libsonnet', - '../main.libsonnet', - 'github.com/crdsonnet/crdsonnet/crdsonnet/main.libsonnet', - ), - output: importstr 'example/json_schema_very_simple_validate.libsonnet.output', - } - ), - withValidation(): { - renderEngine+: renderEngine.withValidation(), - }, -} diff --git a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/render.libsonnet b/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/render.libsonnet deleted file mode 100644 index fef5c86..0000000 --- a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/render.libsonnet +++ /dev/null @@ -1,207 +0,0 @@ -local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; - -{ - local engineTypes = { - static: import 'static.libsonnet', - dynamic: import 'dynamic.libsonnet', - }, - - '#': d.package.newSub( - 'renderEngine', - '`renderEngine` provides an interface to create a renderEngine.', - ), - - '#new': d.fn( - '`new` returns a renderEngine.', - args=[ - d.arg('engineType', d.T.string, enums=['static', 'dynamic']), - ], - ), - new(engineType): { - engine: engineTypes[engineType], - local r = self.engine, - - nilvalue: r.nilvalue, - toObject: r.toObject, - nestInParents(parents, object): r.nestInParents('', parents, object), - newFunction: r.newFunction, - - render(schema): - r.toObject(self.schema(schema)), - - schema(schema): - // foldStart - if 'const' in schema - then self.const(schema) // value is a constant - - else if 'type' in schema - then - if std.isBoolean(schema.type) - then - if schema.type - then self.other(schema) // Any value allowed - else r.nilvalue // No value allowed - - else if std.isArray(schema.type) - then self.other(schema) // Multiple types - - else if schema.type == 'object' - then self.object(schema) // type=object - - else if schema.type == 'array' - then self.array(schema) // type=array - - else if schema.type == 'boolean' - then self.boolean(schema) // type=boolean - - else self.other(schema) // any other type - - else if 'allOf' in schema - || 'anyOf' in schema - || 'oneOf' in schema - then self.xof(schema) // value can be xOf - - else self.other(schema) - , - // foldEnd - - nameParsed(schema, parsed): - // foldStart - if '_name' in schema - && parsed != r.nilvalue - then - r.named( - schema._name, - r.toObject( - parsed - ) - ) - else - parsed - , - // foldEnd - - functions(schema): - // foldStart - if std.length(schema._parents) != 0 && '_name' in schema - then r.withFunction(schema) - + r.mixinFunction(schema) - else r.nilvalue, - // foldEnd - - xofParts(schema): - // foldStart - local handle(schema, k) = - if k in schema - then - std.foldl( - function(acc, n) - acc + self.schema(n), - schema[k], - r.nilvalue - ) - else r.nilvalue; - { - allOf: handle(schema, 'allOf'), - anyOf: handle(schema, 'anyOf'), - oneOf: handle(schema, 'oneOf'), - - combined: - handle(schema, 'allOf') - + handle(schema, 'anyOf') - + handle(schema, 'oneOf'), - }, - // foldEnd - - const(schema): r.withConstant(schema), - - boolean(schema): - if '_name' in schema - then r.withBoolean(schema) - else r.nilvalue, - - other(schema): - // foldStart - if std.length(schema._parents) != 0 && '_name' in schema - then r.withFunction(schema) - else r.nilvalue, - //foldEnd - - object(schema): - // foldStart - local properties = ( - if 'properties' in schema - then - std.foldl( - function(acc, p) - acc + self.schema(schema.properties[p]), - std.objectFields(schema.properties), - r.nilvalue - ) - else r.nilvalue - ); - - local xofParts = self.xofParts(schema + { _parents: super._parents[1:] }); - - local merge(parts) = - if std.isObject(parts) - then - std.foldl( - function(acc, k) - acc + - (if std.isObject(parts[k]) - then parts[k] - else {}), - std.objectFields(parts), - {} - ) - else parts; // Can't merge in static mode - - // Merge allOf/anyOf as they can be used in combination with each other - // Keep oneOf seperate as it they would not be used in combination with each other - local parsed = - merge(xofParts.allOf) - + merge(xofParts.anyOf) - + xofParts.oneOf - + properties; - - self.functions(schema) - + self.nameParsed(schema, parsed), - // foldEnd - - array(schema): - // foldStart - (if '_name' in schema - then r.arrayFunctions(schema) - else r.nilvalue) - + ( - if 'items' in schema - && std.isObject(schema.items) - then self.schema(schema.items + { _parents: [] }) - else r.nilvalue - ), - // foldEnd - - xof(schema): - // foldStart - local parsed = self.xofParts(schema).combined; - self.functions(schema) - + self.nameParsed(schema, parsed), - // foldEnd - }, - withValidation(): { - engine+: { - validate(schema, value):: - local validate = import 'github.com/crdsonnet/validate-libsonnet/main.libsonnet'; - validate.checkParameters({ - [schema._name]: - validate.schemaCheck( - value, - schema - ), - }), - }, - }, -} - -// vim: foldmethod=marker foldmarker=foldStart,foldEnd foldlevel=0 diff --git a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/resolver.libsonnet b/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/resolver.libsonnet deleted file mode 100644 index 60c39d6..0000000 --- a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/resolver.libsonnet +++ /dev/null @@ -1,116 +0,0 @@ -local schemadb_util = import './schemadb.libsonnet'; - -{ - local url = { - // Similar to Python's urllib.urlsplit() - // :///?# - split(url): - local hasFragment = std.length(std.findSubstr('#', url)) > 0; - local fragmentSplit = std.splitLimit(url, '#', 1); - - local hasQuery = std.length(std.findSubstr('?', fragmentSplit[0])) > 0; - local querySplit = std.splitLimit(fragmentSplit[0], '?', 1); - - local hasScheme = std.length(std.findSubstr(':', querySplit[0])) > 0; - local schemeSplit = std.splitLimit(querySplit[0], ':', 1); - - local postSchemeURL = - if hasScheme - then schemeSplit[1] - else schemeSplit[0]; - local hasNetLoc = std.startsWith(postSchemeURL, '//'); - local netLocSplit = std.splitLimit(postSchemeURL, '//', 1); - - local postNetLocURL = - if hasNetLoc - then netLocSplit[1] - else netLocSplit[0]; - local pathSplit = std.splitLimit(postNetLocURL, '/', 1); - local hasPath = - (hasNetLoc && std.length(std.findSubstr('/', postNetLocURL)) > 0) - || (!hasNetLoc && std.startsWith(postNetLocURL, '/')); - { - [if hasScheme then 'scheme']: schemeSplit[0], - [if hasNetLoc then 'net_loc']: pathSplit[0], - [if hasPath then 'path']: pathSplit[1], - [if hasQuery then 'query']: querySplit[1], - [if hasFragment then 'fragment']: fragmentSplit[1], - }, - - join(splitObj): - std.join('', [ - if 'scheme' in splitObj then splitObj.scheme + ':' else '', - if 'net_loc' in splitObj then '//' + splitObj.net_loc else '', - if 'path' in splitObj then '/' + splitObj.path else '', - if 'query' in splitObj then '?' + splitObj.query else '', - if 'fragment' in splitObj then '#' + splitObj.fragment else '', - ]), - }, - - resolveRef(obj, schema, schemaDB): - if '$ref' in obj - then self.resolve(obj['$ref'], schema, schemaDB) - else obj, - - resolve(ref, schema, schemaDB): - local splitRef = url.split(ref); - local splitID = url.split(schemadb_util.getID(schema)); - - local findSchema = - if self.urlWithPath(splitRef) == self.urlWithPath(splitID) // same as schema - then schema - - else if 'net_loc' in splitRef // absolute - then self.getSchemaFromDB( - self.urlWithPath(splitRef), - schemaDB, - ) - - else if 'path' in splitRef // relative - then self.getSchemaFromDB( - self.urlWithPath(splitID + splitRef), - schemaDB, - ) - - else if 'fragment' in splitRef // fragment - then schema - - else {}; // no schema found - - self.findFragment( - std.get(splitRef, 'fragment', ''), - findSchema, - schemaDB, - ), - - urlWithPath(parsedURL): - url.join({ - [if 'scheme' in parsedURL then 'scheme']: parsedURL.scheme, - [if 'net_loc' in parsedURL then 'net_loc']: parsedURL.net_loc, - [if 'path' in parsedURL then 'path']: parsedURL.path, - }), - - getSchemaFromDB(id, schemaDB): - local found = schemadb_util.get( - schemaDB, - id, - ); - self.resolveRef( - found, - found, - schemaDB - ), - - findFragment(fragment, schema, schemaDB={}): - local keys = std.split(fragment, '/')[1:]; - std.foldl( - function(acc, key) - self.resolveRef( - std.get(acc, key, {}), - schema, - schemaDB, - ), - keys, - schema - ), -} diff --git a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/schemadb.libsonnet b/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/schemadb.libsonnet deleted file mode 100644 index e8dd617..0000000 --- a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/schemadb.libsonnet +++ /dev/null @@ -1,44 +0,0 @@ -local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; - -{ - '#': d.package.newSub( - 'schemaDB', - '`schemaDB` provides an interface to describe a schemaDB.', - ), - - '#get': d.fn( - "`get` gets a schema from a 'db'.", - args=[ - d.arg('db', d.T.object), - d.arg('name', d.T.string), - ], - ), - get(db, name): - std.get(db, name, {}), - - '#add': d.fn( - "`add` adds a schema to a 'db', expects a schema to have either am `$id` or `id` field.", - args=[d.arg('schema', d.T.object)], - ), - add(schema): - local id = self.getID(schema); - if id == '' - then error "Can't add schema without id" - else { [id]: schema }, - - '#getID': d.fn( - '`getID` gets the ID from a schema, either `$id` or `id` are returned.', - args=[d.arg('schema', d.T.object)], - ), - getID(schema): - std.get( - schema, - '$id', - std.get( - schema, - 'id', - '' - ) - ), - -} diff --git a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/static.libsonnet b/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/static.libsonnet deleted file mode 100644 index b89cd8d..0000000 --- a/vendor/github.com/crdsonnet/crdsonnet/crdsonnet/static.libsonnet +++ /dev/null @@ -1,131 +0,0 @@ -{ - local this = self, - - nilvalue:: '', - - nestInParents(name, parents, object):: - local obj = std.stripChars( - object, - '{}', // Remove curly brackets it can be nested in parents - ); - std.foldr( - function(p, acc) - if p == name - then acc - else '"' + p + '"+: { ' + acc + ' }', - parents, - obj - ), - - functionName(name):: - local underscores = std.set(std.findSubstr('_', name)); - local n = std.join('', [ - if std.setMember(i - 1, underscores) - then std.asciiUpper(name[i]) - else name[i] - for i in std.range(0, std.length(name) - 1) - if !std.setMember(i, underscores) - ]); - 'with' + std.asciiUpper(n[0]) + n[1:], - - withFunction(schema):: - ||| - %s(value%s): { %s }, - ||| % [ - this.functionName(schema._name), - (if 'default' in schema - then '=%s' % (if std.isString(schema.default) - then '"%s"' % schema.default - else schema.default) - else ''), - this.nestInParents( - schema._name, - schema._parents, - '"%s": value' % schema._name - ), - ], - - withConstant(schema):: - ||| - %s(): { %s }, - ||| % [ - this.functionName(schema._name), - this.nestInParents( - schema._name, - schema._parents, - '"%s": "%s"' % [schema._name, schema.const] - ), - ], - - withBoolean(schema):: - ||| - %s(value=%s): { %s }, - ||| % [ - this.functionName(schema._name), - (if 'default' in schema - then schema.default - else 'true'), - this.nestInParents( - schema._name, - schema._parents, - '"%s": value' % schema._name - ), - ], - - mixinFunction(schema):: - ||| - %sMixin(value): { %s }, - ||| % [ - this.functionName(schema._name), - this.nestInParents( - schema._name, - schema._parents, - '"%s"+: value' % schema._name - ), - ], - - arrayFunctions(schema):: - ||| - %s(value): { %s }, - %sMixin(value): { %s }, - ||| % [ - this.functionName(schema._name), - this.nestInParents( - schema._name, - schema._parents, - ' "%s": if std.isArray(value) then value else [value] ' % schema._name, - ), - this.functionName(schema._name), - this.nestInParents( - schema._name, - schema._parents, - ' "%s"+: if std.isArray(value) then value else [value] ' % schema._name, - ), - ], - - named(name, object):: - ||| - "%s"+: %s, - ||| % [ - name, - object, - ], - - toObject(object):: - '{ %s }' % object, - - newFunction(parents):: - '{\n %s \n}' % - this.nestInParents( - 'new', - parents, - ||| - new(name): - self.withApiVersion() - + self.withKind() - + self.metadata.withName(name), - |||, - ), -} - -// vim: foldmethod=indent diff --git a/vendor/github.com/crdsonnet/validate-libsonnet/.gitignore b/vendor/github.com/crdsonnet/validate-libsonnet/.gitignore deleted file mode 100644 index f9bf6ba..0000000 --- a/vendor/github.com/crdsonnet/validate-libsonnet/.gitignore +++ /dev/null @@ -1,2 +0,0 @@ -jsonnetfile.lock.json -vendor diff --git a/vendor/github.com/crdsonnet/validate-libsonnet/LICENSE b/vendor/github.com/crdsonnet/validate-libsonnet/LICENSE deleted file mode 100644 index 261eeb9..0000000 --- a/vendor/github.com/crdsonnet/validate-libsonnet/LICENSE +++ /dev/null @@ -1,201 +0,0 @@ - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright [yyyy] [name of copyright owner] - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. diff --git a/vendor/github.com/crdsonnet/validate-libsonnet/Makefile b/vendor/github.com/crdsonnet/validate-libsonnet/Makefile deleted file mode 100644 index 51cf27c..0000000 --- a/vendor/github.com/crdsonnet/validate-libsonnet/Makefile +++ /dev/null @@ -1,3 +0,0 @@ -README.md: - jsonnet -J vendor -S -c -m . \ - --exec "(import 'doc-util/main.libsonnet').render(import 'main.libsonnet')" diff --git a/vendor/github.com/crdsonnet/validate-libsonnet/README.md b/vendor/github.com/crdsonnet/validate-libsonnet/README.md deleted file mode 100644 index f10f6cd..0000000 --- a/vendor/github.com/crdsonnet/validate-libsonnet/README.md +++ /dev/null @@ -1,212 +0,0 @@ -# validate-libsonnet - -Type checking is a common grievance in the jsonnet eco-system, this library is an -aid to validate function parameters and other values. - -Here's a comprehensive example validating the function arguments against the -arguments documented by docsonnet: - -```jsonnet -local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; -local validate = import 'github.com/crdsonnet/validate-libsonnet/main.libsonnet'; - -{ - '#func':: - d.func.new( - 'sample function', - args=[ - d.arg('num', d.T.number), - d.arg('str', d.T.string), - d.arg('enum', d.T.string, enums=['valid', 'values']), - ], - ), - func(num, str, enum):: - assert validate.checkParamsFromDocstring( - [num, str, enum], - self['#func'], - ); - {/* do something here */ }, - - return: self.func(100, 'this is a string', 'valid'), -} - -``` - -A failure output would look like this: - -``` -TRACE: vendor/github.com/crdsonnet/validate-libsonnet/main.libsonnet:63 -Invalid parameters: - Parameter enum is invalid: - Value "invalid" MUST match schema: - { - "enum": [ - "valid", - "values" - ], - "type": "string" - } - Parameter str is invalid: - Value 20 MUST match schema: - { - "type": "string" - } -RUNTIME ERROR: Assertion failed - fromdocstring.jsonnet:(15:5)-(19:31) - fromdocstring.jsonnet:21:11-40 object - Field "return" - During manifestation - - -``` - - -## Install - -``` -jb install github.com/crdsonnet/validate-libsonnet@master -``` - -## Usage - -```jsonnet -local validate = import 'github.com/crdsonnet/validate-libsonnet/main.libsonnet' -``` - -## Index - -* [`fn checkParameters(checks)`](#fn-checkparameters) -* [`fn checkParamsFromDocstring(params, docstring)`](#fn-checkparamsfromdocstring) -* [`fn getChecksFromDocstring(params, docstring)`](#fn-getchecksfromdocstring) -* [`fn schemaCheck(param, schema)`](#fn-schemacheck) - -## Fields - -### fn checkParameters - -```ts -checkParameters(checks) -``` - -`checkParameters` validates parameters against their `checks`. - -```jsonnet -local validate = import 'github.com/crdsonnet/validate-libsonnet/main.libsonnet'; - -local func(arg) = - assert validate.checkParameters({ - arg: std.isString(arg), - }); - {/* do something here */ }; - -func('this is a string') - -``` - -A failure output would look like this: - -``` -TRACE: vendor/github.com/crdsonnet/validate-libsonnet/main.libsonnet:63 -Invalid parameters: - Parameter enum is invalid: - Value "invalid" MUST match schema: - { - "enum": [ - "valid", - "values" - ], - "type": "string" - } - Parameter str is invalid: - Value 20 MUST match schema: - { - "type": "string" - } -RUNTIME ERROR: Assertion failed - fromdocstring.jsonnet:(15:5)-(19:31) - fromdocstring.jsonnet:21:11-40 object - Field "return" - During manifestation - - -``` - - -### fn checkParamsFromDocstring - -```ts -checkParamsFromDocstring(params, docstring) -``` - -`checkParamsFromDocstring` validates `params` against a docsonnet `docstring` object. - -```jsonnet -local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; -local validate = import 'github.com/crdsonnet/validate-libsonnet/main.libsonnet'; - -{ - '#func':: - d.func.new( - 'sample function', - args=[ - d.arg('num', d.T.number), - d.arg('str', d.T.string), - d.arg('enum', d.T.string, enums=['valid', 'values']), - ], - ), - func(num, str, enum):: - assert validate.checkParamsFromDocstring( - [num, str, enum], - self['#func'], - ); - {/* do something here */ }, - - return: self.func(100, 'this is a string', 'valid'), -} - -``` - -A failure output would look like this: - -``` -TRACE: vendor/github.com/crdsonnet/validate-libsonnet/main.libsonnet:63 -Invalid parameters: - Parameter enum is invalid: - Value "invalid" MUST match schema: - { - "enum": [ - "valid", - "values" - ], - "type": "string" - } - Parameter str is invalid: - Value 20 MUST match schema: - { - "type": "string" - } -RUNTIME ERROR: Assertion failed - fromdocstring.jsonnet:(15:5)-(19:31) - fromdocstring.jsonnet:21:11-40 object - Field "return" - During manifestation - - -``` - - -### fn getChecksFromDocstring - -```ts -getChecksFromDocstring(params, docstring) -``` - -`getChecksFromDocstring` returns checks for `params` derived from a docsonnet `docstring` object. - -### fn schemaCheck - -```ts -schemaCheck(param, schema) -``` - -`schemaCheck` validates `param` against a JSON `schema`. Note that this function does not resolve "$ref" and recursion. diff --git a/vendor/github.com/crdsonnet/validate-libsonnet/example/fromdocstring.jsonnet b/vendor/github.com/crdsonnet/validate-libsonnet/example/fromdocstring.jsonnet deleted file mode 100644 index fc1ca7a..0000000 --- a/vendor/github.com/crdsonnet/validate-libsonnet/example/fromdocstring.jsonnet +++ /dev/null @@ -1,22 +0,0 @@ -local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; -local validate = import 'validate-libsonnet/main.libsonnet'; - -{ - '#func':: - d.func.new( - 'sample function', - args=[ - d.arg('num', d.T.number), - d.arg('str', d.T.string), - d.arg('enum', d.T.string, enums=['valid', 'values']), - ], - ), - func(num, str, enum):: - assert validate.checkParamsFromDocstring( - [num, str, enum], - self['#func'], - ); - {/* do something here */ }, - - return: self.func(100, 'this is a string', 'valid'), -} diff --git a/vendor/github.com/crdsonnet/validate-libsonnet/example/fromdocstring.jsonnet.output b/vendor/github.com/crdsonnet/validate-libsonnet/example/fromdocstring.jsonnet.output deleted file mode 100644 index 1d20b38..0000000 --- a/vendor/github.com/crdsonnet/validate-libsonnet/example/fromdocstring.jsonnet.output +++ /dev/null @@ -1,22 +0,0 @@ -TRACE: vendor/validate-libsonnet/main.libsonnet:63 -Invalid parameters: - Parameter enum is invalid: - Value "invalid" MUST match schema: - { - "enum": [ - "valid", - "values" - ], - "type": "string" - } - Parameter str is invalid: - Value 20 MUST match schema: - { - "type": "string" - } -RUNTIME ERROR: Assertion failed - fromdocstring.jsonnet:(15:5)-(19:31) - fromdocstring.jsonnet:21:11-40 object - Field "return" - During manifestation - diff --git a/vendor/github.com/crdsonnet/validate-libsonnet/example/jsonnetfile.json b/vendor/github.com/crdsonnet/validate-libsonnet/example/jsonnetfile.json deleted file mode 100644 index 8f39f0c..0000000 --- a/vendor/github.com/crdsonnet/validate-libsonnet/example/jsonnetfile.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "version": 1, - "dependencies": [ - { - "source": { - "git": { - "remote": "https://github.com/jsonnet-libs/docsonnet.git", - "subdir": "doc-util" - } - }, - "version": "master" - }, - { - "source": { - "local": { - "directory": ".." - } - }, - "version": "" - } - ], - "legacyImports": true -} diff --git a/vendor/github.com/crdsonnet/validate-libsonnet/example/samplechecks.jsonnet b/vendor/github.com/crdsonnet/validate-libsonnet/example/samplechecks.jsonnet deleted file mode 100644 index cd1f13a..0000000 --- a/vendor/github.com/crdsonnet/validate-libsonnet/example/samplechecks.jsonnet +++ /dev/null @@ -1,9 +0,0 @@ -// Examples checks: - -local customCheck(value) = - std.member(['a', 'b'], value); - -local stringMaxLengthCheck(value) = - local schema = { type: 'string', maxLength: 1 }; - params.schemaCheck(value, schema); - diff --git a/vendor/github.com/crdsonnet/validate-libsonnet/example/simple.jsonnet b/vendor/github.com/crdsonnet/validate-libsonnet/example/simple.jsonnet deleted file mode 100644 index c8a6d55..0000000 --- a/vendor/github.com/crdsonnet/validate-libsonnet/example/simple.jsonnet +++ /dev/null @@ -1,9 +0,0 @@ -local validate = import 'validate-libsonnet/main.libsonnet'; - -local func(arg) = - assert validate.checkParameters({ - arg: std.isString(arg), - }); - {/* do something here */ }; - -func('this is a string') diff --git a/vendor/github.com/crdsonnet/validate-libsonnet/example/simple.jsonnet.output b/vendor/github.com/crdsonnet/validate-libsonnet/example/simple.jsonnet.output deleted file mode 100644 index 2da2f5b..0000000 --- a/vendor/github.com/crdsonnet/validate-libsonnet/example/simple.jsonnet.output +++ /dev/null @@ -1,8 +0,0 @@ -TRACE: vendor/validate-libsonnet/main.libsonnet:63 -Invalid parameters: - Parameter arg is invalid. -RUNTIME ERROR: Assertion failed - simple.jsonnet:(4:3)-(7:29) - simple.jsonnet:9:1-9 $ - During evaluation - diff --git a/vendor/github.com/crdsonnet/validate-libsonnet/jsonnetfile.json b/vendor/github.com/crdsonnet/validate-libsonnet/jsonnetfile.json deleted file mode 100644 index a8232b3..0000000 --- a/vendor/github.com/crdsonnet/validate-libsonnet/jsonnetfile.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "version": 1, - "dependencies": [ - { - "source": { - "git": { - "remote": "https://github.com/jsonnet-libs/docsonnet.git", - "subdir": "doc-util" - } - }, - "version": "master" - } - ], - "legacyImports": true -} diff --git a/vendor/github.com/crdsonnet/validate-libsonnet/main.libsonnet b/vendor/github.com/crdsonnet/validate-libsonnet/main.libsonnet deleted file mode 100644 index 929e631..0000000 --- a/vendor/github.com/crdsonnet/validate-libsonnet/main.libsonnet +++ /dev/null @@ -1,178 +0,0 @@ -local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; - -{ - local root = self, - - '#': - d.package.new( - 'validate-libsonnet', - 'github.com/crdsonnet/validate-libsonnet', - ||| - Type checking is a common grievance in the jsonnet eco-system, this library is an - aid to validate function parameters and other values. - - Here's a comprehensive example validating the function arguments against the - arguments documented by docsonnet: - - ```jsonnet - %s - ``` - - A failure output would look like this: - - ``` - %s - ``` - ||| % [ - std.strReplace( - importstr 'example/fromdocstring.jsonnet', - 'validate-libsonnet', - 'github.com/crdsonnet/validate-libsonnet', - ), - std.strReplace( - importstr 'example/fromdocstring.jsonnet.output', - 'validate-libsonnet', - 'github.com/crdsonnet/validate-libsonnet', - ), - ], - std.thisFile, - ) - + d.package.withUsageTemplate( - "local validate = import '%(import)s'" - ), - - '#checkParameters': d.fn( - ||| - `checkParameters` validates parameters against their `checks`. - - ```jsonnet - %s - ``` - - A failure output would look like this: - - ``` - %s - ``` - ||| % [ - std.strReplace( - importstr 'example/simple.jsonnet', - 'validate-libsonnet', - 'github.com/crdsonnet/validate-libsonnet', - ), - std.strReplace( - importstr 'example/fromdocstring.jsonnet.output', - 'validate-libsonnet', - 'github.com/crdsonnet/validate-libsonnet', - ), - ], - args=[d.arg('checks', d.T.object)], - ), - checkParameters(checks): - local failures = [ - 'Parameter %s is invalid%s' % [ - n, - (if (std.isArray(checks[n])) - then ':' + std.join('\n ', checks[n][1:]) - else '.'), - ] - for n in std.objectFields(checks) - if (std.isArray(checks[n]) && !checks[n][0]) - || (std.isBoolean(checks[n]) && !checks[n]) - ]; - local tests = std.all([ - if std.isArray(checks[n]) - then checks[n][0] - else checks[n] - for n in std.objectFields(checks) - if (std.isArray(checks[n]) && !checks[n][0]) - || (std.isBoolean(checks[n]) && !checks[n]) - ]); - if tests - then true - else - std.trace( - std.join( - '\n ', - ['\nInvalid parameters:'] - + failures - ), - false - ), - - '#checkParamsFromDocstring': d.fn( - ||| - `checkParamsFromDocstring` validates `params` against a docsonnet `docstring` object. - - ```jsonnet - %s - ``` - - A failure output would look like this: - - ``` - %s - ``` - ||| % [ - std.strReplace( - importstr 'example/fromdocstring.jsonnet', - 'validate-libsonnet', - 'github.com/crdsonnet/validate-libsonnet', - ), - std.strReplace( - importstr 'example/fromdocstring.jsonnet.output', - 'validate-libsonnet', - 'github.com/crdsonnet/validate-libsonnet', - ), - ], - args=[ - d.arg('params', d.T.array), - d.arg('docstring', d.T.object), - ], - ), - checkParamsFromDocstring(params, docstring): - root.checkParameters( - root.getChecksFromDocstring(params, docstring) - ), - - '#getChecksFromDocstring': d.fn( - '`getChecksFromDocstring` returns checks for `params` derived from a docsonnet `docstring` object.', - args=[ - d.arg('params', d.T.array), - d.arg('docstring', d.T.object), - ], - ), - getChecksFromDocstring(params, docstring): - local args = docstring['function'].args; - assert std.length(args) == std.length(params) - : 'checkFromDocstring: expect equal number of args as params'; - - local hasEnum(arg) = 'enums' in arg && std.isArray(arg.enums); - { - [args[i].name]: - root.schemaCheck( - params[i], - { - type: args[i].type, - [if hasEnum(args[i]) then 'enum']: args[i].enums, - } - ) - for i in std.range(0, std.length(params) - 1) - }, - - '#schemaCheck': d.fn( - '`schemaCheck` validates `param` against a JSON `schema`. Note that this function does not resolve "$ref" and recursion.', - args=[ - d.arg('param', d.T.any), - d.arg('schema', d.T.object), - ], - ), - schemaCheck(param, schema): - local v = import './validate.libsonnet'; - local indent = ' '; - [ - v.validate(param, schema), - '\n%sValue %s MUST match schema:' % [indent, std.manifestJson(param)], - indent + std.manifestJsonEx(schema, ' ', '\n ' + indent), - ], -} diff --git a/vendor/github.com/crdsonnet/validate-libsonnet/validate.libsonnet b/vendor/github.com/crdsonnet/validate-libsonnet/validate.libsonnet deleted file mode 100644 index 3b7bdeb..0000000 --- a/vendor/github.com/crdsonnet/validate-libsonnet/validate.libsonnet +++ /dev/null @@ -1,327 +0,0 @@ -{ - local root = self, - - validate(object, schema):: - if std.isBoolean(schema) - then schema - else if schema == {} - then true - else root.process( - object, - schema, - root.genericTestCases - ), - - process(object, schema, testcases): - std.all([ - testcases[keyword](object, schema) - for keyword in std.objectFields(testcases) - if keyword in schema - ]), - - types: { - boolean(object, schema): - std.isBoolean(object), - - 'null'(object, schema): - std.type(object) == 'null', - - string(object, schema):: - // foldStart - if !std.isString(object) - then false - else root.process( - object, - schema, - root.typeTestCases.string - ), - // foldEnd - - number(object, schema):: - // foldStart - if !std.isNumber(object) - then false - else root.process( - object, - schema, - root.typeTestCases.number - ), - // foldEnd - - integer(object, schema):: - // foldStart - if !std.isNumber(object) - && std.mod(object, 1) != 0 - then false - else root.process( - object, - schema, - root.typeTestCases.number - ), - // foldEnd - - object(object, schema):: - // foldStart - if !std.isObject(object) - then false - else root.process( - object, - schema, - root.typeTestCases.object - ), - // foldEnd - - array(object, schema):: - // foldStart - if !std.isArray(object) - then false - else root.process( - object, - schema, - root.typeTestCases.array - ), - // foldEnd - }, - - notImplemented(key, schema): - std.trace('JSON Schema attribute `%s` not implemented.' % key, true), - - genericTestCases: { - enum(object, schema): - std.member(schema.enum, object), - - const(object, schema): - object == schema.const, - - not(object, schema): - !root.validate(object, schema.not), - - allOf(object, schema): - // foldStart - std.all([ - root.validate(object, s) - for s in schema.allOf - ]), - // foldEnd - - anyOf(object, schema): - // foldStart - std.any([ - root.validate(object, s) - for s in schema.anyOf - ]), - // foldEnd - - oneOf(object, schema): - // foldStart - std.length([ - true - for s in schema.oneOf - if root.validate(object, s) - ]) == 1, - // foldEnd - - 'if'(object, schema): - // foldStart - if root.validate( - object, - std.mergePatch( - schema { 'if': true, 'then': true }, - schema['if'] - ) - ) - then - if 'then' in schema - then - root.validate( - object, - std.mergePatch( - schema { 'if': true, 'then': true }, - schema['then'] - ) - ) - else true - else - if 'else' in schema - then - root.validate( - object, - std.mergePatch( - schema { 'if': true, 'then': true }, - schema['else'] - ) - ) - else true, - // foldEnd - - type(object, schema): - // foldStart - if std.isBoolean(schema.type) - then object != null - - else if std.isArray(schema.type) - then std.any([ - root.types[t](object, schema) - for t in schema.type - ]) - - else root.types[schema.type](object, schema), - // foldEnd - }, - - typeTestCases: { - string: { - // foldStart - minLength(object, schema): - std.length(object) >= schema.minLength, - - maxLength(object, schema): - std.length(object) <= schema.maxLength, - - pattern(object, schema): - root.notImplemented('pattern', schema), - - // vocabulary specific - //format(object, schema): - // root.notImplemented('format', schema), - }, // foldEnd - - number: { - // foldStart - multipleOf(object, schema): std.mod(object, schema.multipleOf) == 0, - minimum(object, schema): object >= schema.minimum, - maximum(object, schema): object <= schema.maximum, - - exclusiveMinimum(object, schema): - if std.isBoolean(schema.exclusiveMinimum) // Draft 4 - then - if 'minimum' in schema - then - if schema.exclusiveMinimum - then object > schema.minimum - else object >= schema.minimum - else true // invalid schema doesn't mean invalid object - else object > schema.exclusiveMinimum, - - exclusiveMaximum(object, schema): - if std.isBoolean(schema.exclusiveMaximum) // Draft 4 - then - if 'maximum' in schema - then - if schema.exclusiveMaximum - then object > schema.maximum - else object >= schema.maximum - else true // invalid schema doesn't mean invalid object - else object > schema.exclusiveMaximum, - }, // foldEnd - - object: { - // foldStart - patternProperties(object, schema): - root.notImplemented('patternProperties', schema), - dependentRequired(object, schema): - root.notImplemented('dependentRequired', schema), - unevaluatedProperties(object, schema): - root.notImplemented('unevaluatedProperties', schema), - additionalProperties(object, schema): - root.notImplemented('additionalProperties', schema), - - properties(object, schema): - std.all([ - root.validate(object[property], schema.properties[property]) - for property in std.objectFields(schema.properties) - if property in object - ]), - - required(object, schema): - std.all([ - std.member(std.objectFields(object), property) - for property in schema.required - ]), - - propertyNames(object, schema): - std.all([ - self.string(property, schema.propertyNames) - for property in std.objectFields(schema) - ]), - - minProperties(object, schema): - std.count(std.objectFields(object)) >= schema.minProperties, - - maxProperties(object, schema): - std.count(std.objectFields(object)) <= schema.maxProperties, - - }, // foldEnd - - array: { - // foldStart - minItems(object, schema): - std.length(object) >= schema.minItems, - - maxItems(object, schema): - std.length(object) <= schema.maxItems, - - uniqueItems(object, schema): - local f = function(x) std.md5(std.manifestJson(x)); - if schema.uniqueItems - then std.set(object, f) == std.sort(object, f) - else true, - - prefixItems(object, schema): - if std.length(schema.prefixItems) > 0 - then - local lengthCheck = - if 'items' in schema - && std.isBoolean(schema.items) - && !schema.items - then std.length(object) == std.length(schema.prefixItems) - else std.length(object) >= std.length(schema.prefixItems); - - if !lengthCheck - then false - else - std.all([ - root.validate(object[i], schema.prefixItems[i]) - for i in std.range(0, std.length(schema.prefixItems) - 1) - ]) - else true, - - items(object, schema): - if std.isBoolean(schema.items) - then true // only valid in the context of prefixItems - else - if std.length(object) == 0 - then true // validated by prefixItems and min/maxLength - else - local count = - if 'prefixItems' in schema - then std.length(schema.prefixItems) - else 0; - std.all([ - root.validate(item, schema.items) - for item in object[count:] - ]), - - contains(object, schema): - local validated = [ - true - for item in object - if root.validate(item, schema.contains) - ]; - std.any(validated) - && std.all([ - if 'minContains' in schema - then std.length(validated) >= schema.minContains - else true, - if 'maxContains' in schema - then std.length(validated) <= schema.maxContains - else true, - ]), - - unevaluatedItems(object, schema): - root.notImplemented('unevaluatedItems', schema), - }, // foldEnd - }, -} - -// vim: foldmethod=marker foldmarker=foldStart,foldEnd foldlevel=0 diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-latest/jsonnetfile.json b/vendor/github.com/grafana/grafonnet/gen/grafonnet-latest/jsonnetfile.json deleted file mode 100644 index 6b1bb91..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-latest/jsonnetfile.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "dependencies": [ - { - "source": { - "git": { - "remote": "https://github.com/grafana/grafonnet.git", - "subdir": "gen/grafonnet-v10.0.0" - } - }, - "version": "main" - } - ], - "legacyImports": false, - "version": 1 -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-latest/main.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-latest/main.libsonnet deleted file mode 100644 index 6da9f4e..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-latest/main.libsonnet +++ /dev/null @@ -1 +0,0 @@ -import 'github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/main.libsonnet' diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs.libsonnet deleted file mode 100644 index f0347b0..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs.libsonnet +++ /dev/null @@ -1,3 +0,0 @@ -local grafonnet = import 'github.com/grafana/grafonnet/grafonnet-base/main.libsonnet'; -local main = import './main.libsonnet'; -grafonnet.docs(main) diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/README.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/README.md deleted file mode 100644 index de1f82e..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/README.md +++ /dev/null @@ -1,29 +0,0 @@ -# grafonnet - -Jsonnet library for rendering Grafana resources - -## Install - -``` -jb install github.com/grafana/grafonnet/gen/grafonnet-v10.0.0@main -``` - -## Usage - -```jsonnet -local grafonnet = import "github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/main.libsonnet" -``` - -## Subpackages - -* [dashboard](grafonnet/dashboard/index.md) -* [librarypanel](grafonnet/librarypanel.md) -* [panel](grafonnet/panel/index.md) -* [playlist](grafonnet/playlist.md) -* [preferences](grafonnet/preferences.md) -* [publicdashboard](grafonnet/publicdashboard.md) -* [query](grafonnet/query/index.md) -* [serviceaccount](grafonnet/serviceaccount.md) -* [team](grafonnet/team.md) -* [util](grafonnet/util.md) - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/dashboard/annotation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/dashboard/annotation.md deleted file mode 100644 index 4f3b261..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/dashboard/annotation.md +++ /dev/null @@ -1,217 +0,0 @@ -# annotation - - - -## Index - -* [`fn withDatasource(value)`](#fn-withdatasource) -* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) -* [`fn withEnable(value=true)`](#fn-withenable) -* [`fn withFilter(value)`](#fn-withfilter) -* [`fn withFilterMixin(value)`](#fn-withfiltermixin) -* [`fn withHide(value=false)`](#fn-withhide) -* [`fn withIconColor(value)`](#fn-withiconcolor) -* [`fn withName(value)`](#fn-withname) -* [`fn withTarget(value)`](#fn-withtarget) -* [`fn withTargetMixin(value)`](#fn-withtargetmixin) -* [`fn withType(value)`](#fn-withtype) -* [`obj datasource`](#obj-datasource) - * [`fn withType(value)`](#fn-datasourcewithtype) - * [`fn withUid(value)`](#fn-datasourcewithuid) -* [`obj filter`](#obj-filter) - * [`fn withExclude(value=false)`](#fn-filterwithexclude) - * [`fn withIds(value)`](#fn-filterwithids) - * [`fn withIdsMixin(value)`](#fn-filterwithidsmixin) -* [`obj target`](#obj-target) - * [`fn withLimit(value)`](#fn-targetwithlimit) - * [`fn withMatchAny(value)`](#fn-targetwithmatchany) - * [`fn withTags(value)`](#fn-targetwithtags) - * [`fn withTagsMixin(value)`](#fn-targetwithtagsmixin) - * [`fn withType(value)`](#fn-targetwithtype) - -## Fields - -### fn withDatasource - -```ts -withDatasource(value) -``` - -TODO: Should be DataSourceRef - -### fn withDatasourceMixin - -```ts -withDatasourceMixin(value) -``` - -TODO: Should be DataSourceRef - -### fn withEnable - -```ts -withEnable(value=true) -``` - -When enabled the annotation query is issued with every dashboard refresh - -### fn withFilter - -```ts -withFilter(value) -``` - - - -### fn withFilterMixin - -```ts -withFilterMixin(value) -``` - - - -### fn withHide - -```ts -withHide(value=false) -``` - -Annotation queries can be toggled on or off at the top of the dashboard. -When hide is true, the toggle is not shown in the dashboard. - -### fn withIconColor - -```ts -withIconColor(value) -``` - -Color to use for the annotation event markers - -### fn withName - -```ts -withName(value) -``` - -Name of annotation. - -### fn withTarget - -```ts -withTarget(value) -``` - -TODO: this should be a regular DataQuery that depends on the selected dashboard -these match the properties of the "grafana" datasouce that is default in most dashboards - -### fn withTargetMixin - -```ts -withTargetMixin(value) -``` - -TODO: this should be a regular DataQuery that depends on the selected dashboard -these match the properties of the "grafana" datasouce that is default in most dashboards - -### fn withType - -```ts -withType(value) -``` - -TODO -- this should not exist here, it is based on the --grafana-- datasource - -### obj datasource - - -#### fn datasource.withType - -```ts -withType(value) -``` - - - -#### fn datasource.withUid - -```ts -withUid(value) -``` - - - -### obj filter - - -#### fn filter.withExclude - -```ts -withExclude(value=false) -``` - -Should the specified panels be included or excluded - -#### fn filter.withIds - -```ts -withIds(value) -``` - -Panel IDs that should be included or excluded - -#### fn filter.withIdsMixin - -```ts -withIdsMixin(value) -``` - -Panel IDs that should be included or excluded - -### obj target - - -#### fn target.withLimit - -```ts -withLimit(value) -``` - -Only required/valid for the grafana datasource... -but code+tests is already depending on it so hard to change - -#### fn target.withMatchAny - -```ts -withMatchAny(value) -``` - -Only required/valid for the grafana datasource... -but code+tests is already depending on it so hard to change - -#### fn target.withTags - -```ts -withTags(value) -``` - -Only required/valid for the grafana datasource... -but code+tests is already depending on it so hard to change - -#### fn target.withTagsMixin - -```ts -withTagsMixin(value) -``` - -Only required/valid for the grafana datasource... -but code+tests is already depending on it so hard to change - -#### fn target.withType - -```ts -withType(value) -``` - -Only required/valid for the grafana datasource... -but code+tests is already depending on it so hard to change diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/dashboard/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/dashboard/index.md deleted file mode 100644 index e68e1d3..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/dashboard/index.md +++ /dev/null @@ -1,366 +0,0 @@ -# dashboard - -grafonnet.dashboard - -## Subpackages - -* [annotation](annotation.md) -* [link](link.md) -* [variable](variable.md) - -## Index - -* [`fn new(title)`](#fn-new) -* [`fn withAnnotations(value)`](#fn-withannotations) -* [`fn withAnnotationsMixin(value)`](#fn-withannotationsmixin) -* [`fn withDescription(value)`](#fn-withdescription) -* [`fn withEditable(value=true)`](#fn-witheditable) -* [`fn withFiscalYearStartMonth(value=0)`](#fn-withfiscalyearstartmonth) -* [`fn withLinks(value)`](#fn-withlinks) -* [`fn withLinksMixin(value)`](#fn-withlinksmixin) -* [`fn withLiveNow(value)`](#fn-withlivenow) -* [`fn withPanels(value)`](#fn-withpanels) -* [`fn withPanelsMixin(value)`](#fn-withpanelsmixin) -* [`fn withRefresh(value)`](#fn-withrefresh) -* [`fn withRefreshMixin(value)`](#fn-withrefreshmixin) -* [`fn withSchemaVersion(value=36)`](#fn-withschemaversion) -* [`fn withStyle(value="dark")`](#fn-withstyle) -* [`fn withTags(value)`](#fn-withtags) -* [`fn withTagsMixin(value)`](#fn-withtagsmixin) -* [`fn withTemplating(value)`](#fn-withtemplating) -* [`fn withTemplatingMixin(value)`](#fn-withtemplatingmixin) -* [`fn withTimezone(value="browser")`](#fn-withtimezone) -* [`fn withTitle(value)`](#fn-withtitle) -* [`fn withUid(value)`](#fn-withuid) -* [`fn withVariables(value)`](#fn-withvariables) -* [`fn withVariablesMixin(value)`](#fn-withvariablesmixin) -* [`fn withWeekStart(value)`](#fn-withweekstart) -* [`obj graphTooltip`](#obj-graphtooltip) - * [`fn withSharedCrosshair()`](#fn-graphtooltipwithsharedcrosshair) - * [`fn withSharedTooltip()`](#fn-graphtooltipwithsharedtooltip) -* [`obj time`](#obj-time) - * [`fn withFrom(value="now-6h")`](#fn-timewithfrom) - * [`fn withTo(value="now")`](#fn-timewithto) -* [`obj timepicker`](#obj-timepicker) - * [`fn withCollapse(value=false)`](#fn-timepickerwithcollapse) - * [`fn withEnable(value=true)`](#fn-timepickerwithenable) - * [`fn withHidden(value=false)`](#fn-timepickerwithhidden) - * [`fn withRefreshIntervals(value=["5s","10s","30s","1m","5m","15m","30m","1h","2h","1d"])`](#fn-timepickerwithrefreshintervals) - * [`fn withRefreshIntervalsMixin(value=["5s","10s","30s","1m","5m","15m","30m","1h","2h","1d"])`](#fn-timepickerwithrefreshintervalsmixin) - * [`fn withTimeOptions(value=["5m","15m","1h","6h","12h","24h","2d","7d","30d"])`](#fn-timepickerwithtimeoptions) - * [`fn withTimeOptionsMixin(value=["5m","15m","1h","6h","12h","24h","2d","7d","30d"])`](#fn-timepickerwithtimeoptionsmixin) - -## Fields - -### fn new - -```ts -new(title) -``` - -Creates a new dashboard with a title. - -### fn withAnnotations - -```ts -withAnnotations(value) -``` - -`withAnnotations` adds an array of annotations to a dashboard. - -This function appends passed data to existing values - - -### fn withAnnotationsMixin - -```ts -withAnnotationsMixin(value) -``` - -`withAnnotationsMixin` adds an array of annotations to a dashboard. - -This function appends passed data to existing values - - -### fn withDescription - -```ts -withDescription(value) -``` - -Description of dashboard. - -### fn withEditable - -```ts -withEditable(value=true) -``` - -Whether a dashboard is editable or not. - -### fn withFiscalYearStartMonth - -```ts -withFiscalYearStartMonth(value=0) -``` - -The month that the fiscal year starts on. 0 = January, 11 = December - -### fn withLinks - -```ts -withLinks(value) -``` - -TODO docs - -### fn withLinksMixin - -```ts -withLinksMixin(value) -``` - -TODO docs - -### fn withLiveNow - -```ts -withLiveNow(value) -``` - -When set to true, the dashboard will redraw panels at an interval matching the pixel width. -This will keep data "moving left" regardless of the query refresh rate. This setting helps -avoid dashboards presenting stale live data - -### fn withPanels - -```ts -withPanels(value) -``` - - - -### fn withPanelsMixin - -```ts -withPanelsMixin(value) -``` - - - -### fn withRefresh - -```ts -withRefresh(value) -``` - -Refresh rate of dashboard. Represented via interval string, e.g. "5s", "1m", "1h", "1d". - -### fn withRefreshMixin - -```ts -withRefreshMixin(value) -``` - -Refresh rate of dashboard. Represented via interval string, e.g. "5s", "1m", "1h", "1d". - -### fn withSchemaVersion - -```ts -withSchemaVersion(value=36) -``` - -Version of the JSON schema, incremented each time a Grafana update brings -changes to said schema. -TODO this is the existing schema numbering system. It will be replaced by Thema's themaVersion - -### fn withStyle - -```ts -withStyle(value="dark") -``` - -Theme of dashboard. - -Accepted values for `value` are "dark", "light" - -### fn withTags - -```ts -withTags(value) -``` - -Tags associated with dashboard. - -### fn withTagsMixin - -```ts -withTagsMixin(value) -``` - -Tags associated with dashboard. - -### fn withTemplating - -```ts -withTemplating(value) -``` - -TODO docs - -### fn withTemplatingMixin - -```ts -withTemplatingMixin(value) -``` - -TODO docs - -### fn withTimezone - -```ts -withTimezone(value="browser") -``` - -Timezone of dashboard. Accepts IANA TZDB zone ID or "browser" or "utc". - -### fn withTitle - -```ts -withTitle(value) -``` - -Title of dashboard. - -### fn withUid - -```ts -withUid(value) -``` - -Unique dashboard identifier that can be generated by anyone. string (8-40) - -### fn withVariables - -```ts -withVariables(value) -``` - -`withVariables` adds an array of variables to a dashboard - - -### fn withVariablesMixin - -```ts -withVariablesMixin(value) -``` - -`withVariablesMixin` adds an array of variables to a dashboard. - -This function appends passed data to existing values - - -### fn withWeekStart - -```ts -withWeekStart(value) -``` - -TODO docs - -### obj graphTooltip - - -#### fn graphTooltip.withSharedCrosshair - -```ts -withSharedCrosshair() -``` - -Share crosshair on all panels. - -#### fn graphTooltip.withSharedTooltip - -```ts -withSharedTooltip() -``` - -Share crosshair and tooltip on all panels. - -### obj time - - -#### fn time.withFrom - -```ts -withFrom(value="now-6h") -``` - - - -#### fn time.withTo - -```ts -withTo(value="now") -``` - - - -### obj timepicker - - -#### fn timepicker.withCollapse - -```ts -withCollapse(value=false) -``` - -Whether timepicker is collapsed or not. - -#### fn timepicker.withEnable - -```ts -withEnable(value=true) -``` - -Whether timepicker is enabled or not. - -#### fn timepicker.withHidden - -```ts -withHidden(value=false) -``` - -Whether timepicker is visible or not. - -#### fn timepicker.withRefreshIntervals - -```ts -withRefreshIntervals(value=["5s","10s","30s","1m","5m","15m","30m","1h","2h","1d"]) -``` - -Selectable intervals for auto-refresh. - -#### fn timepicker.withRefreshIntervalsMixin - -```ts -withRefreshIntervalsMixin(value=["5s","10s","30s","1m","5m","15m","30m","1h","2h","1d"]) -``` - -Selectable intervals for auto-refresh. - -#### fn timepicker.withTimeOptions - -```ts -withTimeOptions(value=["5m","15m","1h","6h","12h","24h","2d","7d","30d"]) -``` - -TODO docs - -#### fn timepicker.withTimeOptionsMixin - -```ts -withTimeOptionsMixin(value=["5m","15m","1h","6h","12h","24h","2d","7d","30d"]) -``` - -TODO docs diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/dashboard/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/dashboard/link.md deleted file mode 100644 index 1c82a56..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/dashboard/link.md +++ /dev/null @@ -1,134 +0,0 @@ -# link - - - -## Index - -* [`obj dashboards`](#obj-dashboards) - * [`fn new(title, tags)`](#fn-dashboardsnew) - * [`obj options`](#obj-dashboardsoptions) - * [`fn withAsDropdown(value=false)`](#fn-dashboardsoptionswithasdropdown) - * [`fn withIncludeVars(value=false)`](#fn-dashboardsoptionswithincludevars) - * [`fn withKeepTime(value=false)`](#fn-dashboardsoptionswithkeeptime) - * [`fn withTargetBlank(value=false)`](#fn-dashboardsoptionswithtargetblank) -* [`obj link`](#obj-link) - * [`fn new(title, url)`](#fn-linknew) - * [`fn withIcon(value)`](#fn-linkwithicon) - * [`fn withTooltip(value)`](#fn-linkwithtooltip) - * [`obj options`](#obj-linkoptions) - * [`fn withAsDropdown(value=false)`](#fn-linkoptionswithasdropdown) - * [`fn withIncludeVars(value=false)`](#fn-linkoptionswithincludevars) - * [`fn withKeepTime(value=false)`](#fn-linkoptionswithkeeptime) - * [`fn withTargetBlank(value=false)`](#fn-linkoptionswithtargetblank) - -## Fields - -### obj dashboards - - -#### fn dashboards.new - -```ts -new(title, tags) -``` - -Create links to dashboards based on `tags`. - - -#### obj dashboards.options - - -##### fn dashboards.options.withAsDropdown - -```ts -withAsDropdown(value=false) -``` - - - -##### fn dashboards.options.withIncludeVars - -```ts -withIncludeVars(value=false) -``` - - - -##### fn dashboards.options.withKeepTime - -```ts -withKeepTime(value=false) -``` - - - -##### fn dashboards.options.withTargetBlank - -```ts -withTargetBlank(value=false) -``` - - - -### obj link - - -#### fn link.new - -```ts -new(title, url) -``` - -Create link to an arbitrary URL. - - -#### fn link.withIcon - -```ts -withIcon(value) -``` - - - -#### fn link.withTooltip - -```ts -withTooltip(value) -``` - - - -#### obj link.options - - -##### fn link.options.withAsDropdown - -```ts -withAsDropdown(value=false) -``` - - - -##### fn link.options.withIncludeVars - -```ts -withIncludeVars(value=false) -``` - - - -##### fn link.options.withKeepTime - -```ts -withKeepTime(value=false) -``` - - - -##### fn link.options.withTargetBlank - -```ts -withTargetBlank(value=false) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/dashboard/variable.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/dashboard/variable.md deleted file mode 100644 index 8999706..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/dashboard/variable.md +++ /dev/null @@ -1,780 +0,0 @@ -# variable - -Example usage: - -```jsonnet -local g = import 'g.libsonnet'; -local var = g.dashboard.variable; - -local customVar = - var.custom.new( - 'myOptions', - values=['a', 'b', 'c', 'd'], - ) - + var.custom.generalOptions.withDescription( - 'This is a variable for my custom options.' - ) - + var.custom.selectionOptions.withMulti(); - -local queryVar = - var.query.new('queryOptions') - + var.query.queryTypes.withLabelValues( - 'up', - 'instance', - ) - + var.query.withDatasource( - type='prometheus', - uid='mimir-prod', - ) - + var.query.selectionOptions.withIncludeAll(); - - -g.dashboard.new('my dashboard') -+ g.dashboard.withVariables([ - customVar, - queryVar, -]) -``` - - -## Index - -* [`obj adhoc`](#obj-adhoc) - * [`fn new(name, type, uid)`](#fn-adhocnew) - * [`fn newFromVariable(name, variable)`](#fn-adhocnewfromvariable) - * [`obj generalOptions`](#obj-adhocgeneraloptions) - * [`fn withDescription(value)`](#fn-adhocgeneraloptionswithdescription) - * [`fn withLabel(value)`](#fn-adhocgeneraloptionswithlabel) - * [`fn withName(value)`](#fn-adhocgeneraloptionswithname) - * [`obj showOnDashboard`](#obj-adhocgeneraloptionsshowondashboard) - * [`fn withLabelAndValue()`](#fn-adhocgeneraloptionsshowondashboardwithlabelandvalue) - * [`fn withNothing()`](#fn-adhocgeneraloptionsshowondashboardwithnothing) - * [`fn withValueOnly()`](#fn-adhocgeneraloptionsshowondashboardwithvalueonly) -* [`obj constant`](#obj-constant) - * [`fn new(name, value)`](#fn-constantnew) - * [`obj generalOptions`](#obj-constantgeneraloptions) - * [`fn withDescription(value)`](#fn-constantgeneraloptionswithdescription) - * [`fn withLabel(value)`](#fn-constantgeneraloptionswithlabel) - * [`fn withName(value)`](#fn-constantgeneraloptionswithname) - * [`obj showOnDashboard`](#obj-constantgeneraloptionsshowondashboard) - * [`fn withLabelAndValue()`](#fn-constantgeneraloptionsshowondashboardwithlabelandvalue) - * [`fn withNothing()`](#fn-constantgeneraloptionsshowondashboardwithnothing) - * [`fn withValueOnly()`](#fn-constantgeneraloptionsshowondashboardwithvalueonly) -* [`obj custom`](#obj-custom) - * [`fn new(name, values)`](#fn-customnew) - * [`obj generalOptions`](#obj-customgeneraloptions) - * [`fn withDescription(value)`](#fn-customgeneraloptionswithdescription) - * [`fn withLabel(value)`](#fn-customgeneraloptionswithlabel) - * [`fn withName(value)`](#fn-customgeneraloptionswithname) - * [`obj showOnDashboard`](#obj-customgeneraloptionsshowondashboard) - * [`fn withLabelAndValue()`](#fn-customgeneraloptionsshowondashboardwithlabelandvalue) - * [`fn withNothing()`](#fn-customgeneraloptionsshowondashboardwithnothing) - * [`fn withValueOnly()`](#fn-customgeneraloptionsshowondashboardwithvalueonly) - * [`obj selectionOptions`](#obj-customselectionoptions) - * [`fn withIncludeAll(value=true, customAllValue)`](#fn-customselectionoptionswithincludeall) - * [`fn withMulti(value=true)`](#fn-customselectionoptionswithmulti) -* [`obj datasource`](#obj-datasource) - * [`fn new(name, type)`](#fn-datasourcenew) - * [`fn withRegex(value)`](#fn-datasourcewithregex) - * [`obj generalOptions`](#obj-datasourcegeneraloptions) - * [`fn withDescription(value)`](#fn-datasourcegeneraloptionswithdescription) - * [`fn withLabel(value)`](#fn-datasourcegeneraloptionswithlabel) - * [`fn withName(value)`](#fn-datasourcegeneraloptionswithname) - * [`obj showOnDashboard`](#obj-datasourcegeneraloptionsshowondashboard) - * [`fn withLabelAndValue()`](#fn-datasourcegeneraloptionsshowondashboardwithlabelandvalue) - * [`fn withNothing()`](#fn-datasourcegeneraloptionsshowondashboardwithnothing) - * [`fn withValueOnly()`](#fn-datasourcegeneraloptionsshowondashboardwithvalueonly) - * [`obj selectionOptions`](#obj-datasourceselectionoptions) - * [`fn withIncludeAll(value=true, customAllValue)`](#fn-datasourceselectionoptionswithincludeall) - * [`fn withMulti(value=true)`](#fn-datasourceselectionoptionswithmulti) -* [`obj interval`](#obj-interval) - * [`fn new(name, values)`](#fn-intervalnew) - * [`fn withAutoOption(count, minInterval)`](#fn-intervalwithautooption) - * [`obj generalOptions`](#obj-intervalgeneraloptions) - * [`fn withDescription(value)`](#fn-intervalgeneraloptionswithdescription) - * [`fn withLabel(value)`](#fn-intervalgeneraloptionswithlabel) - * [`fn withName(value)`](#fn-intervalgeneraloptionswithname) - * [`obj showOnDashboard`](#obj-intervalgeneraloptionsshowondashboard) - * [`fn withLabelAndValue()`](#fn-intervalgeneraloptionsshowondashboardwithlabelandvalue) - * [`fn withNothing()`](#fn-intervalgeneraloptionsshowondashboardwithnothing) - * [`fn withValueOnly()`](#fn-intervalgeneraloptionsshowondashboardwithvalueonly) -* [`obj query`](#obj-query) - * [`fn new(name, query="")`](#fn-querynew) - * [`fn withDatasource(type, uid)`](#fn-querywithdatasource) - * [`fn withDatasourceFromVariable(variable)`](#fn-querywithdatasourcefromvariable) - * [`fn withRegex(value)`](#fn-querywithregex) - * [`fn withSort(i=0, type="alphabetical", asc=true, caseInsensitive=false)`](#fn-querywithsort) - * [`obj generalOptions`](#obj-querygeneraloptions) - * [`fn withDescription(value)`](#fn-querygeneraloptionswithdescription) - * [`fn withLabel(value)`](#fn-querygeneraloptionswithlabel) - * [`fn withName(value)`](#fn-querygeneraloptionswithname) - * [`obj showOnDashboard`](#obj-querygeneraloptionsshowondashboard) - * [`fn withLabelAndValue()`](#fn-querygeneraloptionsshowondashboardwithlabelandvalue) - * [`fn withNothing()`](#fn-querygeneraloptionsshowondashboardwithnothing) - * [`fn withValueOnly()`](#fn-querygeneraloptionsshowondashboardwithvalueonly) - * [`obj queryTypes`](#obj-queryquerytypes) - * [`fn withLabelValues(label, metric)`](#fn-queryquerytypeswithlabelvalues) - * [`obj refresh`](#obj-queryrefresh) - * [`fn onLoad()`](#fn-queryrefreshonload) - * [`fn onTime()`](#fn-queryrefreshontime) - * [`obj selectionOptions`](#obj-queryselectionoptions) - * [`fn withIncludeAll(value=true, customAllValue)`](#fn-queryselectionoptionswithincludeall) - * [`fn withMulti(value=true)`](#fn-queryselectionoptionswithmulti) -* [`obj textbox`](#obj-textbox) - * [`fn new(name, default="")`](#fn-textboxnew) - * [`obj generalOptions`](#obj-textboxgeneraloptions) - * [`fn withDescription(value)`](#fn-textboxgeneraloptionswithdescription) - * [`fn withLabel(value)`](#fn-textboxgeneraloptionswithlabel) - * [`fn withName(value)`](#fn-textboxgeneraloptionswithname) - * [`obj showOnDashboard`](#obj-textboxgeneraloptionsshowondashboard) - * [`fn withLabelAndValue()`](#fn-textboxgeneraloptionsshowondashboardwithlabelandvalue) - * [`fn withNothing()`](#fn-textboxgeneraloptionsshowondashboardwithnothing) - * [`fn withValueOnly()`](#fn-textboxgeneraloptionsshowondashboardwithvalueonly) - -## Fields - -### obj adhoc - - -#### fn adhoc.new - -```ts -new(name, type, uid) -``` - -`new` creates an adhoc template variable for datasource with `type` and `uid`. - -#### fn adhoc.newFromVariable - -```ts -newFromVariable(name, variable) -``` - -Same as `new` but selecting the datasource from another template variable. - -#### obj adhoc.generalOptions - - -##### fn adhoc.generalOptions.withDescription - -```ts -withDescription(value) -``` - - - -##### fn adhoc.generalOptions.withLabel - -```ts -withLabel(value) -``` - - - -##### fn adhoc.generalOptions.withName - -```ts -withName(value) -``` - - - -##### obj adhoc.generalOptions.showOnDashboard - - -###### fn adhoc.generalOptions.showOnDashboard.withLabelAndValue - -```ts -withLabelAndValue() -``` - - - -###### fn adhoc.generalOptions.showOnDashboard.withNothing - -```ts -withNothing() -``` - - - -###### fn adhoc.generalOptions.showOnDashboard.withValueOnly - -```ts -withValueOnly() -``` - - - -### obj constant - - -#### fn constant.new - -```ts -new(name, value) -``` - -`new` creates a hidden constant template variable. - -#### obj constant.generalOptions - - -##### fn constant.generalOptions.withDescription - -```ts -withDescription(value) -``` - - - -##### fn constant.generalOptions.withLabel - -```ts -withLabel(value) -``` - - - -##### fn constant.generalOptions.withName - -```ts -withName(value) -``` - - - -##### obj constant.generalOptions.showOnDashboard - - -###### fn constant.generalOptions.showOnDashboard.withLabelAndValue - -```ts -withLabelAndValue() -``` - - - -###### fn constant.generalOptions.showOnDashboard.withNothing - -```ts -withNothing() -``` - - - -###### fn constant.generalOptions.showOnDashboard.withValueOnly - -```ts -withValueOnly() -``` - - - -### obj custom - - -#### fn custom.new - -```ts -new(name, values) -``` - -`new` creates a custom template variable. - -The `values` array accepts an object with key/value keys, if it's not an object -then it will be added as a string. - -Example: -``` -[ - { key: 'mykey', value: 'myvalue' }, - 'myvalue', - 12, -] - - -#### obj custom.generalOptions - - -##### fn custom.generalOptions.withDescription - -```ts -withDescription(value) -``` - - - -##### fn custom.generalOptions.withLabel - -```ts -withLabel(value) -``` - - - -##### fn custom.generalOptions.withName - -```ts -withName(value) -``` - - - -##### obj custom.generalOptions.showOnDashboard - - -###### fn custom.generalOptions.showOnDashboard.withLabelAndValue - -```ts -withLabelAndValue() -``` - - - -###### fn custom.generalOptions.showOnDashboard.withNothing - -```ts -withNothing() -``` - - - -###### fn custom.generalOptions.showOnDashboard.withValueOnly - -```ts -withValueOnly() -``` - - - -#### obj custom.selectionOptions - - -##### fn custom.selectionOptions.withIncludeAll - -```ts -withIncludeAll(value=true, customAllValue) -``` - -`withIncludeAll` enables an option to include all variables. - -Optionally you can set a `customAllValue`. - - -##### fn custom.selectionOptions.withMulti - -```ts -withMulti(value=true) -``` - -Enable selecting multiple values. - -### obj datasource - - -#### fn datasource.new - -```ts -new(name, type) -``` - -`new` creates a datasource template variable. - -#### fn datasource.withRegex - -```ts -withRegex(value) -``` - -`withRegex` filter for which data source instances to choose from in the -variable value list. Example: `/^prod/` - - -#### obj datasource.generalOptions - - -##### fn datasource.generalOptions.withDescription - -```ts -withDescription(value) -``` - - - -##### fn datasource.generalOptions.withLabel - -```ts -withLabel(value) -``` - - - -##### fn datasource.generalOptions.withName - -```ts -withName(value) -``` - - - -##### obj datasource.generalOptions.showOnDashboard - - -###### fn datasource.generalOptions.showOnDashboard.withLabelAndValue - -```ts -withLabelAndValue() -``` - - - -###### fn datasource.generalOptions.showOnDashboard.withNothing - -```ts -withNothing() -``` - - - -###### fn datasource.generalOptions.showOnDashboard.withValueOnly - -```ts -withValueOnly() -``` - - - -#### obj datasource.selectionOptions - - -##### fn datasource.selectionOptions.withIncludeAll - -```ts -withIncludeAll(value=true, customAllValue) -``` - -`withIncludeAll` enables an option to include all variables. - -Optionally you can set a `customAllValue`. - - -##### fn datasource.selectionOptions.withMulti - -```ts -withMulti(value=true) -``` - -Enable selecting multiple values. - -### obj interval - - -#### fn interval.new - -```ts -new(name, values) -``` - -`new` creates an interval template variable. - -#### fn interval.withAutoOption - -```ts -withAutoOption(count, minInterval) -``` - -`withAutoOption` adds an options to dynamically calculate interval by dividing -time range by the count specified. - -`minInterval' has to be either unit-less or end with one of the following units: -"y, M, w, d, h, m, s, ms". - - -#### obj interval.generalOptions - - -##### fn interval.generalOptions.withDescription - -```ts -withDescription(value) -``` - - - -##### fn interval.generalOptions.withLabel - -```ts -withLabel(value) -``` - - - -##### fn interval.generalOptions.withName - -```ts -withName(value) -``` - - - -##### obj interval.generalOptions.showOnDashboard - - -###### fn interval.generalOptions.showOnDashboard.withLabelAndValue - -```ts -withLabelAndValue() -``` - - - -###### fn interval.generalOptions.showOnDashboard.withNothing - -```ts -withNothing() -``` - - - -###### fn interval.generalOptions.showOnDashboard.withValueOnly - -```ts -withValueOnly() -``` - - - -### obj query - - -#### fn query.new - -```ts -new(name, query="") -``` - -Create a query template variable. - -`query` argument is optional, this can also be set with `query.queryTypes`. - - -#### fn query.withDatasource - -```ts -withDatasource(type, uid) -``` - -Select a datasource for the variable template query. - -#### fn query.withDatasourceFromVariable - -```ts -withDatasourceFromVariable(variable) -``` - -Select the datasource from another template variable. - -#### fn query.withRegex - -```ts -withRegex(value) -``` - -`withRegex` can extract part of a series name or metric node segment. Named -capture groups can be used to separate the display text and value -([see examples](https://grafana.com/docs/grafana/latest/variables/filter-variables-with-regex#filter-and-modify-using-named-text-and-value-capture-groups)). - - -#### fn query.withSort - -```ts -withSort(i=0, type="alphabetical", asc=true, caseInsensitive=false) -``` - -Choose how to sort the values in the dropdown. - -This can be called as `withSort() to use the integer values for each -option. If `i==0` then it will be ignored and the other arguments will take -precedence. - -The numerical values are: - -- 1 - Alphabetical (asc) -- 2 - Alphabetical (desc) -- 3 - Numerical (asc) -- 4 - Numerical (desc) -- 5 - Alphabetical (case-insensitive, asc) -- 6 - Alphabetical (case-insensitive, desc) - - -#### obj query.generalOptions - - -##### fn query.generalOptions.withDescription - -```ts -withDescription(value) -``` - - - -##### fn query.generalOptions.withLabel - -```ts -withLabel(value) -``` - - - -##### fn query.generalOptions.withName - -```ts -withName(value) -``` - - - -##### obj query.generalOptions.showOnDashboard - - -###### fn query.generalOptions.showOnDashboard.withLabelAndValue - -```ts -withLabelAndValue() -``` - - - -###### fn query.generalOptions.showOnDashboard.withNothing - -```ts -withNothing() -``` - - - -###### fn query.generalOptions.showOnDashboard.withValueOnly - -```ts -withValueOnly() -``` - - - -#### obj query.queryTypes - - -##### fn query.queryTypes.withLabelValues - -```ts -withLabelValues(label, metric) -``` - -Construct a Prometheus template variable using `label_values()`. - -#### obj query.refresh - - -##### fn query.refresh.onLoad - -```ts -onLoad() -``` - -Refresh label values on dashboard load. - -##### fn query.refresh.onTime - -```ts -onTime() -``` - -Refresh label values on time range change. - -#### obj query.selectionOptions - - -##### fn query.selectionOptions.withIncludeAll - -```ts -withIncludeAll(value=true, customAllValue) -``` - -`withIncludeAll` enables an option to include all variables. - -Optionally you can set a `customAllValue`. - - -##### fn query.selectionOptions.withMulti - -```ts -withMulti(value=true) -``` - -Enable selecting multiple values. - -### obj textbox - - -#### fn textbox.new - -```ts -new(name, default="") -``` - -`new` creates a textbox template variable. - -#### obj textbox.generalOptions - - -##### fn textbox.generalOptions.withDescription - -```ts -withDescription(value) -``` - - - -##### fn textbox.generalOptions.withLabel - -```ts -withLabel(value) -``` - - - -##### fn textbox.generalOptions.withName - -```ts -withName(value) -``` - - - -##### obj textbox.generalOptions.showOnDashboard - - -###### fn textbox.generalOptions.showOnDashboard.withLabelAndValue - -```ts -withLabelAndValue() -``` - - - -###### fn textbox.generalOptions.showOnDashboard.withNothing - -```ts -withNothing() -``` - - - -###### fn textbox.generalOptions.showOnDashboard.withValueOnly - -```ts -withValueOnly() -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/librarypanel.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/librarypanel.md deleted file mode 100644 index 3ae7e2d..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/librarypanel.md +++ /dev/null @@ -1,256 +0,0 @@ -# librarypanel - -grafonnet.librarypanel - -## Index - -* [`fn withDescription(value)`](#fn-withdescription) -* [`fn withFolderUid(value)`](#fn-withfolderuid) -* [`fn withMeta(value)`](#fn-withmeta) -* [`fn withMetaMixin(value)`](#fn-withmetamixin) -* [`fn withModel(value)`](#fn-withmodel) -* [`fn withModelMixin(value)`](#fn-withmodelmixin) -* [`fn withName(value)`](#fn-withname) -* [`fn withSchemaVersion(value)`](#fn-withschemaversion) -* [`fn withType(value)`](#fn-withtype) -* [`fn withUid(value)`](#fn-withuid) -* [`fn withVersion(value)`](#fn-withversion) -* [`obj meta`](#obj-meta) - * [`fn withConnectedDashboards(value)`](#fn-metawithconnecteddashboards) - * [`fn withCreated(value)`](#fn-metawithcreated) - * [`fn withCreatedBy(value)`](#fn-metawithcreatedby) - * [`fn withCreatedByMixin(value)`](#fn-metawithcreatedbymixin) - * [`fn withFolderName(value)`](#fn-metawithfoldername) - * [`fn withFolderUid(value)`](#fn-metawithfolderuid) - * [`fn withUpdated(value)`](#fn-metawithupdated) - * [`fn withUpdatedBy(value)`](#fn-metawithupdatedby) - * [`fn withUpdatedByMixin(value)`](#fn-metawithupdatedbymixin) - * [`obj createdBy`](#obj-metacreatedby) - * [`fn withAvatarUrl(value)`](#fn-metacreatedbywithavatarurl) - * [`fn withId(value)`](#fn-metacreatedbywithid) - * [`fn withName(value)`](#fn-metacreatedbywithname) - * [`obj updatedBy`](#obj-metaupdatedby) - * [`fn withAvatarUrl(value)`](#fn-metaupdatedbywithavatarurl) - * [`fn withId(value)`](#fn-metaupdatedbywithid) - * [`fn withName(value)`](#fn-metaupdatedbywithname) - -## Fields - -### fn withDescription - -```ts -withDescription(value) -``` - -Panel description - -### fn withFolderUid - -```ts -withFolderUid(value) -``` - -Folder UID - -### fn withMeta - -```ts -withMeta(value) -``` - - - -### fn withMetaMixin - -```ts -withMetaMixin(value) -``` - - - -### fn withModel - -```ts -withModel(value) -``` - -TODO: should be the same panel schema defined in dashboard -Typescript: Omit; - -### fn withModelMixin - -```ts -withModelMixin(value) -``` - -TODO: should be the same panel schema defined in dashboard -Typescript: Omit; - -### fn withName - -```ts -withName(value) -``` - -Panel name (also saved in the model) - -### fn withSchemaVersion - -```ts -withSchemaVersion(value) -``` - -Dashboard version when this was saved (zero if unknown) - -### fn withType - -```ts -withType(value) -``` - -The panel type (from inside the model) - -### fn withUid - -```ts -withUid(value) -``` - -Library element UID - -### fn withVersion - -```ts -withVersion(value) -``` - -panel version, incremented each time the dashboard is updated. - -### obj meta - - -#### fn meta.withConnectedDashboards - -```ts -withConnectedDashboards(value) -``` - - - -#### fn meta.withCreated - -```ts -withCreated(value) -``` - - - -#### fn meta.withCreatedBy - -```ts -withCreatedBy(value) -``` - - - -#### fn meta.withCreatedByMixin - -```ts -withCreatedByMixin(value) -``` - - - -#### fn meta.withFolderName - -```ts -withFolderName(value) -``` - - - -#### fn meta.withFolderUid - -```ts -withFolderUid(value) -``` - - - -#### fn meta.withUpdated - -```ts -withUpdated(value) -``` - - - -#### fn meta.withUpdatedBy - -```ts -withUpdatedBy(value) -``` - - - -#### fn meta.withUpdatedByMixin - -```ts -withUpdatedByMixin(value) -``` - - - -#### obj meta.createdBy - - -##### fn meta.createdBy.withAvatarUrl - -```ts -withAvatarUrl(value) -``` - - - -##### fn meta.createdBy.withId - -```ts -withId(value) -``` - - - -##### fn meta.createdBy.withName - -```ts -withName(value) -``` - - - -#### obj meta.updatedBy - - -##### fn meta.updatedBy.withAvatarUrl - -```ts -withAvatarUrl(value) -``` - - - -##### fn meta.updatedBy.withId - -```ts -withId(value) -``` - - - -##### fn meta.updatedBy.withName - -```ts -withName(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/alertGroups/fieldOverride.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/alertGroups/fieldOverride.md deleted file mode 100644 index 3e2667b..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/alertGroups/fieldOverride.md +++ /dev/null @@ -1,194 +0,0 @@ -# fieldOverride - -Overrides allow you to customize visualization settings for specific fields or -series. This is accomplished by adding an override rule that targets -a particular set of fields and that can each define multiple options. - -```jsonnet -fieldOverride.byType.new('number') -+ fieldOverride.byType.withPropertiesFromOptions( - panel.standardOptions.withDecimals(2) - + panel.standardOptions.withUnit('s') -) -``` - - -## Index - -* [`obj byName`](#obj-byname) - * [`fn new(value)`](#fn-bynamenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bynamewithproperty) -* [`obj byQuery`](#obj-byquery) - * [`fn new(value)`](#fn-byquerynew) - * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byquerywithproperty) -* [`obj byRegexp`](#obj-byregexp) - * [`fn new(value)`](#fn-byregexpnew) - * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) -* [`obj byType`](#obj-bytype) - * [`fn new(value)`](#fn-bytypenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bytypewithproperty) -* [`obj byValue`](#obj-byvalue) - * [`fn new(value)`](#fn-byvaluenew) - * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) - -## Fields - -### obj byName - - -#### fn byName.new - -```ts -new(value) -``` - -`new` creates a new override of type `byName`. - -#### fn byName.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byName.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byQuery - - -#### fn byQuery.new - -```ts -new(value) -``` - -`new` creates a new override of type `byQuery`. - -#### fn byQuery.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byQuery.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byRegexp - - -#### fn byRegexp.new - -```ts -new(value) -``` - -`new` creates a new override of type `byRegexp`. - -#### fn byRegexp.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byRegexp.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byType - - -#### fn byType.new - -```ts -new(value) -``` - -`new` creates a new override of type `byType`. - -#### fn byType.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byType.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byValue - - -#### fn byValue.new - -```ts -new(value) -``` - -`new` creates a new override of type `byValue`. - -#### fn byValue.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byValue.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/alertGroups/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/alertGroups/index.md deleted file mode 100644 index 3eb7d60..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/alertGroups/index.md +++ /dev/null @@ -1,497 +0,0 @@ -# alertGroups - -grafonnet.panel.alertGroups - -## Subpackages - -* [fieldOverride](fieldOverride.md) -* [link](link.md) -* [thresholdStep](thresholdStep.md) -* [transformation](transformation.md) -* [valueMapping](valueMapping.md) - -## Index - -* [`fn new(title)`](#fn-new) -* [`obj datasource`](#obj-datasource) - * [`fn withType(value)`](#fn-datasourcewithtype) - * [`fn withUid(value)`](#fn-datasourcewithuid) -* [`obj gridPos`](#obj-gridpos) - * [`fn withH(value=9)`](#fn-gridposwithh) - * [`fn withStatic(value)`](#fn-gridposwithstatic) - * [`fn withW(value=12)`](#fn-gridposwithw) - * [`fn withX(value=0)`](#fn-gridposwithx) - * [`fn withY(value=0)`](#fn-gridposwithy) -* [`obj libraryPanel`](#obj-librarypanel) - * [`fn withName(value)`](#fn-librarypanelwithname) - * [`fn withUid(value)`](#fn-librarypanelwithuid) -* [`obj options`](#obj-options) - * [`fn withAlertmanager(value)`](#fn-optionswithalertmanager) - * [`fn withExpandAll(value)`](#fn-optionswithexpandall) - * [`fn withLabels(value)`](#fn-optionswithlabels) -* [`obj panelOptions`](#obj-paneloptions) - * [`fn withDescription(value)`](#fn-paneloptionswithdescription) - * [`fn withLinks(value)`](#fn-paneloptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) - * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) - * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) - * [`fn withTitle(value)`](#fn-paneloptionswithtitle) - * [`fn withTransparent(value=false)`](#fn-paneloptionswithtransparent) -* [`obj queryOptions`](#obj-queryoptions) - * [`fn withDatasource(value)`](#fn-queryoptionswithdatasource) - * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) - * [`fn withInterval(value)`](#fn-queryoptionswithinterval) - * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) - * [`fn withTargets(value)`](#fn-queryoptionswithtargets) - * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) - * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) - * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) - * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) - * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) -* [`obj standardOptions`](#obj-standardoptions) - * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) - * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) - * [`fn withLinks(value)`](#fn-standardoptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) - * [`fn withMappings(value)`](#fn-standardoptionswithmappings) - * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) - * [`fn withMax(value)`](#fn-standardoptionswithmax) - * [`fn withMin(value)`](#fn-standardoptionswithmin) - * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) - * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) - * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) - * [`fn withUnit(value)`](#fn-standardoptionswithunit) - * [`obj color`](#obj-standardoptionscolor) - * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) - * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) - * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) - * [`obj thresholds`](#obj-standardoptionsthresholds) - * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) - * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) - * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) - -## Fields - -### fn new - -```ts -new(title) -``` - -Creates a new alertGroups panel with a title. - -### obj datasource - - -#### fn datasource.withType - -```ts -withType(value) -``` - - - -#### fn datasource.withUid - -```ts -withUid(value) -``` - - - -### obj gridPos - - -#### fn gridPos.withH - -```ts -withH(value=9) -``` - -Panel - -#### fn gridPos.withStatic - -```ts -withStatic(value) -``` - -true if fixed - -#### fn gridPos.withW - -```ts -withW(value=12) -``` - -Panel - -#### fn gridPos.withX - -```ts -withX(value=0) -``` - -Panel x - -#### fn gridPos.withY - -```ts -withY(value=0) -``` - -Panel y - -### obj libraryPanel - - -#### fn libraryPanel.withName - -```ts -withName(value) -``` - - - -#### fn libraryPanel.withUid - -```ts -withUid(value) -``` - - - -### obj options - - -#### fn options.withAlertmanager - -```ts -withAlertmanager(value) -``` - -Name of the alertmanager used as a source for alerts - -#### fn options.withExpandAll - -```ts -withExpandAll(value) -``` - -Expand all alert groups by default - -#### fn options.withLabels - -```ts -withLabels(value) -``` - -Comma-separated list of values used to filter alert results - -### obj panelOptions - - -#### fn panelOptions.withDescription - -```ts -withDescription(value) -``` - -Description. - -#### fn panelOptions.withLinks - -```ts -withLinks(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withRepeat - -```ts -withRepeat(value) -``` - -Name of template variable to repeat for. - -#### fn panelOptions.withRepeatDirection - -```ts -withRepeatDirection(value="h") -``` - -Direction to repeat in if 'repeat' is set. -"h" for horizontal, "v" for vertical. -TODO this is probably optional - -Accepted values for `value` are "h", "v" - -#### fn panelOptions.withTitle - -```ts -withTitle(value) -``` - -Panel title. - -#### fn panelOptions.withTransparent - -```ts -withTransparent(value=false) -``` - -Whether to display the panel without a background. - -### obj queryOptions - - -#### fn queryOptions.withDatasource - -```ts -withDatasource(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withDatasourceMixin - -```ts -withDatasourceMixin(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withInterval - -```ts -withInterval(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withMaxDataPoints - -```ts -withMaxDataPoints(value) -``` - -TODO docs - -#### fn queryOptions.withTargets - -```ts -withTargets(value) -``` - -TODO docs - -#### fn queryOptions.withTargetsMixin - -```ts -withTargetsMixin(value) -``` - -TODO docs - -#### fn queryOptions.withTimeFrom - -```ts -withTimeFrom(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTimeShift - -```ts -withTimeShift(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTransformations - -```ts -withTransformations(value) -``` - - - -#### fn queryOptions.withTransformationsMixin - -```ts -withTransformationsMixin(value) -``` - - - -### obj standardOptions - - -#### fn standardOptions.withDecimals - -```ts -withDecimals(value) -``` - -Significant digits (for display) - -#### fn standardOptions.withDisplayName - -```ts -withDisplayName(value) -``` - -The display value for this field. This supports template variables blank is auto - -#### fn standardOptions.withLinks - -```ts -withLinks(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withMappings - -```ts -withMappings(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMappingsMixin - -```ts -withMappingsMixin(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMax - -```ts -withMax(value) -``` - - - -#### fn standardOptions.withMin - -```ts -withMin(value) -``` - - - -#### fn standardOptions.withNoValue - -```ts -withNoValue(value) -``` - -Alternative to empty string - -#### fn standardOptions.withOverrides - -```ts -withOverrides(value) -``` - - - -#### fn standardOptions.withOverridesMixin - -```ts -withOverridesMixin(value) -``` - - - -#### fn standardOptions.withUnit - -```ts -withUnit(value) -``` - -Numeric Options - -#### obj standardOptions.color - - -##### fn standardOptions.color.withFixedColor - -```ts -withFixedColor(value) -``` - -Stores the fixed color value if mode is fixed - -##### fn standardOptions.color.withMode - -```ts -withMode(value) -``` - -The main color scheme mode - -##### fn standardOptions.color.withSeriesBy - -```ts -withSeriesBy(value) -``` - -TODO docs - -Accepted values for `value` are "min", "max", "last" - -#### obj standardOptions.thresholds - - -##### fn standardOptions.thresholds.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "absolute", "percentage" - -##### fn standardOptions.thresholds.withSteps - -```ts -withSteps(value) -``` - -Must be sorted by 'value', first value is always -Infinity - -##### fn standardOptions.thresholds.withStepsMixin - -```ts -withStepsMixin(value) -``` - -Must be sorted by 'value', first value is always -Infinity diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/alertGroups/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/alertGroups/link.md deleted file mode 100644 index 1a1d7c4..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/alertGroups/link.md +++ /dev/null @@ -1,109 +0,0 @@ -# link - - - -## Index - -* [`fn withAsDropdown(value=false)`](#fn-withasdropdown) -* [`fn withIcon(value)`](#fn-withicon) -* [`fn withIncludeVars(value=false)`](#fn-withincludevars) -* [`fn withKeepTime(value=false)`](#fn-withkeeptime) -* [`fn withTags(value)`](#fn-withtags) -* [`fn withTagsMixin(value)`](#fn-withtagsmixin) -* [`fn withTargetBlank(value=false)`](#fn-withtargetblank) -* [`fn withTitle(value)`](#fn-withtitle) -* [`fn withTooltip(value)`](#fn-withtooltip) -* [`fn withType(value)`](#fn-withtype) -* [`fn withUrl(value)`](#fn-withurl) - -## Fields - -### fn withAsDropdown - -```ts -withAsDropdown(value=false) -``` - - - -### fn withIcon - -```ts -withIcon(value) -``` - - - -### fn withIncludeVars - -```ts -withIncludeVars(value=false) -``` - - - -### fn withKeepTime - -```ts -withKeepTime(value=false) -``` - - - -### fn withTags - -```ts -withTags(value) -``` - - - -### fn withTagsMixin - -```ts -withTagsMixin(value) -``` - - - -### fn withTargetBlank - -```ts -withTargetBlank(value=false) -``` - - - -### fn withTitle - -```ts -withTitle(value) -``` - - - -### fn withTooltip - -```ts -withTooltip(value) -``` - - - -### fn withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "link", "dashboards" - -### fn withUrl - -```ts -withUrl(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/alertGroups/thresholdStep.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/alertGroups/thresholdStep.md deleted file mode 100644 index 9d6af42..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/alertGroups/thresholdStep.md +++ /dev/null @@ -1,47 +0,0 @@ -# thresholdStep - - - -## Index - -* [`fn withColor(value)`](#fn-withcolor) -* [`fn withIndex(value)`](#fn-withindex) -* [`fn withState(value)`](#fn-withstate) -* [`fn withValue(value)`](#fn-withvalue) - -## Fields - -### fn withColor - -```ts -withColor(value) -``` - -TODO docs - -### fn withIndex - -```ts -withIndex(value) -``` - -Threshold index, an old property that is not needed an should only appear in older dashboards - -### fn withState - -```ts -withState(value) -``` - -TODO docs -TODO are the values here enumerable into a disjunction? -Some seem to be listed in typescript comment - -### fn withValue - -```ts -withValue(value) -``` - -TODO docs -FIXME the corresponding typescript field is required/non-optional, but nulls currently appear here when serializing -Infinity to JSON diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/alertGroups/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/alertGroups/transformation.md deleted file mode 100644 index 3dac7e9..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/alertGroups/transformation.md +++ /dev/null @@ -1,76 +0,0 @@ -# transformation - - - -## Index - -* [`fn withDisabled(value)`](#fn-withdisabled) -* [`fn withFilter(value)`](#fn-withfilter) -* [`fn withFilterMixin(value)`](#fn-withfiltermixin) -* [`fn withId(value)`](#fn-withid) -* [`fn withOptions(value)`](#fn-withoptions) -* [`obj filter`](#obj-filter) - * [`fn withId(value="")`](#fn-filterwithid) - * [`fn withOptions(value)`](#fn-filterwithoptions) - -## Fields - -### fn withDisabled - -```ts -withDisabled(value) -``` - -Disabled transformations are skipped - -### fn withFilter - -```ts -withFilter(value) -``` - - - -### fn withFilterMixin - -```ts -withFilterMixin(value) -``` - - - -### fn withId - -```ts -withId(value) -``` - -Unique identifier of transformer - -### fn withOptions - -```ts -withOptions(value) -``` - -Options to be passed to the transformer -Valid options depend on the transformer id - -### obj filter - - -#### fn filter.withId - -```ts -withId(value="") -``` - - - -#### fn filter.withOptions - -```ts -withOptions(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/alertGroups/valueMapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/alertGroups/valueMapping.md deleted file mode 100644 index a6bbdb3..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/alertGroups/valueMapping.md +++ /dev/null @@ -1,365 +0,0 @@ -# valueMapping - - - -## Index - -* [`obj RangeMap`](#obj-rangemap) - * [`fn withOptions(value)`](#fn-rangemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) - * [`obj options`](#obj-rangemapoptions) - * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) - * [`fn withResult(value)`](#fn-rangemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) - * [`fn withTo(value)`](#fn-rangemapoptionswithto) - * [`obj result`](#obj-rangemapoptionsresult) - * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) -* [`obj RegexMap`](#obj-regexmap) - * [`fn withOptions(value)`](#fn-regexmapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) - * [`obj options`](#obj-regexmapoptions) - * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) - * [`fn withResult(value)`](#fn-regexmapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) - * [`obj result`](#obj-regexmapoptionsresult) - * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) - * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) -* [`obj SpecialValueMap`](#obj-specialvaluemap) - * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) - * [`obj options`](#obj-specialvaluemapoptions) - * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) - * [`fn withPattern(value)`](#fn-specialvaluemapoptionswithpattern) - * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) - * [`obj result`](#obj-specialvaluemapoptionsresult) - * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) -* [`obj ValueMap`](#obj-valuemap) - * [`fn withOptions(value)`](#fn-valuemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) - -## Fields - -### obj RangeMap - - -#### fn RangeMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RangeMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RangeMap.withType - -```ts -withType(value) -``` - - - -#### obj RangeMap.options - - -##### fn RangeMap.options.withFrom - -```ts -withFrom(value) -``` - -to and from are `number | null` in current ts, really not sure what to do - -##### fn RangeMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RangeMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### fn RangeMap.options.withTo - -```ts -withTo(value) -``` - - - -##### obj RangeMap.options.result - - -###### fn RangeMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RangeMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RangeMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RangeMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj RegexMap - - -#### fn RegexMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RegexMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RegexMap.withType - -```ts -withType(value) -``` - - - -#### obj RegexMap.options - - -##### fn RegexMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn RegexMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RegexMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj RegexMap.options.result - - -###### fn RegexMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RegexMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RegexMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RegexMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj SpecialValueMap - - -#### fn SpecialValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn SpecialValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn SpecialValueMap.withType - -```ts -withType(value) -``` - - - -#### obj SpecialValueMap.options - - -##### fn SpecialValueMap.options.withMatch - -```ts -withMatch(value) -``` - - - -Accepted values for `value` are "true", "false" - -##### fn SpecialValueMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn SpecialValueMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn SpecialValueMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj SpecialValueMap.options.result - - -###### fn SpecialValueMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn SpecialValueMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn SpecialValueMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn SpecialValueMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj ValueMap - - -#### fn ValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn ValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn ValueMap.withType - -```ts -withType(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/annotationsList/fieldOverride.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/annotationsList/fieldOverride.md deleted file mode 100644 index 3e2667b..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/annotationsList/fieldOverride.md +++ /dev/null @@ -1,194 +0,0 @@ -# fieldOverride - -Overrides allow you to customize visualization settings for specific fields or -series. This is accomplished by adding an override rule that targets -a particular set of fields and that can each define multiple options. - -```jsonnet -fieldOverride.byType.new('number') -+ fieldOverride.byType.withPropertiesFromOptions( - panel.standardOptions.withDecimals(2) - + panel.standardOptions.withUnit('s') -) -``` - - -## Index - -* [`obj byName`](#obj-byname) - * [`fn new(value)`](#fn-bynamenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bynamewithproperty) -* [`obj byQuery`](#obj-byquery) - * [`fn new(value)`](#fn-byquerynew) - * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byquerywithproperty) -* [`obj byRegexp`](#obj-byregexp) - * [`fn new(value)`](#fn-byregexpnew) - * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) -* [`obj byType`](#obj-bytype) - * [`fn new(value)`](#fn-bytypenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bytypewithproperty) -* [`obj byValue`](#obj-byvalue) - * [`fn new(value)`](#fn-byvaluenew) - * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) - -## Fields - -### obj byName - - -#### fn byName.new - -```ts -new(value) -``` - -`new` creates a new override of type `byName`. - -#### fn byName.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byName.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byQuery - - -#### fn byQuery.new - -```ts -new(value) -``` - -`new` creates a new override of type `byQuery`. - -#### fn byQuery.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byQuery.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byRegexp - - -#### fn byRegexp.new - -```ts -new(value) -``` - -`new` creates a new override of type `byRegexp`. - -#### fn byRegexp.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byRegexp.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byType - - -#### fn byType.new - -```ts -new(value) -``` - -`new` creates a new override of type `byType`. - -#### fn byType.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byType.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byValue - - -#### fn byValue.new - -```ts -new(value) -``` - -`new` creates a new override of type `byValue`. - -#### fn byValue.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byValue.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/annotationsList/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/annotationsList/index.md deleted file mode 100644 index b5d34cf..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/annotationsList/index.md +++ /dev/null @@ -1,569 +0,0 @@ -# annotationsList - -grafonnet.panel.annotationsList - -## Subpackages - -* [fieldOverride](fieldOverride.md) -* [link](link.md) -* [thresholdStep](thresholdStep.md) -* [transformation](transformation.md) -* [valueMapping](valueMapping.md) - -## Index - -* [`fn new(title)`](#fn-new) -* [`obj datasource`](#obj-datasource) - * [`fn withType(value)`](#fn-datasourcewithtype) - * [`fn withUid(value)`](#fn-datasourcewithuid) -* [`obj gridPos`](#obj-gridpos) - * [`fn withH(value=9)`](#fn-gridposwithh) - * [`fn withStatic(value)`](#fn-gridposwithstatic) - * [`fn withW(value=12)`](#fn-gridposwithw) - * [`fn withX(value=0)`](#fn-gridposwithx) - * [`fn withY(value=0)`](#fn-gridposwithy) -* [`obj libraryPanel`](#obj-librarypanel) - * [`fn withName(value)`](#fn-librarypanelwithname) - * [`fn withUid(value)`](#fn-librarypanelwithuid) -* [`obj options`](#obj-options) - * [`fn withLimit(value=10)`](#fn-optionswithlimit) - * [`fn withNavigateAfter(value="10m")`](#fn-optionswithnavigateafter) - * [`fn withNavigateBefore(value="10m")`](#fn-optionswithnavigatebefore) - * [`fn withNavigateToPanel(value=true)`](#fn-optionswithnavigatetopanel) - * [`fn withOnlyFromThisDashboard(value=false)`](#fn-optionswithonlyfromthisdashboard) - * [`fn withOnlyInTimeRange(value=false)`](#fn-optionswithonlyintimerange) - * [`fn withShowTags(value=true)`](#fn-optionswithshowtags) - * [`fn withShowTime(value=true)`](#fn-optionswithshowtime) - * [`fn withShowUser(value=true)`](#fn-optionswithshowuser) - * [`fn withTags(value)`](#fn-optionswithtags) - * [`fn withTagsMixin(value)`](#fn-optionswithtagsmixin) -* [`obj panelOptions`](#obj-paneloptions) - * [`fn withDescription(value)`](#fn-paneloptionswithdescription) - * [`fn withLinks(value)`](#fn-paneloptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) - * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) - * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) - * [`fn withTitle(value)`](#fn-paneloptionswithtitle) - * [`fn withTransparent(value=false)`](#fn-paneloptionswithtransparent) -* [`obj queryOptions`](#obj-queryoptions) - * [`fn withDatasource(value)`](#fn-queryoptionswithdatasource) - * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) - * [`fn withInterval(value)`](#fn-queryoptionswithinterval) - * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) - * [`fn withTargets(value)`](#fn-queryoptionswithtargets) - * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) - * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) - * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) - * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) - * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) -* [`obj standardOptions`](#obj-standardoptions) - * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) - * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) - * [`fn withLinks(value)`](#fn-standardoptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) - * [`fn withMappings(value)`](#fn-standardoptionswithmappings) - * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) - * [`fn withMax(value)`](#fn-standardoptionswithmax) - * [`fn withMin(value)`](#fn-standardoptionswithmin) - * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) - * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) - * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) - * [`fn withUnit(value)`](#fn-standardoptionswithunit) - * [`obj color`](#obj-standardoptionscolor) - * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) - * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) - * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) - * [`obj thresholds`](#obj-standardoptionsthresholds) - * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) - * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) - * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) - -## Fields - -### fn new - -```ts -new(title) -``` - -Creates a new annotationsList panel with a title. - -### obj datasource - - -#### fn datasource.withType - -```ts -withType(value) -``` - - - -#### fn datasource.withUid - -```ts -withUid(value) -``` - - - -### obj gridPos - - -#### fn gridPos.withH - -```ts -withH(value=9) -``` - -Panel - -#### fn gridPos.withStatic - -```ts -withStatic(value) -``` - -true if fixed - -#### fn gridPos.withW - -```ts -withW(value=12) -``` - -Panel - -#### fn gridPos.withX - -```ts -withX(value=0) -``` - -Panel x - -#### fn gridPos.withY - -```ts -withY(value=0) -``` - -Panel y - -### obj libraryPanel - - -#### fn libraryPanel.withName - -```ts -withName(value) -``` - - - -#### fn libraryPanel.withUid - -```ts -withUid(value) -``` - - - -### obj options - - -#### fn options.withLimit - -```ts -withLimit(value=10) -``` - - - -#### fn options.withNavigateAfter - -```ts -withNavigateAfter(value="10m") -``` - - - -#### fn options.withNavigateBefore - -```ts -withNavigateBefore(value="10m") -``` - - - -#### fn options.withNavigateToPanel - -```ts -withNavigateToPanel(value=true) -``` - - - -#### fn options.withOnlyFromThisDashboard - -```ts -withOnlyFromThisDashboard(value=false) -``` - - - -#### fn options.withOnlyInTimeRange - -```ts -withOnlyInTimeRange(value=false) -``` - - - -#### fn options.withShowTags - -```ts -withShowTags(value=true) -``` - - - -#### fn options.withShowTime - -```ts -withShowTime(value=true) -``` - - - -#### fn options.withShowUser - -```ts -withShowUser(value=true) -``` - - - -#### fn options.withTags - -```ts -withTags(value) -``` - - - -#### fn options.withTagsMixin - -```ts -withTagsMixin(value) -``` - - - -### obj panelOptions - - -#### fn panelOptions.withDescription - -```ts -withDescription(value) -``` - -Description. - -#### fn panelOptions.withLinks - -```ts -withLinks(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withRepeat - -```ts -withRepeat(value) -``` - -Name of template variable to repeat for. - -#### fn panelOptions.withRepeatDirection - -```ts -withRepeatDirection(value="h") -``` - -Direction to repeat in if 'repeat' is set. -"h" for horizontal, "v" for vertical. -TODO this is probably optional - -Accepted values for `value` are "h", "v" - -#### fn panelOptions.withTitle - -```ts -withTitle(value) -``` - -Panel title. - -#### fn panelOptions.withTransparent - -```ts -withTransparent(value=false) -``` - -Whether to display the panel without a background. - -### obj queryOptions - - -#### fn queryOptions.withDatasource - -```ts -withDatasource(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withDatasourceMixin - -```ts -withDatasourceMixin(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withInterval - -```ts -withInterval(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withMaxDataPoints - -```ts -withMaxDataPoints(value) -``` - -TODO docs - -#### fn queryOptions.withTargets - -```ts -withTargets(value) -``` - -TODO docs - -#### fn queryOptions.withTargetsMixin - -```ts -withTargetsMixin(value) -``` - -TODO docs - -#### fn queryOptions.withTimeFrom - -```ts -withTimeFrom(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTimeShift - -```ts -withTimeShift(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTransformations - -```ts -withTransformations(value) -``` - - - -#### fn queryOptions.withTransformationsMixin - -```ts -withTransformationsMixin(value) -``` - - - -### obj standardOptions - - -#### fn standardOptions.withDecimals - -```ts -withDecimals(value) -``` - -Significant digits (for display) - -#### fn standardOptions.withDisplayName - -```ts -withDisplayName(value) -``` - -The display value for this field. This supports template variables blank is auto - -#### fn standardOptions.withLinks - -```ts -withLinks(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withMappings - -```ts -withMappings(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMappingsMixin - -```ts -withMappingsMixin(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMax - -```ts -withMax(value) -``` - - - -#### fn standardOptions.withMin - -```ts -withMin(value) -``` - - - -#### fn standardOptions.withNoValue - -```ts -withNoValue(value) -``` - -Alternative to empty string - -#### fn standardOptions.withOverrides - -```ts -withOverrides(value) -``` - - - -#### fn standardOptions.withOverridesMixin - -```ts -withOverridesMixin(value) -``` - - - -#### fn standardOptions.withUnit - -```ts -withUnit(value) -``` - -Numeric Options - -#### obj standardOptions.color - - -##### fn standardOptions.color.withFixedColor - -```ts -withFixedColor(value) -``` - -Stores the fixed color value if mode is fixed - -##### fn standardOptions.color.withMode - -```ts -withMode(value) -``` - -The main color scheme mode - -##### fn standardOptions.color.withSeriesBy - -```ts -withSeriesBy(value) -``` - -TODO docs - -Accepted values for `value` are "min", "max", "last" - -#### obj standardOptions.thresholds - - -##### fn standardOptions.thresholds.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "absolute", "percentage" - -##### fn standardOptions.thresholds.withSteps - -```ts -withSteps(value) -``` - -Must be sorted by 'value', first value is always -Infinity - -##### fn standardOptions.thresholds.withStepsMixin - -```ts -withStepsMixin(value) -``` - -Must be sorted by 'value', first value is always -Infinity diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/annotationsList/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/annotationsList/link.md deleted file mode 100644 index 1a1d7c4..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/annotationsList/link.md +++ /dev/null @@ -1,109 +0,0 @@ -# link - - - -## Index - -* [`fn withAsDropdown(value=false)`](#fn-withasdropdown) -* [`fn withIcon(value)`](#fn-withicon) -* [`fn withIncludeVars(value=false)`](#fn-withincludevars) -* [`fn withKeepTime(value=false)`](#fn-withkeeptime) -* [`fn withTags(value)`](#fn-withtags) -* [`fn withTagsMixin(value)`](#fn-withtagsmixin) -* [`fn withTargetBlank(value=false)`](#fn-withtargetblank) -* [`fn withTitle(value)`](#fn-withtitle) -* [`fn withTooltip(value)`](#fn-withtooltip) -* [`fn withType(value)`](#fn-withtype) -* [`fn withUrl(value)`](#fn-withurl) - -## Fields - -### fn withAsDropdown - -```ts -withAsDropdown(value=false) -``` - - - -### fn withIcon - -```ts -withIcon(value) -``` - - - -### fn withIncludeVars - -```ts -withIncludeVars(value=false) -``` - - - -### fn withKeepTime - -```ts -withKeepTime(value=false) -``` - - - -### fn withTags - -```ts -withTags(value) -``` - - - -### fn withTagsMixin - -```ts -withTagsMixin(value) -``` - - - -### fn withTargetBlank - -```ts -withTargetBlank(value=false) -``` - - - -### fn withTitle - -```ts -withTitle(value) -``` - - - -### fn withTooltip - -```ts -withTooltip(value) -``` - - - -### fn withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "link", "dashboards" - -### fn withUrl - -```ts -withUrl(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/annotationsList/thresholdStep.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/annotationsList/thresholdStep.md deleted file mode 100644 index 9d6af42..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/annotationsList/thresholdStep.md +++ /dev/null @@ -1,47 +0,0 @@ -# thresholdStep - - - -## Index - -* [`fn withColor(value)`](#fn-withcolor) -* [`fn withIndex(value)`](#fn-withindex) -* [`fn withState(value)`](#fn-withstate) -* [`fn withValue(value)`](#fn-withvalue) - -## Fields - -### fn withColor - -```ts -withColor(value) -``` - -TODO docs - -### fn withIndex - -```ts -withIndex(value) -``` - -Threshold index, an old property that is not needed an should only appear in older dashboards - -### fn withState - -```ts -withState(value) -``` - -TODO docs -TODO are the values here enumerable into a disjunction? -Some seem to be listed in typescript comment - -### fn withValue - -```ts -withValue(value) -``` - -TODO docs -FIXME the corresponding typescript field is required/non-optional, but nulls currently appear here when serializing -Infinity to JSON diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/annotationsList/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/annotationsList/transformation.md deleted file mode 100644 index 3dac7e9..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/annotationsList/transformation.md +++ /dev/null @@ -1,76 +0,0 @@ -# transformation - - - -## Index - -* [`fn withDisabled(value)`](#fn-withdisabled) -* [`fn withFilter(value)`](#fn-withfilter) -* [`fn withFilterMixin(value)`](#fn-withfiltermixin) -* [`fn withId(value)`](#fn-withid) -* [`fn withOptions(value)`](#fn-withoptions) -* [`obj filter`](#obj-filter) - * [`fn withId(value="")`](#fn-filterwithid) - * [`fn withOptions(value)`](#fn-filterwithoptions) - -## Fields - -### fn withDisabled - -```ts -withDisabled(value) -``` - -Disabled transformations are skipped - -### fn withFilter - -```ts -withFilter(value) -``` - - - -### fn withFilterMixin - -```ts -withFilterMixin(value) -``` - - - -### fn withId - -```ts -withId(value) -``` - -Unique identifier of transformer - -### fn withOptions - -```ts -withOptions(value) -``` - -Options to be passed to the transformer -Valid options depend on the transformer id - -### obj filter - - -#### fn filter.withId - -```ts -withId(value="") -``` - - - -#### fn filter.withOptions - -```ts -withOptions(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/annotationsList/valueMapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/annotationsList/valueMapping.md deleted file mode 100644 index a6bbdb3..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/annotationsList/valueMapping.md +++ /dev/null @@ -1,365 +0,0 @@ -# valueMapping - - - -## Index - -* [`obj RangeMap`](#obj-rangemap) - * [`fn withOptions(value)`](#fn-rangemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) - * [`obj options`](#obj-rangemapoptions) - * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) - * [`fn withResult(value)`](#fn-rangemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) - * [`fn withTo(value)`](#fn-rangemapoptionswithto) - * [`obj result`](#obj-rangemapoptionsresult) - * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) -* [`obj RegexMap`](#obj-regexmap) - * [`fn withOptions(value)`](#fn-regexmapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) - * [`obj options`](#obj-regexmapoptions) - * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) - * [`fn withResult(value)`](#fn-regexmapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) - * [`obj result`](#obj-regexmapoptionsresult) - * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) - * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) -* [`obj SpecialValueMap`](#obj-specialvaluemap) - * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) - * [`obj options`](#obj-specialvaluemapoptions) - * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) - * [`fn withPattern(value)`](#fn-specialvaluemapoptionswithpattern) - * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) - * [`obj result`](#obj-specialvaluemapoptionsresult) - * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) -* [`obj ValueMap`](#obj-valuemap) - * [`fn withOptions(value)`](#fn-valuemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) - -## Fields - -### obj RangeMap - - -#### fn RangeMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RangeMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RangeMap.withType - -```ts -withType(value) -``` - - - -#### obj RangeMap.options - - -##### fn RangeMap.options.withFrom - -```ts -withFrom(value) -``` - -to and from are `number | null` in current ts, really not sure what to do - -##### fn RangeMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RangeMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### fn RangeMap.options.withTo - -```ts -withTo(value) -``` - - - -##### obj RangeMap.options.result - - -###### fn RangeMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RangeMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RangeMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RangeMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj RegexMap - - -#### fn RegexMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RegexMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RegexMap.withType - -```ts -withType(value) -``` - - - -#### obj RegexMap.options - - -##### fn RegexMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn RegexMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RegexMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj RegexMap.options.result - - -###### fn RegexMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RegexMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RegexMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RegexMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj SpecialValueMap - - -#### fn SpecialValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn SpecialValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn SpecialValueMap.withType - -```ts -withType(value) -``` - - - -#### obj SpecialValueMap.options - - -##### fn SpecialValueMap.options.withMatch - -```ts -withMatch(value) -``` - - - -Accepted values for `value` are "true", "false" - -##### fn SpecialValueMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn SpecialValueMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn SpecialValueMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj SpecialValueMap.options.result - - -###### fn SpecialValueMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn SpecialValueMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn SpecialValueMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn SpecialValueMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj ValueMap - - -#### fn ValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn ValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn ValueMap.withType - -```ts -withType(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barChart/fieldOverride.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barChart/fieldOverride.md deleted file mode 100644 index 3e2667b..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barChart/fieldOverride.md +++ /dev/null @@ -1,194 +0,0 @@ -# fieldOverride - -Overrides allow you to customize visualization settings for specific fields or -series. This is accomplished by adding an override rule that targets -a particular set of fields and that can each define multiple options. - -```jsonnet -fieldOverride.byType.new('number') -+ fieldOverride.byType.withPropertiesFromOptions( - panel.standardOptions.withDecimals(2) - + panel.standardOptions.withUnit('s') -) -``` - - -## Index - -* [`obj byName`](#obj-byname) - * [`fn new(value)`](#fn-bynamenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bynamewithproperty) -* [`obj byQuery`](#obj-byquery) - * [`fn new(value)`](#fn-byquerynew) - * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byquerywithproperty) -* [`obj byRegexp`](#obj-byregexp) - * [`fn new(value)`](#fn-byregexpnew) - * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) -* [`obj byType`](#obj-bytype) - * [`fn new(value)`](#fn-bytypenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bytypewithproperty) -* [`obj byValue`](#obj-byvalue) - * [`fn new(value)`](#fn-byvaluenew) - * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) - -## Fields - -### obj byName - - -#### fn byName.new - -```ts -new(value) -``` - -`new` creates a new override of type `byName`. - -#### fn byName.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byName.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byQuery - - -#### fn byQuery.new - -```ts -new(value) -``` - -`new` creates a new override of type `byQuery`. - -#### fn byQuery.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byQuery.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byRegexp - - -#### fn byRegexp.new - -```ts -new(value) -``` - -`new` creates a new override of type `byRegexp`. - -#### fn byRegexp.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byRegexp.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byType - - -#### fn byType.new - -```ts -new(value) -``` - -`new` creates a new override of type `byType`. - -#### fn byType.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byType.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byValue - - -#### fn byValue.new - -```ts -new(value) -``` - -`new` creates a new override of type `byValue`. - -#### fn byValue.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byValue.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barChart/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barChart/index.md deleted file mode 100644 index e3a21c3..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barChart/index.md +++ /dev/null @@ -1,1030 +0,0 @@ -# barChart - -grafonnet.panel.barChart - -## Subpackages - -* [fieldOverride](fieldOverride.md) -* [link](link.md) -* [thresholdStep](thresholdStep.md) -* [transformation](transformation.md) -* [valueMapping](valueMapping.md) - -## Index - -* [`fn new(title)`](#fn-new) -* [`obj datasource`](#obj-datasource) - * [`fn withType(value)`](#fn-datasourcewithtype) - * [`fn withUid(value)`](#fn-datasourcewithuid) -* [`obj fieldConfig`](#obj-fieldconfig) - * [`obj defaults`](#obj-fieldconfigdefaults) - * [`obj custom`](#obj-fieldconfigdefaultscustom) - * [`fn withAxisCenteredZero(value)`](#fn-fieldconfigdefaultscustomwithaxiscenteredzero) - * [`fn withAxisColorMode(value)`](#fn-fieldconfigdefaultscustomwithaxiscolormode) - * [`fn withAxisGridShow(value)`](#fn-fieldconfigdefaultscustomwithaxisgridshow) - * [`fn withAxisLabel(value)`](#fn-fieldconfigdefaultscustomwithaxislabel) - * [`fn withAxisPlacement(value)`](#fn-fieldconfigdefaultscustomwithaxisplacement) - * [`fn withAxisSoftMax(value)`](#fn-fieldconfigdefaultscustomwithaxissoftmax) - * [`fn withAxisSoftMin(value)`](#fn-fieldconfigdefaultscustomwithaxissoftmin) - * [`fn withAxisWidth(value)`](#fn-fieldconfigdefaultscustomwithaxiswidth) - * [`fn withFillOpacity(value=80)`](#fn-fieldconfigdefaultscustomwithfillopacity) - * [`fn withGradientMode(value)`](#fn-fieldconfigdefaultscustomwithgradientmode) - * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomwithhidefrom) - * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomwithhidefrommixin) - * [`fn withLineWidth(value=1)`](#fn-fieldconfigdefaultscustomwithlinewidth) - * [`fn withScaleDistribution(value)`](#fn-fieldconfigdefaultscustomwithscaledistribution) - * [`fn withScaleDistributionMixin(value)`](#fn-fieldconfigdefaultscustomwithscaledistributionmixin) - * [`fn withThresholdsStyle(value)`](#fn-fieldconfigdefaultscustomwiththresholdsstyle) - * [`fn withThresholdsStyleMixin(value)`](#fn-fieldconfigdefaultscustomwiththresholdsstylemixin) - * [`obj hideFrom`](#obj-fieldconfigdefaultscustomhidefrom) - * [`fn withLegend(value)`](#fn-fieldconfigdefaultscustomhidefromwithlegend) - * [`fn withTooltip(value)`](#fn-fieldconfigdefaultscustomhidefromwithtooltip) - * [`fn withViz(value)`](#fn-fieldconfigdefaultscustomhidefromwithviz) - * [`obj scaleDistribution`](#obj-fieldconfigdefaultscustomscaledistribution) - * [`fn withLinearThreshold(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlinearthreshold) - * [`fn withLog(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlog) - * [`fn withType(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithtype) - * [`obj thresholdsStyle`](#obj-fieldconfigdefaultscustomthresholdsstyle) - * [`fn withMode(value)`](#fn-fieldconfigdefaultscustomthresholdsstylewithmode) -* [`obj gridPos`](#obj-gridpos) - * [`fn withH(value=9)`](#fn-gridposwithh) - * [`fn withStatic(value)`](#fn-gridposwithstatic) - * [`fn withW(value=12)`](#fn-gridposwithw) - * [`fn withX(value=0)`](#fn-gridposwithx) - * [`fn withY(value=0)`](#fn-gridposwithy) -* [`obj libraryPanel`](#obj-librarypanel) - * [`fn withName(value)`](#fn-librarypanelwithname) - * [`fn withUid(value)`](#fn-librarypanelwithuid) -* [`obj options`](#obj-options) - * [`fn withBarRadius(value=0)`](#fn-optionswithbarradius) - * [`fn withBarWidth(value=0.97)`](#fn-optionswithbarwidth) - * [`fn withColorByField(value)`](#fn-optionswithcolorbyfield) - * [`fn withFullHighlight(value=false)`](#fn-optionswithfullhighlight) - * [`fn withGroupWidth(value=0.7)`](#fn-optionswithgroupwidth) - * [`fn withLegend(value)`](#fn-optionswithlegend) - * [`fn withLegendMixin(value)`](#fn-optionswithlegendmixin) - * [`fn withOrientation(value)`](#fn-optionswithorientation) - * [`fn withShowValue(value)`](#fn-optionswithshowvalue) - * [`fn withStacking(value)`](#fn-optionswithstacking) - * [`fn withText(value)`](#fn-optionswithtext) - * [`fn withTextMixin(value)`](#fn-optionswithtextmixin) - * [`fn withTooltip(value)`](#fn-optionswithtooltip) - * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) - * [`fn withXField(value)`](#fn-optionswithxfield) - * [`fn withXTickLabelMaxLength(value)`](#fn-optionswithxticklabelmaxlength) - * [`fn withXTickLabelRotation(value=0)`](#fn-optionswithxticklabelrotation) - * [`fn withXTickLabelSpacing(value=0)`](#fn-optionswithxticklabelspacing) - * [`obj legend`](#obj-optionslegend) - * [`fn withAsTable(value)`](#fn-optionslegendwithastable) - * [`fn withCalcs(value)`](#fn-optionslegendwithcalcs) - * [`fn withCalcsMixin(value)`](#fn-optionslegendwithcalcsmixin) - * [`fn withDisplayMode(value)`](#fn-optionslegendwithdisplaymode) - * [`fn withIsVisible(value)`](#fn-optionslegendwithisvisible) - * [`fn withPlacement(value)`](#fn-optionslegendwithplacement) - * [`fn withShowLegend(value)`](#fn-optionslegendwithshowlegend) - * [`fn withSortBy(value)`](#fn-optionslegendwithsortby) - * [`fn withSortDesc(value)`](#fn-optionslegendwithsortdesc) - * [`fn withWidth(value)`](#fn-optionslegendwithwidth) - * [`obj text`](#obj-optionstext) - * [`fn withTitleSize(value)`](#fn-optionstextwithtitlesize) - * [`fn withValueSize(value)`](#fn-optionstextwithvaluesize) - * [`obj tooltip`](#obj-optionstooltip) - * [`fn withMode(value)`](#fn-optionstooltipwithmode) - * [`fn withSort(value)`](#fn-optionstooltipwithsort) -* [`obj panelOptions`](#obj-paneloptions) - * [`fn withDescription(value)`](#fn-paneloptionswithdescription) - * [`fn withLinks(value)`](#fn-paneloptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) - * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) - * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) - * [`fn withTitle(value)`](#fn-paneloptionswithtitle) - * [`fn withTransparent(value=false)`](#fn-paneloptionswithtransparent) -* [`obj queryOptions`](#obj-queryoptions) - * [`fn withDatasource(value)`](#fn-queryoptionswithdatasource) - * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) - * [`fn withInterval(value)`](#fn-queryoptionswithinterval) - * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) - * [`fn withTargets(value)`](#fn-queryoptionswithtargets) - * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) - * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) - * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) - * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) - * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) -* [`obj standardOptions`](#obj-standardoptions) - * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) - * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) - * [`fn withLinks(value)`](#fn-standardoptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) - * [`fn withMappings(value)`](#fn-standardoptionswithmappings) - * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) - * [`fn withMax(value)`](#fn-standardoptionswithmax) - * [`fn withMin(value)`](#fn-standardoptionswithmin) - * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) - * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) - * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) - * [`fn withUnit(value)`](#fn-standardoptionswithunit) - * [`obj color`](#obj-standardoptionscolor) - * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) - * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) - * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) - * [`obj thresholds`](#obj-standardoptionsthresholds) - * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) - * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) - * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) - -## Fields - -### fn new - -```ts -new(title) -``` - -Creates a new barChart panel with a title. - -### obj datasource - - -#### fn datasource.withType - -```ts -withType(value) -``` - - - -#### fn datasource.withUid - -```ts -withUid(value) -``` - - - -### obj fieldConfig - - -#### obj fieldConfig.defaults - - -##### obj fieldConfig.defaults.custom - - -###### fn fieldConfig.defaults.custom.withAxisCenteredZero - -```ts -withAxisCenteredZero(value) -``` - - - -###### fn fieldConfig.defaults.custom.withAxisColorMode - -```ts -withAxisColorMode(value) -``` - -TODO docs - -Accepted values for `value` are "text", "series" - -###### fn fieldConfig.defaults.custom.withAxisGridShow - -```ts -withAxisGridShow(value) -``` - - - -###### fn fieldConfig.defaults.custom.withAxisLabel - -```ts -withAxisLabel(value) -``` - - - -###### fn fieldConfig.defaults.custom.withAxisPlacement - -```ts -withAxisPlacement(value) -``` - -TODO docs - -Accepted values for `value` are "auto", "top", "right", "bottom", "left", "hidden" - -###### fn fieldConfig.defaults.custom.withAxisSoftMax - -```ts -withAxisSoftMax(value) -``` - - - -###### fn fieldConfig.defaults.custom.withAxisSoftMin - -```ts -withAxisSoftMin(value) -``` - - - -###### fn fieldConfig.defaults.custom.withAxisWidth - -```ts -withAxisWidth(value) -``` - - - -###### fn fieldConfig.defaults.custom.withFillOpacity - -```ts -withFillOpacity(value=80) -``` - -Controls the fill opacity of the bars. - -###### fn fieldConfig.defaults.custom.withGradientMode - -```ts -withGradientMode(value) -``` - -Set the mode of the gradient fill. Fill gradient is based on the line color. To change the color, use the standard color scheme field option. -Gradient appearance is influenced by the Fill opacity setting. - -###### fn fieldConfig.defaults.custom.withHideFrom - -```ts -withHideFrom(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withHideFromMixin - -```ts -withHideFromMixin(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withLineWidth - -```ts -withLineWidth(value=1) -``` - -Controls line width of the bars. - -###### fn fieldConfig.defaults.custom.withScaleDistribution - -```ts -withScaleDistribution(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withScaleDistributionMixin - -```ts -withScaleDistributionMixin(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withThresholdsStyle - -```ts -withThresholdsStyle(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withThresholdsStyleMixin - -```ts -withThresholdsStyleMixin(value) -``` - -TODO docs - -###### obj fieldConfig.defaults.custom.hideFrom - - -####### fn fieldConfig.defaults.custom.hideFrom.withLegend - -```ts -withLegend(value) -``` - - - -####### fn fieldConfig.defaults.custom.hideFrom.withTooltip - -```ts -withTooltip(value) -``` - - - -####### fn fieldConfig.defaults.custom.hideFrom.withViz - -```ts -withViz(value) -``` - - - -###### obj fieldConfig.defaults.custom.scaleDistribution - - -####### fn fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold - -```ts -withLinearThreshold(value) -``` - - - -####### fn fieldConfig.defaults.custom.scaleDistribution.withLog - -```ts -withLog(value) -``` - - - -####### fn fieldConfig.defaults.custom.scaleDistribution.withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "linear", "log", "ordinal", "symlog" - -###### obj fieldConfig.defaults.custom.thresholdsStyle - - -####### fn fieldConfig.defaults.custom.thresholdsStyle.withMode - -```ts -withMode(value) -``` - -TODO docs - -Accepted values for `value` are "off", "line", "dashed", "area", "line+area", "dashed+area", "series" - -### obj gridPos - - -#### fn gridPos.withH - -```ts -withH(value=9) -``` - -Panel - -#### fn gridPos.withStatic - -```ts -withStatic(value) -``` - -true if fixed - -#### fn gridPos.withW - -```ts -withW(value=12) -``` - -Panel - -#### fn gridPos.withX - -```ts -withX(value=0) -``` - -Panel x - -#### fn gridPos.withY - -```ts -withY(value=0) -``` - -Panel y - -### obj libraryPanel - - -#### fn libraryPanel.withName - -```ts -withName(value) -``` - - - -#### fn libraryPanel.withUid - -```ts -withUid(value) -``` - - - -### obj options - - -#### fn options.withBarRadius - -```ts -withBarRadius(value=0) -``` - -Controls the radius of each bar. - -#### fn options.withBarWidth - -```ts -withBarWidth(value=0.97) -``` - -Controls the width of bars. 1 = Max width, 0 = Min width. - -#### fn options.withColorByField - -```ts -withColorByField(value) -``` - -Use the color value for a sibling field to color each bar value. - -#### fn options.withFullHighlight - -```ts -withFullHighlight(value=false) -``` - -Enables mode which highlights the entire bar area and shows tooltip when cursor -hovers over highlighted area - -#### fn options.withGroupWidth - -```ts -withGroupWidth(value=0.7) -``` - -Controls the width of groups. 1 = max with, 0 = min width. - -#### fn options.withLegend - -```ts -withLegend(value) -``` - -TODO docs - -#### fn options.withLegendMixin - -```ts -withLegendMixin(value) -``` - -TODO docs - -#### fn options.withOrientation - -```ts -withOrientation(value) -``` - -Controls the orientation of the bar chart, either vertical or horizontal. - -#### fn options.withShowValue - -```ts -withShowValue(value) -``` - -This controls whether values are shown on top or to the left of bars. - -#### fn options.withStacking - -```ts -withStacking(value) -``` - -Controls whether bars are stacked or not, either normally or in percent mode. - -#### fn options.withText - -```ts -withText(value) -``` - -TODO docs - -#### fn options.withTextMixin - -```ts -withTextMixin(value) -``` - -TODO docs - -#### fn options.withTooltip - -```ts -withTooltip(value) -``` - -TODO docs - -#### fn options.withTooltipMixin - -```ts -withTooltipMixin(value) -``` - -TODO docs - -#### fn options.withXField - -```ts -withXField(value) -``` - -Manually select which field from the dataset to represent the x field. - -#### fn options.withXTickLabelMaxLength - -```ts -withXTickLabelMaxLength(value) -``` - -Sets the max length that a label can have before it is truncated. - -#### fn options.withXTickLabelRotation - -```ts -withXTickLabelRotation(value=0) -``` - -Controls the rotation of the x axis labels. - -#### fn options.withXTickLabelSpacing - -```ts -withXTickLabelSpacing(value=0) -``` - -Controls the spacing between x axis labels. -negative values indicate backwards skipping behavior - -#### obj options.legend - - -##### fn options.legend.withAsTable - -```ts -withAsTable(value) -``` - - - -##### fn options.legend.withCalcs - -```ts -withCalcs(value) -``` - - - -##### fn options.legend.withCalcsMixin - -```ts -withCalcsMixin(value) -``` - - - -##### fn options.legend.withDisplayMode - -```ts -withDisplayMode(value) -``` - -TODO docs -Note: "hidden" needs to remain as an option for plugins compatibility - -Accepted values for `value` are "list", "table", "hidden" - -##### fn options.legend.withIsVisible - -```ts -withIsVisible(value) -``` - - - -##### fn options.legend.withPlacement - -```ts -withPlacement(value) -``` - -TODO docs - -Accepted values for `value` are "bottom", "right" - -##### fn options.legend.withShowLegend - -```ts -withShowLegend(value) -``` - - - -##### fn options.legend.withSortBy - -```ts -withSortBy(value) -``` - - - -##### fn options.legend.withSortDesc - -```ts -withSortDesc(value) -``` - - - -##### fn options.legend.withWidth - -```ts -withWidth(value) -``` - - - -#### obj options.text - - -##### fn options.text.withTitleSize - -```ts -withTitleSize(value) -``` - -Explicit title text size - -##### fn options.text.withValueSize - -```ts -withValueSize(value) -``` - -Explicit value text size - -#### obj options.tooltip - - -##### fn options.tooltip.withMode - -```ts -withMode(value) -``` - -TODO docs - -Accepted values for `value` are "single", "multi", "none" - -##### fn options.tooltip.withSort - -```ts -withSort(value) -``` - -TODO docs - -Accepted values for `value` are "asc", "desc", "none" - -### obj panelOptions - - -#### fn panelOptions.withDescription - -```ts -withDescription(value) -``` - -Description. - -#### fn panelOptions.withLinks - -```ts -withLinks(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withRepeat - -```ts -withRepeat(value) -``` - -Name of template variable to repeat for. - -#### fn panelOptions.withRepeatDirection - -```ts -withRepeatDirection(value="h") -``` - -Direction to repeat in if 'repeat' is set. -"h" for horizontal, "v" for vertical. -TODO this is probably optional - -Accepted values for `value` are "h", "v" - -#### fn panelOptions.withTitle - -```ts -withTitle(value) -``` - -Panel title. - -#### fn panelOptions.withTransparent - -```ts -withTransparent(value=false) -``` - -Whether to display the panel without a background. - -### obj queryOptions - - -#### fn queryOptions.withDatasource - -```ts -withDatasource(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withDatasourceMixin - -```ts -withDatasourceMixin(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withInterval - -```ts -withInterval(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withMaxDataPoints - -```ts -withMaxDataPoints(value) -``` - -TODO docs - -#### fn queryOptions.withTargets - -```ts -withTargets(value) -``` - -TODO docs - -#### fn queryOptions.withTargetsMixin - -```ts -withTargetsMixin(value) -``` - -TODO docs - -#### fn queryOptions.withTimeFrom - -```ts -withTimeFrom(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTimeShift - -```ts -withTimeShift(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTransformations - -```ts -withTransformations(value) -``` - - - -#### fn queryOptions.withTransformationsMixin - -```ts -withTransformationsMixin(value) -``` - - - -### obj standardOptions - - -#### fn standardOptions.withDecimals - -```ts -withDecimals(value) -``` - -Significant digits (for display) - -#### fn standardOptions.withDisplayName - -```ts -withDisplayName(value) -``` - -The display value for this field. This supports template variables blank is auto - -#### fn standardOptions.withLinks - -```ts -withLinks(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withMappings - -```ts -withMappings(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMappingsMixin - -```ts -withMappingsMixin(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMax - -```ts -withMax(value) -``` - - - -#### fn standardOptions.withMin - -```ts -withMin(value) -``` - - - -#### fn standardOptions.withNoValue - -```ts -withNoValue(value) -``` - -Alternative to empty string - -#### fn standardOptions.withOverrides - -```ts -withOverrides(value) -``` - - - -#### fn standardOptions.withOverridesMixin - -```ts -withOverridesMixin(value) -``` - - - -#### fn standardOptions.withUnit - -```ts -withUnit(value) -``` - -Numeric Options - -#### obj standardOptions.color - - -##### fn standardOptions.color.withFixedColor - -```ts -withFixedColor(value) -``` - -Stores the fixed color value if mode is fixed - -##### fn standardOptions.color.withMode - -```ts -withMode(value) -``` - -The main color scheme mode - -##### fn standardOptions.color.withSeriesBy - -```ts -withSeriesBy(value) -``` - -TODO docs - -Accepted values for `value` are "min", "max", "last" - -#### obj standardOptions.thresholds - - -##### fn standardOptions.thresholds.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "absolute", "percentage" - -##### fn standardOptions.thresholds.withSteps - -```ts -withSteps(value) -``` - -Must be sorted by 'value', first value is always -Infinity - -##### fn standardOptions.thresholds.withStepsMixin - -```ts -withStepsMixin(value) -``` - -Must be sorted by 'value', first value is always -Infinity diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barChart/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barChart/link.md deleted file mode 100644 index 1a1d7c4..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barChart/link.md +++ /dev/null @@ -1,109 +0,0 @@ -# link - - - -## Index - -* [`fn withAsDropdown(value=false)`](#fn-withasdropdown) -* [`fn withIcon(value)`](#fn-withicon) -* [`fn withIncludeVars(value=false)`](#fn-withincludevars) -* [`fn withKeepTime(value=false)`](#fn-withkeeptime) -* [`fn withTags(value)`](#fn-withtags) -* [`fn withTagsMixin(value)`](#fn-withtagsmixin) -* [`fn withTargetBlank(value=false)`](#fn-withtargetblank) -* [`fn withTitle(value)`](#fn-withtitle) -* [`fn withTooltip(value)`](#fn-withtooltip) -* [`fn withType(value)`](#fn-withtype) -* [`fn withUrl(value)`](#fn-withurl) - -## Fields - -### fn withAsDropdown - -```ts -withAsDropdown(value=false) -``` - - - -### fn withIcon - -```ts -withIcon(value) -``` - - - -### fn withIncludeVars - -```ts -withIncludeVars(value=false) -``` - - - -### fn withKeepTime - -```ts -withKeepTime(value=false) -``` - - - -### fn withTags - -```ts -withTags(value) -``` - - - -### fn withTagsMixin - -```ts -withTagsMixin(value) -``` - - - -### fn withTargetBlank - -```ts -withTargetBlank(value=false) -``` - - - -### fn withTitle - -```ts -withTitle(value) -``` - - - -### fn withTooltip - -```ts -withTooltip(value) -``` - - - -### fn withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "link", "dashboards" - -### fn withUrl - -```ts -withUrl(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barChart/thresholdStep.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barChart/thresholdStep.md deleted file mode 100644 index 9d6af42..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barChart/thresholdStep.md +++ /dev/null @@ -1,47 +0,0 @@ -# thresholdStep - - - -## Index - -* [`fn withColor(value)`](#fn-withcolor) -* [`fn withIndex(value)`](#fn-withindex) -* [`fn withState(value)`](#fn-withstate) -* [`fn withValue(value)`](#fn-withvalue) - -## Fields - -### fn withColor - -```ts -withColor(value) -``` - -TODO docs - -### fn withIndex - -```ts -withIndex(value) -``` - -Threshold index, an old property that is not needed an should only appear in older dashboards - -### fn withState - -```ts -withState(value) -``` - -TODO docs -TODO are the values here enumerable into a disjunction? -Some seem to be listed in typescript comment - -### fn withValue - -```ts -withValue(value) -``` - -TODO docs -FIXME the corresponding typescript field is required/non-optional, but nulls currently appear here when serializing -Infinity to JSON diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barChart/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barChart/transformation.md deleted file mode 100644 index 3dac7e9..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barChart/transformation.md +++ /dev/null @@ -1,76 +0,0 @@ -# transformation - - - -## Index - -* [`fn withDisabled(value)`](#fn-withdisabled) -* [`fn withFilter(value)`](#fn-withfilter) -* [`fn withFilterMixin(value)`](#fn-withfiltermixin) -* [`fn withId(value)`](#fn-withid) -* [`fn withOptions(value)`](#fn-withoptions) -* [`obj filter`](#obj-filter) - * [`fn withId(value="")`](#fn-filterwithid) - * [`fn withOptions(value)`](#fn-filterwithoptions) - -## Fields - -### fn withDisabled - -```ts -withDisabled(value) -``` - -Disabled transformations are skipped - -### fn withFilter - -```ts -withFilter(value) -``` - - - -### fn withFilterMixin - -```ts -withFilterMixin(value) -``` - - - -### fn withId - -```ts -withId(value) -``` - -Unique identifier of transformer - -### fn withOptions - -```ts -withOptions(value) -``` - -Options to be passed to the transformer -Valid options depend on the transformer id - -### obj filter - - -#### fn filter.withId - -```ts -withId(value="") -``` - - - -#### fn filter.withOptions - -```ts -withOptions(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barChart/valueMapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barChart/valueMapping.md deleted file mode 100644 index a6bbdb3..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barChart/valueMapping.md +++ /dev/null @@ -1,365 +0,0 @@ -# valueMapping - - - -## Index - -* [`obj RangeMap`](#obj-rangemap) - * [`fn withOptions(value)`](#fn-rangemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) - * [`obj options`](#obj-rangemapoptions) - * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) - * [`fn withResult(value)`](#fn-rangemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) - * [`fn withTo(value)`](#fn-rangemapoptionswithto) - * [`obj result`](#obj-rangemapoptionsresult) - * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) -* [`obj RegexMap`](#obj-regexmap) - * [`fn withOptions(value)`](#fn-regexmapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) - * [`obj options`](#obj-regexmapoptions) - * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) - * [`fn withResult(value)`](#fn-regexmapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) - * [`obj result`](#obj-regexmapoptionsresult) - * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) - * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) -* [`obj SpecialValueMap`](#obj-specialvaluemap) - * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) - * [`obj options`](#obj-specialvaluemapoptions) - * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) - * [`fn withPattern(value)`](#fn-specialvaluemapoptionswithpattern) - * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) - * [`obj result`](#obj-specialvaluemapoptionsresult) - * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) -* [`obj ValueMap`](#obj-valuemap) - * [`fn withOptions(value)`](#fn-valuemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) - -## Fields - -### obj RangeMap - - -#### fn RangeMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RangeMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RangeMap.withType - -```ts -withType(value) -``` - - - -#### obj RangeMap.options - - -##### fn RangeMap.options.withFrom - -```ts -withFrom(value) -``` - -to and from are `number | null` in current ts, really not sure what to do - -##### fn RangeMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RangeMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### fn RangeMap.options.withTo - -```ts -withTo(value) -``` - - - -##### obj RangeMap.options.result - - -###### fn RangeMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RangeMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RangeMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RangeMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj RegexMap - - -#### fn RegexMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RegexMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RegexMap.withType - -```ts -withType(value) -``` - - - -#### obj RegexMap.options - - -##### fn RegexMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn RegexMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RegexMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj RegexMap.options.result - - -###### fn RegexMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RegexMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RegexMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RegexMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj SpecialValueMap - - -#### fn SpecialValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn SpecialValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn SpecialValueMap.withType - -```ts -withType(value) -``` - - - -#### obj SpecialValueMap.options - - -##### fn SpecialValueMap.options.withMatch - -```ts -withMatch(value) -``` - - - -Accepted values for `value` are "true", "false" - -##### fn SpecialValueMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn SpecialValueMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn SpecialValueMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj SpecialValueMap.options.result - - -###### fn SpecialValueMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn SpecialValueMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn SpecialValueMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn SpecialValueMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj ValueMap - - -#### fn ValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn ValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn ValueMap.withType - -```ts -withType(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barGauge/fieldOverride.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barGauge/fieldOverride.md deleted file mode 100644 index 3e2667b..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barGauge/fieldOverride.md +++ /dev/null @@ -1,194 +0,0 @@ -# fieldOverride - -Overrides allow you to customize visualization settings for specific fields or -series. This is accomplished by adding an override rule that targets -a particular set of fields and that can each define multiple options. - -```jsonnet -fieldOverride.byType.new('number') -+ fieldOverride.byType.withPropertiesFromOptions( - panel.standardOptions.withDecimals(2) - + panel.standardOptions.withUnit('s') -) -``` - - -## Index - -* [`obj byName`](#obj-byname) - * [`fn new(value)`](#fn-bynamenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bynamewithproperty) -* [`obj byQuery`](#obj-byquery) - * [`fn new(value)`](#fn-byquerynew) - * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byquerywithproperty) -* [`obj byRegexp`](#obj-byregexp) - * [`fn new(value)`](#fn-byregexpnew) - * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) -* [`obj byType`](#obj-bytype) - * [`fn new(value)`](#fn-bytypenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bytypewithproperty) -* [`obj byValue`](#obj-byvalue) - * [`fn new(value)`](#fn-byvaluenew) - * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) - -## Fields - -### obj byName - - -#### fn byName.new - -```ts -new(value) -``` - -`new` creates a new override of type `byName`. - -#### fn byName.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byName.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byQuery - - -#### fn byQuery.new - -```ts -new(value) -``` - -`new` creates a new override of type `byQuery`. - -#### fn byQuery.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byQuery.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byRegexp - - -#### fn byRegexp.new - -```ts -new(value) -``` - -`new` creates a new override of type `byRegexp`. - -#### fn byRegexp.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byRegexp.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byType - - -#### fn byType.new - -```ts -new(value) -``` - -`new` creates a new override of type `byType`. - -#### fn byType.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byType.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byValue - - -#### fn byValue.new - -```ts -new(value) -``` - -`new` creates a new override of type `byValue`. - -#### fn byValue.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byValue.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barGauge/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barGauge/index.md deleted file mode 100644 index 7b9a4ed..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barGauge/index.md +++ /dev/null @@ -1,638 +0,0 @@ -# barGauge - -grafonnet.panel.barGauge - -## Subpackages - -* [fieldOverride](fieldOverride.md) -* [link](link.md) -* [thresholdStep](thresholdStep.md) -* [transformation](transformation.md) -* [valueMapping](valueMapping.md) - -## Index - -* [`fn new(title)`](#fn-new) -* [`obj datasource`](#obj-datasource) - * [`fn withType(value)`](#fn-datasourcewithtype) - * [`fn withUid(value)`](#fn-datasourcewithuid) -* [`obj gridPos`](#obj-gridpos) - * [`fn withH(value=9)`](#fn-gridposwithh) - * [`fn withStatic(value)`](#fn-gridposwithstatic) - * [`fn withW(value=12)`](#fn-gridposwithw) - * [`fn withX(value=0)`](#fn-gridposwithx) - * [`fn withY(value=0)`](#fn-gridposwithy) -* [`obj libraryPanel`](#obj-librarypanel) - * [`fn withName(value)`](#fn-librarypanelwithname) - * [`fn withUid(value)`](#fn-librarypanelwithuid) -* [`obj options`](#obj-options) - * [`fn withDisplayMode(value)`](#fn-optionswithdisplaymode) - * [`fn withMinVizHeight(value=10)`](#fn-optionswithminvizheight) - * [`fn withMinVizWidth(value=0)`](#fn-optionswithminvizwidth) - * [`fn withOrientation(value)`](#fn-optionswithorientation) - * [`fn withReduceOptions(value)`](#fn-optionswithreduceoptions) - * [`fn withReduceOptionsMixin(value)`](#fn-optionswithreduceoptionsmixin) - * [`fn withShowUnfilled(value=true)`](#fn-optionswithshowunfilled) - * [`fn withText(value)`](#fn-optionswithtext) - * [`fn withTextMixin(value)`](#fn-optionswithtextmixin) - * [`fn withValueMode(value)`](#fn-optionswithvaluemode) - * [`obj reduceOptions`](#obj-optionsreduceoptions) - * [`fn withCalcs(value)`](#fn-optionsreduceoptionswithcalcs) - * [`fn withCalcsMixin(value)`](#fn-optionsreduceoptionswithcalcsmixin) - * [`fn withFields(value)`](#fn-optionsreduceoptionswithfields) - * [`fn withLimit(value)`](#fn-optionsreduceoptionswithlimit) - * [`fn withValues(value)`](#fn-optionsreduceoptionswithvalues) - * [`obj text`](#obj-optionstext) - * [`fn withTitleSize(value)`](#fn-optionstextwithtitlesize) - * [`fn withValueSize(value)`](#fn-optionstextwithvaluesize) -* [`obj panelOptions`](#obj-paneloptions) - * [`fn withDescription(value)`](#fn-paneloptionswithdescription) - * [`fn withLinks(value)`](#fn-paneloptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) - * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) - * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) - * [`fn withTitle(value)`](#fn-paneloptionswithtitle) - * [`fn withTransparent(value=false)`](#fn-paneloptionswithtransparent) -* [`obj queryOptions`](#obj-queryoptions) - * [`fn withDatasource(value)`](#fn-queryoptionswithdatasource) - * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) - * [`fn withInterval(value)`](#fn-queryoptionswithinterval) - * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) - * [`fn withTargets(value)`](#fn-queryoptionswithtargets) - * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) - * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) - * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) - * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) - * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) -* [`obj standardOptions`](#obj-standardoptions) - * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) - * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) - * [`fn withLinks(value)`](#fn-standardoptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) - * [`fn withMappings(value)`](#fn-standardoptionswithmappings) - * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) - * [`fn withMax(value)`](#fn-standardoptionswithmax) - * [`fn withMin(value)`](#fn-standardoptionswithmin) - * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) - * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) - * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) - * [`fn withUnit(value)`](#fn-standardoptionswithunit) - * [`obj color`](#obj-standardoptionscolor) - * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) - * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) - * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) - * [`obj thresholds`](#obj-standardoptionsthresholds) - * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) - * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) - * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) - -## Fields - -### fn new - -```ts -new(title) -``` - -Creates a new barGauge panel with a title. - -### obj datasource - - -#### fn datasource.withType - -```ts -withType(value) -``` - - - -#### fn datasource.withUid - -```ts -withUid(value) -``` - - - -### obj gridPos - - -#### fn gridPos.withH - -```ts -withH(value=9) -``` - -Panel - -#### fn gridPos.withStatic - -```ts -withStatic(value) -``` - -true if fixed - -#### fn gridPos.withW - -```ts -withW(value=12) -``` - -Panel - -#### fn gridPos.withX - -```ts -withX(value=0) -``` - -Panel x - -#### fn gridPos.withY - -```ts -withY(value=0) -``` - -Panel y - -### obj libraryPanel - - -#### fn libraryPanel.withName - -```ts -withName(value) -``` - - - -#### fn libraryPanel.withUid - -```ts -withUid(value) -``` - - - -### obj options - - -#### fn options.withDisplayMode - -```ts -withDisplayMode(value) -``` - -Enum expressing the possible display modes -for the bar gauge component of Grafana UI - -Accepted values for `value` are "basic", "lcd", "gradient" - -#### fn options.withMinVizHeight - -```ts -withMinVizHeight(value=10) -``` - - - -#### fn options.withMinVizWidth - -```ts -withMinVizWidth(value=0) -``` - - - -#### fn options.withOrientation - -```ts -withOrientation(value) -``` - -TODO docs - -Accepted values for `value` are "auto", "vertical", "horizontal" - -#### fn options.withReduceOptions - -```ts -withReduceOptions(value) -``` - -TODO docs - -#### fn options.withReduceOptionsMixin - -```ts -withReduceOptionsMixin(value) -``` - -TODO docs - -#### fn options.withShowUnfilled - -```ts -withShowUnfilled(value=true) -``` - - - -#### fn options.withText - -```ts -withText(value) -``` - -TODO docs - -#### fn options.withTextMixin - -```ts -withTextMixin(value) -``` - -TODO docs - -#### fn options.withValueMode - -```ts -withValueMode(value) -``` - -Allows for the table cell gauge display type to set the gauge mode. - -Accepted values for `value` are "color", "text", "hidden" - -#### obj options.reduceOptions - - -##### fn options.reduceOptions.withCalcs - -```ts -withCalcs(value) -``` - -When !values, pick one value for the whole field - -##### fn options.reduceOptions.withCalcsMixin - -```ts -withCalcsMixin(value) -``` - -When !values, pick one value for the whole field - -##### fn options.reduceOptions.withFields - -```ts -withFields(value) -``` - -Which fields to show. By default this is only numeric fields - -##### fn options.reduceOptions.withLimit - -```ts -withLimit(value) -``` - -if showing all values limit - -##### fn options.reduceOptions.withValues - -```ts -withValues(value) -``` - -If true show each row value - -#### obj options.text - - -##### fn options.text.withTitleSize - -```ts -withTitleSize(value) -``` - -Explicit title text size - -##### fn options.text.withValueSize - -```ts -withValueSize(value) -``` - -Explicit value text size - -### obj panelOptions - - -#### fn panelOptions.withDescription - -```ts -withDescription(value) -``` - -Description. - -#### fn panelOptions.withLinks - -```ts -withLinks(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withRepeat - -```ts -withRepeat(value) -``` - -Name of template variable to repeat for. - -#### fn panelOptions.withRepeatDirection - -```ts -withRepeatDirection(value="h") -``` - -Direction to repeat in if 'repeat' is set. -"h" for horizontal, "v" for vertical. -TODO this is probably optional - -Accepted values for `value` are "h", "v" - -#### fn panelOptions.withTitle - -```ts -withTitle(value) -``` - -Panel title. - -#### fn panelOptions.withTransparent - -```ts -withTransparent(value=false) -``` - -Whether to display the panel without a background. - -### obj queryOptions - - -#### fn queryOptions.withDatasource - -```ts -withDatasource(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withDatasourceMixin - -```ts -withDatasourceMixin(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withInterval - -```ts -withInterval(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withMaxDataPoints - -```ts -withMaxDataPoints(value) -``` - -TODO docs - -#### fn queryOptions.withTargets - -```ts -withTargets(value) -``` - -TODO docs - -#### fn queryOptions.withTargetsMixin - -```ts -withTargetsMixin(value) -``` - -TODO docs - -#### fn queryOptions.withTimeFrom - -```ts -withTimeFrom(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTimeShift - -```ts -withTimeShift(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTransformations - -```ts -withTransformations(value) -``` - - - -#### fn queryOptions.withTransformationsMixin - -```ts -withTransformationsMixin(value) -``` - - - -### obj standardOptions - - -#### fn standardOptions.withDecimals - -```ts -withDecimals(value) -``` - -Significant digits (for display) - -#### fn standardOptions.withDisplayName - -```ts -withDisplayName(value) -``` - -The display value for this field. This supports template variables blank is auto - -#### fn standardOptions.withLinks - -```ts -withLinks(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withMappings - -```ts -withMappings(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMappingsMixin - -```ts -withMappingsMixin(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMax - -```ts -withMax(value) -``` - - - -#### fn standardOptions.withMin - -```ts -withMin(value) -``` - - - -#### fn standardOptions.withNoValue - -```ts -withNoValue(value) -``` - -Alternative to empty string - -#### fn standardOptions.withOverrides - -```ts -withOverrides(value) -``` - - - -#### fn standardOptions.withOverridesMixin - -```ts -withOverridesMixin(value) -``` - - - -#### fn standardOptions.withUnit - -```ts -withUnit(value) -``` - -Numeric Options - -#### obj standardOptions.color - - -##### fn standardOptions.color.withFixedColor - -```ts -withFixedColor(value) -``` - -Stores the fixed color value if mode is fixed - -##### fn standardOptions.color.withMode - -```ts -withMode(value) -``` - -The main color scheme mode - -##### fn standardOptions.color.withSeriesBy - -```ts -withSeriesBy(value) -``` - -TODO docs - -Accepted values for `value` are "min", "max", "last" - -#### obj standardOptions.thresholds - - -##### fn standardOptions.thresholds.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "absolute", "percentage" - -##### fn standardOptions.thresholds.withSteps - -```ts -withSteps(value) -``` - -Must be sorted by 'value', first value is always -Infinity - -##### fn standardOptions.thresholds.withStepsMixin - -```ts -withStepsMixin(value) -``` - -Must be sorted by 'value', first value is always -Infinity diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barGauge/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barGauge/link.md deleted file mode 100644 index 1a1d7c4..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barGauge/link.md +++ /dev/null @@ -1,109 +0,0 @@ -# link - - - -## Index - -* [`fn withAsDropdown(value=false)`](#fn-withasdropdown) -* [`fn withIcon(value)`](#fn-withicon) -* [`fn withIncludeVars(value=false)`](#fn-withincludevars) -* [`fn withKeepTime(value=false)`](#fn-withkeeptime) -* [`fn withTags(value)`](#fn-withtags) -* [`fn withTagsMixin(value)`](#fn-withtagsmixin) -* [`fn withTargetBlank(value=false)`](#fn-withtargetblank) -* [`fn withTitle(value)`](#fn-withtitle) -* [`fn withTooltip(value)`](#fn-withtooltip) -* [`fn withType(value)`](#fn-withtype) -* [`fn withUrl(value)`](#fn-withurl) - -## Fields - -### fn withAsDropdown - -```ts -withAsDropdown(value=false) -``` - - - -### fn withIcon - -```ts -withIcon(value) -``` - - - -### fn withIncludeVars - -```ts -withIncludeVars(value=false) -``` - - - -### fn withKeepTime - -```ts -withKeepTime(value=false) -``` - - - -### fn withTags - -```ts -withTags(value) -``` - - - -### fn withTagsMixin - -```ts -withTagsMixin(value) -``` - - - -### fn withTargetBlank - -```ts -withTargetBlank(value=false) -``` - - - -### fn withTitle - -```ts -withTitle(value) -``` - - - -### fn withTooltip - -```ts -withTooltip(value) -``` - - - -### fn withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "link", "dashboards" - -### fn withUrl - -```ts -withUrl(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barGauge/thresholdStep.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barGauge/thresholdStep.md deleted file mode 100644 index 9d6af42..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barGauge/thresholdStep.md +++ /dev/null @@ -1,47 +0,0 @@ -# thresholdStep - - - -## Index - -* [`fn withColor(value)`](#fn-withcolor) -* [`fn withIndex(value)`](#fn-withindex) -* [`fn withState(value)`](#fn-withstate) -* [`fn withValue(value)`](#fn-withvalue) - -## Fields - -### fn withColor - -```ts -withColor(value) -``` - -TODO docs - -### fn withIndex - -```ts -withIndex(value) -``` - -Threshold index, an old property that is not needed an should only appear in older dashboards - -### fn withState - -```ts -withState(value) -``` - -TODO docs -TODO are the values here enumerable into a disjunction? -Some seem to be listed in typescript comment - -### fn withValue - -```ts -withValue(value) -``` - -TODO docs -FIXME the corresponding typescript field is required/non-optional, but nulls currently appear here when serializing -Infinity to JSON diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barGauge/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barGauge/transformation.md deleted file mode 100644 index 3dac7e9..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barGauge/transformation.md +++ /dev/null @@ -1,76 +0,0 @@ -# transformation - - - -## Index - -* [`fn withDisabled(value)`](#fn-withdisabled) -* [`fn withFilter(value)`](#fn-withfilter) -* [`fn withFilterMixin(value)`](#fn-withfiltermixin) -* [`fn withId(value)`](#fn-withid) -* [`fn withOptions(value)`](#fn-withoptions) -* [`obj filter`](#obj-filter) - * [`fn withId(value="")`](#fn-filterwithid) - * [`fn withOptions(value)`](#fn-filterwithoptions) - -## Fields - -### fn withDisabled - -```ts -withDisabled(value) -``` - -Disabled transformations are skipped - -### fn withFilter - -```ts -withFilter(value) -``` - - - -### fn withFilterMixin - -```ts -withFilterMixin(value) -``` - - - -### fn withId - -```ts -withId(value) -``` - -Unique identifier of transformer - -### fn withOptions - -```ts -withOptions(value) -``` - -Options to be passed to the transformer -Valid options depend on the transformer id - -### obj filter - - -#### fn filter.withId - -```ts -withId(value="") -``` - - - -#### fn filter.withOptions - -```ts -withOptions(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barGauge/valueMapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barGauge/valueMapping.md deleted file mode 100644 index a6bbdb3..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/barGauge/valueMapping.md +++ /dev/null @@ -1,365 +0,0 @@ -# valueMapping - - - -## Index - -* [`obj RangeMap`](#obj-rangemap) - * [`fn withOptions(value)`](#fn-rangemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) - * [`obj options`](#obj-rangemapoptions) - * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) - * [`fn withResult(value)`](#fn-rangemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) - * [`fn withTo(value)`](#fn-rangemapoptionswithto) - * [`obj result`](#obj-rangemapoptionsresult) - * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) -* [`obj RegexMap`](#obj-regexmap) - * [`fn withOptions(value)`](#fn-regexmapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) - * [`obj options`](#obj-regexmapoptions) - * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) - * [`fn withResult(value)`](#fn-regexmapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) - * [`obj result`](#obj-regexmapoptionsresult) - * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) - * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) -* [`obj SpecialValueMap`](#obj-specialvaluemap) - * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) - * [`obj options`](#obj-specialvaluemapoptions) - * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) - * [`fn withPattern(value)`](#fn-specialvaluemapoptionswithpattern) - * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) - * [`obj result`](#obj-specialvaluemapoptionsresult) - * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) -* [`obj ValueMap`](#obj-valuemap) - * [`fn withOptions(value)`](#fn-valuemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) - -## Fields - -### obj RangeMap - - -#### fn RangeMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RangeMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RangeMap.withType - -```ts -withType(value) -``` - - - -#### obj RangeMap.options - - -##### fn RangeMap.options.withFrom - -```ts -withFrom(value) -``` - -to and from are `number | null` in current ts, really not sure what to do - -##### fn RangeMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RangeMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### fn RangeMap.options.withTo - -```ts -withTo(value) -``` - - - -##### obj RangeMap.options.result - - -###### fn RangeMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RangeMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RangeMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RangeMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj RegexMap - - -#### fn RegexMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RegexMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RegexMap.withType - -```ts -withType(value) -``` - - - -#### obj RegexMap.options - - -##### fn RegexMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn RegexMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RegexMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj RegexMap.options.result - - -###### fn RegexMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RegexMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RegexMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RegexMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj SpecialValueMap - - -#### fn SpecialValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn SpecialValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn SpecialValueMap.withType - -```ts -withType(value) -``` - - - -#### obj SpecialValueMap.options - - -##### fn SpecialValueMap.options.withMatch - -```ts -withMatch(value) -``` - - - -Accepted values for `value` are "true", "false" - -##### fn SpecialValueMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn SpecialValueMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn SpecialValueMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj SpecialValueMap.options.result - - -###### fn SpecialValueMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn SpecialValueMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn SpecialValueMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn SpecialValueMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj ValueMap - - -#### fn ValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn ValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn ValueMap.withType - -```ts -withType(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/candlestick/fieldOverride.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/candlestick/fieldOverride.md deleted file mode 100644 index 3e2667b..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/candlestick/fieldOverride.md +++ /dev/null @@ -1,194 +0,0 @@ -# fieldOverride - -Overrides allow you to customize visualization settings for specific fields or -series. This is accomplished by adding an override rule that targets -a particular set of fields and that can each define multiple options. - -```jsonnet -fieldOverride.byType.new('number') -+ fieldOverride.byType.withPropertiesFromOptions( - panel.standardOptions.withDecimals(2) - + panel.standardOptions.withUnit('s') -) -``` - - -## Index - -* [`obj byName`](#obj-byname) - * [`fn new(value)`](#fn-bynamenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bynamewithproperty) -* [`obj byQuery`](#obj-byquery) - * [`fn new(value)`](#fn-byquerynew) - * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byquerywithproperty) -* [`obj byRegexp`](#obj-byregexp) - * [`fn new(value)`](#fn-byregexpnew) - * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) -* [`obj byType`](#obj-bytype) - * [`fn new(value)`](#fn-bytypenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bytypewithproperty) -* [`obj byValue`](#obj-byvalue) - * [`fn new(value)`](#fn-byvaluenew) - * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) - -## Fields - -### obj byName - - -#### fn byName.new - -```ts -new(value) -``` - -`new` creates a new override of type `byName`. - -#### fn byName.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byName.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byQuery - - -#### fn byQuery.new - -```ts -new(value) -``` - -`new` creates a new override of type `byQuery`. - -#### fn byQuery.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byQuery.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byRegexp - - -#### fn byRegexp.new - -```ts -new(value) -``` - -`new` creates a new override of type `byRegexp`. - -#### fn byRegexp.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byRegexp.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byType - - -#### fn byType.new - -```ts -new(value) -``` - -`new` creates a new override of type `byType`. - -#### fn byType.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byType.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byValue - - -#### fn byValue.new - -```ts -new(value) -``` - -`new` creates a new override of type `byValue`. - -#### fn byValue.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byValue.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/candlestick/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/candlestick/index.md deleted file mode 100644 index 7012b2f..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/candlestick/index.md +++ /dev/null @@ -1,466 +0,0 @@ -# candlestick - -grafonnet.panel.candlestick - -## Subpackages - -* [fieldOverride](fieldOverride.md) -* [link](link.md) -* [thresholdStep](thresholdStep.md) -* [transformation](transformation.md) -* [valueMapping](valueMapping.md) - -## Index - -* [`fn new(title)`](#fn-new) -* [`obj datasource`](#obj-datasource) - * [`fn withType(value)`](#fn-datasourcewithtype) - * [`fn withUid(value)`](#fn-datasourcewithuid) -* [`obj gridPos`](#obj-gridpos) - * [`fn withH(value=9)`](#fn-gridposwithh) - * [`fn withStatic(value)`](#fn-gridposwithstatic) - * [`fn withW(value=12)`](#fn-gridposwithw) - * [`fn withX(value=0)`](#fn-gridposwithx) - * [`fn withY(value=0)`](#fn-gridposwithy) -* [`obj libraryPanel`](#obj-librarypanel) - * [`fn withName(value)`](#fn-librarypanelwithname) - * [`fn withUid(value)`](#fn-librarypanelwithuid) -* [`obj panelOptions`](#obj-paneloptions) - * [`fn withDescription(value)`](#fn-paneloptionswithdescription) - * [`fn withLinks(value)`](#fn-paneloptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) - * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) - * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) - * [`fn withTitle(value)`](#fn-paneloptionswithtitle) - * [`fn withTransparent(value=false)`](#fn-paneloptionswithtransparent) -* [`obj queryOptions`](#obj-queryoptions) - * [`fn withDatasource(value)`](#fn-queryoptionswithdatasource) - * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) - * [`fn withInterval(value)`](#fn-queryoptionswithinterval) - * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) - * [`fn withTargets(value)`](#fn-queryoptionswithtargets) - * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) - * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) - * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) - * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) - * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) -* [`obj standardOptions`](#obj-standardoptions) - * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) - * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) - * [`fn withLinks(value)`](#fn-standardoptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) - * [`fn withMappings(value)`](#fn-standardoptionswithmappings) - * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) - * [`fn withMax(value)`](#fn-standardoptionswithmax) - * [`fn withMin(value)`](#fn-standardoptionswithmin) - * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) - * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) - * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) - * [`fn withUnit(value)`](#fn-standardoptionswithunit) - * [`obj color`](#obj-standardoptionscolor) - * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) - * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) - * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) - * [`obj thresholds`](#obj-standardoptionsthresholds) - * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) - * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) - * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) - -## Fields - -### fn new - -```ts -new(title) -``` - -Creates a new candlestick panel with a title. - -### obj datasource - - -#### fn datasource.withType - -```ts -withType(value) -``` - - - -#### fn datasource.withUid - -```ts -withUid(value) -``` - - - -### obj gridPos - - -#### fn gridPos.withH - -```ts -withH(value=9) -``` - -Panel - -#### fn gridPos.withStatic - -```ts -withStatic(value) -``` - -true if fixed - -#### fn gridPos.withW - -```ts -withW(value=12) -``` - -Panel - -#### fn gridPos.withX - -```ts -withX(value=0) -``` - -Panel x - -#### fn gridPos.withY - -```ts -withY(value=0) -``` - -Panel y - -### obj libraryPanel - - -#### fn libraryPanel.withName - -```ts -withName(value) -``` - - - -#### fn libraryPanel.withUid - -```ts -withUid(value) -``` - - - -### obj panelOptions - - -#### fn panelOptions.withDescription - -```ts -withDescription(value) -``` - -Description. - -#### fn panelOptions.withLinks - -```ts -withLinks(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withRepeat - -```ts -withRepeat(value) -``` - -Name of template variable to repeat for. - -#### fn panelOptions.withRepeatDirection - -```ts -withRepeatDirection(value="h") -``` - -Direction to repeat in if 'repeat' is set. -"h" for horizontal, "v" for vertical. -TODO this is probably optional - -Accepted values for `value` are "h", "v" - -#### fn panelOptions.withTitle - -```ts -withTitle(value) -``` - -Panel title. - -#### fn panelOptions.withTransparent - -```ts -withTransparent(value=false) -``` - -Whether to display the panel without a background. - -### obj queryOptions - - -#### fn queryOptions.withDatasource - -```ts -withDatasource(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withDatasourceMixin - -```ts -withDatasourceMixin(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withInterval - -```ts -withInterval(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withMaxDataPoints - -```ts -withMaxDataPoints(value) -``` - -TODO docs - -#### fn queryOptions.withTargets - -```ts -withTargets(value) -``` - -TODO docs - -#### fn queryOptions.withTargetsMixin - -```ts -withTargetsMixin(value) -``` - -TODO docs - -#### fn queryOptions.withTimeFrom - -```ts -withTimeFrom(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTimeShift - -```ts -withTimeShift(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTransformations - -```ts -withTransformations(value) -``` - - - -#### fn queryOptions.withTransformationsMixin - -```ts -withTransformationsMixin(value) -``` - - - -### obj standardOptions - - -#### fn standardOptions.withDecimals - -```ts -withDecimals(value) -``` - -Significant digits (for display) - -#### fn standardOptions.withDisplayName - -```ts -withDisplayName(value) -``` - -The display value for this field. This supports template variables blank is auto - -#### fn standardOptions.withLinks - -```ts -withLinks(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withMappings - -```ts -withMappings(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMappingsMixin - -```ts -withMappingsMixin(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMax - -```ts -withMax(value) -``` - - - -#### fn standardOptions.withMin - -```ts -withMin(value) -``` - - - -#### fn standardOptions.withNoValue - -```ts -withNoValue(value) -``` - -Alternative to empty string - -#### fn standardOptions.withOverrides - -```ts -withOverrides(value) -``` - - - -#### fn standardOptions.withOverridesMixin - -```ts -withOverridesMixin(value) -``` - - - -#### fn standardOptions.withUnit - -```ts -withUnit(value) -``` - -Numeric Options - -#### obj standardOptions.color - - -##### fn standardOptions.color.withFixedColor - -```ts -withFixedColor(value) -``` - -Stores the fixed color value if mode is fixed - -##### fn standardOptions.color.withMode - -```ts -withMode(value) -``` - -The main color scheme mode - -##### fn standardOptions.color.withSeriesBy - -```ts -withSeriesBy(value) -``` - -TODO docs - -Accepted values for `value` are "min", "max", "last" - -#### obj standardOptions.thresholds - - -##### fn standardOptions.thresholds.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "absolute", "percentage" - -##### fn standardOptions.thresholds.withSteps - -```ts -withSteps(value) -``` - -Must be sorted by 'value', first value is always -Infinity - -##### fn standardOptions.thresholds.withStepsMixin - -```ts -withStepsMixin(value) -``` - -Must be sorted by 'value', first value is always -Infinity diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/candlestick/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/candlestick/link.md deleted file mode 100644 index 1a1d7c4..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/candlestick/link.md +++ /dev/null @@ -1,109 +0,0 @@ -# link - - - -## Index - -* [`fn withAsDropdown(value=false)`](#fn-withasdropdown) -* [`fn withIcon(value)`](#fn-withicon) -* [`fn withIncludeVars(value=false)`](#fn-withincludevars) -* [`fn withKeepTime(value=false)`](#fn-withkeeptime) -* [`fn withTags(value)`](#fn-withtags) -* [`fn withTagsMixin(value)`](#fn-withtagsmixin) -* [`fn withTargetBlank(value=false)`](#fn-withtargetblank) -* [`fn withTitle(value)`](#fn-withtitle) -* [`fn withTooltip(value)`](#fn-withtooltip) -* [`fn withType(value)`](#fn-withtype) -* [`fn withUrl(value)`](#fn-withurl) - -## Fields - -### fn withAsDropdown - -```ts -withAsDropdown(value=false) -``` - - - -### fn withIcon - -```ts -withIcon(value) -``` - - - -### fn withIncludeVars - -```ts -withIncludeVars(value=false) -``` - - - -### fn withKeepTime - -```ts -withKeepTime(value=false) -``` - - - -### fn withTags - -```ts -withTags(value) -``` - - - -### fn withTagsMixin - -```ts -withTagsMixin(value) -``` - - - -### fn withTargetBlank - -```ts -withTargetBlank(value=false) -``` - - - -### fn withTitle - -```ts -withTitle(value) -``` - - - -### fn withTooltip - -```ts -withTooltip(value) -``` - - - -### fn withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "link", "dashboards" - -### fn withUrl - -```ts -withUrl(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/candlestick/thresholdStep.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/candlestick/thresholdStep.md deleted file mode 100644 index 9d6af42..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/candlestick/thresholdStep.md +++ /dev/null @@ -1,47 +0,0 @@ -# thresholdStep - - - -## Index - -* [`fn withColor(value)`](#fn-withcolor) -* [`fn withIndex(value)`](#fn-withindex) -* [`fn withState(value)`](#fn-withstate) -* [`fn withValue(value)`](#fn-withvalue) - -## Fields - -### fn withColor - -```ts -withColor(value) -``` - -TODO docs - -### fn withIndex - -```ts -withIndex(value) -``` - -Threshold index, an old property that is not needed an should only appear in older dashboards - -### fn withState - -```ts -withState(value) -``` - -TODO docs -TODO are the values here enumerable into a disjunction? -Some seem to be listed in typescript comment - -### fn withValue - -```ts -withValue(value) -``` - -TODO docs -FIXME the corresponding typescript field is required/non-optional, but nulls currently appear here when serializing -Infinity to JSON diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/candlestick/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/candlestick/transformation.md deleted file mode 100644 index 3dac7e9..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/candlestick/transformation.md +++ /dev/null @@ -1,76 +0,0 @@ -# transformation - - - -## Index - -* [`fn withDisabled(value)`](#fn-withdisabled) -* [`fn withFilter(value)`](#fn-withfilter) -* [`fn withFilterMixin(value)`](#fn-withfiltermixin) -* [`fn withId(value)`](#fn-withid) -* [`fn withOptions(value)`](#fn-withoptions) -* [`obj filter`](#obj-filter) - * [`fn withId(value="")`](#fn-filterwithid) - * [`fn withOptions(value)`](#fn-filterwithoptions) - -## Fields - -### fn withDisabled - -```ts -withDisabled(value) -``` - -Disabled transformations are skipped - -### fn withFilter - -```ts -withFilter(value) -``` - - - -### fn withFilterMixin - -```ts -withFilterMixin(value) -``` - - - -### fn withId - -```ts -withId(value) -``` - -Unique identifier of transformer - -### fn withOptions - -```ts -withOptions(value) -``` - -Options to be passed to the transformer -Valid options depend on the transformer id - -### obj filter - - -#### fn filter.withId - -```ts -withId(value="") -``` - - - -#### fn filter.withOptions - -```ts -withOptions(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/candlestick/valueMapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/candlestick/valueMapping.md deleted file mode 100644 index a6bbdb3..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/candlestick/valueMapping.md +++ /dev/null @@ -1,365 +0,0 @@ -# valueMapping - - - -## Index - -* [`obj RangeMap`](#obj-rangemap) - * [`fn withOptions(value)`](#fn-rangemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) - * [`obj options`](#obj-rangemapoptions) - * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) - * [`fn withResult(value)`](#fn-rangemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) - * [`fn withTo(value)`](#fn-rangemapoptionswithto) - * [`obj result`](#obj-rangemapoptionsresult) - * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) -* [`obj RegexMap`](#obj-regexmap) - * [`fn withOptions(value)`](#fn-regexmapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) - * [`obj options`](#obj-regexmapoptions) - * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) - * [`fn withResult(value)`](#fn-regexmapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) - * [`obj result`](#obj-regexmapoptionsresult) - * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) - * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) -* [`obj SpecialValueMap`](#obj-specialvaluemap) - * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) - * [`obj options`](#obj-specialvaluemapoptions) - * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) - * [`fn withPattern(value)`](#fn-specialvaluemapoptionswithpattern) - * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) - * [`obj result`](#obj-specialvaluemapoptionsresult) - * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) -* [`obj ValueMap`](#obj-valuemap) - * [`fn withOptions(value)`](#fn-valuemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) - -## Fields - -### obj RangeMap - - -#### fn RangeMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RangeMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RangeMap.withType - -```ts -withType(value) -``` - - - -#### obj RangeMap.options - - -##### fn RangeMap.options.withFrom - -```ts -withFrom(value) -``` - -to and from are `number | null` in current ts, really not sure what to do - -##### fn RangeMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RangeMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### fn RangeMap.options.withTo - -```ts -withTo(value) -``` - - - -##### obj RangeMap.options.result - - -###### fn RangeMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RangeMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RangeMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RangeMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj RegexMap - - -#### fn RegexMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RegexMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RegexMap.withType - -```ts -withType(value) -``` - - - -#### obj RegexMap.options - - -##### fn RegexMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn RegexMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RegexMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj RegexMap.options.result - - -###### fn RegexMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RegexMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RegexMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RegexMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj SpecialValueMap - - -#### fn SpecialValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn SpecialValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn SpecialValueMap.withType - -```ts -withType(value) -``` - - - -#### obj SpecialValueMap.options - - -##### fn SpecialValueMap.options.withMatch - -```ts -withMatch(value) -``` - - - -Accepted values for `value` are "true", "false" - -##### fn SpecialValueMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn SpecialValueMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn SpecialValueMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj SpecialValueMap.options.result - - -###### fn SpecialValueMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn SpecialValueMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn SpecialValueMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn SpecialValueMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj ValueMap - - -#### fn ValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn ValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn ValueMap.withType - -```ts -withType(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/canvas/fieldOverride.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/canvas/fieldOverride.md deleted file mode 100644 index 3e2667b..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/canvas/fieldOverride.md +++ /dev/null @@ -1,194 +0,0 @@ -# fieldOverride - -Overrides allow you to customize visualization settings for specific fields or -series. This is accomplished by adding an override rule that targets -a particular set of fields and that can each define multiple options. - -```jsonnet -fieldOverride.byType.new('number') -+ fieldOverride.byType.withPropertiesFromOptions( - panel.standardOptions.withDecimals(2) - + panel.standardOptions.withUnit('s') -) -``` - - -## Index - -* [`obj byName`](#obj-byname) - * [`fn new(value)`](#fn-bynamenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bynamewithproperty) -* [`obj byQuery`](#obj-byquery) - * [`fn new(value)`](#fn-byquerynew) - * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byquerywithproperty) -* [`obj byRegexp`](#obj-byregexp) - * [`fn new(value)`](#fn-byregexpnew) - * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) -* [`obj byType`](#obj-bytype) - * [`fn new(value)`](#fn-bytypenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bytypewithproperty) -* [`obj byValue`](#obj-byvalue) - * [`fn new(value)`](#fn-byvaluenew) - * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) - -## Fields - -### obj byName - - -#### fn byName.new - -```ts -new(value) -``` - -`new` creates a new override of type `byName`. - -#### fn byName.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byName.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byQuery - - -#### fn byQuery.new - -```ts -new(value) -``` - -`new` creates a new override of type `byQuery`. - -#### fn byQuery.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byQuery.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byRegexp - - -#### fn byRegexp.new - -```ts -new(value) -``` - -`new` creates a new override of type `byRegexp`. - -#### fn byRegexp.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byRegexp.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byType - - -#### fn byType.new - -```ts -new(value) -``` - -`new` creates a new override of type `byType`. - -#### fn byType.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byType.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byValue - - -#### fn byValue.new - -```ts -new(value) -``` - -`new` creates a new override of type `byValue`. - -#### fn byValue.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byValue.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/canvas/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/canvas/index.md deleted file mode 100644 index 6966e65..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/canvas/index.md +++ /dev/null @@ -1,466 +0,0 @@ -# canvas - -grafonnet.panel.canvas - -## Subpackages - -* [fieldOverride](fieldOverride.md) -* [link](link.md) -* [thresholdStep](thresholdStep.md) -* [transformation](transformation.md) -* [valueMapping](valueMapping.md) - -## Index - -* [`fn new(title)`](#fn-new) -* [`obj datasource`](#obj-datasource) - * [`fn withType(value)`](#fn-datasourcewithtype) - * [`fn withUid(value)`](#fn-datasourcewithuid) -* [`obj gridPos`](#obj-gridpos) - * [`fn withH(value=9)`](#fn-gridposwithh) - * [`fn withStatic(value)`](#fn-gridposwithstatic) - * [`fn withW(value=12)`](#fn-gridposwithw) - * [`fn withX(value=0)`](#fn-gridposwithx) - * [`fn withY(value=0)`](#fn-gridposwithy) -* [`obj libraryPanel`](#obj-librarypanel) - * [`fn withName(value)`](#fn-librarypanelwithname) - * [`fn withUid(value)`](#fn-librarypanelwithuid) -* [`obj panelOptions`](#obj-paneloptions) - * [`fn withDescription(value)`](#fn-paneloptionswithdescription) - * [`fn withLinks(value)`](#fn-paneloptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) - * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) - * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) - * [`fn withTitle(value)`](#fn-paneloptionswithtitle) - * [`fn withTransparent(value=false)`](#fn-paneloptionswithtransparent) -* [`obj queryOptions`](#obj-queryoptions) - * [`fn withDatasource(value)`](#fn-queryoptionswithdatasource) - * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) - * [`fn withInterval(value)`](#fn-queryoptionswithinterval) - * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) - * [`fn withTargets(value)`](#fn-queryoptionswithtargets) - * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) - * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) - * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) - * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) - * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) -* [`obj standardOptions`](#obj-standardoptions) - * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) - * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) - * [`fn withLinks(value)`](#fn-standardoptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) - * [`fn withMappings(value)`](#fn-standardoptionswithmappings) - * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) - * [`fn withMax(value)`](#fn-standardoptionswithmax) - * [`fn withMin(value)`](#fn-standardoptionswithmin) - * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) - * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) - * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) - * [`fn withUnit(value)`](#fn-standardoptionswithunit) - * [`obj color`](#obj-standardoptionscolor) - * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) - * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) - * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) - * [`obj thresholds`](#obj-standardoptionsthresholds) - * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) - * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) - * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) - -## Fields - -### fn new - -```ts -new(title) -``` - -Creates a new canvas panel with a title. - -### obj datasource - - -#### fn datasource.withType - -```ts -withType(value) -``` - - - -#### fn datasource.withUid - -```ts -withUid(value) -``` - - - -### obj gridPos - - -#### fn gridPos.withH - -```ts -withH(value=9) -``` - -Panel - -#### fn gridPos.withStatic - -```ts -withStatic(value) -``` - -true if fixed - -#### fn gridPos.withW - -```ts -withW(value=12) -``` - -Panel - -#### fn gridPos.withX - -```ts -withX(value=0) -``` - -Panel x - -#### fn gridPos.withY - -```ts -withY(value=0) -``` - -Panel y - -### obj libraryPanel - - -#### fn libraryPanel.withName - -```ts -withName(value) -``` - - - -#### fn libraryPanel.withUid - -```ts -withUid(value) -``` - - - -### obj panelOptions - - -#### fn panelOptions.withDescription - -```ts -withDescription(value) -``` - -Description. - -#### fn panelOptions.withLinks - -```ts -withLinks(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withRepeat - -```ts -withRepeat(value) -``` - -Name of template variable to repeat for. - -#### fn panelOptions.withRepeatDirection - -```ts -withRepeatDirection(value="h") -``` - -Direction to repeat in if 'repeat' is set. -"h" for horizontal, "v" for vertical. -TODO this is probably optional - -Accepted values for `value` are "h", "v" - -#### fn panelOptions.withTitle - -```ts -withTitle(value) -``` - -Panel title. - -#### fn panelOptions.withTransparent - -```ts -withTransparent(value=false) -``` - -Whether to display the panel without a background. - -### obj queryOptions - - -#### fn queryOptions.withDatasource - -```ts -withDatasource(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withDatasourceMixin - -```ts -withDatasourceMixin(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withInterval - -```ts -withInterval(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withMaxDataPoints - -```ts -withMaxDataPoints(value) -``` - -TODO docs - -#### fn queryOptions.withTargets - -```ts -withTargets(value) -``` - -TODO docs - -#### fn queryOptions.withTargetsMixin - -```ts -withTargetsMixin(value) -``` - -TODO docs - -#### fn queryOptions.withTimeFrom - -```ts -withTimeFrom(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTimeShift - -```ts -withTimeShift(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTransformations - -```ts -withTransformations(value) -``` - - - -#### fn queryOptions.withTransformationsMixin - -```ts -withTransformationsMixin(value) -``` - - - -### obj standardOptions - - -#### fn standardOptions.withDecimals - -```ts -withDecimals(value) -``` - -Significant digits (for display) - -#### fn standardOptions.withDisplayName - -```ts -withDisplayName(value) -``` - -The display value for this field. This supports template variables blank is auto - -#### fn standardOptions.withLinks - -```ts -withLinks(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withMappings - -```ts -withMappings(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMappingsMixin - -```ts -withMappingsMixin(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMax - -```ts -withMax(value) -``` - - - -#### fn standardOptions.withMin - -```ts -withMin(value) -``` - - - -#### fn standardOptions.withNoValue - -```ts -withNoValue(value) -``` - -Alternative to empty string - -#### fn standardOptions.withOverrides - -```ts -withOverrides(value) -``` - - - -#### fn standardOptions.withOverridesMixin - -```ts -withOverridesMixin(value) -``` - - - -#### fn standardOptions.withUnit - -```ts -withUnit(value) -``` - -Numeric Options - -#### obj standardOptions.color - - -##### fn standardOptions.color.withFixedColor - -```ts -withFixedColor(value) -``` - -Stores the fixed color value if mode is fixed - -##### fn standardOptions.color.withMode - -```ts -withMode(value) -``` - -The main color scheme mode - -##### fn standardOptions.color.withSeriesBy - -```ts -withSeriesBy(value) -``` - -TODO docs - -Accepted values for `value` are "min", "max", "last" - -#### obj standardOptions.thresholds - - -##### fn standardOptions.thresholds.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "absolute", "percentage" - -##### fn standardOptions.thresholds.withSteps - -```ts -withSteps(value) -``` - -Must be sorted by 'value', first value is always -Infinity - -##### fn standardOptions.thresholds.withStepsMixin - -```ts -withStepsMixin(value) -``` - -Must be sorted by 'value', first value is always -Infinity diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/canvas/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/canvas/link.md deleted file mode 100644 index 1a1d7c4..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/canvas/link.md +++ /dev/null @@ -1,109 +0,0 @@ -# link - - - -## Index - -* [`fn withAsDropdown(value=false)`](#fn-withasdropdown) -* [`fn withIcon(value)`](#fn-withicon) -* [`fn withIncludeVars(value=false)`](#fn-withincludevars) -* [`fn withKeepTime(value=false)`](#fn-withkeeptime) -* [`fn withTags(value)`](#fn-withtags) -* [`fn withTagsMixin(value)`](#fn-withtagsmixin) -* [`fn withTargetBlank(value=false)`](#fn-withtargetblank) -* [`fn withTitle(value)`](#fn-withtitle) -* [`fn withTooltip(value)`](#fn-withtooltip) -* [`fn withType(value)`](#fn-withtype) -* [`fn withUrl(value)`](#fn-withurl) - -## Fields - -### fn withAsDropdown - -```ts -withAsDropdown(value=false) -``` - - - -### fn withIcon - -```ts -withIcon(value) -``` - - - -### fn withIncludeVars - -```ts -withIncludeVars(value=false) -``` - - - -### fn withKeepTime - -```ts -withKeepTime(value=false) -``` - - - -### fn withTags - -```ts -withTags(value) -``` - - - -### fn withTagsMixin - -```ts -withTagsMixin(value) -``` - - - -### fn withTargetBlank - -```ts -withTargetBlank(value=false) -``` - - - -### fn withTitle - -```ts -withTitle(value) -``` - - - -### fn withTooltip - -```ts -withTooltip(value) -``` - - - -### fn withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "link", "dashboards" - -### fn withUrl - -```ts -withUrl(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/canvas/thresholdStep.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/canvas/thresholdStep.md deleted file mode 100644 index 9d6af42..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/canvas/thresholdStep.md +++ /dev/null @@ -1,47 +0,0 @@ -# thresholdStep - - - -## Index - -* [`fn withColor(value)`](#fn-withcolor) -* [`fn withIndex(value)`](#fn-withindex) -* [`fn withState(value)`](#fn-withstate) -* [`fn withValue(value)`](#fn-withvalue) - -## Fields - -### fn withColor - -```ts -withColor(value) -``` - -TODO docs - -### fn withIndex - -```ts -withIndex(value) -``` - -Threshold index, an old property that is not needed an should only appear in older dashboards - -### fn withState - -```ts -withState(value) -``` - -TODO docs -TODO are the values here enumerable into a disjunction? -Some seem to be listed in typescript comment - -### fn withValue - -```ts -withValue(value) -``` - -TODO docs -FIXME the corresponding typescript field is required/non-optional, but nulls currently appear here when serializing -Infinity to JSON diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/canvas/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/canvas/transformation.md deleted file mode 100644 index 3dac7e9..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/canvas/transformation.md +++ /dev/null @@ -1,76 +0,0 @@ -# transformation - - - -## Index - -* [`fn withDisabled(value)`](#fn-withdisabled) -* [`fn withFilter(value)`](#fn-withfilter) -* [`fn withFilterMixin(value)`](#fn-withfiltermixin) -* [`fn withId(value)`](#fn-withid) -* [`fn withOptions(value)`](#fn-withoptions) -* [`obj filter`](#obj-filter) - * [`fn withId(value="")`](#fn-filterwithid) - * [`fn withOptions(value)`](#fn-filterwithoptions) - -## Fields - -### fn withDisabled - -```ts -withDisabled(value) -``` - -Disabled transformations are skipped - -### fn withFilter - -```ts -withFilter(value) -``` - - - -### fn withFilterMixin - -```ts -withFilterMixin(value) -``` - - - -### fn withId - -```ts -withId(value) -``` - -Unique identifier of transformer - -### fn withOptions - -```ts -withOptions(value) -``` - -Options to be passed to the transformer -Valid options depend on the transformer id - -### obj filter - - -#### fn filter.withId - -```ts -withId(value="") -``` - - - -#### fn filter.withOptions - -```ts -withOptions(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/canvas/valueMapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/canvas/valueMapping.md deleted file mode 100644 index a6bbdb3..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/canvas/valueMapping.md +++ /dev/null @@ -1,365 +0,0 @@ -# valueMapping - - - -## Index - -* [`obj RangeMap`](#obj-rangemap) - * [`fn withOptions(value)`](#fn-rangemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) - * [`obj options`](#obj-rangemapoptions) - * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) - * [`fn withResult(value)`](#fn-rangemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) - * [`fn withTo(value)`](#fn-rangemapoptionswithto) - * [`obj result`](#obj-rangemapoptionsresult) - * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) -* [`obj RegexMap`](#obj-regexmap) - * [`fn withOptions(value)`](#fn-regexmapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) - * [`obj options`](#obj-regexmapoptions) - * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) - * [`fn withResult(value)`](#fn-regexmapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) - * [`obj result`](#obj-regexmapoptionsresult) - * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) - * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) -* [`obj SpecialValueMap`](#obj-specialvaluemap) - * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) - * [`obj options`](#obj-specialvaluemapoptions) - * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) - * [`fn withPattern(value)`](#fn-specialvaluemapoptionswithpattern) - * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) - * [`obj result`](#obj-specialvaluemapoptionsresult) - * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) -* [`obj ValueMap`](#obj-valuemap) - * [`fn withOptions(value)`](#fn-valuemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) - -## Fields - -### obj RangeMap - - -#### fn RangeMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RangeMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RangeMap.withType - -```ts -withType(value) -``` - - - -#### obj RangeMap.options - - -##### fn RangeMap.options.withFrom - -```ts -withFrom(value) -``` - -to and from are `number | null` in current ts, really not sure what to do - -##### fn RangeMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RangeMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### fn RangeMap.options.withTo - -```ts -withTo(value) -``` - - - -##### obj RangeMap.options.result - - -###### fn RangeMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RangeMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RangeMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RangeMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj RegexMap - - -#### fn RegexMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RegexMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RegexMap.withType - -```ts -withType(value) -``` - - - -#### obj RegexMap.options - - -##### fn RegexMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn RegexMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RegexMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj RegexMap.options.result - - -###### fn RegexMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RegexMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RegexMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RegexMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj SpecialValueMap - - -#### fn SpecialValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn SpecialValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn SpecialValueMap.withType - -```ts -withType(value) -``` - - - -#### obj SpecialValueMap.options - - -##### fn SpecialValueMap.options.withMatch - -```ts -withMatch(value) -``` - - - -Accepted values for `value` are "true", "false" - -##### fn SpecialValueMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn SpecialValueMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn SpecialValueMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj SpecialValueMap.options.result - - -###### fn SpecialValueMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn SpecialValueMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn SpecialValueMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn SpecialValueMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj ValueMap - - -#### fn ValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn ValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn ValueMap.withType - -```ts -withType(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/dashboardList/fieldOverride.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/dashboardList/fieldOverride.md deleted file mode 100644 index 3e2667b..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/dashboardList/fieldOverride.md +++ /dev/null @@ -1,194 +0,0 @@ -# fieldOverride - -Overrides allow you to customize visualization settings for specific fields or -series. This is accomplished by adding an override rule that targets -a particular set of fields and that can each define multiple options. - -```jsonnet -fieldOverride.byType.new('number') -+ fieldOverride.byType.withPropertiesFromOptions( - panel.standardOptions.withDecimals(2) - + panel.standardOptions.withUnit('s') -) -``` - - -## Index - -* [`obj byName`](#obj-byname) - * [`fn new(value)`](#fn-bynamenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bynamewithproperty) -* [`obj byQuery`](#obj-byquery) - * [`fn new(value)`](#fn-byquerynew) - * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byquerywithproperty) -* [`obj byRegexp`](#obj-byregexp) - * [`fn new(value)`](#fn-byregexpnew) - * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) -* [`obj byType`](#obj-bytype) - * [`fn new(value)`](#fn-bytypenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bytypewithproperty) -* [`obj byValue`](#obj-byvalue) - * [`fn new(value)`](#fn-byvaluenew) - * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) - -## Fields - -### obj byName - - -#### fn byName.new - -```ts -new(value) -``` - -`new` creates a new override of type `byName`. - -#### fn byName.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byName.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byQuery - - -#### fn byQuery.new - -```ts -new(value) -``` - -`new` creates a new override of type `byQuery`. - -#### fn byQuery.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byQuery.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byRegexp - - -#### fn byRegexp.new - -```ts -new(value) -``` - -`new` creates a new override of type `byRegexp`. - -#### fn byRegexp.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byRegexp.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byType - - -#### fn byType.new - -```ts -new(value) -``` - -`new` creates a new override of type `byType`. - -#### fn byType.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byType.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byValue - - -#### fn byValue.new - -```ts -new(value) -``` - -`new` creates a new override of type `byValue`. - -#### fn byValue.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byValue.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/dashboardList/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/dashboardList/index.md deleted file mode 100644 index 0d12686..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/dashboardList/index.md +++ /dev/null @@ -1,569 +0,0 @@ -# dashboardList - -grafonnet.panel.dashboardList - -## Subpackages - -* [fieldOverride](fieldOverride.md) -* [link](link.md) -* [thresholdStep](thresholdStep.md) -* [transformation](transformation.md) -* [valueMapping](valueMapping.md) - -## Index - -* [`fn new(title)`](#fn-new) -* [`obj datasource`](#obj-datasource) - * [`fn withType(value)`](#fn-datasourcewithtype) - * [`fn withUid(value)`](#fn-datasourcewithuid) -* [`obj gridPos`](#obj-gridpos) - * [`fn withH(value=9)`](#fn-gridposwithh) - * [`fn withStatic(value)`](#fn-gridposwithstatic) - * [`fn withW(value=12)`](#fn-gridposwithw) - * [`fn withX(value=0)`](#fn-gridposwithx) - * [`fn withY(value=0)`](#fn-gridposwithy) -* [`obj libraryPanel`](#obj-librarypanel) - * [`fn withName(value)`](#fn-librarypanelwithname) - * [`fn withUid(value)`](#fn-librarypanelwithuid) -* [`obj options`](#obj-options) - * [`fn withFolderId(value)`](#fn-optionswithfolderid) - * [`fn withIncludeVars(value=false)`](#fn-optionswithincludevars) - * [`fn withKeepTime(value=false)`](#fn-optionswithkeeptime) - * [`fn withMaxItems(value=10)`](#fn-optionswithmaxitems) - * [`fn withQuery(value="")`](#fn-optionswithquery) - * [`fn withShowHeadings(value=true)`](#fn-optionswithshowheadings) - * [`fn withShowRecentlyViewed(value=false)`](#fn-optionswithshowrecentlyviewed) - * [`fn withShowSearch(value=false)`](#fn-optionswithshowsearch) - * [`fn withShowStarred(value=true)`](#fn-optionswithshowstarred) - * [`fn withTags(value)`](#fn-optionswithtags) - * [`fn withTagsMixin(value)`](#fn-optionswithtagsmixin) -* [`obj panelOptions`](#obj-paneloptions) - * [`fn withDescription(value)`](#fn-paneloptionswithdescription) - * [`fn withLinks(value)`](#fn-paneloptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) - * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) - * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) - * [`fn withTitle(value)`](#fn-paneloptionswithtitle) - * [`fn withTransparent(value=false)`](#fn-paneloptionswithtransparent) -* [`obj queryOptions`](#obj-queryoptions) - * [`fn withDatasource(value)`](#fn-queryoptionswithdatasource) - * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) - * [`fn withInterval(value)`](#fn-queryoptionswithinterval) - * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) - * [`fn withTargets(value)`](#fn-queryoptionswithtargets) - * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) - * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) - * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) - * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) - * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) -* [`obj standardOptions`](#obj-standardoptions) - * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) - * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) - * [`fn withLinks(value)`](#fn-standardoptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) - * [`fn withMappings(value)`](#fn-standardoptionswithmappings) - * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) - * [`fn withMax(value)`](#fn-standardoptionswithmax) - * [`fn withMin(value)`](#fn-standardoptionswithmin) - * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) - * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) - * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) - * [`fn withUnit(value)`](#fn-standardoptionswithunit) - * [`obj color`](#obj-standardoptionscolor) - * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) - * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) - * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) - * [`obj thresholds`](#obj-standardoptionsthresholds) - * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) - * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) - * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) - -## Fields - -### fn new - -```ts -new(title) -``` - -Creates a new dashboardList panel with a title. - -### obj datasource - - -#### fn datasource.withType - -```ts -withType(value) -``` - - - -#### fn datasource.withUid - -```ts -withUid(value) -``` - - - -### obj gridPos - - -#### fn gridPos.withH - -```ts -withH(value=9) -``` - -Panel - -#### fn gridPos.withStatic - -```ts -withStatic(value) -``` - -true if fixed - -#### fn gridPos.withW - -```ts -withW(value=12) -``` - -Panel - -#### fn gridPos.withX - -```ts -withX(value=0) -``` - -Panel x - -#### fn gridPos.withY - -```ts -withY(value=0) -``` - -Panel y - -### obj libraryPanel - - -#### fn libraryPanel.withName - -```ts -withName(value) -``` - - - -#### fn libraryPanel.withUid - -```ts -withUid(value) -``` - - - -### obj options - - -#### fn options.withFolderId - -```ts -withFolderId(value) -``` - - - -#### fn options.withIncludeVars - -```ts -withIncludeVars(value=false) -``` - - - -#### fn options.withKeepTime - -```ts -withKeepTime(value=false) -``` - - - -#### fn options.withMaxItems - -```ts -withMaxItems(value=10) -``` - - - -#### fn options.withQuery - -```ts -withQuery(value="") -``` - - - -#### fn options.withShowHeadings - -```ts -withShowHeadings(value=true) -``` - - - -#### fn options.withShowRecentlyViewed - -```ts -withShowRecentlyViewed(value=false) -``` - - - -#### fn options.withShowSearch - -```ts -withShowSearch(value=false) -``` - - - -#### fn options.withShowStarred - -```ts -withShowStarred(value=true) -``` - - - -#### fn options.withTags - -```ts -withTags(value) -``` - - - -#### fn options.withTagsMixin - -```ts -withTagsMixin(value) -``` - - - -### obj panelOptions - - -#### fn panelOptions.withDescription - -```ts -withDescription(value) -``` - -Description. - -#### fn panelOptions.withLinks - -```ts -withLinks(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withRepeat - -```ts -withRepeat(value) -``` - -Name of template variable to repeat for. - -#### fn panelOptions.withRepeatDirection - -```ts -withRepeatDirection(value="h") -``` - -Direction to repeat in if 'repeat' is set. -"h" for horizontal, "v" for vertical. -TODO this is probably optional - -Accepted values for `value` are "h", "v" - -#### fn panelOptions.withTitle - -```ts -withTitle(value) -``` - -Panel title. - -#### fn panelOptions.withTransparent - -```ts -withTransparent(value=false) -``` - -Whether to display the panel without a background. - -### obj queryOptions - - -#### fn queryOptions.withDatasource - -```ts -withDatasource(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withDatasourceMixin - -```ts -withDatasourceMixin(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withInterval - -```ts -withInterval(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withMaxDataPoints - -```ts -withMaxDataPoints(value) -``` - -TODO docs - -#### fn queryOptions.withTargets - -```ts -withTargets(value) -``` - -TODO docs - -#### fn queryOptions.withTargetsMixin - -```ts -withTargetsMixin(value) -``` - -TODO docs - -#### fn queryOptions.withTimeFrom - -```ts -withTimeFrom(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTimeShift - -```ts -withTimeShift(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTransformations - -```ts -withTransformations(value) -``` - - - -#### fn queryOptions.withTransformationsMixin - -```ts -withTransformationsMixin(value) -``` - - - -### obj standardOptions - - -#### fn standardOptions.withDecimals - -```ts -withDecimals(value) -``` - -Significant digits (for display) - -#### fn standardOptions.withDisplayName - -```ts -withDisplayName(value) -``` - -The display value for this field. This supports template variables blank is auto - -#### fn standardOptions.withLinks - -```ts -withLinks(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withMappings - -```ts -withMappings(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMappingsMixin - -```ts -withMappingsMixin(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMax - -```ts -withMax(value) -``` - - - -#### fn standardOptions.withMin - -```ts -withMin(value) -``` - - - -#### fn standardOptions.withNoValue - -```ts -withNoValue(value) -``` - -Alternative to empty string - -#### fn standardOptions.withOverrides - -```ts -withOverrides(value) -``` - - - -#### fn standardOptions.withOverridesMixin - -```ts -withOverridesMixin(value) -``` - - - -#### fn standardOptions.withUnit - -```ts -withUnit(value) -``` - -Numeric Options - -#### obj standardOptions.color - - -##### fn standardOptions.color.withFixedColor - -```ts -withFixedColor(value) -``` - -Stores the fixed color value if mode is fixed - -##### fn standardOptions.color.withMode - -```ts -withMode(value) -``` - -The main color scheme mode - -##### fn standardOptions.color.withSeriesBy - -```ts -withSeriesBy(value) -``` - -TODO docs - -Accepted values for `value` are "min", "max", "last" - -#### obj standardOptions.thresholds - - -##### fn standardOptions.thresholds.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "absolute", "percentage" - -##### fn standardOptions.thresholds.withSteps - -```ts -withSteps(value) -``` - -Must be sorted by 'value', first value is always -Infinity - -##### fn standardOptions.thresholds.withStepsMixin - -```ts -withStepsMixin(value) -``` - -Must be sorted by 'value', first value is always -Infinity diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/dashboardList/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/dashboardList/link.md deleted file mode 100644 index 1a1d7c4..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/dashboardList/link.md +++ /dev/null @@ -1,109 +0,0 @@ -# link - - - -## Index - -* [`fn withAsDropdown(value=false)`](#fn-withasdropdown) -* [`fn withIcon(value)`](#fn-withicon) -* [`fn withIncludeVars(value=false)`](#fn-withincludevars) -* [`fn withKeepTime(value=false)`](#fn-withkeeptime) -* [`fn withTags(value)`](#fn-withtags) -* [`fn withTagsMixin(value)`](#fn-withtagsmixin) -* [`fn withTargetBlank(value=false)`](#fn-withtargetblank) -* [`fn withTitle(value)`](#fn-withtitle) -* [`fn withTooltip(value)`](#fn-withtooltip) -* [`fn withType(value)`](#fn-withtype) -* [`fn withUrl(value)`](#fn-withurl) - -## Fields - -### fn withAsDropdown - -```ts -withAsDropdown(value=false) -``` - - - -### fn withIcon - -```ts -withIcon(value) -``` - - - -### fn withIncludeVars - -```ts -withIncludeVars(value=false) -``` - - - -### fn withKeepTime - -```ts -withKeepTime(value=false) -``` - - - -### fn withTags - -```ts -withTags(value) -``` - - - -### fn withTagsMixin - -```ts -withTagsMixin(value) -``` - - - -### fn withTargetBlank - -```ts -withTargetBlank(value=false) -``` - - - -### fn withTitle - -```ts -withTitle(value) -``` - - - -### fn withTooltip - -```ts -withTooltip(value) -``` - - - -### fn withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "link", "dashboards" - -### fn withUrl - -```ts -withUrl(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/dashboardList/thresholdStep.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/dashboardList/thresholdStep.md deleted file mode 100644 index 9d6af42..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/dashboardList/thresholdStep.md +++ /dev/null @@ -1,47 +0,0 @@ -# thresholdStep - - - -## Index - -* [`fn withColor(value)`](#fn-withcolor) -* [`fn withIndex(value)`](#fn-withindex) -* [`fn withState(value)`](#fn-withstate) -* [`fn withValue(value)`](#fn-withvalue) - -## Fields - -### fn withColor - -```ts -withColor(value) -``` - -TODO docs - -### fn withIndex - -```ts -withIndex(value) -``` - -Threshold index, an old property that is not needed an should only appear in older dashboards - -### fn withState - -```ts -withState(value) -``` - -TODO docs -TODO are the values here enumerable into a disjunction? -Some seem to be listed in typescript comment - -### fn withValue - -```ts -withValue(value) -``` - -TODO docs -FIXME the corresponding typescript field is required/non-optional, but nulls currently appear here when serializing -Infinity to JSON diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/dashboardList/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/dashboardList/transformation.md deleted file mode 100644 index 3dac7e9..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/dashboardList/transformation.md +++ /dev/null @@ -1,76 +0,0 @@ -# transformation - - - -## Index - -* [`fn withDisabled(value)`](#fn-withdisabled) -* [`fn withFilter(value)`](#fn-withfilter) -* [`fn withFilterMixin(value)`](#fn-withfiltermixin) -* [`fn withId(value)`](#fn-withid) -* [`fn withOptions(value)`](#fn-withoptions) -* [`obj filter`](#obj-filter) - * [`fn withId(value="")`](#fn-filterwithid) - * [`fn withOptions(value)`](#fn-filterwithoptions) - -## Fields - -### fn withDisabled - -```ts -withDisabled(value) -``` - -Disabled transformations are skipped - -### fn withFilter - -```ts -withFilter(value) -``` - - - -### fn withFilterMixin - -```ts -withFilterMixin(value) -``` - - - -### fn withId - -```ts -withId(value) -``` - -Unique identifier of transformer - -### fn withOptions - -```ts -withOptions(value) -``` - -Options to be passed to the transformer -Valid options depend on the transformer id - -### obj filter - - -#### fn filter.withId - -```ts -withId(value="") -``` - - - -#### fn filter.withOptions - -```ts -withOptions(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/dashboardList/valueMapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/dashboardList/valueMapping.md deleted file mode 100644 index a6bbdb3..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/dashboardList/valueMapping.md +++ /dev/null @@ -1,365 +0,0 @@ -# valueMapping - - - -## Index - -* [`obj RangeMap`](#obj-rangemap) - * [`fn withOptions(value)`](#fn-rangemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) - * [`obj options`](#obj-rangemapoptions) - * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) - * [`fn withResult(value)`](#fn-rangemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) - * [`fn withTo(value)`](#fn-rangemapoptionswithto) - * [`obj result`](#obj-rangemapoptionsresult) - * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) -* [`obj RegexMap`](#obj-regexmap) - * [`fn withOptions(value)`](#fn-regexmapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) - * [`obj options`](#obj-regexmapoptions) - * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) - * [`fn withResult(value)`](#fn-regexmapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) - * [`obj result`](#obj-regexmapoptionsresult) - * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) - * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) -* [`obj SpecialValueMap`](#obj-specialvaluemap) - * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) - * [`obj options`](#obj-specialvaluemapoptions) - * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) - * [`fn withPattern(value)`](#fn-specialvaluemapoptionswithpattern) - * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) - * [`obj result`](#obj-specialvaluemapoptionsresult) - * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) -* [`obj ValueMap`](#obj-valuemap) - * [`fn withOptions(value)`](#fn-valuemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) - -## Fields - -### obj RangeMap - - -#### fn RangeMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RangeMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RangeMap.withType - -```ts -withType(value) -``` - - - -#### obj RangeMap.options - - -##### fn RangeMap.options.withFrom - -```ts -withFrom(value) -``` - -to and from are `number | null` in current ts, really not sure what to do - -##### fn RangeMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RangeMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### fn RangeMap.options.withTo - -```ts -withTo(value) -``` - - - -##### obj RangeMap.options.result - - -###### fn RangeMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RangeMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RangeMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RangeMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj RegexMap - - -#### fn RegexMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RegexMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RegexMap.withType - -```ts -withType(value) -``` - - - -#### obj RegexMap.options - - -##### fn RegexMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn RegexMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RegexMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj RegexMap.options.result - - -###### fn RegexMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RegexMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RegexMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RegexMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj SpecialValueMap - - -#### fn SpecialValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn SpecialValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn SpecialValueMap.withType - -```ts -withType(value) -``` - - - -#### obj SpecialValueMap.options - - -##### fn SpecialValueMap.options.withMatch - -```ts -withMatch(value) -``` - - - -Accepted values for `value` are "true", "false" - -##### fn SpecialValueMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn SpecialValueMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn SpecialValueMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj SpecialValueMap.options.result - - -###### fn SpecialValueMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn SpecialValueMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn SpecialValueMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn SpecialValueMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj ValueMap - - -#### fn ValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn ValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn ValueMap.withType - -```ts -withType(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/datagrid/fieldOverride.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/datagrid/fieldOverride.md deleted file mode 100644 index 3e2667b..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/datagrid/fieldOverride.md +++ /dev/null @@ -1,194 +0,0 @@ -# fieldOverride - -Overrides allow you to customize visualization settings for specific fields or -series. This is accomplished by adding an override rule that targets -a particular set of fields and that can each define multiple options. - -```jsonnet -fieldOverride.byType.new('number') -+ fieldOverride.byType.withPropertiesFromOptions( - panel.standardOptions.withDecimals(2) - + panel.standardOptions.withUnit('s') -) -``` - - -## Index - -* [`obj byName`](#obj-byname) - * [`fn new(value)`](#fn-bynamenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bynamewithproperty) -* [`obj byQuery`](#obj-byquery) - * [`fn new(value)`](#fn-byquerynew) - * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byquerywithproperty) -* [`obj byRegexp`](#obj-byregexp) - * [`fn new(value)`](#fn-byregexpnew) - * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) -* [`obj byType`](#obj-bytype) - * [`fn new(value)`](#fn-bytypenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bytypewithproperty) -* [`obj byValue`](#obj-byvalue) - * [`fn new(value)`](#fn-byvaluenew) - * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) - -## Fields - -### obj byName - - -#### fn byName.new - -```ts -new(value) -``` - -`new` creates a new override of type `byName`. - -#### fn byName.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byName.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byQuery - - -#### fn byQuery.new - -```ts -new(value) -``` - -`new` creates a new override of type `byQuery`. - -#### fn byQuery.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byQuery.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byRegexp - - -#### fn byRegexp.new - -```ts -new(value) -``` - -`new` creates a new override of type `byRegexp`. - -#### fn byRegexp.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byRegexp.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byType - - -#### fn byType.new - -```ts -new(value) -``` - -`new` creates a new override of type `byType`. - -#### fn byType.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byType.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byValue - - -#### fn byValue.new - -```ts -new(value) -``` - -`new` creates a new override of type `byValue`. - -#### fn byValue.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byValue.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/datagrid/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/datagrid/index.md deleted file mode 100644 index 7cc60ea..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/datagrid/index.md +++ /dev/null @@ -1,479 +0,0 @@ -# datagrid - -grafonnet.panel.datagrid - -## Subpackages - -* [fieldOverride](fieldOverride.md) -* [link](link.md) -* [thresholdStep](thresholdStep.md) -* [transformation](transformation.md) -* [valueMapping](valueMapping.md) - -## Index - -* [`fn new(title)`](#fn-new) -* [`obj datasource`](#obj-datasource) - * [`fn withType(value)`](#fn-datasourcewithtype) - * [`fn withUid(value)`](#fn-datasourcewithuid) -* [`obj gridPos`](#obj-gridpos) - * [`fn withH(value=9)`](#fn-gridposwithh) - * [`fn withStatic(value)`](#fn-gridposwithstatic) - * [`fn withW(value=12)`](#fn-gridposwithw) - * [`fn withX(value=0)`](#fn-gridposwithx) - * [`fn withY(value=0)`](#fn-gridposwithy) -* [`obj libraryPanel`](#obj-librarypanel) - * [`fn withName(value)`](#fn-librarypanelwithname) - * [`fn withUid(value)`](#fn-librarypanelwithuid) -* [`obj options`](#obj-options) - * [`fn withSelectedSeries(value=0)`](#fn-optionswithselectedseries) -* [`obj panelOptions`](#obj-paneloptions) - * [`fn withDescription(value)`](#fn-paneloptionswithdescription) - * [`fn withLinks(value)`](#fn-paneloptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) - * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) - * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) - * [`fn withTitle(value)`](#fn-paneloptionswithtitle) - * [`fn withTransparent(value=false)`](#fn-paneloptionswithtransparent) -* [`obj queryOptions`](#obj-queryoptions) - * [`fn withDatasource(value)`](#fn-queryoptionswithdatasource) - * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) - * [`fn withInterval(value)`](#fn-queryoptionswithinterval) - * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) - * [`fn withTargets(value)`](#fn-queryoptionswithtargets) - * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) - * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) - * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) - * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) - * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) -* [`obj standardOptions`](#obj-standardoptions) - * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) - * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) - * [`fn withLinks(value)`](#fn-standardoptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) - * [`fn withMappings(value)`](#fn-standardoptionswithmappings) - * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) - * [`fn withMax(value)`](#fn-standardoptionswithmax) - * [`fn withMin(value)`](#fn-standardoptionswithmin) - * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) - * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) - * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) - * [`fn withUnit(value)`](#fn-standardoptionswithunit) - * [`obj color`](#obj-standardoptionscolor) - * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) - * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) - * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) - * [`obj thresholds`](#obj-standardoptionsthresholds) - * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) - * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) - * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) - -## Fields - -### fn new - -```ts -new(title) -``` - -Creates a new datagrid panel with a title. - -### obj datasource - - -#### fn datasource.withType - -```ts -withType(value) -``` - - - -#### fn datasource.withUid - -```ts -withUid(value) -``` - - - -### obj gridPos - - -#### fn gridPos.withH - -```ts -withH(value=9) -``` - -Panel - -#### fn gridPos.withStatic - -```ts -withStatic(value) -``` - -true if fixed - -#### fn gridPos.withW - -```ts -withW(value=12) -``` - -Panel - -#### fn gridPos.withX - -```ts -withX(value=0) -``` - -Panel x - -#### fn gridPos.withY - -```ts -withY(value=0) -``` - -Panel y - -### obj libraryPanel - - -#### fn libraryPanel.withName - -```ts -withName(value) -``` - - - -#### fn libraryPanel.withUid - -```ts -withUid(value) -``` - - - -### obj options - - -#### fn options.withSelectedSeries - -```ts -withSelectedSeries(value=0) -``` - - - -### obj panelOptions - - -#### fn panelOptions.withDescription - -```ts -withDescription(value) -``` - -Description. - -#### fn panelOptions.withLinks - -```ts -withLinks(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withRepeat - -```ts -withRepeat(value) -``` - -Name of template variable to repeat for. - -#### fn panelOptions.withRepeatDirection - -```ts -withRepeatDirection(value="h") -``` - -Direction to repeat in if 'repeat' is set. -"h" for horizontal, "v" for vertical. -TODO this is probably optional - -Accepted values for `value` are "h", "v" - -#### fn panelOptions.withTitle - -```ts -withTitle(value) -``` - -Panel title. - -#### fn panelOptions.withTransparent - -```ts -withTransparent(value=false) -``` - -Whether to display the panel without a background. - -### obj queryOptions - - -#### fn queryOptions.withDatasource - -```ts -withDatasource(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withDatasourceMixin - -```ts -withDatasourceMixin(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withInterval - -```ts -withInterval(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withMaxDataPoints - -```ts -withMaxDataPoints(value) -``` - -TODO docs - -#### fn queryOptions.withTargets - -```ts -withTargets(value) -``` - -TODO docs - -#### fn queryOptions.withTargetsMixin - -```ts -withTargetsMixin(value) -``` - -TODO docs - -#### fn queryOptions.withTimeFrom - -```ts -withTimeFrom(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTimeShift - -```ts -withTimeShift(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTransformations - -```ts -withTransformations(value) -``` - - - -#### fn queryOptions.withTransformationsMixin - -```ts -withTransformationsMixin(value) -``` - - - -### obj standardOptions - - -#### fn standardOptions.withDecimals - -```ts -withDecimals(value) -``` - -Significant digits (for display) - -#### fn standardOptions.withDisplayName - -```ts -withDisplayName(value) -``` - -The display value for this field. This supports template variables blank is auto - -#### fn standardOptions.withLinks - -```ts -withLinks(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withMappings - -```ts -withMappings(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMappingsMixin - -```ts -withMappingsMixin(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMax - -```ts -withMax(value) -``` - - - -#### fn standardOptions.withMin - -```ts -withMin(value) -``` - - - -#### fn standardOptions.withNoValue - -```ts -withNoValue(value) -``` - -Alternative to empty string - -#### fn standardOptions.withOverrides - -```ts -withOverrides(value) -``` - - - -#### fn standardOptions.withOverridesMixin - -```ts -withOverridesMixin(value) -``` - - - -#### fn standardOptions.withUnit - -```ts -withUnit(value) -``` - -Numeric Options - -#### obj standardOptions.color - - -##### fn standardOptions.color.withFixedColor - -```ts -withFixedColor(value) -``` - -Stores the fixed color value if mode is fixed - -##### fn standardOptions.color.withMode - -```ts -withMode(value) -``` - -The main color scheme mode - -##### fn standardOptions.color.withSeriesBy - -```ts -withSeriesBy(value) -``` - -TODO docs - -Accepted values for `value` are "min", "max", "last" - -#### obj standardOptions.thresholds - - -##### fn standardOptions.thresholds.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "absolute", "percentage" - -##### fn standardOptions.thresholds.withSteps - -```ts -withSteps(value) -``` - -Must be sorted by 'value', first value is always -Infinity - -##### fn standardOptions.thresholds.withStepsMixin - -```ts -withStepsMixin(value) -``` - -Must be sorted by 'value', first value is always -Infinity diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/datagrid/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/datagrid/link.md deleted file mode 100644 index 1a1d7c4..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/datagrid/link.md +++ /dev/null @@ -1,109 +0,0 @@ -# link - - - -## Index - -* [`fn withAsDropdown(value=false)`](#fn-withasdropdown) -* [`fn withIcon(value)`](#fn-withicon) -* [`fn withIncludeVars(value=false)`](#fn-withincludevars) -* [`fn withKeepTime(value=false)`](#fn-withkeeptime) -* [`fn withTags(value)`](#fn-withtags) -* [`fn withTagsMixin(value)`](#fn-withtagsmixin) -* [`fn withTargetBlank(value=false)`](#fn-withtargetblank) -* [`fn withTitle(value)`](#fn-withtitle) -* [`fn withTooltip(value)`](#fn-withtooltip) -* [`fn withType(value)`](#fn-withtype) -* [`fn withUrl(value)`](#fn-withurl) - -## Fields - -### fn withAsDropdown - -```ts -withAsDropdown(value=false) -``` - - - -### fn withIcon - -```ts -withIcon(value) -``` - - - -### fn withIncludeVars - -```ts -withIncludeVars(value=false) -``` - - - -### fn withKeepTime - -```ts -withKeepTime(value=false) -``` - - - -### fn withTags - -```ts -withTags(value) -``` - - - -### fn withTagsMixin - -```ts -withTagsMixin(value) -``` - - - -### fn withTargetBlank - -```ts -withTargetBlank(value=false) -``` - - - -### fn withTitle - -```ts -withTitle(value) -``` - - - -### fn withTooltip - -```ts -withTooltip(value) -``` - - - -### fn withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "link", "dashboards" - -### fn withUrl - -```ts -withUrl(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/datagrid/thresholdStep.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/datagrid/thresholdStep.md deleted file mode 100644 index 9d6af42..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/datagrid/thresholdStep.md +++ /dev/null @@ -1,47 +0,0 @@ -# thresholdStep - - - -## Index - -* [`fn withColor(value)`](#fn-withcolor) -* [`fn withIndex(value)`](#fn-withindex) -* [`fn withState(value)`](#fn-withstate) -* [`fn withValue(value)`](#fn-withvalue) - -## Fields - -### fn withColor - -```ts -withColor(value) -``` - -TODO docs - -### fn withIndex - -```ts -withIndex(value) -``` - -Threshold index, an old property that is not needed an should only appear in older dashboards - -### fn withState - -```ts -withState(value) -``` - -TODO docs -TODO are the values here enumerable into a disjunction? -Some seem to be listed in typescript comment - -### fn withValue - -```ts -withValue(value) -``` - -TODO docs -FIXME the corresponding typescript field is required/non-optional, but nulls currently appear here when serializing -Infinity to JSON diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/datagrid/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/datagrid/transformation.md deleted file mode 100644 index 3dac7e9..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/datagrid/transformation.md +++ /dev/null @@ -1,76 +0,0 @@ -# transformation - - - -## Index - -* [`fn withDisabled(value)`](#fn-withdisabled) -* [`fn withFilter(value)`](#fn-withfilter) -* [`fn withFilterMixin(value)`](#fn-withfiltermixin) -* [`fn withId(value)`](#fn-withid) -* [`fn withOptions(value)`](#fn-withoptions) -* [`obj filter`](#obj-filter) - * [`fn withId(value="")`](#fn-filterwithid) - * [`fn withOptions(value)`](#fn-filterwithoptions) - -## Fields - -### fn withDisabled - -```ts -withDisabled(value) -``` - -Disabled transformations are skipped - -### fn withFilter - -```ts -withFilter(value) -``` - - - -### fn withFilterMixin - -```ts -withFilterMixin(value) -``` - - - -### fn withId - -```ts -withId(value) -``` - -Unique identifier of transformer - -### fn withOptions - -```ts -withOptions(value) -``` - -Options to be passed to the transformer -Valid options depend on the transformer id - -### obj filter - - -#### fn filter.withId - -```ts -withId(value="") -``` - - - -#### fn filter.withOptions - -```ts -withOptions(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/datagrid/valueMapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/datagrid/valueMapping.md deleted file mode 100644 index a6bbdb3..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/datagrid/valueMapping.md +++ /dev/null @@ -1,365 +0,0 @@ -# valueMapping - - - -## Index - -* [`obj RangeMap`](#obj-rangemap) - * [`fn withOptions(value)`](#fn-rangemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) - * [`obj options`](#obj-rangemapoptions) - * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) - * [`fn withResult(value)`](#fn-rangemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) - * [`fn withTo(value)`](#fn-rangemapoptionswithto) - * [`obj result`](#obj-rangemapoptionsresult) - * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) -* [`obj RegexMap`](#obj-regexmap) - * [`fn withOptions(value)`](#fn-regexmapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) - * [`obj options`](#obj-regexmapoptions) - * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) - * [`fn withResult(value)`](#fn-regexmapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) - * [`obj result`](#obj-regexmapoptionsresult) - * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) - * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) -* [`obj SpecialValueMap`](#obj-specialvaluemap) - * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) - * [`obj options`](#obj-specialvaluemapoptions) - * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) - * [`fn withPattern(value)`](#fn-specialvaluemapoptionswithpattern) - * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) - * [`obj result`](#obj-specialvaluemapoptionsresult) - * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) -* [`obj ValueMap`](#obj-valuemap) - * [`fn withOptions(value)`](#fn-valuemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) - -## Fields - -### obj RangeMap - - -#### fn RangeMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RangeMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RangeMap.withType - -```ts -withType(value) -``` - - - -#### obj RangeMap.options - - -##### fn RangeMap.options.withFrom - -```ts -withFrom(value) -``` - -to and from are `number | null` in current ts, really not sure what to do - -##### fn RangeMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RangeMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### fn RangeMap.options.withTo - -```ts -withTo(value) -``` - - - -##### obj RangeMap.options.result - - -###### fn RangeMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RangeMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RangeMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RangeMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj RegexMap - - -#### fn RegexMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RegexMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RegexMap.withType - -```ts -withType(value) -``` - - - -#### obj RegexMap.options - - -##### fn RegexMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn RegexMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RegexMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj RegexMap.options.result - - -###### fn RegexMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RegexMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RegexMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RegexMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj SpecialValueMap - - -#### fn SpecialValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn SpecialValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn SpecialValueMap.withType - -```ts -withType(value) -``` - - - -#### obj SpecialValueMap.options - - -##### fn SpecialValueMap.options.withMatch - -```ts -withMatch(value) -``` - - - -Accepted values for `value` are "true", "false" - -##### fn SpecialValueMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn SpecialValueMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn SpecialValueMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj SpecialValueMap.options.result - - -###### fn SpecialValueMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn SpecialValueMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn SpecialValueMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn SpecialValueMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj ValueMap - - -#### fn ValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn ValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn ValueMap.withType - -```ts -withType(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/debug/fieldOverride.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/debug/fieldOverride.md deleted file mode 100644 index 3e2667b..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/debug/fieldOverride.md +++ /dev/null @@ -1,194 +0,0 @@ -# fieldOverride - -Overrides allow you to customize visualization settings for specific fields or -series. This is accomplished by adding an override rule that targets -a particular set of fields and that can each define multiple options. - -```jsonnet -fieldOverride.byType.new('number') -+ fieldOverride.byType.withPropertiesFromOptions( - panel.standardOptions.withDecimals(2) - + panel.standardOptions.withUnit('s') -) -``` - - -## Index - -* [`obj byName`](#obj-byname) - * [`fn new(value)`](#fn-bynamenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bynamewithproperty) -* [`obj byQuery`](#obj-byquery) - * [`fn new(value)`](#fn-byquerynew) - * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byquerywithproperty) -* [`obj byRegexp`](#obj-byregexp) - * [`fn new(value)`](#fn-byregexpnew) - * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) -* [`obj byType`](#obj-bytype) - * [`fn new(value)`](#fn-bytypenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bytypewithproperty) -* [`obj byValue`](#obj-byvalue) - * [`fn new(value)`](#fn-byvaluenew) - * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) - -## Fields - -### obj byName - - -#### fn byName.new - -```ts -new(value) -``` - -`new` creates a new override of type `byName`. - -#### fn byName.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byName.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byQuery - - -#### fn byQuery.new - -```ts -new(value) -``` - -`new` creates a new override of type `byQuery`. - -#### fn byQuery.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byQuery.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byRegexp - - -#### fn byRegexp.new - -```ts -new(value) -``` - -`new` creates a new override of type `byRegexp`. - -#### fn byRegexp.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byRegexp.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byType - - -#### fn byType.new - -```ts -new(value) -``` - -`new` creates a new override of type `byType`. - -#### fn byType.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byType.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byValue - - -#### fn byValue.new - -```ts -new(value) -``` - -`new` creates a new override of type `byValue`. - -#### fn byValue.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byValue.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/debug/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/debug/index.md deleted file mode 100644 index 4fff5d9..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/debug/index.md +++ /dev/null @@ -1,530 +0,0 @@ -# debug - -grafonnet.panel.debug - -## Subpackages - -* [fieldOverride](fieldOverride.md) -* [link](link.md) -* [thresholdStep](thresholdStep.md) -* [transformation](transformation.md) -* [valueMapping](valueMapping.md) - -## Index - -* [`fn new(title)`](#fn-new) -* [`obj datasource`](#obj-datasource) - * [`fn withType(value)`](#fn-datasourcewithtype) - * [`fn withUid(value)`](#fn-datasourcewithuid) -* [`obj gridPos`](#obj-gridpos) - * [`fn withH(value=9)`](#fn-gridposwithh) - * [`fn withStatic(value)`](#fn-gridposwithstatic) - * [`fn withW(value=12)`](#fn-gridposwithw) - * [`fn withX(value=0)`](#fn-gridposwithx) - * [`fn withY(value=0)`](#fn-gridposwithy) -* [`obj libraryPanel`](#obj-librarypanel) - * [`fn withName(value)`](#fn-librarypanelwithname) - * [`fn withUid(value)`](#fn-librarypanelwithuid) -* [`obj options`](#obj-options) - * [`fn withCounters(value)`](#fn-optionswithcounters) - * [`fn withCountersMixin(value)`](#fn-optionswithcountersmixin) - * [`fn withMode(value)`](#fn-optionswithmode) - * [`obj counters`](#obj-optionscounters) - * [`fn withDataChanged(value)`](#fn-optionscounterswithdatachanged) - * [`fn withRender(value)`](#fn-optionscounterswithrender) - * [`fn withSchemaChanged(value)`](#fn-optionscounterswithschemachanged) -* [`obj panelOptions`](#obj-paneloptions) - * [`fn withDescription(value)`](#fn-paneloptionswithdescription) - * [`fn withLinks(value)`](#fn-paneloptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) - * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) - * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) - * [`fn withTitle(value)`](#fn-paneloptionswithtitle) - * [`fn withTransparent(value=false)`](#fn-paneloptionswithtransparent) -* [`obj queryOptions`](#obj-queryoptions) - * [`fn withDatasource(value)`](#fn-queryoptionswithdatasource) - * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) - * [`fn withInterval(value)`](#fn-queryoptionswithinterval) - * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) - * [`fn withTargets(value)`](#fn-queryoptionswithtargets) - * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) - * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) - * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) - * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) - * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) -* [`obj standardOptions`](#obj-standardoptions) - * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) - * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) - * [`fn withLinks(value)`](#fn-standardoptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) - * [`fn withMappings(value)`](#fn-standardoptionswithmappings) - * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) - * [`fn withMax(value)`](#fn-standardoptionswithmax) - * [`fn withMin(value)`](#fn-standardoptionswithmin) - * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) - * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) - * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) - * [`fn withUnit(value)`](#fn-standardoptionswithunit) - * [`obj color`](#obj-standardoptionscolor) - * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) - * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) - * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) - * [`obj thresholds`](#obj-standardoptionsthresholds) - * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) - * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) - * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) - -## Fields - -### fn new - -```ts -new(title) -``` - -Creates a new debug panel with a title. - -### obj datasource - - -#### fn datasource.withType - -```ts -withType(value) -``` - - - -#### fn datasource.withUid - -```ts -withUid(value) -``` - - - -### obj gridPos - - -#### fn gridPos.withH - -```ts -withH(value=9) -``` - -Panel - -#### fn gridPos.withStatic - -```ts -withStatic(value) -``` - -true if fixed - -#### fn gridPos.withW - -```ts -withW(value=12) -``` - -Panel - -#### fn gridPos.withX - -```ts -withX(value=0) -``` - -Panel x - -#### fn gridPos.withY - -```ts -withY(value=0) -``` - -Panel y - -### obj libraryPanel - - -#### fn libraryPanel.withName - -```ts -withName(value) -``` - - - -#### fn libraryPanel.withUid - -```ts -withUid(value) -``` - - - -### obj options - - -#### fn options.withCounters - -```ts -withCounters(value) -``` - - - -#### fn options.withCountersMixin - -```ts -withCountersMixin(value) -``` - - - -#### fn options.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "render", "events", "cursor", "State", "ThrowError" - -#### obj options.counters - - -##### fn options.counters.withDataChanged - -```ts -withDataChanged(value) -``` - - - -##### fn options.counters.withRender - -```ts -withRender(value) -``` - - - -##### fn options.counters.withSchemaChanged - -```ts -withSchemaChanged(value) -``` - - - -### obj panelOptions - - -#### fn panelOptions.withDescription - -```ts -withDescription(value) -``` - -Description. - -#### fn panelOptions.withLinks - -```ts -withLinks(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withRepeat - -```ts -withRepeat(value) -``` - -Name of template variable to repeat for. - -#### fn panelOptions.withRepeatDirection - -```ts -withRepeatDirection(value="h") -``` - -Direction to repeat in if 'repeat' is set. -"h" for horizontal, "v" for vertical. -TODO this is probably optional - -Accepted values for `value` are "h", "v" - -#### fn panelOptions.withTitle - -```ts -withTitle(value) -``` - -Panel title. - -#### fn panelOptions.withTransparent - -```ts -withTransparent(value=false) -``` - -Whether to display the panel without a background. - -### obj queryOptions - - -#### fn queryOptions.withDatasource - -```ts -withDatasource(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withDatasourceMixin - -```ts -withDatasourceMixin(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withInterval - -```ts -withInterval(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withMaxDataPoints - -```ts -withMaxDataPoints(value) -``` - -TODO docs - -#### fn queryOptions.withTargets - -```ts -withTargets(value) -``` - -TODO docs - -#### fn queryOptions.withTargetsMixin - -```ts -withTargetsMixin(value) -``` - -TODO docs - -#### fn queryOptions.withTimeFrom - -```ts -withTimeFrom(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTimeShift - -```ts -withTimeShift(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTransformations - -```ts -withTransformations(value) -``` - - - -#### fn queryOptions.withTransformationsMixin - -```ts -withTransformationsMixin(value) -``` - - - -### obj standardOptions - - -#### fn standardOptions.withDecimals - -```ts -withDecimals(value) -``` - -Significant digits (for display) - -#### fn standardOptions.withDisplayName - -```ts -withDisplayName(value) -``` - -The display value for this field. This supports template variables blank is auto - -#### fn standardOptions.withLinks - -```ts -withLinks(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withMappings - -```ts -withMappings(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMappingsMixin - -```ts -withMappingsMixin(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMax - -```ts -withMax(value) -``` - - - -#### fn standardOptions.withMin - -```ts -withMin(value) -``` - - - -#### fn standardOptions.withNoValue - -```ts -withNoValue(value) -``` - -Alternative to empty string - -#### fn standardOptions.withOverrides - -```ts -withOverrides(value) -``` - - - -#### fn standardOptions.withOverridesMixin - -```ts -withOverridesMixin(value) -``` - - - -#### fn standardOptions.withUnit - -```ts -withUnit(value) -``` - -Numeric Options - -#### obj standardOptions.color - - -##### fn standardOptions.color.withFixedColor - -```ts -withFixedColor(value) -``` - -Stores the fixed color value if mode is fixed - -##### fn standardOptions.color.withMode - -```ts -withMode(value) -``` - -The main color scheme mode - -##### fn standardOptions.color.withSeriesBy - -```ts -withSeriesBy(value) -``` - -TODO docs - -Accepted values for `value` are "min", "max", "last" - -#### obj standardOptions.thresholds - - -##### fn standardOptions.thresholds.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "absolute", "percentage" - -##### fn standardOptions.thresholds.withSteps - -```ts -withSteps(value) -``` - -Must be sorted by 'value', first value is always -Infinity - -##### fn standardOptions.thresholds.withStepsMixin - -```ts -withStepsMixin(value) -``` - -Must be sorted by 'value', first value is always -Infinity diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/debug/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/debug/link.md deleted file mode 100644 index 1a1d7c4..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/debug/link.md +++ /dev/null @@ -1,109 +0,0 @@ -# link - - - -## Index - -* [`fn withAsDropdown(value=false)`](#fn-withasdropdown) -* [`fn withIcon(value)`](#fn-withicon) -* [`fn withIncludeVars(value=false)`](#fn-withincludevars) -* [`fn withKeepTime(value=false)`](#fn-withkeeptime) -* [`fn withTags(value)`](#fn-withtags) -* [`fn withTagsMixin(value)`](#fn-withtagsmixin) -* [`fn withTargetBlank(value=false)`](#fn-withtargetblank) -* [`fn withTitle(value)`](#fn-withtitle) -* [`fn withTooltip(value)`](#fn-withtooltip) -* [`fn withType(value)`](#fn-withtype) -* [`fn withUrl(value)`](#fn-withurl) - -## Fields - -### fn withAsDropdown - -```ts -withAsDropdown(value=false) -``` - - - -### fn withIcon - -```ts -withIcon(value) -``` - - - -### fn withIncludeVars - -```ts -withIncludeVars(value=false) -``` - - - -### fn withKeepTime - -```ts -withKeepTime(value=false) -``` - - - -### fn withTags - -```ts -withTags(value) -``` - - - -### fn withTagsMixin - -```ts -withTagsMixin(value) -``` - - - -### fn withTargetBlank - -```ts -withTargetBlank(value=false) -``` - - - -### fn withTitle - -```ts -withTitle(value) -``` - - - -### fn withTooltip - -```ts -withTooltip(value) -``` - - - -### fn withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "link", "dashboards" - -### fn withUrl - -```ts -withUrl(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/debug/thresholdStep.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/debug/thresholdStep.md deleted file mode 100644 index 9d6af42..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/debug/thresholdStep.md +++ /dev/null @@ -1,47 +0,0 @@ -# thresholdStep - - - -## Index - -* [`fn withColor(value)`](#fn-withcolor) -* [`fn withIndex(value)`](#fn-withindex) -* [`fn withState(value)`](#fn-withstate) -* [`fn withValue(value)`](#fn-withvalue) - -## Fields - -### fn withColor - -```ts -withColor(value) -``` - -TODO docs - -### fn withIndex - -```ts -withIndex(value) -``` - -Threshold index, an old property that is not needed an should only appear in older dashboards - -### fn withState - -```ts -withState(value) -``` - -TODO docs -TODO are the values here enumerable into a disjunction? -Some seem to be listed in typescript comment - -### fn withValue - -```ts -withValue(value) -``` - -TODO docs -FIXME the corresponding typescript field is required/non-optional, but nulls currently appear here when serializing -Infinity to JSON diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/debug/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/debug/transformation.md deleted file mode 100644 index 3dac7e9..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/debug/transformation.md +++ /dev/null @@ -1,76 +0,0 @@ -# transformation - - - -## Index - -* [`fn withDisabled(value)`](#fn-withdisabled) -* [`fn withFilter(value)`](#fn-withfilter) -* [`fn withFilterMixin(value)`](#fn-withfiltermixin) -* [`fn withId(value)`](#fn-withid) -* [`fn withOptions(value)`](#fn-withoptions) -* [`obj filter`](#obj-filter) - * [`fn withId(value="")`](#fn-filterwithid) - * [`fn withOptions(value)`](#fn-filterwithoptions) - -## Fields - -### fn withDisabled - -```ts -withDisabled(value) -``` - -Disabled transformations are skipped - -### fn withFilter - -```ts -withFilter(value) -``` - - - -### fn withFilterMixin - -```ts -withFilterMixin(value) -``` - - - -### fn withId - -```ts -withId(value) -``` - -Unique identifier of transformer - -### fn withOptions - -```ts -withOptions(value) -``` - -Options to be passed to the transformer -Valid options depend on the transformer id - -### obj filter - - -#### fn filter.withId - -```ts -withId(value="") -``` - - - -#### fn filter.withOptions - -```ts -withOptions(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/debug/valueMapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/debug/valueMapping.md deleted file mode 100644 index a6bbdb3..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/debug/valueMapping.md +++ /dev/null @@ -1,365 +0,0 @@ -# valueMapping - - - -## Index - -* [`obj RangeMap`](#obj-rangemap) - * [`fn withOptions(value)`](#fn-rangemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) - * [`obj options`](#obj-rangemapoptions) - * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) - * [`fn withResult(value)`](#fn-rangemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) - * [`fn withTo(value)`](#fn-rangemapoptionswithto) - * [`obj result`](#obj-rangemapoptionsresult) - * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) -* [`obj RegexMap`](#obj-regexmap) - * [`fn withOptions(value)`](#fn-regexmapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) - * [`obj options`](#obj-regexmapoptions) - * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) - * [`fn withResult(value)`](#fn-regexmapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) - * [`obj result`](#obj-regexmapoptionsresult) - * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) - * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) -* [`obj SpecialValueMap`](#obj-specialvaluemap) - * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) - * [`obj options`](#obj-specialvaluemapoptions) - * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) - * [`fn withPattern(value)`](#fn-specialvaluemapoptionswithpattern) - * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) - * [`obj result`](#obj-specialvaluemapoptionsresult) - * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) -* [`obj ValueMap`](#obj-valuemap) - * [`fn withOptions(value)`](#fn-valuemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) - -## Fields - -### obj RangeMap - - -#### fn RangeMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RangeMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RangeMap.withType - -```ts -withType(value) -``` - - - -#### obj RangeMap.options - - -##### fn RangeMap.options.withFrom - -```ts -withFrom(value) -``` - -to and from are `number | null` in current ts, really not sure what to do - -##### fn RangeMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RangeMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### fn RangeMap.options.withTo - -```ts -withTo(value) -``` - - - -##### obj RangeMap.options.result - - -###### fn RangeMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RangeMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RangeMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RangeMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj RegexMap - - -#### fn RegexMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RegexMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RegexMap.withType - -```ts -withType(value) -``` - - - -#### obj RegexMap.options - - -##### fn RegexMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn RegexMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RegexMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj RegexMap.options.result - - -###### fn RegexMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RegexMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RegexMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RegexMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj SpecialValueMap - - -#### fn SpecialValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn SpecialValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn SpecialValueMap.withType - -```ts -withType(value) -``` - - - -#### obj SpecialValueMap.options - - -##### fn SpecialValueMap.options.withMatch - -```ts -withMatch(value) -``` - - - -Accepted values for `value` are "true", "false" - -##### fn SpecialValueMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn SpecialValueMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn SpecialValueMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj SpecialValueMap.options.result - - -###### fn SpecialValueMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn SpecialValueMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn SpecialValueMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn SpecialValueMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj ValueMap - - -#### fn ValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn ValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn ValueMap.withType - -```ts -withType(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/gauge/fieldOverride.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/gauge/fieldOverride.md deleted file mode 100644 index 3e2667b..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/gauge/fieldOverride.md +++ /dev/null @@ -1,194 +0,0 @@ -# fieldOverride - -Overrides allow you to customize visualization settings for specific fields or -series. This is accomplished by adding an override rule that targets -a particular set of fields and that can each define multiple options. - -```jsonnet -fieldOverride.byType.new('number') -+ fieldOverride.byType.withPropertiesFromOptions( - panel.standardOptions.withDecimals(2) - + panel.standardOptions.withUnit('s') -) -``` - - -## Index - -* [`obj byName`](#obj-byname) - * [`fn new(value)`](#fn-bynamenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bynamewithproperty) -* [`obj byQuery`](#obj-byquery) - * [`fn new(value)`](#fn-byquerynew) - * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byquerywithproperty) -* [`obj byRegexp`](#obj-byregexp) - * [`fn new(value)`](#fn-byregexpnew) - * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) -* [`obj byType`](#obj-bytype) - * [`fn new(value)`](#fn-bytypenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bytypewithproperty) -* [`obj byValue`](#obj-byvalue) - * [`fn new(value)`](#fn-byvaluenew) - * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) - -## Fields - -### obj byName - - -#### fn byName.new - -```ts -new(value) -``` - -`new` creates a new override of type `byName`. - -#### fn byName.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byName.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byQuery - - -#### fn byQuery.new - -```ts -new(value) -``` - -`new` creates a new override of type `byQuery`. - -#### fn byQuery.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byQuery.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byRegexp - - -#### fn byRegexp.new - -```ts -new(value) -``` - -`new` creates a new override of type `byRegexp`. - -#### fn byRegexp.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byRegexp.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byType - - -#### fn byType.new - -```ts -new(value) -``` - -`new` creates a new override of type `byType`. - -#### fn byType.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byType.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byValue - - -#### fn byValue.new - -```ts -new(value) -``` - -`new` creates a new override of type `byValue`. - -#### fn byValue.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byValue.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/gauge/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/gauge/index.md deleted file mode 100644 index 0c3b383..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/gauge/index.md +++ /dev/null @@ -1,606 +0,0 @@ -# gauge - -grafonnet.panel.gauge - -## Subpackages - -* [fieldOverride](fieldOverride.md) -* [link](link.md) -* [thresholdStep](thresholdStep.md) -* [transformation](transformation.md) -* [valueMapping](valueMapping.md) - -## Index - -* [`fn new(title)`](#fn-new) -* [`obj datasource`](#obj-datasource) - * [`fn withType(value)`](#fn-datasourcewithtype) - * [`fn withUid(value)`](#fn-datasourcewithuid) -* [`obj gridPos`](#obj-gridpos) - * [`fn withH(value=9)`](#fn-gridposwithh) - * [`fn withStatic(value)`](#fn-gridposwithstatic) - * [`fn withW(value=12)`](#fn-gridposwithw) - * [`fn withX(value=0)`](#fn-gridposwithx) - * [`fn withY(value=0)`](#fn-gridposwithy) -* [`obj libraryPanel`](#obj-librarypanel) - * [`fn withName(value)`](#fn-librarypanelwithname) - * [`fn withUid(value)`](#fn-librarypanelwithuid) -* [`obj options`](#obj-options) - * [`fn withOrientation(value)`](#fn-optionswithorientation) - * [`fn withReduceOptions(value)`](#fn-optionswithreduceoptions) - * [`fn withReduceOptionsMixin(value)`](#fn-optionswithreduceoptionsmixin) - * [`fn withShowThresholdLabels(value=false)`](#fn-optionswithshowthresholdlabels) - * [`fn withShowThresholdMarkers(value=true)`](#fn-optionswithshowthresholdmarkers) - * [`fn withText(value)`](#fn-optionswithtext) - * [`fn withTextMixin(value)`](#fn-optionswithtextmixin) - * [`obj reduceOptions`](#obj-optionsreduceoptions) - * [`fn withCalcs(value)`](#fn-optionsreduceoptionswithcalcs) - * [`fn withCalcsMixin(value)`](#fn-optionsreduceoptionswithcalcsmixin) - * [`fn withFields(value)`](#fn-optionsreduceoptionswithfields) - * [`fn withLimit(value)`](#fn-optionsreduceoptionswithlimit) - * [`fn withValues(value)`](#fn-optionsreduceoptionswithvalues) - * [`obj text`](#obj-optionstext) - * [`fn withTitleSize(value)`](#fn-optionstextwithtitlesize) - * [`fn withValueSize(value)`](#fn-optionstextwithvaluesize) -* [`obj panelOptions`](#obj-paneloptions) - * [`fn withDescription(value)`](#fn-paneloptionswithdescription) - * [`fn withLinks(value)`](#fn-paneloptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) - * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) - * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) - * [`fn withTitle(value)`](#fn-paneloptionswithtitle) - * [`fn withTransparent(value=false)`](#fn-paneloptionswithtransparent) -* [`obj queryOptions`](#obj-queryoptions) - * [`fn withDatasource(value)`](#fn-queryoptionswithdatasource) - * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) - * [`fn withInterval(value)`](#fn-queryoptionswithinterval) - * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) - * [`fn withTargets(value)`](#fn-queryoptionswithtargets) - * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) - * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) - * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) - * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) - * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) -* [`obj standardOptions`](#obj-standardoptions) - * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) - * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) - * [`fn withLinks(value)`](#fn-standardoptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) - * [`fn withMappings(value)`](#fn-standardoptionswithmappings) - * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) - * [`fn withMax(value)`](#fn-standardoptionswithmax) - * [`fn withMin(value)`](#fn-standardoptionswithmin) - * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) - * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) - * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) - * [`fn withUnit(value)`](#fn-standardoptionswithunit) - * [`obj color`](#obj-standardoptionscolor) - * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) - * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) - * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) - * [`obj thresholds`](#obj-standardoptionsthresholds) - * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) - * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) - * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) - -## Fields - -### fn new - -```ts -new(title) -``` - -Creates a new gauge panel with a title. - -### obj datasource - - -#### fn datasource.withType - -```ts -withType(value) -``` - - - -#### fn datasource.withUid - -```ts -withUid(value) -``` - - - -### obj gridPos - - -#### fn gridPos.withH - -```ts -withH(value=9) -``` - -Panel - -#### fn gridPos.withStatic - -```ts -withStatic(value) -``` - -true if fixed - -#### fn gridPos.withW - -```ts -withW(value=12) -``` - -Panel - -#### fn gridPos.withX - -```ts -withX(value=0) -``` - -Panel x - -#### fn gridPos.withY - -```ts -withY(value=0) -``` - -Panel y - -### obj libraryPanel - - -#### fn libraryPanel.withName - -```ts -withName(value) -``` - - - -#### fn libraryPanel.withUid - -```ts -withUid(value) -``` - - - -### obj options - - -#### fn options.withOrientation - -```ts -withOrientation(value) -``` - -TODO docs - -Accepted values for `value` are "auto", "vertical", "horizontal" - -#### fn options.withReduceOptions - -```ts -withReduceOptions(value) -``` - -TODO docs - -#### fn options.withReduceOptionsMixin - -```ts -withReduceOptionsMixin(value) -``` - -TODO docs - -#### fn options.withShowThresholdLabels - -```ts -withShowThresholdLabels(value=false) -``` - - - -#### fn options.withShowThresholdMarkers - -```ts -withShowThresholdMarkers(value=true) -``` - - - -#### fn options.withText - -```ts -withText(value) -``` - -TODO docs - -#### fn options.withTextMixin - -```ts -withTextMixin(value) -``` - -TODO docs - -#### obj options.reduceOptions - - -##### fn options.reduceOptions.withCalcs - -```ts -withCalcs(value) -``` - -When !values, pick one value for the whole field - -##### fn options.reduceOptions.withCalcsMixin - -```ts -withCalcsMixin(value) -``` - -When !values, pick one value for the whole field - -##### fn options.reduceOptions.withFields - -```ts -withFields(value) -``` - -Which fields to show. By default this is only numeric fields - -##### fn options.reduceOptions.withLimit - -```ts -withLimit(value) -``` - -if showing all values limit - -##### fn options.reduceOptions.withValues - -```ts -withValues(value) -``` - -If true show each row value - -#### obj options.text - - -##### fn options.text.withTitleSize - -```ts -withTitleSize(value) -``` - -Explicit title text size - -##### fn options.text.withValueSize - -```ts -withValueSize(value) -``` - -Explicit value text size - -### obj panelOptions - - -#### fn panelOptions.withDescription - -```ts -withDescription(value) -``` - -Description. - -#### fn panelOptions.withLinks - -```ts -withLinks(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withRepeat - -```ts -withRepeat(value) -``` - -Name of template variable to repeat for. - -#### fn panelOptions.withRepeatDirection - -```ts -withRepeatDirection(value="h") -``` - -Direction to repeat in if 'repeat' is set. -"h" for horizontal, "v" for vertical. -TODO this is probably optional - -Accepted values for `value` are "h", "v" - -#### fn panelOptions.withTitle - -```ts -withTitle(value) -``` - -Panel title. - -#### fn panelOptions.withTransparent - -```ts -withTransparent(value=false) -``` - -Whether to display the panel without a background. - -### obj queryOptions - - -#### fn queryOptions.withDatasource - -```ts -withDatasource(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withDatasourceMixin - -```ts -withDatasourceMixin(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withInterval - -```ts -withInterval(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withMaxDataPoints - -```ts -withMaxDataPoints(value) -``` - -TODO docs - -#### fn queryOptions.withTargets - -```ts -withTargets(value) -``` - -TODO docs - -#### fn queryOptions.withTargetsMixin - -```ts -withTargetsMixin(value) -``` - -TODO docs - -#### fn queryOptions.withTimeFrom - -```ts -withTimeFrom(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTimeShift - -```ts -withTimeShift(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTransformations - -```ts -withTransformations(value) -``` - - - -#### fn queryOptions.withTransformationsMixin - -```ts -withTransformationsMixin(value) -``` - - - -### obj standardOptions - - -#### fn standardOptions.withDecimals - -```ts -withDecimals(value) -``` - -Significant digits (for display) - -#### fn standardOptions.withDisplayName - -```ts -withDisplayName(value) -``` - -The display value for this field. This supports template variables blank is auto - -#### fn standardOptions.withLinks - -```ts -withLinks(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withMappings - -```ts -withMappings(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMappingsMixin - -```ts -withMappingsMixin(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMax - -```ts -withMax(value) -``` - - - -#### fn standardOptions.withMin - -```ts -withMin(value) -``` - - - -#### fn standardOptions.withNoValue - -```ts -withNoValue(value) -``` - -Alternative to empty string - -#### fn standardOptions.withOverrides - -```ts -withOverrides(value) -``` - - - -#### fn standardOptions.withOverridesMixin - -```ts -withOverridesMixin(value) -``` - - - -#### fn standardOptions.withUnit - -```ts -withUnit(value) -``` - -Numeric Options - -#### obj standardOptions.color - - -##### fn standardOptions.color.withFixedColor - -```ts -withFixedColor(value) -``` - -Stores the fixed color value if mode is fixed - -##### fn standardOptions.color.withMode - -```ts -withMode(value) -``` - -The main color scheme mode - -##### fn standardOptions.color.withSeriesBy - -```ts -withSeriesBy(value) -``` - -TODO docs - -Accepted values for `value` are "min", "max", "last" - -#### obj standardOptions.thresholds - - -##### fn standardOptions.thresholds.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "absolute", "percentage" - -##### fn standardOptions.thresholds.withSteps - -```ts -withSteps(value) -``` - -Must be sorted by 'value', first value is always -Infinity - -##### fn standardOptions.thresholds.withStepsMixin - -```ts -withStepsMixin(value) -``` - -Must be sorted by 'value', first value is always -Infinity diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/gauge/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/gauge/link.md deleted file mode 100644 index 1a1d7c4..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/gauge/link.md +++ /dev/null @@ -1,109 +0,0 @@ -# link - - - -## Index - -* [`fn withAsDropdown(value=false)`](#fn-withasdropdown) -* [`fn withIcon(value)`](#fn-withicon) -* [`fn withIncludeVars(value=false)`](#fn-withincludevars) -* [`fn withKeepTime(value=false)`](#fn-withkeeptime) -* [`fn withTags(value)`](#fn-withtags) -* [`fn withTagsMixin(value)`](#fn-withtagsmixin) -* [`fn withTargetBlank(value=false)`](#fn-withtargetblank) -* [`fn withTitle(value)`](#fn-withtitle) -* [`fn withTooltip(value)`](#fn-withtooltip) -* [`fn withType(value)`](#fn-withtype) -* [`fn withUrl(value)`](#fn-withurl) - -## Fields - -### fn withAsDropdown - -```ts -withAsDropdown(value=false) -``` - - - -### fn withIcon - -```ts -withIcon(value) -``` - - - -### fn withIncludeVars - -```ts -withIncludeVars(value=false) -``` - - - -### fn withKeepTime - -```ts -withKeepTime(value=false) -``` - - - -### fn withTags - -```ts -withTags(value) -``` - - - -### fn withTagsMixin - -```ts -withTagsMixin(value) -``` - - - -### fn withTargetBlank - -```ts -withTargetBlank(value=false) -``` - - - -### fn withTitle - -```ts -withTitle(value) -``` - - - -### fn withTooltip - -```ts -withTooltip(value) -``` - - - -### fn withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "link", "dashboards" - -### fn withUrl - -```ts -withUrl(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/gauge/thresholdStep.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/gauge/thresholdStep.md deleted file mode 100644 index 9d6af42..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/gauge/thresholdStep.md +++ /dev/null @@ -1,47 +0,0 @@ -# thresholdStep - - - -## Index - -* [`fn withColor(value)`](#fn-withcolor) -* [`fn withIndex(value)`](#fn-withindex) -* [`fn withState(value)`](#fn-withstate) -* [`fn withValue(value)`](#fn-withvalue) - -## Fields - -### fn withColor - -```ts -withColor(value) -``` - -TODO docs - -### fn withIndex - -```ts -withIndex(value) -``` - -Threshold index, an old property that is not needed an should only appear in older dashboards - -### fn withState - -```ts -withState(value) -``` - -TODO docs -TODO are the values here enumerable into a disjunction? -Some seem to be listed in typescript comment - -### fn withValue - -```ts -withValue(value) -``` - -TODO docs -FIXME the corresponding typescript field is required/non-optional, but nulls currently appear here when serializing -Infinity to JSON diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/gauge/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/gauge/transformation.md deleted file mode 100644 index 3dac7e9..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/gauge/transformation.md +++ /dev/null @@ -1,76 +0,0 @@ -# transformation - - - -## Index - -* [`fn withDisabled(value)`](#fn-withdisabled) -* [`fn withFilter(value)`](#fn-withfilter) -* [`fn withFilterMixin(value)`](#fn-withfiltermixin) -* [`fn withId(value)`](#fn-withid) -* [`fn withOptions(value)`](#fn-withoptions) -* [`obj filter`](#obj-filter) - * [`fn withId(value="")`](#fn-filterwithid) - * [`fn withOptions(value)`](#fn-filterwithoptions) - -## Fields - -### fn withDisabled - -```ts -withDisabled(value) -``` - -Disabled transformations are skipped - -### fn withFilter - -```ts -withFilter(value) -``` - - - -### fn withFilterMixin - -```ts -withFilterMixin(value) -``` - - - -### fn withId - -```ts -withId(value) -``` - -Unique identifier of transformer - -### fn withOptions - -```ts -withOptions(value) -``` - -Options to be passed to the transformer -Valid options depend on the transformer id - -### obj filter - - -#### fn filter.withId - -```ts -withId(value="") -``` - - - -#### fn filter.withOptions - -```ts -withOptions(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/gauge/valueMapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/gauge/valueMapping.md deleted file mode 100644 index a6bbdb3..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/gauge/valueMapping.md +++ /dev/null @@ -1,365 +0,0 @@ -# valueMapping - - - -## Index - -* [`obj RangeMap`](#obj-rangemap) - * [`fn withOptions(value)`](#fn-rangemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) - * [`obj options`](#obj-rangemapoptions) - * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) - * [`fn withResult(value)`](#fn-rangemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) - * [`fn withTo(value)`](#fn-rangemapoptionswithto) - * [`obj result`](#obj-rangemapoptionsresult) - * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) -* [`obj RegexMap`](#obj-regexmap) - * [`fn withOptions(value)`](#fn-regexmapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) - * [`obj options`](#obj-regexmapoptions) - * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) - * [`fn withResult(value)`](#fn-regexmapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) - * [`obj result`](#obj-regexmapoptionsresult) - * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) - * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) -* [`obj SpecialValueMap`](#obj-specialvaluemap) - * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) - * [`obj options`](#obj-specialvaluemapoptions) - * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) - * [`fn withPattern(value)`](#fn-specialvaluemapoptionswithpattern) - * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) - * [`obj result`](#obj-specialvaluemapoptionsresult) - * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) -* [`obj ValueMap`](#obj-valuemap) - * [`fn withOptions(value)`](#fn-valuemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) - -## Fields - -### obj RangeMap - - -#### fn RangeMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RangeMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RangeMap.withType - -```ts -withType(value) -``` - - - -#### obj RangeMap.options - - -##### fn RangeMap.options.withFrom - -```ts -withFrom(value) -``` - -to and from are `number | null` in current ts, really not sure what to do - -##### fn RangeMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RangeMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### fn RangeMap.options.withTo - -```ts -withTo(value) -``` - - - -##### obj RangeMap.options.result - - -###### fn RangeMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RangeMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RangeMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RangeMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj RegexMap - - -#### fn RegexMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RegexMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RegexMap.withType - -```ts -withType(value) -``` - - - -#### obj RegexMap.options - - -##### fn RegexMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn RegexMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RegexMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj RegexMap.options.result - - -###### fn RegexMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RegexMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RegexMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RegexMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj SpecialValueMap - - -#### fn SpecialValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn SpecialValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn SpecialValueMap.withType - -```ts -withType(value) -``` - - - -#### obj SpecialValueMap.options - - -##### fn SpecialValueMap.options.withMatch - -```ts -withMatch(value) -``` - - - -Accepted values for `value` are "true", "false" - -##### fn SpecialValueMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn SpecialValueMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn SpecialValueMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj SpecialValueMap.options.result - - -###### fn SpecialValueMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn SpecialValueMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn SpecialValueMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn SpecialValueMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj ValueMap - - -#### fn ValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn ValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn ValueMap.withType - -```ts -withType(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/geomap/fieldOverride.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/geomap/fieldOverride.md deleted file mode 100644 index 3e2667b..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/geomap/fieldOverride.md +++ /dev/null @@ -1,194 +0,0 @@ -# fieldOverride - -Overrides allow you to customize visualization settings for specific fields or -series. This is accomplished by adding an override rule that targets -a particular set of fields and that can each define multiple options. - -```jsonnet -fieldOverride.byType.new('number') -+ fieldOverride.byType.withPropertiesFromOptions( - panel.standardOptions.withDecimals(2) - + panel.standardOptions.withUnit('s') -) -``` - - -## Index - -* [`obj byName`](#obj-byname) - * [`fn new(value)`](#fn-bynamenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bynamewithproperty) -* [`obj byQuery`](#obj-byquery) - * [`fn new(value)`](#fn-byquerynew) - * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byquerywithproperty) -* [`obj byRegexp`](#obj-byregexp) - * [`fn new(value)`](#fn-byregexpnew) - * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) -* [`obj byType`](#obj-bytype) - * [`fn new(value)`](#fn-bytypenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bytypewithproperty) -* [`obj byValue`](#obj-byvalue) - * [`fn new(value)`](#fn-byvaluenew) - * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) - -## Fields - -### obj byName - - -#### fn byName.new - -```ts -new(value) -``` - -`new` creates a new override of type `byName`. - -#### fn byName.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byName.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byQuery - - -#### fn byQuery.new - -```ts -new(value) -``` - -`new` creates a new override of type `byQuery`. - -#### fn byQuery.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byQuery.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byRegexp - - -#### fn byRegexp.new - -```ts -new(value) -``` - -`new` creates a new override of type `byRegexp`. - -#### fn byRegexp.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byRegexp.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byType - - -#### fn byType.new - -```ts -new(value) -``` - -`new` creates a new override of type `byType`. - -#### fn byType.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byType.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byValue - - -#### fn byValue.new - -```ts -new(value) -``` - -`new` creates a new override of type `byValue`. - -#### fn byValue.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byValue.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/geomap/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/geomap/index.md deleted file mode 100644 index 2da7755..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/geomap/index.md +++ /dev/null @@ -1,1030 +0,0 @@ -# geomap - -grafonnet.panel.geomap - -## Subpackages - -* [fieldOverride](fieldOverride.md) -* [link](link.md) -* [thresholdStep](thresholdStep.md) -* [transformation](transformation.md) -* [valueMapping](valueMapping.md) - -## Index - -* [`fn new(title)`](#fn-new) -* [`obj datasource`](#obj-datasource) - * [`fn withType(value)`](#fn-datasourcewithtype) - * [`fn withUid(value)`](#fn-datasourcewithuid) -* [`obj gridPos`](#obj-gridpos) - * [`fn withH(value=9)`](#fn-gridposwithh) - * [`fn withStatic(value)`](#fn-gridposwithstatic) - * [`fn withW(value=12)`](#fn-gridposwithw) - * [`fn withX(value=0)`](#fn-gridposwithx) - * [`fn withY(value=0)`](#fn-gridposwithy) -* [`obj libraryPanel`](#obj-librarypanel) - * [`fn withName(value)`](#fn-librarypanelwithname) - * [`fn withUid(value)`](#fn-librarypanelwithuid) -* [`obj options`](#obj-options) - * [`fn withBasemap(value)`](#fn-optionswithbasemap) - * [`fn withBasemapMixin(value)`](#fn-optionswithbasemapmixin) - * [`fn withControls(value)`](#fn-optionswithcontrols) - * [`fn withControlsMixin(value)`](#fn-optionswithcontrolsmixin) - * [`fn withLayers(value)`](#fn-optionswithlayers) - * [`fn withLayersMixin(value)`](#fn-optionswithlayersmixin) - * [`fn withTooltip(value)`](#fn-optionswithtooltip) - * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) - * [`fn withView(value)`](#fn-optionswithview) - * [`fn withViewMixin(value)`](#fn-optionswithviewmixin) - * [`obj basemap`](#obj-optionsbasemap) - * [`fn withConfig(value)`](#fn-optionsbasemapwithconfig) - * [`fn withFilterData(value)`](#fn-optionsbasemapwithfilterdata) - * [`fn withLocation(value)`](#fn-optionsbasemapwithlocation) - * [`fn withLocationMixin(value)`](#fn-optionsbasemapwithlocationmixin) - * [`fn withName(value)`](#fn-optionsbasemapwithname) - * [`fn withOpacity(value)`](#fn-optionsbasemapwithopacity) - * [`fn withTooltip(value)`](#fn-optionsbasemapwithtooltip) - * [`fn withType(value)`](#fn-optionsbasemapwithtype) - * [`obj location`](#obj-optionsbasemaplocation) - * [`fn withGazetteer(value)`](#fn-optionsbasemaplocationwithgazetteer) - * [`fn withGeohash(value)`](#fn-optionsbasemaplocationwithgeohash) - * [`fn withLatitude(value)`](#fn-optionsbasemaplocationwithlatitude) - * [`fn withLongitude(value)`](#fn-optionsbasemaplocationwithlongitude) - * [`fn withLookup(value)`](#fn-optionsbasemaplocationwithlookup) - * [`fn withMode(value)`](#fn-optionsbasemaplocationwithmode) - * [`fn withWkt(value)`](#fn-optionsbasemaplocationwithwkt) - * [`obj controls`](#obj-optionscontrols) - * [`fn withMouseWheelZoom(value)`](#fn-optionscontrolswithmousewheelzoom) - * [`fn withShowAttribution(value)`](#fn-optionscontrolswithshowattribution) - * [`fn withShowDebug(value)`](#fn-optionscontrolswithshowdebug) - * [`fn withShowMeasure(value)`](#fn-optionscontrolswithshowmeasure) - * [`fn withShowScale(value)`](#fn-optionscontrolswithshowscale) - * [`fn withShowZoom(value)`](#fn-optionscontrolswithshowzoom) - * [`obj layers`](#obj-optionslayers) - * [`fn withConfig(value)`](#fn-optionslayerswithconfig) - * [`fn withFilterData(value)`](#fn-optionslayerswithfilterdata) - * [`fn withLocation(value)`](#fn-optionslayerswithlocation) - * [`fn withLocationMixin(value)`](#fn-optionslayerswithlocationmixin) - * [`fn withName(value)`](#fn-optionslayerswithname) - * [`fn withOpacity(value)`](#fn-optionslayerswithopacity) - * [`fn withTooltip(value)`](#fn-optionslayerswithtooltip) - * [`fn withType(value)`](#fn-optionslayerswithtype) - * [`obj location`](#obj-optionslayerslocation) - * [`fn withGazetteer(value)`](#fn-optionslayerslocationwithgazetteer) - * [`fn withGeohash(value)`](#fn-optionslayerslocationwithgeohash) - * [`fn withLatitude(value)`](#fn-optionslayerslocationwithlatitude) - * [`fn withLongitude(value)`](#fn-optionslayerslocationwithlongitude) - * [`fn withLookup(value)`](#fn-optionslayerslocationwithlookup) - * [`fn withMode(value)`](#fn-optionslayerslocationwithmode) - * [`fn withWkt(value)`](#fn-optionslayerslocationwithwkt) - * [`obj tooltip`](#obj-optionstooltip) - * [`fn withMode(value)`](#fn-optionstooltipwithmode) - * [`obj view`](#obj-optionsview) - * [`fn withAllLayers(value=true)`](#fn-optionsviewwithalllayers) - * [`fn withId(value="zero")`](#fn-optionsviewwithid) - * [`fn withLastOnly(value)`](#fn-optionsviewwithlastonly) - * [`fn withLat(value=0)`](#fn-optionsviewwithlat) - * [`fn withLayer(value)`](#fn-optionsviewwithlayer) - * [`fn withLon(value=0)`](#fn-optionsviewwithlon) - * [`fn withMaxZoom(value)`](#fn-optionsviewwithmaxzoom) - * [`fn withMinZoom(value)`](#fn-optionsviewwithminzoom) - * [`fn withPadding(value)`](#fn-optionsviewwithpadding) - * [`fn withShared(value)`](#fn-optionsviewwithshared) - * [`fn withZoom(value=1)`](#fn-optionsviewwithzoom) -* [`obj panelOptions`](#obj-paneloptions) - * [`fn withDescription(value)`](#fn-paneloptionswithdescription) - * [`fn withLinks(value)`](#fn-paneloptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) - * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) - * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) - * [`fn withTitle(value)`](#fn-paneloptionswithtitle) - * [`fn withTransparent(value=false)`](#fn-paneloptionswithtransparent) -* [`obj queryOptions`](#obj-queryoptions) - * [`fn withDatasource(value)`](#fn-queryoptionswithdatasource) - * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) - * [`fn withInterval(value)`](#fn-queryoptionswithinterval) - * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) - * [`fn withTargets(value)`](#fn-queryoptionswithtargets) - * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) - * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) - * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) - * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) - * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) -* [`obj standardOptions`](#obj-standardoptions) - * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) - * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) - * [`fn withLinks(value)`](#fn-standardoptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) - * [`fn withMappings(value)`](#fn-standardoptionswithmappings) - * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) - * [`fn withMax(value)`](#fn-standardoptionswithmax) - * [`fn withMin(value)`](#fn-standardoptionswithmin) - * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) - * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) - * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) - * [`fn withUnit(value)`](#fn-standardoptionswithunit) - * [`obj color`](#obj-standardoptionscolor) - * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) - * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) - * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) - * [`obj thresholds`](#obj-standardoptionsthresholds) - * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) - * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) - * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) - -## Fields - -### fn new - -```ts -new(title) -``` - -Creates a new geomap panel with a title. - -### obj datasource - - -#### fn datasource.withType - -```ts -withType(value) -``` - - - -#### fn datasource.withUid - -```ts -withUid(value) -``` - - - -### obj gridPos - - -#### fn gridPos.withH - -```ts -withH(value=9) -``` - -Panel - -#### fn gridPos.withStatic - -```ts -withStatic(value) -``` - -true if fixed - -#### fn gridPos.withW - -```ts -withW(value=12) -``` - -Panel - -#### fn gridPos.withX - -```ts -withX(value=0) -``` - -Panel x - -#### fn gridPos.withY - -```ts -withY(value=0) -``` - -Panel y - -### obj libraryPanel - - -#### fn libraryPanel.withName - -```ts -withName(value) -``` - - - -#### fn libraryPanel.withUid - -```ts -withUid(value) -``` - - - -### obj options - - -#### fn options.withBasemap - -```ts -withBasemap(value) -``` - - - -#### fn options.withBasemapMixin - -```ts -withBasemapMixin(value) -``` - - - -#### fn options.withControls - -```ts -withControls(value) -``` - - - -#### fn options.withControlsMixin - -```ts -withControlsMixin(value) -``` - - - -#### fn options.withLayers - -```ts -withLayers(value) -``` - - - -#### fn options.withLayersMixin - -```ts -withLayersMixin(value) -``` - - - -#### fn options.withTooltip - -```ts -withTooltip(value) -``` - - - -#### fn options.withTooltipMixin - -```ts -withTooltipMixin(value) -``` - - - -#### fn options.withView - -```ts -withView(value) -``` - - - -#### fn options.withViewMixin - -```ts -withViewMixin(value) -``` - - - -#### obj options.basemap - - -##### fn options.basemap.withConfig - -```ts -withConfig(value) -``` - -Custom options depending on the type - -##### fn options.basemap.withFilterData - -```ts -withFilterData(value) -``` - -Defines a frame MatcherConfig that may filter data for the given layer - -##### fn options.basemap.withLocation - -```ts -withLocation(value) -``` - - - -##### fn options.basemap.withLocationMixin - -```ts -withLocationMixin(value) -``` - - - -##### fn options.basemap.withName - -```ts -withName(value) -``` - -configured unique display name - -##### fn options.basemap.withOpacity - -```ts -withOpacity(value) -``` - -Common properties: -https://openlayers.org/en/latest/apidoc/module-ol_layer_Base-BaseLayer.html -Layer opacity (0-1) - -##### fn options.basemap.withTooltip - -```ts -withTooltip(value) -``` - -Check tooltip (defaults to true) - -##### fn options.basemap.withType - -```ts -withType(value) -``` - - - -##### obj options.basemap.location - - -###### fn options.basemap.location.withGazetteer - -```ts -withGazetteer(value) -``` - -Path to Gazetteer - -###### fn options.basemap.location.withGeohash - -```ts -withGeohash(value) -``` - -Field mappings - -###### fn options.basemap.location.withLatitude - -```ts -withLatitude(value) -``` - - - -###### fn options.basemap.location.withLongitude - -```ts -withLongitude(value) -``` - - - -###### fn options.basemap.location.withLookup - -```ts -withLookup(value) -``` - - - -###### fn options.basemap.location.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "auto", "geohash", "coords", "lookup" - -###### fn options.basemap.location.withWkt - -```ts -withWkt(value) -``` - - - -#### obj options.controls - - -##### fn options.controls.withMouseWheelZoom - -```ts -withMouseWheelZoom(value) -``` - -let the mouse wheel zoom - -##### fn options.controls.withShowAttribution - -```ts -withShowAttribution(value) -``` - -Lower right - -##### fn options.controls.withShowDebug - -```ts -withShowDebug(value) -``` - -Show debug - -##### fn options.controls.withShowMeasure - -```ts -withShowMeasure(value) -``` - -Show measure - -##### fn options.controls.withShowScale - -```ts -withShowScale(value) -``` - -Scale options - -##### fn options.controls.withShowZoom - -```ts -withShowZoom(value) -``` - -Zoom (upper left) - -#### obj options.layers - - -##### fn options.layers.withConfig - -```ts -withConfig(value) -``` - -Custom options depending on the type - -##### fn options.layers.withFilterData - -```ts -withFilterData(value) -``` - -Defines a frame MatcherConfig that may filter data for the given layer - -##### fn options.layers.withLocation - -```ts -withLocation(value) -``` - - - -##### fn options.layers.withLocationMixin - -```ts -withLocationMixin(value) -``` - - - -##### fn options.layers.withName - -```ts -withName(value) -``` - -configured unique display name - -##### fn options.layers.withOpacity - -```ts -withOpacity(value) -``` - -Common properties: -https://openlayers.org/en/latest/apidoc/module-ol_layer_Base-BaseLayer.html -Layer opacity (0-1) - -##### fn options.layers.withTooltip - -```ts -withTooltip(value) -``` - -Check tooltip (defaults to true) - -##### fn options.layers.withType - -```ts -withType(value) -``` - - - -##### obj options.layers.location - - -###### fn options.layers.location.withGazetteer - -```ts -withGazetteer(value) -``` - -Path to Gazetteer - -###### fn options.layers.location.withGeohash - -```ts -withGeohash(value) -``` - -Field mappings - -###### fn options.layers.location.withLatitude - -```ts -withLatitude(value) -``` - - - -###### fn options.layers.location.withLongitude - -```ts -withLongitude(value) -``` - - - -###### fn options.layers.location.withLookup - -```ts -withLookup(value) -``` - - - -###### fn options.layers.location.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "auto", "geohash", "coords", "lookup" - -###### fn options.layers.location.withWkt - -```ts -withWkt(value) -``` - - - -#### obj options.tooltip - - -##### fn options.tooltip.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "none", "details" - -#### obj options.view - - -##### fn options.view.withAllLayers - -```ts -withAllLayers(value=true) -``` - - - -##### fn options.view.withId - -```ts -withId(value="zero") -``` - - - -##### fn options.view.withLastOnly - -```ts -withLastOnly(value) -``` - - - -##### fn options.view.withLat - -```ts -withLat(value=0) -``` - - - -##### fn options.view.withLayer - -```ts -withLayer(value) -``` - - - -##### fn options.view.withLon - -```ts -withLon(value=0) -``` - - - -##### fn options.view.withMaxZoom - -```ts -withMaxZoom(value) -``` - - - -##### fn options.view.withMinZoom - -```ts -withMinZoom(value) -``` - - - -##### fn options.view.withPadding - -```ts -withPadding(value) -``` - - - -##### fn options.view.withShared - -```ts -withShared(value) -``` - - - -##### fn options.view.withZoom - -```ts -withZoom(value=1) -``` - - - -### obj panelOptions - - -#### fn panelOptions.withDescription - -```ts -withDescription(value) -``` - -Description. - -#### fn panelOptions.withLinks - -```ts -withLinks(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withRepeat - -```ts -withRepeat(value) -``` - -Name of template variable to repeat for. - -#### fn panelOptions.withRepeatDirection - -```ts -withRepeatDirection(value="h") -``` - -Direction to repeat in if 'repeat' is set. -"h" for horizontal, "v" for vertical. -TODO this is probably optional - -Accepted values for `value` are "h", "v" - -#### fn panelOptions.withTitle - -```ts -withTitle(value) -``` - -Panel title. - -#### fn panelOptions.withTransparent - -```ts -withTransparent(value=false) -``` - -Whether to display the panel without a background. - -### obj queryOptions - - -#### fn queryOptions.withDatasource - -```ts -withDatasource(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withDatasourceMixin - -```ts -withDatasourceMixin(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withInterval - -```ts -withInterval(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withMaxDataPoints - -```ts -withMaxDataPoints(value) -``` - -TODO docs - -#### fn queryOptions.withTargets - -```ts -withTargets(value) -``` - -TODO docs - -#### fn queryOptions.withTargetsMixin - -```ts -withTargetsMixin(value) -``` - -TODO docs - -#### fn queryOptions.withTimeFrom - -```ts -withTimeFrom(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTimeShift - -```ts -withTimeShift(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTransformations - -```ts -withTransformations(value) -``` - - - -#### fn queryOptions.withTransformationsMixin - -```ts -withTransformationsMixin(value) -``` - - - -### obj standardOptions - - -#### fn standardOptions.withDecimals - -```ts -withDecimals(value) -``` - -Significant digits (for display) - -#### fn standardOptions.withDisplayName - -```ts -withDisplayName(value) -``` - -The display value for this field. This supports template variables blank is auto - -#### fn standardOptions.withLinks - -```ts -withLinks(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withMappings - -```ts -withMappings(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMappingsMixin - -```ts -withMappingsMixin(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMax - -```ts -withMax(value) -``` - - - -#### fn standardOptions.withMin - -```ts -withMin(value) -``` - - - -#### fn standardOptions.withNoValue - -```ts -withNoValue(value) -``` - -Alternative to empty string - -#### fn standardOptions.withOverrides - -```ts -withOverrides(value) -``` - - - -#### fn standardOptions.withOverridesMixin - -```ts -withOverridesMixin(value) -``` - - - -#### fn standardOptions.withUnit - -```ts -withUnit(value) -``` - -Numeric Options - -#### obj standardOptions.color - - -##### fn standardOptions.color.withFixedColor - -```ts -withFixedColor(value) -``` - -Stores the fixed color value if mode is fixed - -##### fn standardOptions.color.withMode - -```ts -withMode(value) -``` - -The main color scheme mode - -##### fn standardOptions.color.withSeriesBy - -```ts -withSeriesBy(value) -``` - -TODO docs - -Accepted values for `value` are "min", "max", "last" - -#### obj standardOptions.thresholds - - -##### fn standardOptions.thresholds.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "absolute", "percentage" - -##### fn standardOptions.thresholds.withSteps - -```ts -withSteps(value) -``` - -Must be sorted by 'value', first value is always -Infinity - -##### fn standardOptions.thresholds.withStepsMixin - -```ts -withStepsMixin(value) -``` - -Must be sorted by 'value', first value is always -Infinity diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/geomap/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/geomap/link.md deleted file mode 100644 index 1a1d7c4..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/geomap/link.md +++ /dev/null @@ -1,109 +0,0 @@ -# link - - - -## Index - -* [`fn withAsDropdown(value=false)`](#fn-withasdropdown) -* [`fn withIcon(value)`](#fn-withicon) -* [`fn withIncludeVars(value=false)`](#fn-withincludevars) -* [`fn withKeepTime(value=false)`](#fn-withkeeptime) -* [`fn withTags(value)`](#fn-withtags) -* [`fn withTagsMixin(value)`](#fn-withtagsmixin) -* [`fn withTargetBlank(value=false)`](#fn-withtargetblank) -* [`fn withTitle(value)`](#fn-withtitle) -* [`fn withTooltip(value)`](#fn-withtooltip) -* [`fn withType(value)`](#fn-withtype) -* [`fn withUrl(value)`](#fn-withurl) - -## Fields - -### fn withAsDropdown - -```ts -withAsDropdown(value=false) -``` - - - -### fn withIcon - -```ts -withIcon(value) -``` - - - -### fn withIncludeVars - -```ts -withIncludeVars(value=false) -``` - - - -### fn withKeepTime - -```ts -withKeepTime(value=false) -``` - - - -### fn withTags - -```ts -withTags(value) -``` - - - -### fn withTagsMixin - -```ts -withTagsMixin(value) -``` - - - -### fn withTargetBlank - -```ts -withTargetBlank(value=false) -``` - - - -### fn withTitle - -```ts -withTitle(value) -``` - - - -### fn withTooltip - -```ts -withTooltip(value) -``` - - - -### fn withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "link", "dashboards" - -### fn withUrl - -```ts -withUrl(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/geomap/thresholdStep.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/geomap/thresholdStep.md deleted file mode 100644 index 9d6af42..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/geomap/thresholdStep.md +++ /dev/null @@ -1,47 +0,0 @@ -# thresholdStep - - - -## Index - -* [`fn withColor(value)`](#fn-withcolor) -* [`fn withIndex(value)`](#fn-withindex) -* [`fn withState(value)`](#fn-withstate) -* [`fn withValue(value)`](#fn-withvalue) - -## Fields - -### fn withColor - -```ts -withColor(value) -``` - -TODO docs - -### fn withIndex - -```ts -withIndex(value) -``` - -Threshold index, an old property that is not needed an should only appear in older dashboards - -### fn withState - -```ts -withState(value) -``` - -TODO docs -TODO are the values here enumerable into a disjunction? -Some seem to be listed in typescript comment - -### fn withValue - -```ts -withValue(value) -``` - -TODO docs -FIXME the corresponding typescript field is required/non-optional, but nulls currently appear here when serializing -Infinity to JSON diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/geomap/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/geomap/transformation.md deleted file mode 100644 index 3dac7e9..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/geomap/transformation.md +++ /dev/null @@ -1,76 +0,0 @@ -# transformation - - - -## Index - -* [`fn withDisabled(value)`](#fn-withdisabled) -* [`fn withFilter(value)`](#fn-withfilter) -* [`fn withFilterMixin(value)`](#fn-withfiltermixin) -* [`fn withId(value)`](#fn-withid) -* [`fn withOptions(value)`](#fn-withoptions) -* [`obj filter`](#obj-filter) - * [`fn withId(value="")`](#fn-filterwithid) - * [`fn withOptions(value)`](#fn-filterwithoptions) - -## Fields - -### fn withDisabled - -```ts -withDisabled(value) -``` - -Disabled transformations are skipped - -### fn withFilter - -```ts -withFilter(value) -``` - - - -### fn withFilterMixin - -```ts -withFilterMixin(value) -``` - - - -### fn withId - -```ts -withId(value) -``` - -Unique identifier of transformer - -### fn withOptions - -```ts -withOptions(value) -``` - -Options to be passed to the transformer -Valid options depend on the transformer id - -### obj filter - - -#### fn filter.withId - -```ts -withId(value="") -``` - - - -#### fn filter.withOptions - -```ts -withOptions(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/geomap/valueMapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/geomap/valueMapping.md deleted file mode 100644 index a6bbdb3..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/geomap/valueMapping.md +++ /dev/null @@ -1,365 +0,0 @@ -# valueMapping - - - -## Index - -* [`obj RangeMap`](#obj-rangemap) - * [`fn withOptions(value)`](#fn-rangemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) - * [`obj options`](#obj-rangemapoptions) - * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) - * [`fn withResult(value)`](#fn-rangemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) - * [`fn withTo(value)`](#fn-rangemapoptionswithto) - * [`obj result`](#obj-rangemapoptionsresult) - * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) -* [`obj RegexMap`](#obj-regexmap) - * [`fn withOptions(value)`](#fn-regexmapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) - * [`obj options`](#obj-regexmapoptions) - * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) - * [`fn withResult(value)`](#fn-regexmapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) - * [`obj result`](#obj-regexmapoptionsresult) - * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) - * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) -* [`obj SpecialValueMap`](#obj-specialvaluemap) - * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) - * [`obj options`](#obj-specialvaluemapoptions) - * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) - * [`fn withPattern(value)`](#fn-specialvaluemapoptionswithpattern) - * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) - * [`obj result`](#obj-specialvaluemapoptionsresult) - * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) -* [`obj ValueMap`](#obj-valuemap) - * [`fn withOptions(value)`](#fn-valuemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) - -## Fields - -### obj RangeMap - - -#### fn RangeMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RangeMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RangeMap.withType - -```ts -withType(value) -``` - - - -#### obj RangeMap.options - - -##### fn RangeMap.options.withFrom - -```ts -withFrom(value) -``` - -to and from are `number | null` in current ts, really not sure what to do - -##### fn RangeMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RangeMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### fn RangeMap.options.withTo - -```ts -withTo(value) -``` - - - -##### obj RangeMap.options.result - - -###### fn RangeMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RangeMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RangeMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RangeMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj RegexMap - - -#### fn RegexMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RegexMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RegexMap.withType - -```ts -withType(value) -``` - - - -#### obj RegexMap.options - - -##### fn RegexMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn RegexMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RegexMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj RegexMap.options.result - - -###### fn RegexMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RegexMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RegexMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RegexMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj SpecialValueMap - - -#### fn SpecialValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn SpecialValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn SpecialValueMap.withType - -```ts -withType(value) -``` - - - -#### obj SpecialValueMap.options - - -##### fn SpecialValueMap.options.withMatch - -```ts -withMatch(value) -``` - - - -Accepted values for `value` are "true", "false" - -##### fn SpecialValueMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn SpecialValueMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn SpecialValueMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj SpecialValueMap.options.result - - -###### fn SpecialValueMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn SpecialValueMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn SpecialValueMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn SpecialValueMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj ValueMap - - -#### fn ValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn ValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn ValueMap.withType - -```ts -withType(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/heatmap/fieldOverride.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/heatmap/fieldOverride.md deleted file mode 100644 index 3e2667b..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/heatmap/fieldOverride.md +++ /dev/null @@ -1,194 +0,0 @@ -# fieldOverride - -Overrides allow you to customize visualization settings for specific fields or -series. This is accomplished by adding an override rule that targets -a particular set of fields and that can each define multiple options. - -```jsonnet -fieldOverride.byType.new('number') -+ fieldOverride.byType.withPropertiesFromOptions( - panel.standardOptions.withDecimals(2) - + panel.standardOptions.withUnit('s') -) -``` - - -## Index - -* [`obj byName`](#obj-byname) - * [`fn new(value)`](#fn-bynamenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bynamewithproperty) -* [`obj byQuery`](#obj-byquery) - * [`fn new(value)`](#fn-byquerynew) - * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byquerywithproperty) -* [`obj byRegexp`](#obj-byregexp) - * [`fn new(value)`](#fn-byregexpnew) - * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) -* [`obj byType`](#obj-bytype) - * [`fn new(value)`](#fn-bytypenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bytypewithproperty) -* [`obj byValue`](#obj-byvalue) - * [`fn new(value)`](#fn-byvaluenew) - * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) - -## Fields - -### obj byName - - -#### fn byName.new - -```ts -new(value) -``` - -`new` creates a new override of type `byName`. - -#### fn byName.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byName.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byQuery - - -#### fn byQuery.new - -```ts -new(value) -``` - -`new` creates a new override of type `byQuery`. - -#### fn byQuery.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byQuery.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byRegexp - - -#### fn byRegexp.new - -```ts -new(value) -``` - -`new` creates a new override of type `byRegexp`. - -#### fn byRegexp.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byRegexp.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byType - - -#### fn byType.new - -```ts -new(value) -``` - -`new` creates a new override of type `byType`. - -#### fn byType.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byType.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byValue - - -#### fn byValue.new - -```ts -new(value) -``` - -`new` creates a new override of type `byValue`. - -#### fn byValue.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byValue.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/heatmap/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/heatmap/index.md deleted file mode 100644 index 316949e..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/heatmap/index.md +++ /dev/null @@ -1,1420 +0,0 @@ -# heatmap - -grafonnet.panel.heatmap - -## Subpackages - -* [fieldOverride](fieldOverride.md) -* [link](link.md) -* [thresholdStep](thresholdStep.md) -* [transformation](transformation.md) -* [valueMapping](valueMapping.md) - -## Index - -* [`fn new(title)`](#fn-new) -* [`obj datasource`](#obj-datasource) - * [`fn withType(value)`](#fn-datasourcewithtype) - * [`fn withUid(value)`](#fn-datasourcewithuid) -* [`obj fieldConfig`](#obj-fieldconfig) - * [`obj defaults`](#obj-fieldconfigdefaults) - * [`obj custom`](#obj-fieldconfigdefaultscustom) - * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomwithhidefrom) - * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomwithhidefrommixin) - * [`fn withScaleDistribution(value)`](#fn-fieldconfigdefaultscustomwithscaledistribution) - * [`fn withScaleDistributionMixin(value)`](#fn-fieldconfigdefaultscustomwithscaledistributionmixin) - * [`obj hideFrom`](#obj-fieldconfigdefaultscustomhidefrom) - * [`fn withLegend(value)`](#fn-fieldconfigdefaultscustomhidefromwithlegend) - * [`fn withTooltip(value)`](#fn-fieldconfigdefaultscustomhidefromwithtooltip) - * [`fn withViz(value)`](#fn-fieldconfigdefaultscustomhidefromwithviz) - * [`obj scaleDistribution`](#obj-fieldconfigdefaultscustomscaledistribution) - * [`fn withLinearThreshold(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlinearthreshold) - * [`fn withLog(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlog) - * [`fn withType(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithtype) -* [`obj gridPos`](#obj-gridpos) - * [`fn withH(value=9)`](#fn-gridposwithh) - * [`fn withStatic(value)`](#fn-gridposwithstatic) - * [`fn withW(value=12)`](#fn-gridposwithw) - * [`fn withX(value=0)`](#fn-gridposwithx) - * [`fn withY(value=0)`](#fn-gridposwithy) -* [`obj libraryPanel`](#obj-librarypanel) - * [`fn withName(value)`](#fn-librarypanelwithname) - * [`fn withUid(value)`](#fn-librarypanelwithuid) -* [`obj options`](#obj-options) - * [`fn withCalculate(value=false)`](#fn-optionswithcalculate) - * [`fn withCalculation(value)`](#fn-optionswithcalculation) - * [`fn withCalculationMixin(value)`](#fn-optionswithcalculationmixin) - * [`fn withCellGap(value=1)`](#fn-optionswithcellgap) - * [`fn withCellRadius(value)`](#fn-optionswithcellradius) - * [`fn withCellValues(value={})`](#fn-optionswithcellvalues) - * [`fn withCellValuesMixin(value={})`](#fn-optionswithcellvaluesmixin) - * [`fn withColor(value={"exponent": 0.5,"fill": "dark-orange","reverse": false,"scheme": "Oranges","steps": 64})`](#fn-optionswithcolor) - * [`fn withColorMixin(value={"exponent": 0.5,"fill": "dark-orange","reverse": false,"scheme": "Oranges","steps": 64})`](#fn-optionswithcolormixin) - * [`fn withExemplars(value)`](#fn-optionswithexemplars) - * [`fn withExemplarsMixin(value)`](#fn-optionswithexemplarsmixin) - * [`fn withFilterValues(value={"le": 0.000000001})`](#fn-optionswithfiltervalues) - * [`fn withFilterValuesMixin(value={"le": 0.000000001})`](#fn-optionswithfiltervaluesmixin) - * [`fn withLegend(value)`](#fn-optionswithlegend) - * [`fn withLegendMixin(value)`](#fn-optionswithlegendmixin) - * [`fn withRowsFrame(value)`](#fn-optionswithrowsframe) - * [`fn withRowsFrameMixin(value)`](#fn-optionswithrowsframemixin) - * [`fn withShowValue(value)`](#fn-optionswithshowvalue) - * [`fn withTooltip(value)`](#fn-optionswithtooltip) - * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) - * [`fn withYAxis(value)`](#fn-optionswithyaxis) - * [`fn withYAxisMixin(value)`](#fn-optionswithyaxismixin) - * [`obj calculation`](#obj-optionscalculation) - * [`fn withXBuckets(value)`](#fn-optionscalculationwithxbuckets) - * [`fn withXBucketsMixin(value)`](#fn-optionscalculationwithxbucketsmixin) - * [`fn withYBuckets(value)`](#fn-optionscalculationwithybuckets) - * [`fn withYBucketsMixin(value)`](#fn-optionscalculationwithybucketsmixin) - * [`obj xBuckets`](#obj-optionscalculationxbuckets) - * [`fn withMode(value)`](#fn-optionscalculationxbucketswithmode) - * [`fn withScale(value)`](#fn-optionscalculationxbucketswithscale) - * [`fn withScaleMixin(value)`](#fn-optionscalculationxbucketswithscalemixin) - * [`fn withValue(value)`](#fn-optionscalculationxbucketswithvalue) - * [`obj scale`](#obj-optionscalculationxbucketsscale) - * [`fn withLinearThreshold(value)`](#fn-optionscalculationxbucketsscalewithlinearthreshold) - * [`fn withLog(value)`](#fn-optionscalculationxbucketsscalewithlog) - * [`fn withType(value)`](#fn-optionscalculationxbucketsscalewithtype) - * [`obj yBuckets`](#obj-optionscalculationybuckets) - * [`fn withMode(value)`](#fn-optionscalculationybucketswithmode) - * [`fn withScale(value)`](#fn-optionscalculationybucketswithscale) - * [`fn withScaleMixin(value)`](#fn-optionscalculationybucketswithscalemixin) - * [`fn withValue(value)`](#fn-optionscalculationybucketswithvalue) - * [`obj scale`](#obj-optionscalculationybucketsscale) - * [`fn withLinearThreshold(value)`](#fn-optionscalculationybucketsscalewithlinearthreshold) - * [`fn withLog(value)`](#fn-optionscalculationybucketsscalewithlog) - * [`fn withType(value)`](#fn-optionscalculationybucketsscalewithtype) - * [`obj cellValues`](#obj-optionscellvalues) - * [`fn withCellValues(value)`](#fn-optionscellvalueswithcellvalues) - * [`fn withCellValuesMixin(value)`](#fn-optionscellvalueswithcellvaluesmixin) - * [`obj CellValues`](#obj-optionscellvaluescellvalues) - * [`fn withDecimals(value)`](#fn-optionscellvaluescellvalueswithdecimals) - * [`fn withUnit(value)`](#fn-optionscellvaluescellvalueswithunit) - * [`obj color`](#obj-optionscolor) - * [`fn withHeatmapColorOptions(value)`](#fn-optionscolorwithheatmapcoloroptions) - * [`fn withHeatmapColorOptionsMixin(value)`](#fn-optionscolorwithheatmapcoloroptionsmixin) - * [`obj HeatmapColorOptions`](#obj-optionscolorheatmapcoloroptions) - * [`fn withExponent(value)`](#fn-optionscolorheatmapcoloroptionswithexponent) - * [`fn withFill(value)`](#fn-optionscolorheatmapcoloroptionswithfill) - * [`fn withMax(value)`](#fn-optionscolorheatmapcoloroptionswithmax) - * [`fn withMin(value)`](#fn-optionscolorheatmapcoloroptionswithmin) - * [`fn withMode(value)`](#fn-optionscolorheatmapcoloroptionswithmode) - * [`fn withReverse(value)`](#fn-optionscolorheatmapcoloroptionswithreverse) - * [`fn withScale(value)`](#fn-optionscolorheatmapcoloroptionswithscale) - * [`fn withScheme(value)`](#fn-optionscolorheatmapcoloroptionswithscheme) - * [`fn withSteps(value)`](#fn-optionscolorheatmapcoloroptionswithsteps) - * [`obj exemplars`](#obj-optionsexemplars) - * [`fn withColor(value)`](#fn-optionsexemplarswithcolor) - * [`obj filterValues`](#obj-optionsfiltervalues) - * [`fn withFilterValueRange(value)`](#fn-optionsfiltervalueswithfiltervaluerange) - * [`fn withFilterValueRangeMixin(value)`](#fn-optionsfiltervalueswithfiltervaluerangemixin) - * [`obj FilterValueRange`](#obj-optionsfiltervaluesfiltervaluerange) - * [`fn withGe(value)`](#fn-optionsfiltervaluesfiltervaluerangewithge) - * [`fn withLe(value)`](#fn-optionsfiltervaluesfiltervaluerangewithle) - * [`obj legend`](#obj-optionslegend) - * [`fn withShow(value)`](#fn-optionslegendwithshow) - * [`obj rowsFrame`](#obj-optionsrowsframe) - * [`fn withLayout(value)`](#fn-optionsrowsframewithlayout) - * [`fn withValue(value)`](#fn-optionsrowsframewithvalue) - * [`obj tooltip`](#obj-optionstooltip) - * [`fn withShow(value)`](#fn-optionstooltipwithshow) - * [`fn withYHistogram(value)`](#fn-optionstooltipwithyhistogram) - * [`obj yAxis`](#obj-optionsyaxis) - * [`fn withAxisCenteredZero(value)`](#fn-optionsyaxiswithaxiscenteredzero) - * [`fn withAxisColorMode(value)`](#fn-optionsyaxiswithaxiscolormode) - * [`fn withAxisGridShow(value)`](#fn-optionsyaxiswithaxisgridshow) - * [`fn withAxisLabel(value)`](#fn-optionsyaxiswithaxislabel) - * [`fn withAxisPlacement(value)`](#fn-optionsyaxiswithaxisplacement) - * [`fn withAxisSoftMax(value)`](#fn-optionsyaxiswithaxissoftmax) - * [`fn withAxisSoftMin(value)`](#fn-optionsyaxiswithaxissoftmin) - * [`fn withAxisWidth(value)`](#fn-optionsyaxiswithaxiswidth) - * [`fn withDecimals(value)`](#fn-optionsyaxiswithdecimals) - * [`fn withMax(value)`](#fn-optionsyaxiswithmax) - * [`fn withMin(value)`](#fn-optionsyaxiswithmin) - * [`fn withReverse(value)`](#fn-optionsyaxiswithreverse) - * [`fn withScaleDistribution(value)`](#fn-optionsyaxiswithscaledistribution) - * [`fn withScaleDistributionMixin(value)`](#fn-optionsyaxiswithscaledistributionmixin) - * [`fn withUnit(value)`](#fn-optionsyaxiswithunit) - * [`obj scaleDistribution`](#obj-optionsyaxisscaledistribution) - * [`fn withLinearThreshold(value)`](#fn-optionsyaxisscaledistributionwithlinearthreshold) - * [`fn withLog(value)`](#fn-optionsyaxisscaledistributionwithlog) - * [`fn withType(value)`](#fn-optionsyaxisscaledistributionwithtype) -* [`obj panelOptions`](#obj-paneloptions) - * [`fn withDescription(value)`](#fn-paneloptionswithdescription) - * [`fn withLinks(value)`](#fn-paneloptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) - * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) - * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) - * [`fn withTitle(value)`](#fn-paneloptionswithtitle) - * [`fn withTransparent(value=false)`](#fn-paneloptionswithtransparent) -* [`obj queryOptions`](#obj-queryoptions) - * [`fn withDatasource(value)`](#fn-queryoptionswithdatasource) - * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) - * [`fn withInterval(value)`](#fn-queryoptionswithinterval) - * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) - * [`fn withTargets(value)`](#fn-queryoptionswithtargets) - * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) - * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) - * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) - * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) - * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) -* [`obj standardOptions`](#obj-standardoptions) - * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) - * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) - * [`fn withLinks(value)`](#fn-standardoptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) - * [`fn withMappings(value)`](#fn-standardoptionswithmappings) - * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) - * [`fn withMax(value)`](#fn-standardoptionswithmax) - * [`fn withMin(value)`](#fn-standardoptionswithmin) - * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) - * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) - * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) - * [`fn withUnit(value)`](#fn-standardoptionswithunit) - * [`obj color`](#obj-standardoptionscolor) - * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) - * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) - * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) - * [`obj thresholds`](#obj-standardoptionsthresholds) - * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) - * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) - * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) - -## Fields - -### fn new - -```ts -new(title) -``` - -Creates a new heatmap panel with a title. - -### obj datasource - - -#### fn datasource.withType - -```ts -withType(value) -``` - - - -#### fn datasource.withUid - -```ts -withUid(value) -``` - - - -### obj fieldConfig - - -#### obj fieldConfig.defaults - - -##### obj fieldConfig.defaults.custom - - -###### fn fieldConfig.defaults.custom.withHideFrom - -```ts -withHideFrom(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withHideFromMixin - -```ts -withHideFromMixin(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withScaleDistribution - -```ts -withScaleDistribution(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withScaleDistributionMixin - -```ts -withScaleDistributionMixin(value) -``` - -TODO docs - -###### obj fieldConfig.defaults.custom.hideFrom - - -####### fn fieldConfig.defaults.custom.hideFrom.withLegend - -```ts -withLegend(value) -``` - - - -####### fn fieldConfig.defaults.custom.hideFrom.withTooltip - -```ts -withTooltip(value) -``` - - - -####### fn fieldConfig.defaults.custom.hideFrom.withViz - -```ts -withViz(value) -``` - - - -###### obj fieldConfig.defaults.custom.scaleDistribution - - -####### fn fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold - -```ts -withLinearThreshold(value) -``` - - - -####### fn fieldConfig.defaults.custom.scaleDistribution.withLog - -```ts -withLog(value) -``` - - - -####### fn fieldConfig.defaults.custom.scaleDistribution.withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "linear", "log", "ordinal", "symlog" - -### obj gridPos - - -#### fn gridPos.withH - -```ts -withH(value=9) -``` - -Panel - -#### fn gridPos.withStatic - -```ts -withStatic(value) -``` - -true if fixed - -#### fn gridPos.withW - -```ts -withW(value=12) -``` - -Panel - -#### fn gridPos.withX - -```ts -withX(value=0) -``` - -Panel x - -#### fn gridPos.withY - -```ts -withY(value=0) -``` - -Panel y - -### obj libraryPanel - - -#### fn libraryPanel.withName - -```ts -withName(value) -``` - - - -#### fn libraryPanel.withUid - -```ts -withUid(value) -``` - - - -### obj options - - -#### fn options.withCalculate - -```ts -withCalculate(value=false) -``` - -Controls if the heatmap should be calculated from data - -#### fn options.withCalculation - -```ts -withCalculation(value) -``` - - - -#### fn options.withCalculationMixin - -```ts -withCalculationMixin(value) -``` - - - -#### fn options.withCellGap - -```ts -withCellGap(value=1) -``` - -Controls gap between cells - -#### fn options.withCellRadius - -```ts -withCellRadius(value) -``` - -Controls cell radius - -#### fn options.withCellValues - -```ts -withCellValues(value={}) -``` - -Controls cell value unit - -#### fn options.withCellValuesMixin - -```ts -withCellValuesMixin(value={}) -``` - -Controls cell value unit - -#### fn options.withColor - -```ts -withColor(value={"exponent": 0.5,"fill": "dark-orange","reverse": false,"scheme": "Oranges","steps": 64}) -``` - -Controls the color options - -#### fn options.withColorMixin - -```ts -withColorMixin(value={"exponent": 0.5,"fill": "dark-orange","reverse": false,"scheme": "Oranges","steps": 64}) -``` - -Controls the color options - -#### fn options.withExemplars - -```ts -withExemplars(value) -``` - -Controls exemplar options - -#### fn options.withExemplarsMixin - -```ts -withExemplarsMixin(value) -``` - -Controls exemplar options - -#### fn options.withFilterValues - -```ts -withFilterValues(value={"le": 0.000000001}) -``` - -Filters values between a given range - -#### fn options.withFilterValuesMixin - -```ts -withFilterValuesMixin(value={"le": 0.000000001}) -``` - -Filters values between a given range - -#### fn options.withLegend - -```ts -withLegend(value) -``` - -Controls legend options - -#### fn options.withLegendMixin - -```ts -withLegendMixin(value) -``` - -Controls legend options - -#### fn options.withRowsFrame - -```ts -withRowsFrame(value) -``` - -Controls frame rows options - -#### fn options.withRowsFrameMixin - -```ts -withRowsFrameMixin(value) -``` - -Controls frame rows options - -#### fn options.withShowValue - -```ts -withShowValue(value) -``` - -| *{ - layout: ui.HeatmapCellLayout & "auto" // TODO: fix after remove when https://github.com/grafana/cuetsy/issues/74 is fixed -} -Controls the display of the value in the cell - -#### fn options.withTooltip - -```ts -withTooltip(value) -``` - -Controls tooltip options - -#### fn options.withTooltipMixin - -```ts -withTooltipMixin(value) -``` - -Controls tooltip options - -#### fn options.withYAxis - -```ts -withYAxis(value) -``` - -Configuration options for the yAxis - -#### fn options.withYAxisMixin - -```ts -withYAxisMixin(value) -``` - -Configuration options for the yAxis - -#### obj options.calculation - - -##### fn options.calculation.withXBuckets - -```ts -withXBuckets(value) -``` - - - -##### fn options.calculation.withXBucketsMixin - -```ts -withXBucketsMixin(value) -``` - - - -##### fn options.calculation.withYBuckets - -```ts -withYBuckets(value) -``` - - - -##### fn options.calculation.withYBucketsMixin - -```ts -withYBucketsMixin(value) -``` - - - -##### obj options.calculation.xBuckets - - -###### fn options.calculation.xBuckets.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "size", "count" - -###### fn options.calculation.xBuckets.withScale - -```ts -withScale(value) -``` - -TODO docs - -###### fn options.calculation.xBuckets.withScaleMixin - -```ts -withScaleMixin(value) -``` - -TODO docs - -###### fn options.calculation.xBuckets.withValue - -```ts -withValue(value) -``` - -The number of buckets to use for the axis in the heatmap - -###### obj options.calculation.xBuckets.scale - - -####### fn options.calculation.xBuckets.scale.withLinearThreshold - -```ts -withLinearThreshold(value) -``` - - - -####### fn options.calculation.xBuckets.scale.withLog - -```ts -withLog(value) -``` - - - -####### fn options.calculation.xBuckets.scale.withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "linear", "log", "ordinal", "symlog" - -##### obj options.calculation.yBuckets - - -###### fn options.calculation.yBuckets.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "size", "count" - -###### fn options.calculation.yBuckets.withScale - -```ts -withScale(value) -``` - -TODO docs - -###### fn options.calculation.yBuckets.withScaleMixin - -```ts -withScaleMixin(value) -``` - -TODO docs - -###### fn options.calculation.yBuckets.withValue - -```ts -withValue(value) -``` - -The number of buckets to use for the axis in the heatmap - -###### obj options.calculation.yBuckets.scale - - -####### fn options.calculation.yBuckets.scale.withLinearThreshold - -```ts -withLinearThreshold(value) -``` - - - -####### fn options.calculation.yBuckets.scale.withLog - -```ts -withLog(value) -``` - - - -####### fn options.calculation.yBuckets.scale.withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "linear", "log", "ordinal", "symlog" - -#### obj options.cellValues - - -##### fn options.cellValues.withCellValues - -```ts -withCellValues(value) -``` - -Controls cell value options - -##### fn options.cellValues.withCellValuesMixin - -```ts -withCellValuesMixin(value) -``` - -Controls cell value options - -##### obj options.cellValues.CellValues - - -###### fn options.cellValues.CellValues.withDecimals - -```ts -withDecimals(value) -``` - -Controls the number of decimals for cell values - -###### fn options.cellValues.CellValues.withUnit - -```ts -withUnit(value) -``` - -Controls the cell value unit - -#### obj options.color - - -##### fn options.color.withHeatmapColorOptions - -```ts -withHeatmapColorOptions(value) -``` - -Controls various color options - -##### fn options.color.withHeatmapColorOptionsMixin - -```ts -withHeatmapColorOptionsMixin(value) -``` - -Controls various color options - -##### obj options.color.HeatmapColorOptions - - -###### fn options.color.HeatmapColorOptions.withExponent - -```ts -withExponent(value) -``` - -Controls the exponent when scale is set to exponential - -###### fn options.color.HeatmapColorOptions.withFill - -```ts -withFill(value) -``` - -Controls the color fill when in opacity mode - -###### fn options.color.HeatmapColorOptions.withMax - -```ts -withMax(value) -``` - -Sets the maximum value for the color scale - -###### fn options.color.HeatmapColorOptions.withMin - -```ts -withMin(value) -``` - -Sets the minimum value for the color scale - -###### fn options.color.HeatmapColorOptions.withMode - -```ts -withMode(value) -``` - -Controls the color mode of the heatmap - -Accepted values for `value` are "opacity", "scheme" - -###### fn options.color.HeatmapColorOptions.withReverse - -```ts -withReverse(value) -``` - -Reverses the color scheme - -###### fn options.color.HeatmapColorOptions.withScale - -```ts -withScale(value) -``` - -Controls the color scale of the heatmap - -Accepted values for `value` are "linear", "exponential" - -###### fn options.color.HeatmapColorOptions.withScheme - -```ts -withScheme(value) -``` - -Controls the color scheme used - -###### fn options.color.HeatmapColorOptions.withSteps - -```ts -withSteps(value) -``` - -Controls the number of color steps - -#### obj options.exemplars - - -##### fn options.exemplars.withColor - -```ts -withColor(value) -``` - -Sets the color of the exemplar markers - -#### obj options.filterValues - - -##### fn options.filterValues.withFilterValueRange - -```ts -withFilterValueRange(value) -``` - -Controls the value filter range - -##### fn options.filterValues.withFilterValueRangeMixin - -```ts -withFilterValueRangeMixin(value) -``` - -Controls the value filter range - -##### obj options.filterValues.FilterValueRange - - -###### fn options.filterValues.FilterValueRange.withGe - -```ts -withGe(value) -``` - -Sets the filter range to values greater than or equal to the given value - -###### fn options.filterValues.FilterValueRange.withLe - -```ts -withLe(value) -``` - -Sets the filter range to values less than or equal to the given value - -#### obj options.legend - - -##### fn options.legend.withShow - -```ts -withShow(value) -``` - -Controls if the legend is shown - -#### obj options.rowsFrame - - -##### fn options.rowsFrame.withLayout - -```ts -withLayout(value) -``` - - - -Accepted values for `value` are "le", "ge", "unknown", "auto" - -##### fn options.rowsFrame.withValue - -```ts -withValue(value) -``` - -Sets the name of the cell when not calculating from data - -#### obj options.tooltip - - -##### fn options.tooltip.withShow - -```ts -withShow(value) -``` - -Controls if the tooltip is shown - -##### fn options.tooltip.withYHistogram - -```ts -withYHistogram(value) -``` - -Controls if the tooltip shows a histogram of the y-axis values - -#### obj options.yAxis - - -##### fn options.yAxis.withAxisCenteredZero - -```ts -withAxisCenteredZero(value) -``` - - - -##### fn options.yAxis.withAxisColorMode - -```ts -withAxisColorMode(value) -``` - -TODO docs - -Accepted values for `value` are "text", "series" - -##### fn options.yAxis.withAxisGridShow - -```ts -withAxisGridShow(value) -``` - - - -##### fn options.yAxis.withAxisLabel - -```ts -withAxisLabel(value) -``` - - - -##### fn options.yAxis.withAxisPlacement - -```ts -withAxisPlacement(value) -``` - -TODO docs - -Accepted values for `value` are "auto", "top", "right", "bottom", "left", "hidden" - -##### fn options.yAxis.withAxisSoftMax - -```ts -withAxisSoftMax(value) -``` - - - -##### fn options.yAxis.withAxisSoftMin - -```ts -withAxisSoftMin(value) -``` - - - -##### fn options.yAxis.withAxisWidth - -```ts -withAxisWidth(value) -``` - - - -##### fn options.yAxis.withDecimals - -```ts -withDecimals(value) -``` - -Controls the number of decimals for yAxis values - -##### fn options.yAxis.withMax - -```ts -withMax(value) -``` - -Sets the maximum value for the yAxis - -##### fn options.yAxis.withMin - -```ts -withMin(value) -``` - -Sets the minimum value for the yAxis - -##### fn options.yAxis.withReverse - -```ts -withReverse(value) -``` - -Reverses the yAxis - -##### fn options.yAxis.withScaleDistribution - -```ts -withScaleDistribution(value) -``` - -TODO docs - -##### fn options.yAxis.withScaleDistributionMixin - -```ts -withScaleDistributionMixin(value) -``` - -TODO docs - -##### fn options.yAxis.withUnit - -```ts -withUnit(value) -``` - -Sets the yAxis unit - -##### obj options.yAxis.scaleDistribution - - -###### fn options.yAxis.scaleDistribution.withLinearThreshold - -```ts -withLinearThreshold(value) -``` - - - -###### fn options.yAxis.scaleDistribution.withLog - -```ts -withLog(value) -``` - - - -###### fn options.yAxis.scaleDistribution.withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "linear", "log", "ordinal", "symlog" - -### obj panelOptions - - -#### fn panelOptions.withDescription - -```ts -withDescription(value) -``` - -Description. - -#### fn panelOptions.withLinks - -```ts -withLinks(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withRepeat - -```ts -withRepeat(value) -``` - -Name of template variable to repeat for. - -#### fn panelOptions.withRepeatDirection - -```ts -withRepeatDirection(value="h") -``` - -Direction to repeat in if 'repeat' is set. -"h" for horizontal, "v" for vertical. -TODO this is probably optional - -Accepted values for `value` are "h", "v" - -#### fn panelOptions.withTitle - -```ts -withTitle(value) -``` - -Panel title. - -#### fn panelOptions.withTransparent - -```ts -withTransparent(value=false) -``` - -Whether to display the panel without a background. - -### obj queryOptions - - -#### fn queryOptions.withDatasource - -```ts -withDatasource(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withDatasourceMixin - -```ts -withDatasourceMixin(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withInterval - -```ts -withInterval(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withMaxDataPoints - -```ts -withMaxDataPoints(value) -``` - -TODO docs - -#### fn queryOptions.withTargets - -```ts -withTargets(value) -``` - -TODO docs - -#### fn queryOptions.withTargetsMixin - -```ts -withTargetsMixin(value) -``` - -TODO docs - -#### fn queryOptions.withTimeFrom - -```ts -withTimeFrom(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTimeShift - -```ts -withTimeShift(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTransformations - -```ts -withTransformations(value) -``` - - - -#### fn queryOptions.withTransformationsMixin - -```ts -withTransformationsMixin(value) -``` - - - -### obj standardOptions - - -#### fn standardOptions.withDecimals - -```ts -withDecimals(value) -``` - -Significant digits (for display) - -#### fn standardOptions.withDisplayName - -```ts -withDisplayName(value) -``` - -The display value for this field. This supports template variables blank is auto - -#### fn standardOptions.withLinks - -```ts -withLinks(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withMappings - -```ts -withMappings(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMappingsMixin - -```ts -withMappingsMixin(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMax - -```ts -withMax(value) -``` - - - -#### fn standardOptions.withMin - -```ts -withMin(value) -``` - - - -#### fn standardOptions.withNoValue - -```ts -withNoValue(value) -``` - -Alternative to empty string - -#### fn standardOptions.withOverrides - -```ts -withOverrides(value) -``` - - - -#### fn standardOptions.withOverridesMixin - -```ts -withOverridesMixin(value) -``` - - - -#### fn standardOptions.withUnit - -```ts -withUnit(value) -``` - -Numeric Options - -#### obj standardOptions.color - - -##### fn standardOptions.color.withFixedColor - -```ts -withFixedColor(value) -``` - -Stores the fixed color value if mode is fixed - -##### fn standardOptions.color.withMode - -```ts -withMode(value) -``` - -The main color scheme mode - -##### fn standardOptions.color.withSeriesBy - -```ts -withSeriesBy(value) -``` - -TODO docs - -Accepted values for `value` are "min", "max", "last" - -#### obj standardOptions.thresholds - - -##### fn standardOptions.thresholds.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "absolute", "percentage" - -##### fn standardOptions.thresholds.withSteps - -```ts -withSteps(value) -``` - -Must be sorted by 'value', first value is always -Infinity - -##### fn standardOptions.thresholds.withStepsMixin - -```ts -withStepsMixin(value) -``` - -Must be sorted by 'value', first value is always -Infinity diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/heatmap/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/heatmap/link.md deleted file mode 100644 index 1a1d7c4..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/heatmap/link.md +++ /dev/null @@ -1,109 +0,0 @@ -# link - - - -## Index - -* [`fn withAsDropdown(value=false)`](#fn-withasdropdown) -* [`fn withIcon(value)`](#fn-withicon) -* [`fn withIncludeVars(value=false)`](#fn-withincludevars) -* [`fn withKeepTime(value=false)`](#fn-withkeeptime) -* [`fn withTags(value)`](#fn-withtags) -* [`fn withTagsMixin(value)`](#fn-withtagsmixin) -* [`fn withTargetBlank(value=false)`](#fn-withtargetblank) -* [`fn withTitle(value)`](#fn-withtitle) -* [`fn withTooltip(value)`](#fn-withtooltip) -* [`fn withType(value)`](#fn-withtype) -* [`fn withUrl(value)`](#fn-withurl) - -## Fields - -### fn withAsDropdown - -```ts -withAsDropdown(value=false) -``` - - - -### fn withIcon - -```ts -withIcon(value) -``` - - - -### fn withIncludeVars - -```ts -withIncludeVars(value=false) -``` - - - -### fn withKeepTime - -```ts -withKeepTime(value=false) -``` - - - -### fn withTags - -```ts -withTags(value) -``` - - - -### fn withTagsMixin - -```ts -withTagsMixin(value) -``` - - - -### fn withTargetBlank - -```ts -withTargetBlank(value=false) -``` - - - -### fn withTitle - -```ts -withTitle(value) -``` - - - -### fn withTooltip - -```ts -withTooltip(value) -``` - - - -### fn withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "link", "dashboards" - -### fn withUrl - -```ts -withUrl(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/heatmap/thresholdStep.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/heatmap/thresholdStep.md deleted file mode 100644 index 9d6af42..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/heatmap/thresholdStep.md +++ /dev/null @@ -1,47 +0,0 @@ -# thresholdStep - - - -## Index - -* [`fn withColor(value)`](#fn-withcolor) -* [`fn withIndex(value)`](#fn-withindex) -* [`fn withState(value)`](#fn-withstate) -* [`fn withValue(value)`](#fn-withvalue) - -## Fields - -### fn withColor - -```ts -withColor(value) -``` - -TODO docs - -### fn withIndex - -```ts -withIndex(value) -``` - -Threshold index, an old property that is not needed an should only appear in older dashboards - -### fn withState - -```ts -withState(value) -``` - -TODO docs -TODO are the values here enumerable into a disjunction? -Some seem to be listed in typescript comment - -### fn withValue - -```ts -withValue(value) -``` - -TODO docs -FIXME the corresponding typescript field is required/non-optional, but nulls currently appear here when serializing -Infinity to JSON diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/heatmap/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/heatmap/transformation.md deleted file mode 100644 index 3dac7e9..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/heatmap/transformation.md +++ /dev/null @@ -1,76 +0,0 @@ -# transformation - - - -## Index - -* [`fn withDisabled(value)`](#fn-withdisabled) -* [`fn withFilter(value)`](#fn-withfilter) -* [`fn withFilterMixin(value)`](#fn-withfiltermixin) -* [`fn withId(value)`](#fn-withid) -* [`fn withOptions(value)`](#fn-withoptions) -* [`obj filter`](#obj-filter) - * [`fn withId(value="")`](#fn-filterwithid) - * [`fn withOptions(value)`](#fn-filterwithoptions) - -## Fields - -### fn withDisabled - -```ts -withDisabled(value) -``` - -Disabled transformations are skipped - -### fn withFilter - -```ts -withFilter(value) -``` - - - -### fn withFilterMixin - -```ts -withFilterMixin(value) -``` - - - -### fn withId - -```ts -withId(value) -``` - -Unique identifier of transformer - -### fn withOptions - -```ts -withOptions(value) -``` - -Options to be passed to the transformer -Valid options depend on the transformer id - -### obj filter - - -#### fn filter.withId - -```ts -withId(value="") -``` - - - -#### fn filter.withOptions - -```ts -withOptions(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/heatmap/valueMapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/heatmap/valueMapping.md deleted file mode 100644 index a6bbdb3..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/heatmap/valueMapping.md +++ /dev/null @@ -1,365 +0,0 @@ -# valueMapping - - - -## Index - -* [`obj RangeMap`](#obj-rangemap) - * [`fn withOptions(value)`](#fn-rangemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) - * [`obj options`](#obj-rangemapoptions) - * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) - * [`fn withResult(value)`](#fn-rangemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) - * [`fn withTo(value)`](#fn-rangemapoptionswithto) - * [`obj result`](#obj-rangemapoptionsresult) - * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) -* [`obj RegexMap`](#obj-regexmap) - * [`fn withOptions(value)`](#fn-regexmapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) - * [`obj options`](#obj-regexmapoptions) - * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) - * [`fn withResult(value)`](#fn-regexmapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) - * [`obj result`](#obj-regexmapoptionsresult) - * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) - * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) -* [`obj SpecialValueMap`](#obj-specialvaluemap) - * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) - * [`obj options`](#obj-specialvaluemapoptions) - * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) - * [`fn withPattern(value)`](#fn-specialvaluemapoptionswithpattern) - * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) - * [`obj result`](#obj-specialvaluemapoptionsresult) - * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) -* [`obj ValueMap`](#obj-valuemap) - * [`fn withOptions(value)`](#fn-valuemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) - -## Fields - -### obj RangeMap - - -#### fn RangeMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RangeMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RangeMap.withType - -```ts -withType(value) -``` - - - -#### obj RangeMap.options - - -##### fn RangeMap.options.withFrom - -```ts -withFrom(value) -``` - -to and from are `number | null` in current ts, really not sure what to do - -##### fn RangeMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RangeMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### fn RangeMap.options.withTo - -```ts -withTo(value) -``` - - - -##### obj RangeMap.options.result - - -###### fn RangeMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RangeMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RangeMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RangeMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj RegexMap - - -#### fn RegexMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RegexMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RegexMap.withType - -```ts -withType(value) -``` - - - -#### obj RegexMap.options - - -##### fn RegexMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn RegexMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RegexMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj RegexMap.options.result - - -###### fn RegexMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RegexMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RegexMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RegexMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj SpecialValueMap - - -#### fn SpecialValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn SpecialValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn SpecialValueMap.withType - -```ts -withType(value) -``` - - - -#### obj SpecialValueMap.options - - -##### fn SpecialValueMap.options.withMatch - -```ts -withMatch(value) -``` - - - -Accepted values for `value` are "true", "false" - -##### fn SpecialValueMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn SpecialValueMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn SpecialValueMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj SpecialValueMap.options.result - - -###### fn SpecialValueMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn SpecialValueMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn SpecialValueMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn SpecialValueMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj ValueMap - - -#### fn ValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn ValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn ValueMap.withType - -```ts -withType(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/histogram/fieldOverride.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/histogram/fieldOverride.md deleted file mode 100644 index 3e2667b..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/histogram/fieldOverride.md +++ /dev/null @@ -1,194 +0,0 @@ -# fieldOverride - -Overrides allow you to customize visualization settings for specific fields or -series. This is accomplished by adding an override rule that targets -a particular set of fields and that can each define multiple options. - -```jsonnet -fieldOverride.byType.new('number') -+ fieldOverride.byType.withPropertiesFromOptions( - panel.standardOptions.withDecimals(2) - + panel.standardOptions.withUnit('s') -) -``` - - -## Index - -* [`obj byName`](#obj-byname) - * [`fn new(value)`](#fn-bynamenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bynamewithproperty) -* [`obj byQuery`](#obj-byquery) - * [`fn new(value)`](#fn-byquerynew) - * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byquerywithproperty) -* [`obj byRegexp`](#obj-byregexp) - * [`fn new(value)`](#fn-byregexpnew) - * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) -* [`obj byType`](#obj-bytype) - * [`fn new(value)`](#fn-bytypenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bytypewithproperty) -* [`obj byValue`](#obj-byvalue) - * [`fn new(value)`](#fn-byvaluenew) - * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) - -## Fields - -### obj byName - - -#### fn byName.new - -```ts -new(value) -``` - -`new` creates a new override of type `byName`. - -#### fn byName.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byName.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byQuery - - -#### fn byQuery.new - -```ts -new(value) -``` - -`new` creates a new override of type `byQuery`. - -#### fn byQuery.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byQuery.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byRegexp - - -#### fn byRegexp.new - -```ts -new(value) -``` - -`new` creates a new override of type `byRegexp`. - -#### fn byRegexp.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byRegexp.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byType - - -#### fn byType.new - -```ts -new(value) -``` - -`new` creates a new override of type `byType`. - -#### fn byType.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byType.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byValue - - -#### fn byValue.new - -```ts -new(value) -``` - -`new` creates a new override of type `byValue`. - -#### fn byValue.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byValue.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/histogram/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/histogram/index.md deleted file mode 100644 index fc3218d..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/histogram/index.md +++ /dev/null @@ -1,874 +0,0 @@ -# histogram - -grafonnet.panel.histogram - -## Subpackages - -* [fieldOverride](fieldOverride.md) -* [link](link.md) -* [thresholdStep](thresholdStep.md) -* [transformation](transformation.md) -* [valueMapping](valueMapping.md) - -## Index - -* [`fn new(title)`](#fn-new) -* [`obj datasource`](#obj-datasource) - * [`fn withType(value)`](#fn-datasourcewithtype) - * [`fn withUid(value)`](#fn-datasourcewithuid) -* [`obj fieldConfig`](#obj-fieldconfig) - * [`obj defaults`](#obj-fieldconfigdefaults) - * [`obj custom`](#obj-fieldconfigdefaultscustom) - * [`fn withAxisCenteredZero(value)`](#fn-fieldconfigdefaultscustomwithaxiscenteredzero) - * [`fn withAxisColorMode(value)`](#fn-fieldconfigdefaultscustomwithaxiscolormode) - * [`fn withAxisGridShow(value)`](#fn-fieldconfigdefaultscustomwithaxisgridshow) - * [`fn withAxisLabel(value)`](#fn-fieldconfigdefaultscustomwithaxislabel) - * [`fn withAxisPlacement(value)`](#fn-fieldconfigdefaultscustomwithaxisplacement) - * [`fn withAxisSoftMax(value)`](#fn-fieldconfigdefaultscustomwithaxissoftmax) - * [`fn withAxisSoftMin(value)`](#fn-fieldconfigdefaultscustomwithaxissoftmin) - * [`fn withAxisWidth(value)`](#fn-fieldconfigdefaultscustomwithaxiswidth) - * [`fn withFillOpacity(value=80)`](#fn-fieldconfigdefaultscustomwithfillopacity) - * [`fn withGradientMode(value)`](#fn-fieldconfigdefaultscustomwithgradientmode) - * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomwithhidefrom) - * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomwithhidefrommixin) - * [`fn withLineWidth(value=1)`](#fn-fieldconfigdefaultscustomwithlinewidth) - * [`fn withScaleDistribution(value)`](#fn-fieldconfigdefaultscustomwithscaledistribution) - * [`fn withScaleDistributionMixin(value)`](#fn-fieldconfigdefaultscustomwithscaledistributionmixin) - * [`obj hideFrom`](#obj-fieldconfigdefaultscustomhidefrom) - * [`fn withLegend(value)`](#fn-fieldconfigdefaultscustomhidefromwithlegend) - * [`fn withTooltip(value)`](#fn-fieldconfigdefaultscustomhidefromwithtooltip) - * [`fn withViz(value)`](#fn-fieldconfigdefaultscustomhidefromwithviz) - * [`obj scaleDistribution`](#obj-fieldconfigdefaultscustomscaledistribution) - * [`fn withLinearThreshold(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlinearthreshold) - * [`fn withLog(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlog) - * [`fn withType(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithtype) -* [`obj gridPos`](#obj-gridpos) - * [`fn withH(value=9)`](#fn-gridposwithh) - * [`fn withStatic(value)`](#fn-gridposwithstatic) - * [`fn withW(value=12)`](#fn-gridposwithw) - * [`fn withX(value=0)`](#fn-gridposwithx) - * [`fn withY(value=0)`](#fn-gridposwithy) -* [`obj libraryPanel`](#obj-librarypanel) - * [`fn withName(value)`](#fn-librarypanelwithname) - * [`fn withUid(value)`](#fn-librarypanelwithuid) -* [`obj options`](#obj-options) - * [`fn withBucketOffset(value=0)`](#fn-optionswithbucketoffset) - * [`fn withBucketSize(value)`](#fn-optionswithbucketsize) - * [`fn withCombine(value)`](#fn-optionswithcombine) - * [`fn withLegend(value)`](#fn-optionswithlegend) - * [`fn withLegendMixin(value)`](#fn-optionswithlegendmixin) - * [`fn withTooltip(value)`](#fn-optionswithtooltip) - * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) - * [`obj legend`](#obj-optionslegend) - * [`fn withAsTable(value)`](#fn-optionslegendwithastable) - * [`fn withCalcs(value)`](#fn-optionslegendwithcalcs) - * [`fn withCalcsMixin(value)`](#fn-optionslegendwithcalcsmixin) - * [`fn withDisplayMode(value)`](#fn-optionslegendwithdisplaymode) - * [`fn withIsVisible(value)`](#fn-optionslegendwithisvisible) - * [`fn withPlacement(value)`](#fn-optionslegendwithplacement) - * [`fn withShowLegend(value)`](#fn-optionslegendwithshowlegend) - * [`fn withSortBy(value)`](#fn-optionslegendwithsortby) - * [`fn withSortDesc(value)`](#fn-optionslegendwithsortdesc) - * [`fn withWidth(value)`](#fn-optionslegendwithwidth) - * [`obj tooltip`](#obj-optionstooltip) - * [`fn withMode(value)`](#fn-optionstooltipwithmode) - * [`fn withSort(value)`](#fn-optionstooltipwithsort) -* [`obj panelOptions`](#obj-paneloptions) - * [`fn withDescription(value)`](#fn-paneloptionswithdescription) - * [`fn withLinks(value)`](#fn-paneloptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) - * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) - * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) - * [`fn withTitle(value)`](#fn-paneloptionswithtitle) - * [`fn withTransparent(value=false)`](#fn-paneloptionswithtransparent) -* [`obj queryOptions`](#obj-queryoptions) - * [`fn withDatasource(value)`](#fn-queryoptionswithdatasource) - * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) - * [`fn withInterval(value)`](#fn-queryoptionswithinterval) - * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) - * [`fn withTargets(value)`](#fn-queryoptionswithtargets) - * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) - * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) - * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) - * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) - * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) -* [`obj standardOptions`](#obj-standardoptions) - * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) - * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) - * [`fn withLinks(value)`](#fn-standardoptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) - * [`fn withMappings(value)`](#fn-standardoptionswithmappings) - * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) - * [`fn withMax(value)`](#fn-standardoptionswithmax) - * [`fn withMin(value)`](#fn-standardoptionswithmin) - * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) - * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) - * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) - * [`fn withUnit(value)`](#fn-standardoptionswithunit) - * [`obj color`](#obj-standardoptionscolor) - * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) - * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) - * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) - * [`obj thresholds`](#obj-standardoptionsthresholds) - * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) - * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) - * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) - -## Fields - -### fn new - -```ts -new(title) -``` - -Creates a new histogram panel with a title. - -### obj datasource - - -#### fn datasource.withType - -```ts -withType(value) -``` - - - -#### fn datasource.withUid - -```ts -withUid(value) -``` - - - -### obj fieldConfig - - -#### obj fieldConfig.defaults - - -##### obj fieldConfig.defaults.custom - - -###### fn fieldConfig.defaults.custom.withAxisCenteredZero - -```ts -withAxisCenteredZero(value) -``` - - - -###### fn fieldConfig.defaults.custom.withAxisColorMode - -```ts -withAxisColorMode(value) -``` - -TODO docs - -Accepted values for `value` are "text", "series" - -###### fn fieldConfig.defaults.custom.withAxisGridShow - -```ts -withAxisGridShow(value) -``` - - - -###### fn fieldConfig.defaults.custom.withAxisLabel - -```ts -withAxisLabel(value) -``` - - - -###### fn fieldConfig.defaults.custom.withAxisPlacement - -```ts -withAxisPlacement(value) -``` - -TODO docs - -Accepted values for `value` are "auto", "top", "right", "bottom", "left", "hidden" - -###### fn fieldConfig.defaults.custom.withAxisSoftMax - -```ts -withAxisSoftMax(value) -``` - - - -###### fn fieldConfig.defaults.custom.withAxisSoftMin - -```ts -withAxisSoftMin(value) -``` - - - -###### fn fieldConfig.defaults.custom.withAxisWidth - -```ts -withAxisWidth(value) -``` - - - -###### fn fieldConfig.defaults.custom.withFillOpacity - -```ts -withFillOpacity(value=80) -``` - -Controls the fill opacity of the bars. - -###### fn fieldConfig.defaults.custom.withGradientMode - -```ts -withGradientMode(value) -``` - -Set the mode of the gradient fill. Fill gradient is based on the line color. To change the color, use the standard color scheme field option. -Gradient appearance is influenced by the Fill opacity setting. - -###### fn fieldConfig.defaults.custom.withHideFrom - -```ts -withHideFrom(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withHideFromMixin - -```ts -withHideFromMixin(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withLineWidth - -```ts -withLineWidth(value=1) -``` - -Controls line width of the bars. - -###### fn fieldConfig.defaults.custom.withScaleDistribution - -```ts -withScaleDistribution(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withScaleDistributionMixin - -```ts -withScaleDistributionMixin(value) -``` - -TODO docs - -###### obj fieldConfig.defaults.custom.hideFrom - - -####### fn fieldConfig.defaults.custom.hideFrom.withLegend - -```ts -withLegend(value) -``` - - - -####### fn fieldConfig.defaults.custom.hideFrom.withTooltip - -```ts -withTooltip(value) -``` - - - -####### fn fieldConfig.defaults.custom.hideFrom.withViz - -```ts -withViz(value) -``` - - - -###### obj fieldConfig.defaults.custom.scaleDistribution - - -####### fn fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold - -```ts -withLinearThreshold(value) -``` - - - -####### fn fieldConfig.defaults.custom.scaleDistribution.withLog - -```ts -withLog(value) -``` - - - -####### fn fieldConfig.defaults.custom.scaleDistribution.withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "linear", "log", "ordinal", "symlog" - -### obj gridPos - - -#### fn gridPos.withH - -```ts -withH(value=9) -``` - -Panel - -#### fn gridPos.withStatic - -```ts -withStatic(value) -``` - -true if fixed - -#### fn gridPos.withW - -```ts -withW(value=12) -``` - -Panel - -#### fn gridPos.withX - -```ts -withX(value=0) -``` - -Panel x - -#### fn gridPos.withY - -```ts -withY(value=0) -``` - -Panel y - -### obj libraryPanel - - -#### fn libraryPanel.withName - -```ts -withName(value) -``` - - - -#### fn libraryPanel.withUid - -```ts -withUid(value) -``` - - - -### obj options - - -#### fn options.withBucketOffset - -```ts -withBucketOffset(value=0) -``` - -Offset buckets by this amount - -#### fn options.withBucketSize - -```ts -withBucketSize(value) -``` - -Size of each bucket - -#### fn options.withCombine - -```ts -withCombine(value) -``` - -Combines multiple series into a single histogram - -#### fn options.withLegend - -```ts -withLegend(value) -``` - -TODO docs - -#### fn options.withLegendMixin - -```ts -withLegendMixin(value) -``` - -TODO docs - -#### fn options.withTooltip - -```ts -withTooltip(value) -``` - -TODO docs - -#### fn options.withTooltipMixin - -```ts -withTooltipMixin(value) -``` - -TODO docs - -#### obj options.legend - - -##### fn options.legend.withAsTable - -```ts -withAsTable(value) -``` - - - -##### fn options.legend.withCalcs - -```ts -withCalcs(value) -``` - - - -##### fn options.legend.withCalcsMixin - -```ts -withCalcsMixin(value) -``` - - - -##### fn options.legend.withDisplayMode - -```ts -withDisplayMode(value) -``` - -TODO docs -Note: "hidden" needs to remain as an option for plugins compatibility - -Accepted values for `value` are "list", "table", "hidden" - -##### fn options.legend.withIsVisible - -```ts -withIsVisible(value) -``` - - - -##### fn options.legend.withPlacement - -```ts -withPlacement(value) -``` - -TODO docs - -Accepted values for `value` are "bottom", "right" - -##### fn options.legend.withShowLegend - -```ts -withShowLegend(value) -``` - - - -##### fn options.legend.withSortBy - -```ts -withSortBy(value) -``` - - - -##### fn options.legend.withSortDesc - -```ts -withSortDesc(value) -``` - - - -##### fn options.legend.withWidth - -```ts -withWidth(value) -``` - - - -#### obj options.tooltip - - -##### fn options.tooltip.withMode - -```ts -withMode(value) -``` - -TODO docs - -Accepted values for `value` are "single", "multi", "none" - -##### fn options.tooltip.withSort - -```ts -withSort(value) -``` - -TODO docs - -Accepted values for `value` are "asc", "desc", "none" - -### obj panelOptions - - -#### fn panelOptions.withDescription - -```ts -withDescription(value) -``` - -Description. - -#### fn panelOptions.withLinks - -```ts -withLinks(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withRepeat - -```ts -withRepeat(value) -``` - -Name of template variable to repeat for. - -#### fn panelOptions.withRepeatDirection - -```ts -withRepeatDirection(value="h") -``` - -Direction to repeat in if 'repeat' is set. -"h" for horizontal, "v" for vertical. -TODO this is probably optional - -Accepted values for `value` are "h", "v" - -#### fn panelOptions.withTitle - -```ts -withTitle(value) -``` - -Panel title. - -#### fn panelOptions.withTransparent - -```ts -withTransparent(value=false) -``` - -Whether to display the panel without a background. - -### obj queryOptions - - -#### fn queryOptions.withDatasource - -```ts -withDatasource(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withDatasourceMixin - -```ts -withDatasourceMixin(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withInterval - -```ts -withInterval(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withMaxDataPoints - -```ts -withMaxDataPoints(value) -``` - -TODO docs - -#### fn queryOptions.withTargets - -```ts -withTargets(value) -``` - -TODO docs - -#### fn queryOptions.withTargetsMixin - -```ts -withTargetsMixin(value) -``` - -TODO docs - -#### fn queryOptions.withTimeFrom - -```ts -withTimeFrom(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTimeShift - -```ts -withTimeShift(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTransformations - -```ts -withTransformations(value) -``` - - - -#### fn queryOptions.withTransformationsMixin - -```ts -withTransformationsMixin(value) -``` - - - -### obj standardOptions - - -#### fn standardOptions.withDecimals - -```ts -withDecimals(value) -``` - -Significant digits (for display) - -#### fn standardOptions.withDisplayName - -```ts -withDisplayName(value) -``` - -The display value for this field. This supports template variables blank is auto - -#### fn standardOptions.withLinks - -```ts -withLinks(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withMappings - -```ts -withMappings(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMappingsMixin - -```ts -withMappingsMixin(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMax - -```ts -withMax(value) -``` - - - -#### fn standardOptions.withMin - -```ts -withMin(value) -``` - - - -#### fn standardOptions.withNoValue - -```ts -withNoValue(value) -``` - -Alternative to empty string - -#### fn standardOptions.withOverrides - -```ts -withOverrides(value) -``` - - - -#### fn standardOptions.withOverridesMixin - -```ts -withOverridesMixin(value) -``` - - - -#### fn standardOptions.withUnit - -```ts -withUnit(value) -``` - -Numeric Options - -#### obj standardOptions.color - - -##### fn standardOptions.color.withFixedColor - -```ts -withFixedColor(value) -``` - -Stores the fixed color value if mode is fixed - -##### fn standardOptions.color.withMode - -```ts -withMode(value) -``` - -The main color scheme mode - -##### fn standardOptions.color.withSeriesBy - -```ts -withSeriesBy(value) -``` - -TODO docs - -Accepted values for `value` are "min", "max", "last" - -#### obj standardOptions.thresholds - - -##### fn standardOptions.thresholds.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "absolute", "percentage" - -##### fn standardOptions.thresholds.withSteps - -```ts -withSteps(value) -``` - -Must be sorted by 'value', first value is always -Infinity - -##### fn standardOptions.thresholds.withStepsMixin - -```ts -withStepsMixin(value) -``` - -Must be sorted by 'value', first value is always -Infinity diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/histogram/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/histogram/link.md deleted file mode 100644 index 1a1d7c4..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/histogram/link.md +++ /dev/null @@ -1,109 +0,0 @@ -# link - - - -## Index - -* [`fn withAsDropdown(value=false)`](#fn-withasdropdown) -* [`fn withIcon(value)`](#fn-withicon) -* [`fn withIncludeVars(value=false)`](#fn-withincludevars) -* [`fn withKeepTime(value=false)`](#fn-withkeeptime) -* [`fn withTags(value)`](#fn-withtags) -* [`fn withTagsMixin(value)`](#fn-withtagsmixin) -* [`fn withTargetBlank(value=false)`](#fn-withtargetblank) -* [`fn withTitle(value)`](#fn-withtitle) -* [`fn withTooltip(value)`](#fn-withtooltip) -* [`fn withType(value)`](#fn-withtype) -* [`fn withUrl(value)`](#fn-withurl) - -## Fields - -### fn withAsDropdown - -```ts -withAsDropdown(value=false) -``` - - - -### fn withIcon - -```ts -withIcon(value) -``` - - - -### fn withIncludeVars - -```ts -withIncludeVars(value=false) -``` - - - -### fn withKeepTime - -```ts -withKeepTime(value=false) -``` - - - -### fn withTags - -```ts -withTags(value) -``` - - - -### fn withTagsMixin - -```ts -withTagsMixin(value) -``` - - - -### fn withTargetBlank - -```ts -withTargetBlank(value=false) -``` - - - -### fn withTitle - -```ts -withTitle(value) -``` - - - -### fn withTooltip - -```ts -withTooltip(value) -``` - - - -### fn withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "link", "dashboards" - -### fn withUrl - -```ts -withUrl(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/histogram/thresholdStep.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/histogram/thresholdStep.md deleted file mode 100644 index 9d6af42..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/histogram/thresholdStep.md +++ /dev/null @@ -1,47 +0,0 @@ -# thresholdStep - - - -## Index - -* [`fn withColor(value)`](#fn-withcolor) -* [`fn withIndex(value)`](#fn-withindex) -* [`fn withState(value)`](#fn-withstate) -* [`fn withValue(value)`](#fn-withvalue) - -## Fields - -### fn withColor - -```ts -withColor(value) -``` - -TODO docs - -### fn withIndex - -```ts -withIndex(value) -``` - -Threshold index, an old property that is not needed an should only appear in older dashboards - -### fn withState - -```ts -withState(value) -``` - -TODO docs -TODO are the values here enumerable into a disjunction? -Some seem to be listed in typescript comment - -### fn withValue - -```ts -withValue(value) -``` - -TODO docs -FIXME the corresponding typescript field is required/non-optional, but nulls currently appear here when serializing -Infinity to JSON diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/histogram/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/histogram/transformation.md deleted file mode 100644 index 3dac7e9..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/histogram/transformation.md +++ /dev/null @@ -1,76 +0,0 @@ -# transformation - - - -## Index - -* [`fn withDisabled(value)`](#fn-withdisabled) -* [`fn withFilter(value)`](#fn-withfilter) -* [`fn withFilterMixin(value)`](#fn-withfiltermixin) -* [`fn withId(value)`](#fn-withid) -* [`fn withOptions(value)`](#fn-withoptions) -* [`obj filter`](#obj-filter) - * [`fn withId(value="")`](#fn-filterwithid) - * [`fn withOptions(value)`](#fn-filterwithoptions) - -## Fields - -### fn withDisabled - -```ts -withDisabled(value) -``` - -Disabled transformations are skipped - -### fn withFilter - -```ts -withFilter(value) -``` - - - -### fn withFilterMixin - -```ts -withFilterMixin(value) -``` - - - -### fn withId - -```ts -withId(value) -``` - -Unique identifier of transformer - -### fn withOptions - -```ts -withOptions(value) -``` - -Options to be passed to the transformer -Valid options depend on the transformer id - -### obj filter - - -#### fn filter.withId - -```ts -withId(value="") -``` - - - -#### fn filter.withOptions - -```ts -withOptions(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/histogram/valueMapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/histogram/valueMapping.md deleted file mode 100644 index a6bbdb3..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/histogram/valueMapping.md +++ /dev/null @@ -1,365 +0,0 @@ -# valueMapping - - - -## Index - -* [`obj RangeMap`](#obj-rangemap) - * [`fn withOptions(value)`](#fn-rangemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) - * [`obj options`](#obj-rangemapoptions) - * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) - * [`fn withResult(value)`](#fn-rangemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) - * [`fn withTo(value)`](#fn-rangemapoptionswithto) - * [`obj result`](#obj-rangemapoptionsresult) - * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) -* [`obj RegexMap`](#obj-regexmap) - * [`fn withOptions(value)`](#fn-regexmapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) - * [`obj options`](#obj-regexmapoptions) - * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) - * [`fn withResult(value)`](#fn-regexmapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) - * [`obj result`](#obj-regexmapoptionsresult) - * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) - * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) -* [`obj SpecialValueMap`](#obj-specialvaluemap) - * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) - * [`obj options`](#obj-specialvaluemapoptions) - * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) - * [`fn withPattern(value)`](#fn-specialvaluemapoptionswithpattern) - * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) - * [`obj result`](#obj-specialvaluemapoptionsresult) - * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) -* [`obj ValueMap`](#obj-valuemap) - * [`fn withOptions(value)`](#fn-valuemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) - -## Fields - -### obj RangeMap - - -#### fn RangeMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RangeMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RangeMap.withType - -```ts -withType(value) -``` - - - -#### obj RangeMap.options - - -##### fn RangeMap.options.withFrom - -```ts -withFrom(value) -``` - -to and from are `number | null` in current ts, really not sure what to do - -##### fn RangeMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RangeMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### fn RangeMap.options.withTo - -```ts -withTo(value) -``` - - - -##### obj RangeMap.options.result - - -###### fn RangeMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RangeMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RangeMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RangeMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj RegexMap - - -#### fn RegexMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RegexMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RegexMap.withType - -```ts -withType(value) -``` - - - -#### obj RegexMap.options - - -##### fn RegexMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn RegexMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RegexMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj RegexMap.options.result - - -###### fn RegexMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RegexMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RegexMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RegexMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj SpecialValueMap - - -#### fn SpecialValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn SpecialValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn SpecialValueMap.withType - -```ts -withType(value) -``` - - - -#### obj SpecialValueMap.options - - -##### fn SpecialValueMap.options.withMatch - -```ts -withMatch(value) -``` - - - -Accepted values for `value` are "true", "false" - -##### fn SpecialValueMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn SpecialValueMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn SpecialValueMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj SpecialValueMap.options.result - - -###### fn SpecialValueMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn SpecialValueMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn SpecialValueMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn SpecialValueMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj ValueMap - - -#### fn ValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn ValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn ValueMap.withType - -```ts -withType(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/index.md deleted file mode 100644 index be9bac0..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/index.md +++ /dev/null @@ -1,33 +0,0 @@ -# panel - -grafonnet.panel - -## Subpackages - -* [alertGroups](alertGroups/index.md) -* [annotationsList](annotationsList/index.md) -* [barChart](barChart/index.md) -* [barGauge](barGauge/index.md) -* [candlestick](candlestick/index.md) -* [canvas](canvas/index.md) -* [dashboardList](dashboardList/index.md) -* [datagrid](datagrid/index.md) -* [debug](debug/index.md) -* [gauge](gauge/index.md) -* [geomap](geomap/index.md) -* [heatmap](heatmap/index.md) -* [histogram](histogram/index.md) -* [logs](logs/index.md) -* [news](news/index.md) -* [nodeGraph](nodeGraph/index.md) -* [pieChart](pieChart/index.md) -* [row](row.md) -* [stat](stat/index.md) -* [stateTimeline](stateTimeline/index.md) -* [statusHistory](statusHistory/index.md) -* [table](table/index.md) -* [text](text/index.md) -* [timeSeries](timeSeries/index.md) -* [trend](trend/index.md) -* [xyChart](xyChart/index.md) - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/logs/fieldOverride.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/logs/fieldOverride.md deleted file mode 100644 index 3e2667b..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/logs/fieldOverride.md +++ /dev/null @@ -1,194 +0,0 @@ -# fieldOverride - -Overrides allow you to customize visualization settings for specific fields or -series. This is accomplished by adding an override rule that targets -a particular set of fields and that can each define multiple options. - -```jsonnet -fieldOverride.byType.new('number') -+ fieldOverride.byType.withPropertiesFromOptions( - panel.standardOptions.withDecimals(2) - + panel.standardOptions.withUnit('s') -) -``` - - -## Index - -* [`obj byName`](#obj-byname) - * [`fn new(value)`](#fn-bynamenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bynamewithproperty) -* [`obj byQuery`](#obj-byquery) - * [`fn new(value)`](#fn-byquerynew) - * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byquerywithproperty) -* [`obj byRegexp`](#obj-byregexp) - * [`fn new(value)`](#fn-byregexpnew) - * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) -* [`obj byType`](#obj-bytype) - * [`fn new(value)`](#fn-bytypenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bytypewithproperty) -* [`obj byValue`](#obj-byvalue) - * [`fn new(value)`](#fn-byvaluenew) - * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) - -## Fields - -### obj byName - - -#### fn byName.new - -```ts -new(value) -``` - -`new` creates a new override of type `byName`. - -#### fn byName.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byName.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byQuery - - -#### fn byQuery.new - -```ts -new(value) -``` - -`new` creates a new override of type `byQuery`. - -#### fn byQuery.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byQuery.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byRegexp - - -#### fn byRegexp.new - -```ts -new(value) -``` - -`new` creates a new override of type `byRegexp`. - -#### fn byRegexp.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byRegexp.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byType - - -#### fn byType.new - -```ts -new(value) -``` - -`new` creates a new override of type `byType`. - -#### fn byType.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byType.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byValue - - -#### fn byValue.new - -```ts -new(value) -``` - -`new` creates a new override of type `byValue`. - -#### fn byValue.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byValue.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/logs/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/logs/index.md deleted file mode 100644 index eb4916a..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/logs/index.md +++ /dev/null @@ -1,546 +0,0 @@ -# logs - -grafonnet.panel.logs - -## Subpackages - -* [fieldOverride](fieldOverride.md) -* [link](link.md) -* [thresholdStep](thresholdStep.md) -* [transformation](transformation.md) -* [valueMapping](valueMapping.md) - -## Index - -* [`fn new(title)`](#fn-new) -* [`obj datasource`](#obj-datasource) - * [`fn withType(value)`](#fn-datasourcewithtype) - * [`fn withUid(value)`](#fn-datasourcewithuid) -* [`obj gridPos`](#obj-gridpos) - * [`fn withH(value=9)`](#fn-gridposwithh) - * [`fn withStatic(value)`](#fn-gridposwithstatic) - * [`fn withW(value=12)`](#fn-gridposwithw) - * [`fn withX(value=0)`](#fn-gridposwithx) - * [`fn withY(value=0)`](#fn-gridposwithy) -* [`obj libraryPanel`](#obj-librarypanel) - * [`fn withName(value)`](#fn-librarypanelwithname) - * [`fn withUid(value)`](#fn-librarypanelwithuid) -* [`obj options`](#obj-options) - * [`fn withDedupStrategy(value)`](#fn-optionswithdedupstrategy) - * [`fn withEnableLogDetails(value)`](#fn-optionswithenablelogdetails) - * [`fn withPrettifyLogMessage(value)`](#fn-optionswithprettifylogmessage) - * [`fn withShowCommonLabels(value)`](#fn-optionswithshowcommonlabels) - * [`fn withShowLabels(value)`](#fn-optionswithshowlabels) - * [`fn withShowTime(value)`](#fn-optionswithshowtime) - * [`fn withSortOrder(value)`](#fn-optionswithsortorder) - * [`fn withWrapLogMessage(value)`](#fn-optionswithwraplogmessage) -* [`obj panelOptions`](#obj-paneloptions) - * [`fn withDescription(value)`](#fn-paneloptionswithdescription) - * [`fn withLinks(value)`](#fn-paneloptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) - * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) - * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) - * [`fn withTitle(value)`](#fn-paneloptionswithtitle) - * [`fn withTransparent(value=false)`](#fn-paneloptionswithtransparent) -* [`obj queryOptions`](#obj-queryoptions) - * [`fn withDatasource(value)`](#fn-queryoptionswithdatasource) - * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) - * [`fn withInterval(value)`](#fn-queryoptionswithinterval) - * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) - * [`fn withTargets(value)`](#fn-queryoptionswithtargets) - * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) - * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) - * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) - * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) - * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) -* [`obj standardOptions`](#obj-standardoptions) - * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) - * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) - * [`fn withLinks(value)`](#fn-standardoptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) - * [`fn withMappings(value)`](#fn-standardoptionswithmappings) - * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) - * [`fn withMax(value)`](#fn-standardoptionswithmax) - * [`fn withMin(value)`](#fn-standardoptionswithmin) - * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) - * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) - * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) - * [`fn withUnit(value)`](#fn-standardoptionswithunit) - * [`obj color`](#obj-standardoptionscolor) - * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) - * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) - * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) - * [`obj thresholds`](#obj-standardoptionsthresholds) - * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) - * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) - * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) - -## Fields - -### fn new - -```ts -new(title) -``` - -Creates a new logs panel with a title. - -### obj datasource - - -#### fn datasource.withType - -```ts -withType(value) -``` - - - -#### fn datasource.withUid - -```ts -withUid(value) -``` - - - -### obj gridPos - - -#### fn gridPos.withH - -```ts -withH(value=9) -``` - -Panel - -#### fn gridPos.withStatic - -```ts -withStatic(value) -``` - -true if fixed - -#### fn gridPos.withW - -```ts -withW(value=12) -``` - -Panel - -#### fn gridPos.withX - -```ts -withX(value=0) -``` - -Panel x - -#### fn gridPos.withY - -```ts -withY(value=0) -``` - -Panel y - -### obj libraryPanel - - -#### fn libraryPanel.withName - -```ts -withName(value) -``` - - - -#### fn libraryPanel.withUid - -```ts -withUid(value) -``` - - - -### obj options - - -#### fn options.withDedupStrategy - -```ts -withDedupStrategy(value) -``` - - - -Accepted values for `value` are "none", "exact", "numbers", "signature" - -#### fn options.withEnableLogDetails - -```ts -withEnableLogDetails(value) -``` - - - -#### fn options.withPrettifyLogMessage - -```ts -withPrettifyLogMessage(value) -``` - - - -#### fn options.withShowCommonLabels - -```ts -withShowCommonLabels(value) -``` - - - -#### fn options.withShowLabels - -```ts -withShowLabels(value) -``` - - - -#### fn options.withShowTime - -```ts -withShowTime(value) -``` - - - -#### fn options.withSortOrder - -```ts -withSortOrder(value) -``` - - - -Accepted values for `value` are "Descending", "Ascending" - -#### fn options.withWrapLogMessage - -```ts -withWrapLogMessage(value) -``` - - - -### obj panelOptions - - -#### fn panelOptions.withDescription - -```ts -withDescription(value) -``` - -Description. - -#### fn panelOptions.withLinks - -```ts -withLinks(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withRepeat - -```ts -withRepeat(value) -``` - -Name of template variable to repeat for. - -#### fn panelOptions.withRepeatDirection - -```ts -withRepeatDirection(value="h") -``` - -Direction to repeat in if 'repeat' is set. -"h" for horizontal, "v" for vertical. -TODO this is probably optional - -Accepted values for `value` are "h", "v" - -#### fn panelOptions.withTitle - -```ts -withTitle(value) -``` - -Panel title. - -#### fn panelOptions.withTransparent - -```ts -withTransparent(value=false) -``` - -Whether to display the panel without a background. - -### obj queryOptions - - -#### fn queryOptions.withDatasource - -```ts -withDatasource(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withDatasourceMixin - -```ts -withDatasourceMixin(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withInterval - -```ts -withInterval(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withMaxDataPoints - -```ts -withMaxDataPoints(value) -``` - -TODO docs - -#### fn queryOptions.withTargets - -```ts -withTargets(value) -``` - -TODO docs - -#### fn queryOptions.withTargetsMixin - -```ts -withTargetsMixin(value) -``` - -TODO docs - -#### fn queryOptions.withTimeFrom - -```ts -withTimeFrom(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTimeShift - -```ts -withTimeShift(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTransformations - -```ts -withTransformations(value) -``` - - - -#### fn queryOptions.withTransformationsMixin - -```ts -withTransformationsMixin(value) -``` - - - -### obj standardOptions - - -#### fn standardOptions.withDecimals - -```ts -withDecimals(value) -``` - -Significant digits (for display) - -#### fn standardOptions.withDisplayName - -```ts -withDisplayName(value) -``` - -The display value for this field. This supports template variables blank is auto - -#### fn standardOptions.withLinks - -```ts -withLinks(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withMappings - -```ts -withMappings(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMappingsMixin - -```ts -withMappingsMixin(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMax - -```ts -withMax(value) -``` - - - -#### fn standardOptions.withMin - -```ts -withMin(value) -``` - - - -#### fn standardOptions.withNoValue - -```ts -withNoValue(value) -``` - -Alternative to empty string - -#### fn standardOptions.withOverrides - -```ts -withOverrides(value) -``` - - - -#### fn standardOptions.withOverridesMixin - -```ts -withOverridesMixin(value) -``` - - - -#### fn standardOptions.withUnit - -```ts -withUnit(value) -``` - -Numeric Options - -#### obj standardOptions.color - - -##### fn standardOptions.color.withFixedColor - -```ts -withFixedColor(value) -``` - -Stores the fixed color value if mode is fixed - -##### fn standardOptions.color.withMode - -```ts -withMode(value) -``` - -The main color scheme mode - -##### fn standardOptions.color.withSeriesBy - -```ts -withSeriesBy(value) -``` - -TODO docs - -Accepted values for `value` are "min", "max", "last" - -#### obj standardOptions.thresholds - - -##### fn standardOptions.thresholds.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "absolute", "percentage" - -##### fn standardOptions.thresholds.withSteps - -```ts -withSteps(value) -``` - -Must be sorted by 'value', first value is always -Infinity - -##### fn standardOptions.thresholds.withStepsMixin - -```ts -withStepsMixin(value) -``` - -Must be sorted by 'value', first value is always -Infinity diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/logs/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/logs/link.md deleted file mode 100644 index 1a1d7c4..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/logs/link.md +++ /dev/null @@ -1,109 +0,0 @@ -# link - - - -## Index - -* [`fn withAsDropdown(value=false)`](#fn-withasdropdown) -* [`fn withIcon(value)`](#fn-withicon) -* [`fn withIncludeVars(value=false)`](#fn-withincludevars) -* [`fn withKeepTime(value=false)`](#fn-withkeeptime) -* [`fn withTags(value)`](#fn-withtags) -* [`fn withTagsMixin(value)`](#fn-withtagsmixin) -* [`fn withTargetBlank(value=false)`](#fn-withtargetblank) -* [`fn withTitle(value)`](#fn-withtitle) -* [`fn withTooltip(value)`](#fn-withtooltip) -* [`fn withType(value)`](#fn-withtype) -* [`fn withUrl(value)`](#fn-withurl) - -## Fields - -### fn withAsDropdown - -```ts -withAsDropdown(value=false) -``` - - - -### fn withIcon - -```ts -withIcon(value) -``` - - - -### fn withIncludeVars - -```ts -withIncludeVars(value=false) -``` - - - -### fn withKeepTime - -```ts -withKeepTime(value=false) -``` - - - -### fn withTags - -```ts -withTags(value) -``` - - - -### fn withTagsMixin - -```ts -withTagsMixin(value) -``` - - - -### fn withTargetBlank - -```ts -withTargetBlank(value=false) -``` - - - -### fn withTitle - -```ts -withTitle(value) -``` - - - -### fn withTooltip - -```ts -withTooltip(value) -``` - - - -### fn withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "link", "dashboards" - -### fn withUrl - -```ts -withUrl(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/logs/thresholdStep.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/logs/thresholdStep.md deleted file mode 100644 index 9d6af42..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/logs/thresholdStep.md +++ /dev/null @@ -1,47 +0,0 @@ -# thresholdStep - - - -## Index - -* [`fn withColor(value)`](#fn-withcolor) -* [`fn withIndex(value)`](#fn-withindex) -* [`fn withState(value)`](#fn-withstate) -* [`fn withValue(value)`](#fn-withvalue) - -## Fields - -### fn withColor - -```ts -withColor(value) -``` - -TODO docs - -### fn withIndex - -```ts -withIndex(value) -``` - -Threshold index, an old property that is not needed an should only appear in older dashboards - -### fn withState - -```ts -withState(value) -``` - -TODO docs -TODO are the values here enumerable into a disjunction? -Some seem to be listed in typescript comment - -### fn withValue - -```ts -withValue(value) -``` - -TODO docs -FIXME the corresponding typescript field is required/non-optional, but nulls currently appear here when serializing -Infinity to JSON diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/logs/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/logs/transformation.md deleted file mode 100644 index 3dac7e9..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/logs/transformation.md +++ /dev/null @@ -1,76 +0,0 @@ -# transformation - - - -## Index - -* [`fn withDisabled(value)`](#fn-withdisabled) -* [`fn withFilter(value)`](#fn-withfilter) -* [`fn withFilterMixin(value)`](#fn-withfiltermixin) -* [`fn withId(value)`](#fn-withid) -* [`fn withOptions(value)`](#fn-withoptions) -* [`obj filter`](#obj-filter) - * [`fn withId(value="")`](#fn-filterwithid) - * [`fn withOptions(value)`](#fn-filterwithoptions) - -## Fields - -### fn withDisabled - -```ts -withDisabled(value) -``` - -Disabled transformations are skipped - -### fn withFilter - -```ts -withFilter(value) -``` - - - -### fn withFilterMixin - -```ts -withFilterMixin(value) -``` - - - -### fn withId - -```ts -withId(value) -``` - -Unique identifier of transformer - -### fn withOptions - -```ts -withOptions(value) -``` - -Options to be passed to the transformer -Valid options depend on the transformer id - -### obj filter - - -#### fn filter.withId - -```ts -withId(value="") -``` - - - -#### fn filter.withOptions - -```ts -withOptions(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/logs/valueMapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/logs/valueMapping.md deleted file mode 100644 index a6bbdb3..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/logs/valueMapping.md +++ /dev/null @@ -1,365 +0,0 @@ -# valueMapping - - - -## Index - -* [`obj RangeMap`](#obj-rangemap) - * [`fn withOptions(value)`](#fn-rangemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) - * [`obj options`](#obj-rangemapoptions) - * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) - * [`fn withResult(value)`](#fn-rangemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) - * [`fn withTo(value)`](#fn-rangemapoptionswithto) - * [`obj result`](#obj-rangemapoptionsresult) - * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) -* [`obj RegexMap`](#obj-regexmap) - * [`fn withOptions(value)`](#fn-regexmapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) - * [`obj options`](#obj-regexmapoptions) - * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) - * [`fn withResult(value)`](#fn-regexmapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) - * [`obj result`](#obj-regexmapoptionsresult) - * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) - * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) -* [`obj SpecialValueMap`](#obj-specialvaluemap) - * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) - * [`obj options`](#obj-specialvaluemapoptions) - * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) - * [`fn withPattern(value)`](#fn-specialvaluemapoptionswithpattern) - * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) - * [`obj result`](#obj-specialvaluemapoptionsresult) - * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) -* [`obj ValueMap`](#obj-valuemap) - * [`fn withOptions(value)`](#fn-valuemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) - -## Fields - -### obj RangeMap - - -#### fn RangeMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RangeMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RangeMap.withType - -```ts -withType(value) -``` - - - -#### obj RangeMap.options - - -##### fn RangeMap.options.withFrom - -```ts -withFrom(value) -``` - -to and from are `number | null` in current ts, really not sure what to do - -##### fn RangeMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RangeMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### fn RangeMap.options.withTo - -```ts -withTo(value) -``` - - - -##### obj RangeMap.options.result - - -###### fn RangeMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RangeMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RangeMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RangeMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj RegexMap - - -#### fn RegexMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RegexMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RegexMap.withType - -```ts -withType(value) -``` - - - -#### obj RegexMap.options - - -##### fn RegexMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn RegexMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RegexMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj RegexMap.options.result - - -###### fn RegexMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RegexMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RegexMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RegexMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj SpecialValueMap - - -#### fn SpecialValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn SpecialValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn SpecialValueMap.withType - -```ts -withType(value) -``` - - - -#### obj SpecialValueMap.options - - -##### fn SpecialValueMap.options.withMatch - -```ts -withMatch(value) -``` - - - -Accepted values for `value` are "true", "false" - -##### fn SpecialValueMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn SpecialValueMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn SpecialValueMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj SpecialValueMap.options.result - - -###### fn SpecialValueMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn SpecialValueMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn SpecialValueMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn SpecialValueMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj ValueMap - - -#### fn ValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn ValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn ValueMap.withType - -```ts -withType(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/news/fieldOverride.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/news/fieldOverride.md deleted file mode 100644 index 3e2667b..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/news/fieldOverride.md +++ /dev/null @@ -1,194 +0,0 @@ -# fieldOverride - -Overrides allow you to customize visualization settings for specific fields or -series. This is accomplished by adding an override rule that targets -a particular set of fields and that can each define multiple options. - -```jsonnet -fieldOverride.byType.new('number') -+ fieldOverride.byType.withPropertiesFromOptions( - panel.standardOptions.withDecimals(2) - + panel.standardOptions.withUnit('s') -) -``` - - -## Index - -* [`obj byName`](#obj-byname) - * [`fn new(value)`](#fn-bynamenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bynamewithproperty) -* [`obj byQuery`](#obj-byquery) - * [`fn new(value)`](#fn-byquerynew) - * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byquerywithproperty) -* [`obj byRegexp`](#obj-byregexp) - * [`fn new(value)`](#fn-byregexpnew) - * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) -* [`obj byType`](#obj-bytype) - * [`fn new(value)`](#fn-bytypenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bytypewithproperty) -* [`obj byValue`](#obj-byvalue) - * [`fn new(value)`](#fn-byvaluenew) - * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) - -## Fields - -### obj byName - - -#### fn byName.new - -```ts -new(value) -``` - -`new` creates a new override of type `byName`. - -#### fn byName.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byName.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byQuery - - -#### fn byQuery.new - -```ts -new(value) -``` - -`new` creates a new override of type `byQuery`. - -#### fn byQuery.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byQuery.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byRegexp - - -#### fn byRegexp.new - -```ts -new(value) -``` - -`new` creates a new override of type `byRegexp`. - -#### fn byRegexp.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byRegexp.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byType - - -#### fn byType.new - -```ts -new(value) -``` - -`new` creates a new override of type `byType`. - -#### fn byType.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byType.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byValue - - -#### fn byValue.new - -```ts -new(value) -``` - -`new` creates a new override of type `byValue`. - -#### fn byValue.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byValue.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/news/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/news/index.md deleted file mode 100644 index daa046c..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/news/index.md +++ /dev/null @@ -1,488 +0,0 @@ -# news - -grafonnet.panel.news - -## Subpackages - -* [fieldOverride](fieldOverride.md) -* [link](link.md) -* [thresholdStep](thresholdStep.md) -* [transformation](transformation.md) -* [valueMapping](valueMapping.md) - -## Index - -* [`fn new(title)`](#fn-new) -* [`obj datasource`](#obj-datasource) - * [`fn withType(value)`](#fn-datasourcewithtype) - * [`fn withUid(value)`](#fn-datasourcewithuid) -* [`obj gridPos`](#obj-gridpos) - * [`fn withH(value=9)`](#fn-gridposwithh) - * [`fn withStatic(value)`](#fn-gridposwithstatic) - * [`fn withW(value=12)`](#fn-gridposwithw) - * [`fn withX(value=0)`](#fn-gridposwithx) - * [`fn withY(value=0)`](#fn-gridposwithy) -* [`obj libraryPanel`](#obj-librarypanel) - * [`fn withName(value)`](#fn-librarypanelwithname) - * [`fn withUid(value)`](#fn-librarypanelwithuid) -* [`obj options`](#obj-options) - * [`fn withFeedUrl(value)`](#fn-optionswithfeedurl) - * [`fn withShowImage(value=true)`](#fn-optionswithshowimage) -* [`obj panelOptions`](#obj-paneloptions) - * [`fn withDescription(value)`](#fn-paneloptionswithdescription) - * [`fn withLinks(value)`](#fn-paneloptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) - * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) - * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) - * [`fn withTitle(value)`](#fn-paneloptionswithtitle) - * [`fn withTransparent(value=false)`](#fn-paneloptionswithtransparent) -* [`obj queryOptions`](#obj-queryoptions) - * [`fn withDatasource(value)`](#fn-queryoptionswithdatasource) - * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) - * [`fn withInterval(value)`](#fn-queryoptionswithinterval) - * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) - * [`fn withTargets(value)`](#fn-queryoptionswithtargets) - * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) - * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) - * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) - * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) - * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) -* [`obj standardOptions`](#obj-standardoptions) - * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) - * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) - * [`fn withLinks(value)`](#fn-standardoptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) - * [`fn withMappings(value)`](#fn-standardoptionswithmappings) - * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) - * [`fn withMax(value)`](#fn-standardoptionswithmax) - * [`fn withMin(value)`](#fn-standardoptionswithmin) - * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) - * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) - * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) - * [`fn withUnit(value)`](#fn-standardoptionswithunit) - * [`obj color`](#obj-standardoptionscolor) - * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) - * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) - * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) - * [`obj thresholds`](#obj-standardoptionsthresholds) - * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) - * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) - * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) - -## Fields - -### fn new - -```ts -new(title) -``` - -Creates a new news panel with a title. - -### obj datasource - - -#### fn datasource.withType - -```ts -withType(value) -``` - - - -#### fn datasource.withUid - -```ts -withUid(value) -``` - - - -### obj gridPos - - -#### fn gridPos.withH - -```ts -withH(value=9) -``` - -Panel - -#### fn gridPos.withStatic - -```ts -withStatic(value) -``` - -true if fixed - -#### fn gridPos.withW - -```ts -withW(value=12) -``` - -Panel - -#### fn gridPos.withX - -```ts -withX(value=0) -``` - -Panel x - -#### fn gridPos.withY - -```ts -withY(value=0) -``` - -Panel y - -### obj libraryPanel - - -#### fn libraryPanel.withName - -```ts -withName(value) -``` - - - -#### fn libraryPanel.withUid - -```ts -withUid(value) -``` - - - -### obj options - - -#### fn options.withFeedUrl - -```ts -withFeedUrl(value) -``` - -empty/missing will default to grafana blog - -#### fn options.withShowImage - -```ts -withShowImage(value=true) -``` - - - -### obj panelOptions - - -#### fn panelOptions.withDescription - -```ts -withDescription(value) -``` - -Description. - -#### fn panelOptions.withLinks - -```ts -withLinks(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withRepeat - -```ts -withRepeat(value) -``` - -Name of template variable to repeat for. - -#### fn panelOptions.withRepeatDirection - -```ts -withRepeatDirection(value="h") -``` - -Direction to repeat in if 'repeat' is set. -"h" for horizontal, "v" for vertical. -TODO this is probably optional - -Accepted values for `value` are "h", "v" - -#### fn panelOptions.withTitle - -```ts -withTitle(value) -``` - -Panel title. - -#### fn panelOptions.withTransparent - -```ts -withTransparent(value=false) -``` - -Whether to display the panel without a background. - -### obj queryOptions - - -#### fn queryOptions.withDatasource - -```ts -withDatasource(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withDatasourceMixin - -```ts -withDatasourceMixin(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withInterval - -```ts -withInterval(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withMaxDataPoints - -```ts -withMaxDataPoints(value) -``` - -TODO docs - -#### fn queryOptions.withTargets - -```ts -withTargets(value) -``` - -TODO docs - -#### fn queryOptions.withTargetsMixin - -```ts -withTargetsMixin(value) -``` - -TODO docs - -#### fn queryOptions.withTimeFrom - -```ts -withTimeFrom(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTimeShift - -```ts -withTimeShift(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTransformations - -```ts -withTransformations(value) -``` - - - -#### fn queryOptions.withTransformationsMixin - -```ts -withTransformationsMixin(value) -``` - - - -### obj standardOptions - - -#### fn standardOptions.withDecimals - -```ts -withDecimals(value) -``` - -Significant digits (for display) - -#### fn standardOptions.withDisplayName - -```ts -withDisplayName(value) -``` - -The display value for this field. This supports template variables blank is auto - -#### fn standardOptions.withLinks - -```ts -withLinks(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withMappings - -```ts -withMappings(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMappingsMixin - -```ts -withMappingsMixin(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMax - -```ts -withMax(value) -``` - - - -#### fn standardOptions.withMin - -```ts -withMin(value) -``` - - - -#### fn standardOptions.withNoValue - -```ts -withNoValue(value) -``` - -Alternative to empty string - -#### fn standardOptions.withOverrides - -```ts -withOverrides(value) -``` - - - -#### fn standardOptions.withOverridesMixin - -```ts -withOverridesMixin(value) -``` - - - -#### fn standardOptions.withUnit - -```ts -withUnit(value) -``` - -Numeric Options - -#### obj standardOptions.color - - -##### fn standardOptions.color.withFixedColor - -```ts -withFixedColor(value) -``` - -Stores the fixed color value if mode is fixed - -##### fn standardOptions.color.withMode - -```ts -withMode(value) -``` - -The main color scheme mode - -##### fn standardOptions.color.withSeriesBy - -```ts -withSeriesBy(value) -``` - -TODO docs - -Accepted values for `value` are "min", "max", "last" - -#### obj standardOptions.thresholds - - -##### fn standardOptions.thresholds.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "absolute", "percentage" - -##### fn standardOptions.thresholds.withSteps - -```ts -withSteps(value) -``` - -Must be sorted by 'value', first value is always -Infinity - -##### fn standardOptions.thresholds.withStepsMixin - -```ts -withStepsMixin(value) -``` - -Must be sorted by 'value', first value is always -Infinity diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/news/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/news/link.md deleted file mode 100644 index 1a1d7c4..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/news/link.md +++ /dev/null @@ -1,109 +0,0 @@ -# link - - - -## Index - -* [`fn withAsDropdown(value=false)`](#fn-withasdropdown) -* [`fn withIcon(value)`](#fn-withicon) -* [`fn withIncludeVars(value=false)`](#fn-withincludevars) -* [`fn withKeepTime(value=false)`](#fn-withkeeptime) -* [`fn withTags(value)`](#fn-withtags) -* [`fn withTagsMixin(value)`](#fn-withtagsmixin) -* [`fn withTargetBlank(value=false)`](#fn-withtargetblank) -* [`fn withTitle(value)`](#fn-withtitle) -* [`fn withTooltip(value)`](#fn-withtooltip) -* [`fn withType(value)`](#fn-withtype) -* [`fn withUrl(value)`](#fn-withurl) - -## Fields - -### fn withAsDropdown - -```ts -withAsDropdown(value=false) -``` - - - -### fn withIcon - -```ts -withIcon(value) -``` - - - -### fn withIncludeVars - -```ts -withIncludeVars(value=false) -``` - - - -### fn withKeepTime - -```ts -withKeepTime(value=false) -``` - - - -### fn withTags - -```ts -withTags(value) -``` - - - -### fn withTagsMixin - -```ts -withTagsMixin(value) -``` - - - -### fn withTargetBlank - -```ts -withTargetBlank(value=false) -``` - - - -### fn withTitle - -```ts -withTitle(value) -``` - - - -### fn withTooltip - -```ts -withTooltip(value) -``` - - - -### fn withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "link", "dashboards" - -### fn withUrl - -```ts -withUrl(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/news/thresholdStep.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/news/thresholdStep.md deleted file mode 100644 index 9d6af42..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/news/thresholdStep.md +++ /dev/null @@ -1,47 +0,0 @@ -# thresholdStep - - - -## Index - -* [`fn withColor(value)`](#fn-withcolor) -* [`fn withIndex(value)`](#fn-withindex) -* [`fn withState(value)`](#fn-withstate) -* [`fn withValue(value)`](#fn-withvalue) - -## Fields - -### fn withColor - -```ts -withColor(value) -``` - -TODO docs - -### fn withIndex - -```ts -withIndex(value) -``` - -Threshold index, an old property that is not needed an should only appear in older dashboards - -### fn withState - -```ts -withState(value) -``` - -TODO docs -TODO are the values here enumerable into a disjunction? -Some seem to be listed in typescript comment - -### fn withValue - -```ts -withValue(value) -``` - -TODO docs -FIXME the corresponding typescript field is required/non-optional, but nulls currently appear here when serializing -Infinity to JSON diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/news/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/news/transformation.md deleted file mode 100644 index 3dac7e9..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/news/transformation.md +++ /dev/null @@ -1,76 +0,0 @@ -# transformation - - - -## Index - -* [`fn withDisabled(value)`](#fn-withdisabled) -* [`fn withFilter(value)`](#fn-withfilter) -* [`fn withFilterMixin(value)`](#fn-withfiltermixin) -* [`fn withId(value)`](#fn-withid) -* [`fn withOptions(value)`](#fn-withoptions) -* [`obj filter`](#obj-filter) - * [`fn withId(value="")`](#fn-filterwithid) - * [`fn withOptions(value)`](#fn-filterwithoptions) - -## Fields - -### fn withDisabled - -```ts -withDisabled(value) -``` - -Disabled transformations are skipped - -### fn withFilter - -```ts -withFilter(value) -``` - - - -### fn withFilterMixin - -```ts -withFilterMixin(value) -``` - - - -### fn withId - -```ts -withId(value) -``` - -Unique identifier of transformer - -### fn withOptions - -```ts -withOptions(value) -``` - -Options to be passed to the transformer -Valid options depend on the transformer id - -### obj filter - - -#### fn filter.withId - -```ts -withId(value="") -``` - - - -#### fn filter.withOptions - -```ts -withOptions(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/news/valueMapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/news/valueMapping.md deleted file mode 100644 index a6bbdb3..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/news/valueMapping.md +++ /dev/null @@ -1,365 +0,0 @@ -# valueMapping - - - -## Index - -* [`obj RangeMap`](#obj-rangemap) - * [`fn withOptions(value)`](#fn-rangemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) - * [`obj options`](#obj-rangemapoptions) - * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) - * [`fn withResult(value)`](#fn-rangemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) - * [`fn withTo(value)`](#fn-rangemapoptionswithto) - * [`obj result`](#obj-rangemapoptionsresult) - * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) -* [`obj RegexMap`](#obj-regexmap) - * [`fn withOptions(value)`](#fn-regexmapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) - * [`obj options`](#obj-regexmapoptions) - * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) - * [`fn withResult(value)`](#fn-regexmapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) - * [`obj result`](#obj-regexmapoptionsresult) - * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) - * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) -* [`obj SpecialValueMap`](#obj-specialvaluemap) - * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) - * [`obj options`](#obj-specialvaluemapoptions) - * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) - * [`fn withPattern(value)`](#fn-specialvaluemapoptionswithpattern) - * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) - * [`obj result`](#obj-specialvaluemapoptionsresult) - * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) -* [`obj ValueMap`](#obj-valuemap) - * [`fn withOptions(value)`](#fn-valuemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) - -## Fields - -### obj RangeMap - - -#### fn RangeMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RangeMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RangeMap.withType - -```ts -withType(value) -``` - - - -#### obj RangeMap.options - - -##### fn RangeMap.options.withFrom - -```ts -withFrom(value) -``` - -to and from are `number | null` in current ts, really not sure what to do - -##### fn RangeMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RangeMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### fn RangeMap.options.withTo - -```ts -withTo(value) -``` - - - -##### obj RangeMap.options.result - - -###### fn RangeMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RangeMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RangeMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RangeMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj RegexMap - - -#### fn RegexMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RegexMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RegexMap.withType - -```ts -withType(value) -``` - - - -#### obj RegexMap.options - - -##### fn RegexMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn RegexMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RegexMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj RegexMap.options.result - - -###### fn RegexMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RegexMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RegexMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RegexMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj SpecialValueMap - - -#### fn SpecialValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn SpecialValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn SpecialValueMap.withType - -```ts -withType(value) -``` - - - -#### obj SpecialValueMap.options - - -##### fn SpecialValueMap.options.withMatch - -```ts -withMatch(value) -``` - - - -Accepted values for `value` are "true", "false" - -##### fn SpecialValueMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn SpecialValueMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn SpecialValueMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj SpecialValueMap.options.result - - -###### fn SpecialValueMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn SpecialValueMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn SpecialValueMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn SpecialValueMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj ValueMap - - -#### fn ValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn ValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn ValueMap.withType - -```ts -withType(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/nodeGraph/fieldOverride.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/nodeGraph/fieldOverride.md deleted file mode 100644 index 3e2667b..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/nodeGraph/fieldOverride.md +++ /dev/null @@ -1,194 +0,0 @@ -# fieldOverride - -Overrides allow you to customize visualization settings for specific fields or -series. This is accomplished by adding an override rule that targets -a particular set of fields and that can each define multiple options. - -```jsonnet -fieldOverride.byType.new('number') -+ fieldOverride.byType.withPropertiesFromOptions( - panel.standardOptions.withDecimals(2) - + panel.standardOptions.withUnit('s') -) -``` - - -## Index - -* [`obj byName`](#obj-byname) - * [`fn new(value)`](#fn-bynamenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bynamewithproperty) -* [`obj byQuery`](#obj-byquery) - * [`fn new(value)`](#fn-byquerynew) - * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byquerywithproperty) -* [`obj byRegexp`](#obj-byregexp) - * [`fn new(value)`](#fn-byregexpnew) - * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) -* [`obj byType`](#obj-bytype) - * [`fn new(value)`](#fn-bytypenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bytypewithproperty) -* [`obj byValue`](#obj-byvalue) - * [`fn new(value)`](#fn-byvaluenew) - * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) - -## Fields - -### obj byName - - -#### fn byName.new - -```ts -new(value) -``` - -`new` creates a new override of type `byName`. - -#### fn byName.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byName.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byQuery - - -#### fn byQuery.new - -```ts -new(value) -``` - -`new` creates a new override of type `byQuery`. - -#### fn byQuery.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byQuery.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byRegexp - - -#### fn byRegexp.new - -```ts -new(value) -``` - -`new` creates a new override of type `byRegexp`. - -#### fn byRegexp.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byRegexp.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byType - - -#### fn byType.new - -```ts -new(value) -``` - -`new` creates a new override of type `byType`. - -#### fn byType.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byType.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byValue - - -#### fn byValue.new - -```ts -new(value) -``` - -`new` creates a new override of type `byValue`. - -#### fn byValue.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byValue.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/nodeGraph/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/nodeGraph/index.md deleted file mode 100644 index 4bc338f..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/nodeGraph/index.md +++ /dev/null @@ -1,590 +0,0 @@ -# nodeGraph - -grafonnet.panel.nodeGraph - -## Subpackages - -* [fieldOverride](fieldOverride.md) -* [link](link.md) -* [thresholdStep](thresholdStep.md) -* [transformation](transformation.md) -* [valueMapping](valueMapping.md) - -## Index - -* [`fn new(title)`](#fn-new) -* [`obj datasource`](#obj-datasource) - * [`fn withType(value)`](#fn-datasourcewithtype) - * [`fn withUid(value)`](#fn-datasourcewithuid) -* [`obj gridPos`](#obj-gridpos) - * [`fn withH(value=9)`](#fn-gridposwithh) - * [`fn withStatic(value)`](#fn-gridposwithstatic) - * [`fn withW(value=12)`](#fn-gridposwithw) - * [`fn withX(value=0)`](#fn-gridposwithx) - * [`fn withY(value=0)`](#fn-gridposwithy) -* [`obj libraryPanel`](#obj-librarypanel) - * [`fn withName(value)`](#fn-librarypanelwithname) - * [`fn withUid(value)`](#fn-librarypanelwithuid) -* [`obj options`](#obj-options) - * [`fn withEdges(value)`](#fn-optionswithedges) - * [`fn withEdgesMixin(value)`](#fn-optionswithedgesmixin) - * [`fn withNodes(value)`](#fn-optionswithnodes) - * [`fn withNodesMixin(value)`](#fn-optionswithnodesmixin) - * [`obj edges`](#obj-optionsedges) - * [`fn withMainStatUnit(value)`](#fn-optionsedgeswithmainstatunit) - * [`fn withSecondaryStatUnit(value)`](#fn-optionsedgeswithsecondarystatunit) - * [`obj nodes`](#obj-optionsnodes) - * [`fn withArcs(value)`](#fn-optionsnodeswitharcs) - * [`fn withArcsMixin(value)`](#fn-optionsnodeswitharcsmixin) - * [`fn withMainStatUnit(value)`](#fn-optionsnodeswithmainstatunit) - * [`fn withSecondaryStatUnit(value)`](#fn-optionsnodeswithsecondarystatunit) - * [`obj arcs`](#obj-optionsnodesarcs) - * [`fn withColor(value)`](#fn-optionsnodesarcswithcolor) - * [`fn withField(value)`](#fn-optionsnodesarcswithfield) -* [`obj panelOptions`](#obj-paneloptions) - * [`fn withDescription(value)`](#fn-paneloptionswithdescription) - * [`fn withLinks(value)`](#fn-paneloptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) - * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) - * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) - * [`fn withTitle(value)`](#fn-paneloptionswithtitle) - * [`fn withTransparent(value=false)`](#fn-paneloptionswithtransparent) -* [`obj queryOptions`](#obj-queryoptions) - * [`fn withDatasource(value)`](#fn-queryoptionswithdatasource) - * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) - * [`fn withInterval(value)`](#fn-queryoptionswithinterval) - * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) - * [`fn withTargets(value)`](#fn-queryoptionswithtargets) - * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) - * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) - * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) - * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) - * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) -* [`obj standardOptions`](#obj-standardoptions) - * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) - * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) - * [`fn withLinks(value)`](#fn-standardoptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) - * [`fn withMappings(value)`](#fn-standardoptionswithmappings) - * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) - * [`fn withMax(value)`](#fn-standardoptionswithmax) - * [`fn withMin(value)`](#fn-standardoptionswithmin) - * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) - * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) - * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) - * [`fn withUnit(value)`](#fn-standardoptionswithunit) - * [`obj color`](#obj-standardoptionscolor) - * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) - * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) - * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) - * [`obj thresholds`](#obj-standardoptionsthresholds) - * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) - * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) - * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) - -## Fields - -### fn new - -```ts -new(title) -``` - -Creates a new nodeGraph panel with a title. - -### obj datasource - - -#### fn datasource.withType - -```ts -withType(value) -``` - - - -#### fn datasource.withUid - -```ts -withUid(value) -``` - - - -### obj gridPos - - -#### fn gridPos.withH - -```ts -withH(value=9) -``` - -Panel - -#### fn gridPos.withStatic - -```ts -withStatic(value) -``` - -true if fixed - -#### fn gridPos.withW - -```ts -withW(value=12) -``` - -Panel - -#### fn gridPos.withX - -```ts -withX(value=0) -``` - -Panel x - -#### fn gridPos.withY - -```ts -withY(value=0) -``` - -Panel y - -### obj libraryPanel - - -#### fn libraryPanel.withName - -```ts -withName(value) -``` - - - -#### fn libraryPanel.withUid - -```ts -withUid(value) -``` - - - -### obj options - - -#### fn options.withEdges - -```ts -withEdges(value) -``` - - - -#### fn options.withEdgesMixin - -```ts -withEdgesMixin(value) -``` - - - -#### fn options.withNodes - -```ts -withNodes(value) -``` - - - -#### fn options.withNodesMixin - -```ts -withNodesMixin(value) -``` - - - -#### obj options.edges - - -##### fn options.edges.withMainStatUnit - -```ts -withMainStatUnit(value) -``` - -Unit for the main stat to override what ever is set in the data frame. - -##### fn options.edges.withSecondaryStatUnit - -```ts -withSecondaryStatUnit(value) -``` - -Unit for the secondary stat to override what ever is set in the data frame. - -#### obj options.nodes - - -##### fn options.nodes.withArcs - -```ts -withArcs(value) -``` - -Define which fields are shown as part of the node arc (colored circle around the node). - -##### fn options.nodes.withArcsMixin - -```ts -withArcsMixin(value) -``` - -Define which fields are shown as part of the node arc (colored circle around the node). - -##### fn options.nodes.withMainStatUnit - -```ts -withMainStatUnit(value) -``` - -Unit for the main stat to override what ever is set in the data frame. - -##### fn options.nodes.withSecondaryStatUnit - -```ts -withSecondaryStatUnit(value) -``` - -Unit for the secondary stat to override what ever is set in the data frame. - -##### obj options.nodes.arcs - - -###### fn options.nodes.arcs.withColor - -```ts -withColor(value) -``` - -The color of the arc. - -###### fn options.nodes.arcs.withField - -```ts -withField(value) -``` - -Field from which to get the value. Values should be less than 1, representing fraction of a circle. - -### obj panelOptions - - -#### fn panelOptions.withDescription - -```ts -withDescription(value) -``` - -Description. - -#### fn panelOptions.withLinks - -```ts -withLinks(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withRepeat - -```ts -withRepeat(value) -``` - -Name of template variable to repeat for. - -#### fn panelOptions.withRepeatDirection - -```ts -withRepeatDirection(value="h") -``` - -Direction to repeat in if 'repeat' is set. -"h" for horizontal, "v" for vertical. -TODO this is probably optional - -Accepted values for `value` are "h", "v" - -#### fn panelOptions.withTitle - -```ts -withTitle(value) -``` - -Panel title. - -#### fn panelOptions.withTransparent - -```ts -withTransparent(value=false) -``` - -Whether to display the panel without a background. - -### obj queryOptions - - -#### fn queryOptions.withDatasource - -```ts -withDatasource(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withDatasourceMixin - -```ts -withDatasourceMixin(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withInterval - -```ts -withInterval(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withMaxDataPoints - -```ts -withMaxDataPoints(value) -``` - -TODO docs - -#### fn queryOptions.withTargets - -```ts -withTargets(value) -``` - -TODO docs - -#### fn queryOptions.withTargetsMixin - -```ts -withTargetsMixin(value) -``` - -TODO docs - -#### fn queryOptions.withTimeFrom - -```ts -withTimeFrom(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTimeShift - -```ts -withTimeShift(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTransformations - -```ts -withTransformations(value) -``` - - - -#### fn queryOptions.withTransformationsMixin - -```ts -withTransformationsMixin(value) -``` - - - -### obj standardOptions - - -#### fn standardOptions.withDecimals - -```ts -withDecimals(value) -``` - -Significant digits (for display) - -#### fn standardOptions.withDisplayName - -```ts -withDisplayName(value) -``` - -The display value for this field. This supports template variables blank is auto - -#### fn standardOptions.withLinks - -```ts -withLinks(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withMappings - -```ts -withMappings(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMappingsMixin - -```ts -withMappingsMixin(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMax - -```ts -withMax(value) -``` - - - -#### fn standardOptions.withMin - -```ts -withMin(value) -``` - - - -#### fn standardOptions.withNoValue - -```ts -withNoValue(value) -``` - -Alternative to empty string - -#### fn standardOptions.withOverrides - -```ts -withOverrides(value) -``` - - - -#### fn standardOptions.withOverridesMixin - -```ts -withOverridesMixin(value) -``` - - - -#### fn standardOptions.withUnit - -```ts -withUnit(value) -``` - -Numeric Options - -#### obj standardOptions.color - - -##### fn standardOptions.color.withFixedColor - -```ts -withFixedColor(value) -``` - -Stores the fixed color value if mode is fixed - -##### fn standardOptions.color.withMode - -```ts -withMode(value) -``` - -The main color scheme mode - -##### fn standardOptions.color.withSeriesBy - -```ts -withSeriesBy(value) -``` - -TODO docs - -Accepted values for `value` are "min", "max", "last" - -#### obj standardOptions.thresholds - - -##### fn standardOptions.thresholds.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "absolute", "percentage" - -##### fn standardOptions.thresholds.withSteps - -```ts -withSteps(value) -``` - -Must be sorted by 'value', first value is always -Infinity - -##### fn standardOptions.thresholds.withStepsMixin - -```ts -withStepsMixin(value) -``` - -Must be sorted by 'value', first value is always -Infinity diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/nodeGraph/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/nodeGraph/link.md deleted file mode 100644 index 1a1d7c4..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/nodeGraph/link.md +++ /dev/null @@ -1,109 +0,0 @@ -# link - - - -## Index - -* [`fn withAsDropdown(value=false)`](#fn-withasdropdown) -* [`fn withIcon(value)`](#fn-withicon) -* [`fn withIncludeVars(value=false)`](#fn-withincludevars) -* [`fn withKeepTime(value=false)`](#fn-withkeeptime) -* [`fn withTags(value)`](#fn-withtags) -* [`fn withTagsMixin(value)`](#fn-withtagsmixin) -* [`fn withTargetBlank(value=false)`](#fn-withtargetblank) -* [`fn withTitle(value)`](#fn-withtitle) -* [`fn withTooltip(value)`](#fn-withtooltip) -* [`fn withType(value)`](#fn-withtype) -* [`fn withUrl(value)`](#fn-withurl) - -## Fields - -### fn withAsDropdown - -```ts -withAsDropdown(value=false) -``` - - - -### fn withIcon - -```ts -withIcon(value) -``` - - - -### fn withIncludeVars - -```ts -withIncludeVars(value=false) -``` - - - -### fn withKeepTime - -```ts -withKeepTime(value=false) -``` - - - -### fn withTags - -```ts -withTags(value) -``` - - - -### fn withTagsMixin - -```ts -withTagsMixin(value) -``` - - - -### fn withTargetBlank - -```ts -withTargetBlank(value=false) -``` - - - -### fn withTitle - -```ts -withTitle(value) -``` - - - -### fn withTooltip - -```ts -withTooltip(value) -``` - - - -### fn withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "link", "dashboards" - -### fn withUrl - -```ts -withUrl(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/nodeGraph/thresholdStep.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/nodeGraph/thresholdStep.md deleted file mode 100644 index 9d6af42..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/nodeGraph/thresholdStep.md +++ /dev/null @@ -1,47 +0,0 @@ -# thresholdStep - - - -## Index - -* [`fn withColor(value)`](#fn-withcolor) -* [`fn withIndex(value)`](#fn-withindex) -* [`fn withState(value)`](#fn-withstate) -* [`fn withValue(value)`](#fn-withvalue) - -## Fields - -### fn withColor - -```ts -withColor(value) -``` - -TODO docs - -### fn withIndex - -```ts -withIndex(value) -``` - -Threshold index, an old property that is not needed an should only appear in older dashboards - -### fn withState - -```ts -withState(value) -``` - -TODO docs -TODO are the values here enumerable into a disjunction? -Some seem to be listed in typescript comment - -### fn withValue - -```ts -withValue(value) -``` - -TODO docs -FIXME the corresponding typescript field is required/non-optional, but nulls currently appear here when serializing -Infinity to JSON diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/nodeGraph/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/nodeGraph/transformation.md deleted file mode 100644 index 3dac7e9..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/nodeGraph/transformation.md +++ /dev/null @@ -1,76 +0,0 @@ -# transformation - - - -## Index - -* [`fn withDisabled(value)`](#fn-withdisabled) -* [`fn withFilter(value)`](#fn-withfilter) -* [`fn withFilterMixin(value)`](#fn-withfiltermixin) -* [`fn withId(value)`](#fn-withid) -* [`fn withOptions(value)`](#fn-withoptions) -* [`obj filter`](#obj-filter) - * [`fn withId(value="")`](#fn-filterwithid) - * [`fn withOptions(value)`](#fn-filterwithoptions) - -## Fields - -### fn withDisabled - -```ts -withDisabled(value) -``` - -Disabled transformations are skipped - -### fn withFilter - -```ts -withFilter(value) -``` - - - -### fn withFilterMixin - -```ts -withFilterMixin(value) -``` - - - -### fn withId - -```ts -withId(value) -``` - -Unique identifier of transformer - -### fn withOptions - -```ts -withOptions(value) -``` - -Options to be passed to the transformer -Valid options depend on the transformer id - -### obj filter - - -#### fn filter.withId - -```ts -withId(value="") -``` - - - -#### fn filter.withOptions - -```ts -withOptions(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/nodeGraph/valueMapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/nodeGraph/valueMapping.md deleted file mode 100644 index a6bbdb3..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/nodeGraph/valueMapping.md +++ /dev/null @@ -1,365 +0,0 @@ -# valueMapping - - - -## Index - -* [`obj RangeMap`](#obj-rangemap) - * [`fn withOptions(value)`](#fn-rangemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) - * [`obj options`](#obj-rangemapoptions) - * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) - * [`fn withResult(value)`](#fn-rangemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) - * [`fn withTo(value)`](#fn-rangemapoptionswithto) - * [`obj result`](#obj-rangemapoptionsresult) - * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) -* [`obj RegexMap`](#obj-regexmap) - * [`fn withOptions(value)`](#fn-regexmapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) - * [`obj options`](#obj-regexmapoptions) - * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) - * [`fn withResult(value)`](#fn-regexmapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) - * [`obj result`](#obj-regexmapoptionsresult) - * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) - * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) -* [`obj SpecialValueMap`](#obj-specialvaluemap) - * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) - * [`obj options`](#obj-specialvaluemapoptions) - * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) - * [`fn withPattern(value)`](#fn-specialvaluemapoptionswithpattern) - * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) - * [`obj result`](#obj-specialvaluemapoptionsresult) - * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) -* [`obj ValueMap`](#obj-valuemap) - * [`fn withOptions(value)`](#fn-valuemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) - -## Fields - -### obj RangeMap - - -#### fn RangeMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RangeMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RangeMap.withType - -```ts -withType(value) -``` - - - -#### obj RangeMap.options - - -##### fn RangeMap.options.withFrom - -```ts -withFrom(value) -``` - -to and from are `number | null` in current ts, really not sure what to do - -##### fn RangeMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RangeMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### fn RangeMap.options.withTo - -```ts -withTo(value) -``` - - - -##### obj RangeMap.options.result - - -###### fn RangeMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RangeMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RangeMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RangeMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj RegexMap - - -#### fn RegexMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RegexMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RegexMap.withType - -```ts -withType(value) -``` - - - -#### obj RegexMap.options - - -##### fn RegexMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn RegexMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RegexMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj RegexMap.options.result - - -###### fn RegexMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RegexMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RegexMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RegexMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj SpecialValueMap - - -#### fn SpecialValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn SpecialValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn SpecialValueMap.withType - -```ts -withType(value) -``` - - - -#### obj SpecialValueMap.options - - -##### fn SpecialValueMap.options.withMatch - -```ts -withMatch(value) -``` - - - -Accepted values for `value` are "true", "false" - -##### fn SpecialValueMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn SpecialValueMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn SpecialValueMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj SpecialValueMap.options.result - - -###### fn SpecialValueMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn SpecialValueMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn SpecialValueMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn SpecialValueMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj ValueMap - - -#### fn ValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn ValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn ValueMap.withType - -```ts -withType(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/pieChart/fieldOverride.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/pieChart/fieldOverride.md deleted file mode 100644 index 3e2667b..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/pieChart/fieldOverride.md +++ /dev/null @@ -1,194 +0,0 @@ -# fieldOverride - -Overrides allow you to customize visualization settings for specific fields or -series. This is accomplished by adding an override rule that targets -a particular set of fields and that can each define multiple options. - -```jsonnet -fieldOverride.byType.new('number') -+ fieldOverride.byType.withPropertiesFromOptions( - panel.standardOptions.withDecimals(2) - + panel.standardOptions.withUnit('s') -) -``` - - -## Index - -* [`obj byName`](#obj-byname) - * [`fn new(value)`](#fn-bynamenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bynamewithproperty) -* [`obj byQuery`](#obj-byquery) - * [`fn new(value)`](#fn-byquerynew) - * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byquerywithproperty) -* [`obj byRegexp`](#obj-byregexp) - * [`fn new(value)`](#fn-byregexpnew) - * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) -* [`obj byType`](#obj-bytype) - * [`fn new(value)`](#fn-bytypenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bytypewithproperty) -* [`obj byValue`](#obj-byvalue) - * [`fn new(value)`](#fn-byvaluenew) - * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) - -## Fields - -### obj byName - - -#### fn byName.new - -```ts -new(value) -``` - -`new` creates a new override of type `byName`. - -#### fn byName.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byName.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byQuery - - -#### fn byQuery.new - -```ts -new(value) -``` - -`new` creates a new override of type `byQuery`. - -#### fn byQuery.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byQuery.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byRegexp - - -#### fn byRegexp.new - -```ts -new(value) -``` - -`new` creates a new override of type `byRegexp`. - -#### fn byRegexp.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byRegexp.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byType - - -#### fn byType.new - -```ts -new(value) -``` - -`new` creates a new override of type `byType`. - -#### fn byType.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byType.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byValue - - -#### fn byValue.new - -```ts -new(value) -``` - -`new` creates a new override of type `byValue`. - -#### fn byValue.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byValue.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/pieChart/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/pieChart/index.md deleted file mode 100644 index c919257..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/pieChart/index.md +++ /dev/null @@ -1,857 +0,0 @@ -# pieChart - -grafonnet.panel.pieChart - -## Subpackages - -* [fieldOverride](fieldOverride.md) -* [link](link.md) -* [thresholdStep](thresholdStep.md) -* [transformation](transformation.md) -* [valueMapping](valueMapping.md) - -## Index - -* [`fn new(title)`](#fn-new) -* [`obj datasource`](#obj-datasource) - * [`fn withType(value)`](#fn-datasourcewithtype) - * [`fn withUid(value)`](#fn-datasourcewithuid) -* [`obj fieldConfig`](#obj-fieldconfig) - * [`obj defaults`](#obj-fieldconfigdefaults) - * [`obj custom`](#obj-fieldconfigdefaultscustom) - * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomwithhidefrom) - * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomwithhidefrommixin) - * [`obj hideFrom`](#obj-fieldconfigdefaultscustomhidefrom) - * [`fn withLegend(value)`](#fn-fieldconfigdefaultscustomhidefromwithlegend) - * [`fn withTooltip(value)`](#fn-fieldconfigdefaultscustomhidefromwithtooltip) - * [`fn withViz(value)`](#fn-fieldconfigdefaultscustomhidefromwithviz) -* [`obj gridPos`](#obj-gridpos) - * [`fn withH(value=9)`](#fn-gridposwithh) - * [`fn withStatic(value)`](#fn-gridposwithstatic) - * [`fn withW(value=12)`](#fn-gridposwithw) - * [`fn withX(value=0)`](#fn-gridposwithx) - * [`fn withY(value=0)`](#fn-gridposwithy) -* [`obj libraryPanel`](#obj-librarypanel) - * [`fn withName(value)`](#fn-librarypanelwithname) - * [`fn withUid(value)`](#fn-librarypanelwithuid) -* [`obj options`](#obj-options) - * [`fn withDisplayLabels(value)`](#fn-optionswithdisplaylabels) - * [`fn withDisplayLabelsMixin(value)`](#fn-optionswithdisplaylabelsmixin) - * [`fn withLegend(value)`](#fn-optionswithlegend) - * [`fn withLegendMixin(value)`](#fn-optionswithlegendmixin) - * [`fn withOrientation(value)`](#fn-optionswithorientation) - * [`fn withPieType(value)`](#fn-optionswithpietype) - * [`fn withReduceOptions(value)`](#fn-optionswithreduceoptions) - * [`fn withReduceOptionsMixin(value)`](#fn-optionswithreduceoptionsmixin) - * [`fn withText(value)`](#fn-optionswithtext) - * [`fn withTextMixin(value)`](#fn-optionswithtextmixin) - * [`fn withTooltip(value)`](#fn-optionswithtooltip) - * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) - * [`obj legend`](#obj-optionslegend) - * [`fn withAsTable(value)`](#fn-optionslegendwithastable) - * [`fn withCalcs(value)`](#fn-optionslegendwithcalcs) - * [`fn withCalcsMixin(value)`](#fn-optionslegendwithcalcsmixin) - * [`fn withDisplayMode(value)`](#fn-optionslegendwithdisplaymode) - * [`fn withIsVisible(value)`](#fn-optionslegendwithisvisible) - * [`fn withPlacement(value)`](#fn-optionslegendwithplacement) - * [`fn withShowLegend(value)`](#fn-optionslegendwithshowlegend) - * [`fn withSortBy(value)`](#fn-optionslegendwithsortby) - * [`fn withSortDesc(value)`](#fn-optionslegendwithsortdesc) - * [`fn withValues(value)`](#fn-optionslegendwithvalues) - * [`fn withValuesMixin(value)`](#fn-optionslegendwithvaluesmixin) - * [`fn withWidth(value)`](#fn-optionslegendwithwidth) - * [`obj reduceOptions`](#obj-optionsreduceoptions) - * [`fn withCalcs(value)`](#fn-optionsreduceoptionswithcalcs) - * [`fn withCalcsMixin(value)`](#fn-optionsreduceoptionswithcalcsmixin) - * [`fn withFields(value)`](#fn-optionsreduceoptionswithfields) - * [`fn withLimit(value)`](#fn-optionsreduceoptionswithlimit) - * [`fn withValues(value)`](#fn-optionsreduceoptionswithvalues) - * [`obj text`](#obj-optionstext) - * [`fn withTitleSize(value)`](#fn-optionstextwithtitlesize) - * [`fn withValueSize(value)`](#fn-optionstextwithvaluesize) - * [`obj tooltip`](#obj-optionstooltip) - * [`fn withMode(value)`](#fn-optionstooltipwithmode) - * [`fn withSort(value)`](#fn-optionstooltipwithsort) -* [`obj panelOptions`](#obj-paneloptions) - * [`fn withDescription(value)`](#fn-paneloptionswithdescription) - * [`fn withLinks(value)`](#fn-paneloptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) - * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) - * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) - * [`fn withTitle(value)`](#fn-paneloptionswithtitle) - * [`fn withTransparent(value=false)`](#fn-paneloptionswithtransparent) -* [`obj queryOptions`](#obj-queryoptions) - * [`fn withDatasource(value)`](#fn-queryoptionswithdatasource) - * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) - * [`fn withInterval(value)`](#fn-queryoptionswithinterval) - * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) - * [`fn withTargets(value)`](#fn-queryoptionswithtargets) - * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) - * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) - * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) - * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) - * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) -* [`obj standardOptions`](#obj-standardoptions) - * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) - * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) - * [`fn withLinks(value)`](#fn-standardoptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) - * [`fn withMappings(value)`](#fn-standardoptionswithmappings) - * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) - * [`fn withMax(value)`](#fn-standardoptionswithmax) - * [`fn withMin(value)`](#fn-standardoptionswithmin) - * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) - * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) - * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) - * [`fn withUnit(value)`](#fn-standardoptionswithunit) - * [`obj color`](#obj-standardoptionscolor) - * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) - * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) - * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) - * [`obj thresholds`](#obj-standardoptionsthresholds) - * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) - * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) - * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) - -## Fields - -### fn new - -```ts -new(title) -``` - -Creates a new pieChart panel with a title. - -### obj datasource - - -#### fn datasource.withType - -```ts -withType(value) -``` - - - -#### fn datasource.withUid - -```ts -withUid(value) -``` - - - -### obj fieldConfig - - -#### obj fieldConfig.defaults - - -##### obj fieldConfig.defaults.custom - - -###### fn fieldConfig.defaults.custom.withHideFrom - -```ts -withHideFrom(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withHideFromMixin - -```ts -withHideFromMixin(value) -``` - -TODO docs - -###### obj fieldConfig.defaults.custom.hideFrom - - -####### fn fieldConfig.defaults.custom.hideFrom.withLegend - -```ts -withLegend(value) -``` - - - -####### fn fieldConfig.defaults.custom.hideFrom.withTooltip - -```ts -withTooltip(value) -``` - - - -####### fn fieldConfig.defaults.custom.hideFrom.withViz - -```ts -withViz(value) -``` - - - -### obj gridPos - - -#### fn gridPos.withH - -```ts -withH(value=9) -``` - -Panel - -#### fn gridPos.withStatic - -```ts -withStatic(value) -``` - -true if fixed - -#### fn gridPos.withW - -```ts -withW(value=12) -``` - -Panel - -#### fn gridPos.withX - -```ts -withX(value=0) -``` - -Panel x - -#### fn gridPos.withY - -```ts -withY(value=0) -``` - -Panel y - -### obj libraryPanel - - -#### fn libraryPanel.withName - -```ts -withName(value) -``` - - - -#### fn libraryPanel.withUid - -```ts -withUid(value) -``` - - - -### obj options - - -#### fn options.withDisplayLabels - -```ts -withDisplayLabels(value) -``` - - - -#### fn options.withDisplayLabelsMixin - -```ts -withDisplayLabelsMixin(value) -``` - - - -#### fn options.withLegend - -```ts -withLegend(value) -``` - - - -#### fn options.withLegendMixin - -```ts -withLegendMixin(value) -``` - - - -#### fn options.withOrientation - -```ts -withOrientation(value) -``` - -TODO docs - -Accepted values for `value` are "auto", "vertical", "horizontal" - -#### fn options.withPieType - -```ts -withPieType(value) -``` - -Select the pie chart display style. - -Accepted values for `value` are "pie", "donut" - -#### fn options.withReduceOptions - -```ts -withReduceOptions(value) -``` - -TODO docs - -#### fn options.withReduceOptionsMixin - -```ts -withReduceOptionsMixin(value) -``` - -TODO docs - -#### fn options.withText - -```ts -withText(value) -``` - -TODO docs - -#### fn options.withTextMixin - -```ts -withTextMixin(value) -``` - -TODO docs - -#### fn options.withTooltip - -```ts -withTooltip(value) -``` - -TODO docs - -#### fn options.withTooltipMixin - -```ts -withTooltipMixin(value) -``` - -TODO docs - -#### obj options.legend - - -##### fn options.legend.withAsTable - -```ts -withAsTable(value) -``` - - - -##### fn options.legend.withCalcs - -```ts -withCalcs(value) -``` - - - -##### fn options.legend.withCalcsMixin - -```ts -withCalcsMixin(value) -``` - - - -##### fn options.legend.withDisplayMode - -```ts -withDisplayMode(value) -``` - -TODO docs -Note: "hidden" needs to remain as an option for plugins compatibility - -Accepted values for `value` are "list", "table", "hidden" - -##### fn options.legend.withIsVisible - -```ts -withIsVisible(value) -``` - - - -##### fn options.legend.withPlacement - -```ts -withPlacement(value) -``` - -TODO docs - -Accepted values for `value` are "bottom", "right" - -##### fn options.legend.withShowLegend - -```ts -withShowLegend(value) -``` - - - -##### fn options.legend.withSortBy - -```ts -withSortBy(value) -``` - - - -##### fn options.legend.withSortDesc - -```ts -withSortDesc(value) -``` - - - -##### fn options.legend.withValues - -```ts -withValues(value) -``` - - - -##### fn options.legend.withValuesMixin - -```ts -withValuesMixin(value) -``` - - - -##### fn options.legend.withWidth - -```ts -withWidth(value) -``` - - - -#### obj options.reduceOptions - - -##### fn options.reduceOptions.withCalcs - -```ts -withCalcs(value) -``` - -When !values, pick one value for the whole field - -##### fn options.reduceOptions.withCalcsMixin - -```ts -withCalcsMixin(value) -``` - -When !values, pick one value for the whole field - -##### fn options.reduceOptions.withFields - -```ts -withFields(value) -``` - -Which fields to show. By default this is only numeric fields - -##### fn options.reduceOptions.withLimit - -```ts -withLimit(value) -``` - -if showing all values limit - -##### fn options.reduceOptions.withValues - -```ts -withValues(value) -``` - -If true show each row value - -#### obj options.text - - -##### fn options.text.withTitleSize - -```ts -withTitleSize(value) -``` - -Explicit title text size - -##### fn options.text.withValueSize - -```ts -withValueSize(value) -``` - -Explicit value text size - -#### obj options.tooltip - - -##### fn options.tooltip.withMode - -```ts -withMode(value) -``` - -TODO docs - -Accepted values for `value` are "single", "multi", "none" - -##### fn options.tooltip.withSort - -```ts -withSort(value) -``` - -TODO docs - -Accepted values for `value` are "asc", "desc", "none" - -### obj panelOptions - - -#### fn panelOptions.withDescription - -```ts -withDescription(value) -``` - -Description. - -#### fn panelOptions.withLinks - -```ts -withLinks(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withRepeat - -```ts -withRepeat(value) -``` - -Name of template variable to repeat for. - -#### fn panelOptions.withRepeatDirection - -```ts -withRepeatDirection(value="h") -``` - -Direction to repeat in if 'repeat' is set. -"h" for horizontal, "v" for vertical. -TODO this is probably optional - -Accepted values for `value` are "h", "v" - -#### fn panelOptions.withTitle - -```ts -withTitle(value) -``` - -Panel title. - -#### fn panelOptions.withTransparent - -```ts -withTransparent(value=false) -``` - -Whether to display the panel without a background. - -### obj queryOptions - - -#### fn queryOptions.withDatasource - -```ts -withDatasource(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withDatasourceMixin - -```ts -withDatasourceMixin(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withInterval - -```ts -withInterval(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withMaxDataPoints - -```ts -withMaxDataPoints(value) -``` - -TODO docs - -#### fn queryOptions.withTargets - -```ts -withTargets(value) -``` - -TODO docs - -#### fn queryOptions.withTargetsMixin - -```ts -withTargetsMixin(value) -``` - -TODO docs - -#### fn queryOptions.withTimeFrom - -```ts -withTimeFrom(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTimeShift - -```ts -withTimeShift(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTransformations - -```ts -withTransformations(value) -``` - - - -#### fn queryOptions.withTransformationsMixin - -```ts -withTransformationsMixin(value) -``` - - - -### obj standardOptions - - -#### fn standardOptions.withDecimals - -```ts -withDecimals(value) -``` - -Significant digits (for display) - -#### fn standardOptions.withDisplayName - -```ts -withDisplayName(value) -``` - -The display value for this field. This supports template variables blank is auto - -#### fn standardOptions.withLinks - -```ts -withLinks(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withMappings - -```ts -withMappings(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMappingsMixin - -```ts -withMappingsMixin(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMax - -```ts -withMax(value) -``` - - - -#### fn standardOptions.withMin - -```ts -withMin(value) -``` - - - -#### fn standardOptions.withNoValue - -```ts -withNoValue(value) -``` - -Alternative to empty string - -#### fn standardOptions.withOverrides - -```ts -withOverrides(value) -``` - - - -#### fn standardOptions.withOverridesMixin - -```ts -withOverridesMixin(value) -``` - - - -#### fn standardOptions.withUnit - -```ts -withUnit(value) -``` - -Numeric Options - -#### obj standardOptions.color - - -##### fn standardOptions.color.withFixedColor - -```ts -withFixedColor(value) -``` - -Stores the fixed color value if mode is fixed - -##### fn standardOptions.color.withMode - -```ts -withMode(value) -``` - -The main color scheme mode - -##### fn standardOptions.color.withSeriesBy - -```ts -withSeriesBy(value) -``` - -TODO docs - -Accepted values for `value` are "min", "max", "last" - -#### obj standardOptions.thresholds - - -##### fn standardOptions.thresholds.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "absolute", "percentage" - -##### fn standardOptions.thresholds.withSteps - -```ts -withSteps(value) -``` - -Must be sorted by 'value', first value is always -Infinity - -##### fn standardOptions.thresholds.withStepsMixin - -```ts -withStepsMixin(value) -``` - -Must be sorted by 'value', first value is always -Infinity diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/pieChart/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/pieChart/link.md deleted file mode 100644 index 1a1d7c4..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/pieChart/link.md +++ /dev/null @@ -1,109 +0,0 @@ -# link - - - -## Index - -* [`fn withAsDropdown(value=false)`](#fn-withasdropdown) -* [`fn withIcon(value)`](#fn-withicon) -* [`fn withIncludeVars(value=false)`](#fn-withincludevars) -* [`fn withKeepTime(value=false)`](#fn-withkeeptime) -* [`fn withTags(value)`](#fn-withtags) -* [`fn withTagsMixin(value)`](#fn-withtagsmixin) -* [`fn withTargetBlank(value=false)`](#fn-withtargetblank) -* [`fn withTitle(value)`](#fn-withtitle) -* [`fn withTooltip(value)`](#fn-withtooltip) -* [`fn withType(value)`](#fn-withtype) -* [`fn withUrl(value)`](#fn-withurl) - -## Fields - -### fn withAsDropdown - -```ts -withAsDropdown(value=false) -``` - - - -### fn withIcon - -```ts -withIcon(value) -``` - - - -### fn withIncludeVars - -```ts -withIncludeVars(value=false) -``` - - - -### fn withKeepTime - -```ts -withKeepTime(value=false) -``` - - - -### fn withTags - -```ts -withTags(value) -``` - - - -### fn withTagsMixin - -```ts -withTagsMixin(value) -``` - - - -### fn withTargetBlank - -```ts -withTargetBlank(value=false) -``` - - - -### fn withTitle - -```ts -withTitle(value) -``` - - - -### fn withTooltip - -```ts -withTooltip(value) -``` - - - -### fn withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "link", "dashboards" - -### fn withUrl - -```ts -withUrl(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/pieChart/thresholdStep.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/pieChart/thresholdStep.md deleted file mode 100644 index 9d6af42..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/pieChart/thresholdStep.md +++ /dev/null @@ -1,47 +0,0 @@ -# thresholdStep - - - -## Index - -* [`fn withColor(value)`](#fn-withcolor) -* [`fn withIndex(value)`](#fn-withindex) -* [`fn withState(value)`](#fn-withstate) -* [`fn withValue(value)`](#fn-withvalue) - -## Fields - -### fn withColor - -```ts -withColor(value) -``` - -TODO docs - -### fn withIndex - -```ts -withIndex(value) -``` - -Threshold index, an old property that is not needed an should only appear in older dashboards - -### fn withState - -```ts -withState(value) -``` - -TODO docs -TODO are the values here enumerable into a disjunction? -Some seem to be listed in typescript comment - -### fn withValue - -```ts -withValue(value) -``` - -TODO docs -FIXME the corresponding typescript field is required/non-optional, but nulls currently appear here when serializing -Infinity to JSON diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/pieChart/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/pieChart/transformation.md deleted file mode 100644 index 3dac7e9..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/pieChart/transformation.md +++ /dev/null @@ -1,76 +0,0 @@ -# transformation - - - -## Index - -* [`fn withDisabled(value)`](#fn-withdisabled) -* [`fn withFilter(value)`](#fn-withfilter) -* [`fn withFilterMixin(value)`](#fn-withfiltermixin) -* [`fn withId(value)`](#fn-withid) -* [`fn withOptions(value)`](#fn-withoptions) -* [`obj filter`](#obj-filter) - * [`fn withId(value="")`](#fn-filterwithid) - * [`fn withOptions(value)`](#fn-filterwithoptions) - -## Fields - -### fn withDisabled - -```ts -withDisabled(value) -``` - -Disabled transformations are skipped - -### fn withFilter - -```ts -withFilter(value) -``` - - - -### fn withFilterMixin - -```ts -withFilterMixin(value) -``` - - - -### fn withId - -```ts -withId(value) -``` - -Unique identifier of transformer - -### fn withOptions - -```ts -withOptions(value) -``` - -Options to be passed to the transformer -Valid options depend on the transformer id - -### obj filter - - -#### fn filter.withId - -```ts -withId(value="") -``` - - - -#### fn filter.withOptions - -```ts -withOptions(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/pieChart/valueMapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/pieChart/valueMapping.md deleted file mode 100644 index a6bbdb3..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/pieChart/valueMapping.md +++ /dev/null @@ -1,365 +0,0 @@ -# valueMapping - - - -## Index - -* [`obj RangeMap`](#obj-rangemap) - * [`fn withOptions(value)`](#fn-rangemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) - * [`obj options`](#obj-rangemapoptions) - * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) - * [`fn withResult(value)`](#fn-rangemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) - * [`fn withTo(value)`](#fn-rangemapoptionswithto) - * [`obj result`](#obj-rangemapoptionsresult) - * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) -* [`obj RegexMap`](#obj-regexmap) - * [`fn withOptions(value)`](#fn-regexmapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) - * [`obj options`](#obj-regexmapoptions) - * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) - * [`fn withResult(value)`](#fn-regexmapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) - * [`obj result`](#obj-regexmapoptionsresult) - * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) - * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) -* [`obj SpecialValueMap`](#obj-specialvaluemap) - * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) - * [`obj options`](#obj-specialvaluemapoptions) - * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) - * [`fn withPattern(value)`](#fn-specialvaluemapoptionswithpattern) - * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) - * [`obj result`](#obj-specialvaluemapoptionsresult) - * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) -* [`obj ValueMap`](#obj-valuemap) - * [`fn withOptions(value)`](#fn-valuemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) - -## Fields - -### obj RangeMap - - -#### fn RangeMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RangeMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RangeMap.withType - -```ts -withType(value) -``` - - - -#### obj RangeMap.options - - -##### fn RangeMap.options.withFrom - -```ts -withFrom(value) -``` - -to and from are `number | null` in current ts, really not sure what to do - -##### fn RangeMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RangeMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### fn RangeMap.options.withTo - -```ts -withTo(value) -``` - - - -##### obj RangeMap.options.result - - -###### fn RangeMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RangeMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RangeMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RangeMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj RegexMap - - -#### fn RegexMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RegexMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RegexMap.withType - -```ts -withType(value) -``` - - - -#### obj RegexMap.options - - -##### fn RegexMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn RegexMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RegexMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj RegexMap.options.result - - -###### fn RegexMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RegexMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RegexMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RegexMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj SpecialValueMap - - -#### fn SpecialValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn SpecialValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn SpecialValueMap.withType - -```ts -withType(value) -``` - - - -#### obj SpecialValueMap.options - - -##### fn SpecialValueMap.options.withMatch - -```ts -withMatch(value) -``` - - - -Accepted values for `value` are "true", "false" - -##### fn SpecialValueMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn SpecialValueMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn SpecialValueMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj SpecialValueMap.options.result - - -###### fn SpecialValueMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn SpecialValueMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn SpecialValueMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn SpecialValueMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj ValueMap - - -#### fn ValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn ValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn ValueMap.withType - -```ts -withType(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/row.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/row.md deleted file mode 100644 index d19255f..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/row.md +++ /dev/null @@ -1,187 +0,0 @@ -# row - -grafonnet.panel.row - -## Index - -* [`fn new(title)`](#fn-new) -* [`fn withCollapsed(value=false)`](#fn-withcollapsed) -* [`fn withDatasource(value)`](#fn-withdatasource) -* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) -* [`fn withGridPos(value)`](#fn-withgridpos) -* [`fn withGridPosMixin(value)`](#fn-withgridposmixin) -* [`fn withId(value)`](#fn-withid) -* [`fn withPanels(value)`](#fn-withpanels) -* [`fn withPanelsMixin(value)`](#fn-withpanelsmixin) -* [`fn withRepeat(value)`](#fn-withrepeat) -* [`fn withTitle(value)`](#fn-withtitle) -* [`fn withType()`](#fn-withtype) -* [`obj datasource`](#obj-datasource) - * [`fn withType(value)`](#fn-datasourcewithtype) - * [`fn withUid(value)`](#fn-datasourcewithuid) -* [`obj gridPos`](#obj-gridpos) - * [`fn withH(value=9)`](#fn-gridposwithh) - * [`fn withStatic(value)`](#fn-gridposwithstatic) - * [`fn withW(value=12)`](#fn-gridposwithw) - * [`fn withX(value=0)`](#fn-gridposwithx) - * [`fn withY(value=0)`](#fn-gridposwithy) - -## Fields - -### fn new - -```ts -new(title) -``` - -Creates a new row panel with a title. - -### fn withCollapsed - -```ts -withCollapsed(value=false) -``` - - - -### fn withDatasource - -```ts -withDatasource(value) -``` - -Name of default datasource. - -### fn withDatasourceMixin - -```ts -withDatasourceMixin(value) -``` - -Name of default datasource. - -### fn withGridPos - -```ts -withGridPos(value) -``` - - - -### fn withGridPosMixin - -```ts -withGridPosMixin(value) -``` - - - -### fn withId - -```ts -withId(value) -``` - - - -### fn withPanels - -```ts -withPanels(value) -``` - - - -### fn withPanelsMixin - -```ts -withPanelsMixin(value) -``` - - - -### fn withRepeat - -```ts -withRepeat(value) -``` - -Name of template variable to repeat for. - -### fn withTitle - -```ts -withTitle(value) -``` - - - -### fn withType - -```ts -withType() -``` - - - -### obj datasource - - -#### fn datasource.withType - -```ts -withType(value) -``` - - - -#### fn datasource.withUid - -```ts -withUid(value) -``` - - - -### obj gridPos - - -#### fn gridPos.withH - -```ts -withH(value=9) -``` - -Panel - -#### fn gridPos.withStatic - -```ts -withStatic(value) -``` - -true if fixed - -#### fn gridPos.withW - -```ts -withW(value=12) -``` - -Panel - -#### fn gridPos.withX - -```ts -withX(value=0) -``` - -Panel x - -#### fn gridPos.withY - -```ts -withY(value=0) -``` - -Panel y diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stat/fieldOverride.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stat/fieldOverride.md deleted file mode 100644 index 3e2667b..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stat/fieldOverride.md +++ /dev/null @@ -1,194 +0,0 @@ -# fieldOverride - -Overrides allow you to customize visualization settings for specific fields or -series. This is accomplished by adding an override rule that targets -a particular set of fields and that can each define multiple options. - -```jsonnet -fieldOverride.byType.new('number') -+ fieldOverride.byType.withPropertiesFromOptions( - panel.standardOptions.withDecimals(2) - + panel.standardOptions.withUnit('s') -) -``` - - -## Index - -* [`obj byName`](#obj-byname) - * [`fn new(value)`](#fn-bynamenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bynamewithproperty) -* [`obj byQuery`](#obj-byquery) - * [`fn new(value)`](#fn-byquerynew) - * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byquerywithproperty) -* [`obj byRegexp`](#obj-byregexp) - * [`fn new(value)`](#fn-byregexpnew) - * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) -* [`obj byType`](#obj-bytype) - * [`fn new(value)`](#fn-bytypenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bytypewithproperty) -* [`obj byValue`](#obj-byvalue) - * [`fn new(value)`](#fn-byvaluenew) - * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) - -## Fields - -### obj byName - - -#### fn byName.new - -```ts -new(value) -``` - -`new` creates a new override of type `byName`. - -#### fn byName.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byName.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byQuery - - -#### fn byQuery.new - -```ts -new(value) -``` - -`new` creates a new override of type `byQuery`. - -#### fn byQuery.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byQuery.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byRegexp - - -#### fn byRegexp.new - -```ts -new(value) -``` - -`new` creates a new override of type `byRegexp`. - -#### fn byRegexp.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byRegexp.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byType - - -#### fn byType.new - -```ts -new(value) -``` - -`new` creates a new override of type `byType`. - -#### fn byType.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byType.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byValue - - -#### fn byValue.new - -```ts -new(value) -``` - -`new` creates a new override of type `byValue`. - -#### fn byValue.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byValue.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stat/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stat/index.md deleted file mode 100644 index 259e64c..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stat/index.md +++ /dev/null @@ -1,632 +0,0 @@ -# stat - -grafonnet.panel.stat - -## Subpackages - -* [fieldOverride](fieldOverride.md) -* [link](link.md) -* [thresholdStep](thresholdStep.md) -* [transformation](transformation.md) -* [valueMapping](valueMapping.md) - -## Index - -* [`fn new(title)`](#fn-new) -* [`obj datasource`](#obj-datasource) - * [`fn withType(value)`](#fn-datasourcewithtype) - * [`fn withUid(value)`](#fn-datasourcewithuid) -* [`obj gridPos`](#obj-gridpos) - * [`fn withH(value=9)`](#fn-gridposwithh) - * [`fn withStatic(value)`](#fn-gridposwithstatic) - * [`fn withW(value=12)`](#fn-gridposwithw) - * [`fn withX(value=0)`](#fn-gridposwithx) - * [`fn withY(value=0)`](#fn-gridposwithy) -* [`obj libraryPanel`](#obj-librarypanel) - * [`fn withName(value)`](#fn-librarypanelwithname) - * [`fn withUid(value)`](#fn-librarypanelwithuid) -* [`obj options`](#obj-options) - * [`fn withColorMode(value)`](#fn-optionswithcolormode) - * [`fn withGraphMode(value)`](#fn-optionswithgraphmode) - * [`fn withJustifyMode(value)`](#fn-optionswithjustifymode) - * [`fn withOrientation(value)`](#fn-optionswithorientation) - * [`fn withReduceOptions(value)`](#fn-optionswithreduceoptions) - * [`fn withReduceOptionsMixin(value)`](#fn-optionswithreduceoptionsmixin) - * [`fn withText(value)`](#fn-optionswithtext) - * [`fn withTextMixin(value)`](#fn-optionswithtextmixin) - * [`fn withTextMode(value)`](#fn-optionswithtextmode) - * [`obj reduceOptions`](#obj-optionsreduceoptions) - * [`fn withCalcs(value)`](#fn-optionsreduceoptionswithcalcs) - * [`fn withCalcsMixin(value)`](#fn-optionsreduceoptionswithcalcsmixin) - * [`fn withFields(value)`](#fn-optionsreduceoptionswithfields) - * [`fn withLimit(value)`](#fn-optionsreduceoptionswithlimit) - * [`fn withValues(value)`](#fn-optionsreduceoptionswithvalues) - * [`obj text`](#obj-optionstext) - * [`fn withTitleSize(value)`](#fn-optionstextwithtitlesize) - * [`fn withValueSize(value)`](#fn-optionstextwithvaluesize) -* [`obj panelOptions`](#obj-paneloptions) - * [`fn withDescription(value)`](#fn-paneloptionswithdescription) - * [`fn withLinks(value)`](#fn-paneloptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) - * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) - * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) - * [`fn withTitle(value)`](#fn-paneloptionswithtitle) - * [`fn withTransparent(value=false)`](#fn-paneloptionswithtransparent) -* [`obj queryOptions`](#obj-queryoptions) - * [`fn withDatasource(value)`](#fn-queryoptionswithdatasource) - * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) - * [`fn withInterval(value)`](#fn-queryoptionswithinterval) - * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) - * [`fn withTargets(value)`](#fn-queryoptionswithtargets) - * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) - * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) - * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) - * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) - * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) -* [`obj standardOptions`](#obj-standardoptions) - * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) - * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) - * [`fn withLinks(value)`](#fn-standardoptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) - * [`fn withMappings(value)`](#fn-standardoptionswithmappings) - * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) - * [`fn withMax(value)`](#fn-standardoptionswithmax) - * [`fn withMin(value)`](#fn-standardoptionswithmin) - * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) - * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) - * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) - * [`fn withUnit(value)`](#fn-standardoptionswithunit) - * [`obj color`](#obj-standardoptionscolor) - * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) - * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) - * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) - * [`obj thresholds`](#obj-standardoptionsthresholds) - * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) - * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) - * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) - -## Fields - -### fn new - -```ts -new(title) -``` - -Creates a new stat panel with a title. - -### obj datasource - - -#### fn datasource.withType - -```ts -withType(value) -``` - - - -#### fn datasource.withUid - -```ts -withUid(value) -``` - - - -### obj gridPos - - -#### fn gridPos.withH - -```ts -withH(value=9) -``` - -Panel - -#### fn gridPos.withStatic - -```ts -withStatic(value) -``` - -true if fixed - -#### fn gridPos.withW - -```ts -withW(value=12) -``` - -Panel - -#### fn gridPos.withX - -```ts -withX(value=0) -``` - -Panel x - -#### fn gridPos.withY - -```ts -withY(value=0) -``` - -Panel y - -### obj libraryPanel - - -#### fn libraryPanel.withName - -```ts -withName(value) -``` - - - -#### fn libraryPanel.withUid - -```ts -withUid(value) -``` - - - -### obj options - - -#### fn options.withColorMode - -```ts -withColorMode(value) -``` - -TODO docs - -Accepted values for `value` are "value", "background", "background_solid", "none" - -#### fn options.withGraphMode - -```ts -withGraphMode(value) -``` - -TODO docs - -Accepted values for `value` are "none", "line", "area" - -#### fn options.withJustifyMode - -```ts -withJustifyMode(value) -``` - -TODO docs - -Accepted values for `value` are "auto", "center" - -#### fn options.withOrientation - -```ts -withOrientation(value) -``` - -TODO docs - -Accepted values for `value` are "auto", "vertical", "horizontal" - -#### fn options.withReduceOptions - -```ts -withReduceOptions(value) -``` - -TODO docs - -#### fn options.withReduceOptionsMixin - -```ts -withReduceOptionsMixin(value) -``` - -TODO docs - -#### fn options.withText - -```ts -withText(value) -``` - -TODO docs - -#### fn options.withTextMixin - -```ts -withTextMixin(value) -``` - -TODO docs - -#### fn options.withTextMode - -```ts -withTextMode(value) -``` - -TODO docs - -Accepted values for `value` are "auto", "value", "value_and_name", "name", "none" - -#### obj options.reduceOptions - - -##### fn options.reduceOptions.withCalcs - -```ts -withCalcs(value) -``` - -When !values, pick one value for the whole field - -##### fn options.reduceOptions.withCalcsMixin - -```ts -withCalcsMixin(value) -``` - -When !values, pick one value for the whole field - -##### fn options.reduceOptions.withFields - -```ts -withFields(value) -``` - -Which fields to show. By default this is only numeric fields - -##### fn options.reduceOptions.withLimit - -```ts -withLimit(value) -``` - -if showing all values limit - -##### fn options.reduceOptions.withValues - -```ts -withValues(value) -``` - -If true show each row value - -#### obj options.text - - -##### fn options.text.withTitleSize - -```ts -withTitleSize(value) -``` - -Explicit title text size - -##### fn options.text.withValueSize - -```ts -withValueSize(value) -``` - -Explicit value text size - -### obj panelOptions - - -#### fn panelOptions.withDescription - -```ts -withDescription(value) -``` - -Description. - -#### fn panelOptions.withLinks - -```ts -withLinks(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withRepeat - -```ts -withRepeat(value) -``` - -Name of template variable to repeat for. - -#### fn panelOptions.withRepeatDirection - -```ts -withRepeatDirection(value="h") -``` - -Direction to repeat in if 'repeat' is set. -"h" for horizontal, "v" for vertical. -TODO this is probably optional - -Accepted values for `value` are "h", "v" - -#### fn panelOptions.withTitle - -```ts -withTitle(value) -``` - -Panel title. - -#### fn panelOptions.withTransparent - -```ts -withTransparent(value=false) -``` - -Whether to display the panel without a background. - -### obj queryOptions - - -#### fn queryOptions.withDatasource - -```ts -withDatasource(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withDatasourceMixin - -```ts -withDatasourceMixin(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withInterval - -```ts -withInterval(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withMaxDataPoints - -```ts -withMaxDataPoints(value) -``` - -TODO docs - -#### fn queryOptions.withTargets - -```ts -withTargets(value) -``` - -TODO docs - -#### fn queryOptions.withTargetsMixin - -```ts -withTargetsMixin(value) -``` - -TODO docs - -#### fn queryOptions.withTimeFrom - -```ts -withTimeFrom(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTimeShift - -```ts -withTimeShift(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTransformations - -```ts -withTransformations(value) -``` - - - -#### fn queryOptions.withTransformationsMixin - -```ts -withTransformationsMixin(value) -``` - - - -### obj standardOptions - - -#### fn standardOptions.withDecimals - -```ts -withDecimals(value) -``` - -Significant digits (for display) - -#### fn standardOptions.withDisplayName - -```ts -withDisplayName(value) -``` - -The display value for this field. This supports template variables blank is auto - -#### fn standardOptions.withLinks - -```ts -withLinks(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withMappings - -```ts -withMappings(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMappingsMixin - -```ts -withMappingsMixin(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMax - -```ts -withMax(value) -``` - - - -#### fn standardOptions.withMin - -```ts -withMin(value) -``` - - - -#### fn standardOptions.withNoValue - -```ts -withNoValue(value) -``` - -Alternative to empty string - -#### fn standardOptions.withOverrides - -```ts -withOverrides(value) -``` - - - -#### fn standardOptions.withOverridesMixin - -```ts -withOverridesMixin(value) -``` - - - -#### fn standardOptions.withUnit - -```ts -withUnit(value) -``` - -Numeric Options - -#### obj standardOptions.color - - -##### fn standardOptions.color.withFixedColor - -```ts -withFixedColor(value) -``` - -Stores the fixed color value if mode is fixed - -##### fn standardOptions.color.withMode - -```ts -withMode(value) -``` - -The main color scheme mode - -##### fn standardOptions.color.withSeriesBy - -```ts -withSeriesBy(value) -``` - -TODO docs - -Accepted values for `value` are "min", "max", "last" - -#### obj standardOptions.thresholds - - -##### fn standardOptions.thresholds.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "absolute", "percentage" - -##### fn standardOptions.thresholds.withSteps - -```ts -withSteps(value) -``` - -Must be sorted by 'value', first value is always -Infinity - -##### fn standardOptions.thresholds.withStepsMixin - -```ts -withStepsMixin(value) -``` - -Must be sorted by 'value', first value is always -Infinity diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stat/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stat/link.md deleted file mode 100644 index 1a1d7c4..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stat/link.md +++ /dev/null @@ -1,109 +0,0 @@ -# link - - - -## Index - -* [`fn withAsDropdown(value=false)`](#fn-withasdropdown) -* [`fn withIcon(value)`](#fn-withicon) -* [`fn withIncludeVars(value=false)`](#fn-withincludevars) -* [`fn withKeepTime(value=false)`](#fn-withkeeptime) -* [`fn withTags(value)`](#fn-withtags) -* [`fn withTagsMixin(value)`](#fn-withtagsmixin) -* [`fn withTargetBlank(value=false)`](#fn-withtargetblank) -* [`fn withTitle(value)`](#fn-withtitle) -* [`fn withTooltip(value)`](#fn-withtooltip) -* [`fn withType(value)`](#fn-withtype) -* [`fn withUrl(value)`](#fn-withurl) - -## Fields - -### fn withAsDropdown - -```ts -withAsDropdown(value=false) -``` - - - -### fn withIcon - -```ts -withIcon(value) -``` - - - -### fn withIncludeVars - -```ts -withIncludeVars(value=false) -``` - - - -### fn withKeepTime - -```ts -withKeepTime(value=false) -``` - - - -### fn withTags - -```ts -withTags(value) -``` - - - -### fn withTagsMixin - -```ts -withTagsMixin(value) -``` - - - -### fn withTargetBlank - -```ts -withTargetBlank(value=false) -``` - - - -### fn withTitle - -```ts -withTitle(value) -``` - - - -### fn withTooltip - -```ts -withTooltip(value) -``` - - - -### fn withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "link", "dashboards" - -### fn withUrl - -```ts -withUrl(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stat/thresholdStep.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stat/thresholdStep.md deleted file mode 100644 index 9d6af42..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stat/thresholdStep.md +++ /dev/null @@ -1,47 +0,0 @@ -# thresholdStep - - - -## Index - -* [`fn withColor(value)`](#fn-withcolor) -* [`fn withIndex(value)`](#fn-withindex) -* [`fn withState(value)`](#fn-withstate) -* [`fn withValue(value)`](#fn-withvalue) - -## Fields - -### fn withColor - -```ts -withColor(value) -``` - -TODO docs - -### fn withIndex - -```ts -withIndex(value) -``` - -Threshold index, an old property that is not needed an should only appear in older dashboards - -### fn withState - -```ts -withState(value) -``` - -TODO docs -TODO are the values here enumerable into a disjunction? -Some seem to be listed in typescript comment - -### fn withValue - -```ts -withValue(value) -``` - -TODO docs -FIXME the corresponding typescript field is required/non-optional, but nulls currently appear here when serializing -Infinity to JSON diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stat/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stat/transformation.md deleted file mode 100644 index 3dac7e9..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stat/transformation.md +++ /dev/null @@ -1,76 +0,0 @@ -# transformation - - - -## Index - -* [`fn withDisabled(value)`](#fn-withdisabled) -* [`fn withFilter(value)`](#fn-withfilter) -* [`fn withFilterMixin(value)`](#fn-withfiltermixin) -* [`fn withId(value)`](#fn-withid) -* [`fn withOptions(value)`](#fn-withoptions) -* [`obj filter`](#obj-filter) - * [`fn withId(value="")`](#fn-filterwithid) - * [`fn withOptions(value)`](#fn-filterwithoptions) - -## Fields - -### fn withDisabled - -```ts -withDisabled(value) -``` - -Disabled transformations are skipped - -### fn withFilter - -```ts -withFilter(value) -``` - - - -### fn withFilterMixin - -```ts -withFilterMixin(value) -``` - - - -### fn withId - -```ts -withId(value) -``` - -Unique identifier of transformer - -### fn withOptions - -```ts -withOptions(value) -``` - -Options to be passed to the transformer -Valid options depend on the transformer id - -### obj filter - - -#### fn filter.withId - -```ts -withId(value="") -``` - - - -#### fn filter.withOptions - -```ts -withOptions(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stat/valueMapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stat/valueMapping.md deleted file mode 100644 index a6bbdb3..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stat/valueMapping.md +++ /dev/null @@ -1,365 +0,0 @@ -# valueMapping - - - -## Index - -* [`obj RangeMap`](#obj-rangemap) - * [`fn withOptions(value)`](#fn-rangemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) - * [`obj options`](#obj-rangemapoptions) - * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) - * [`fn withResult(value)`](#fn-rangemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) - * [`fn withTo(value)`](#fn-rangemapoptionswithto) - * [`obj result`](#obj-rangemapoptionsresult) - * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) -* [`obj RegexMap`](#obj-regexmap) - * [`fn withOptions(value)`](#fn-regexmapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) - * [`obj options`](#obj-regexmapoptions) - * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) - * [`fn withResult(value)`](#fn-regexmapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) - * [`obj result`](#obj-regexmapoptionsresult) - * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) - * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) -* [`obj SpecialValueMap`](#obj-specialvaluemap) - * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) - * [`obj options`](#obj-specialvaluemapoptions) - * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) - * [`fn withPattern(value)`](#fn-specialvaluemapoptionswithpattern) - * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) - * [`obj result`](#obj-specialvaluemapoptionsresult) - * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) -* [`obj ValueMap`](#obj-valuemap) - * [`fn withOptions(value)`](#fn-valuemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) - -## Fields - -### obj RangeMap - - -#### fn RangeMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RangeMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RangeMap.withType - -```ts -withType(value) -``` - - - -#### obj RangeMap.options - - -##### fn RangeMap.options.withFrom - -```ts -withFrom(value) -``` - -to and from are `number | null` in current ts, really not sure what to do - -##### fn RangeMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RangeMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### fn RangeMap.options.withTo - -```ts -withTo(value) -``` - - - -##### obj RangeMap.options.result - - -###### fn RangeMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RangeMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RangeMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RangeMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj RegexMap - - -#### fn RegexMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RegexMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RegexMap.withType - -```ts -withType(value) -``` - - - -#### obj RegexMap.options - - -##### fn RegexMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn RegexMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RegexMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj RegexMap.options.result - - -###### fn RegexMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RegexMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RegexMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RegexMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj SpecialValueMap - - -#### fn SpecialValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn SpecialValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn SpecialValueMap.withType - -```ts -withType(value) -``` - - - -#### obj SpecialValueMap.options - - -##### fn SpecialValueMap.options.withMatch - -```ts -withMatch(value) -``` - - - -Accepted values for `value` are "true", "false" - -##### fn SpecialValueMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn SpecialValueMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn SpecialValueMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj SpecialValueMap.options.result - - -###### fn SpecialValueMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn SpecialValueMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn SpecialValueMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn SpecialValueMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj ValueMap - - -#### fn ValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn ValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn ValueMap.withType - -```ts -withType(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stateTimeline/fieldOverride.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stateTimeline/fieldOverride.md deleted file mode 100644 index 3e2667b..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stateTimeline/fieldOverride.md +++ /dev/null @@ -1,194 +0,0 @@ -# fieldOverride - -Overrides allow you to customize visualization settings for specific fields or -series. This is accomplished by adding an override rule that targets -a particular set of fields and that can each define multiple options. - -```jsonnet -fieldOverride.byType.new('number') -+ fieldOverride.byType.withPropertiesFromOptions( - panel.standardOptions.withDecimals(2) - + panel.standardOptions.withUnit('s') -) -``` - - -## Index - -* [`obj byName`](#obj-byname) - * [`fn new(value)`](#fn-bynamenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bynamewithproperty) -* [`obj byQuery`](#obj-byquery) - * [`fn new(value)`](#fn-byquerynew) - * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byquerywithproperty) -* [`obj byRegexp`](#obj-byregexp) - * [`fn new(value)`](#fn-byregexpnew) - * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) -* [`obj byType`](#obj-bytype) - * [`fn new(value)`](#fn-bytypenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bytypewithproperty) -* [`obj byValue`](#obj-byvalue) - * [`fn new(value)`](#fn-byvaluenew) - * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) - -## Fields - -### obj byName - - -#### fn byName.new - -```ts -new(value) -``` - -`new` creates a new override of type `byName`. - -#### fn byName.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byName.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byQuery - - -#### fn byQuery.new - -```ts -new(value) -``` - -`new` creates a new override of type `byQuery`. - -#### fn byQuery.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byQuery.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byRegexp - - -#### fn byRegexp.new - -```ts -new(value) -``` - -`new` creates a new override of type `byRegexp`. - -#### fn byRegexp.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byRegexp.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byType - - -#### fn byType.new - -```ts -new(value) -``` - -`new` creates a new override of type `byType`. - -#### fn byType.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byType.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byValue - - -#### fn byValue.new - -```ts -new(value) -``` - -`new` creates a new override of type `byValue`. - -#### fn byValue.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byValue.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stateTimeline/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stateTimeline/index.md deleted file mode 100644 index 78b99cd..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stateTimeline/index.md +++ /dev/null @@ -1,764 +0,0 @@ -# stateTimeline - -grafonnet.panel.stateTimeline - -## Subpackages - -* [fieldOverride](fieldOverride.md) -* [link](link.md) -* [thresholdStep](thresholdStep.md) -* [transformation](transformation.md) -* [valueMapping](valueMapping.md) - -## Index - -* [`fn new(title)`](#fn-new) -* [`obj datasource`](#obj-datasource) - * [`fn withType(value)`](#fn-datasourcewithtype) - * [`fn withUid(value)`](#fn-datasourcewithuid) -* [`obj fieldConfig`](#obj-fieldconfig) - * [`obj defaults`](#obj-fieldconfigdefaults) - * [`obj custom`](#obj-fieldconfigdefaultscustom) - * [`fn withFillOpacity(value=70)`](#fn-fieldconfigdefaultscustomwithfillopacity) - * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomwithhidefrom) - * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomwithhidefrommixin) - * [`fn withLineWidth(value=0)`](#fn-fieldconfigdefaultscustomwithlinewidth) - * [`obj hideFrom`](#obj-fieldconfigdefaultscustomhidefrom) - * [`fn withLegend(value)`](#fn-fieldconfigdefaultscustomhidefromwithlegend) - * [`fn withTooltip(value)`](#fn-fieldconfigdefaultscustomhidefromwithtooltip) - * [`fn withViz(value)`](#fn-fieldconfigdefaultscustomhidefromwithviz) -* [`obj gridPos`](#obj-gridpos) - * [`fn withH(value=9)`](#fn-gridposwithh) - * [`fn withStatic(value)`](#fn-gridposwithstatic) - * [`fn withW(value=12)`](#fn-gridposwithw) - * [`fn withX(value=0)`](#fn-gridposwithx) - * [`fn withY(value=0)`](#fn-gridposwithy) -* [`obj libraryPanel`](#obj-librarypanel) - * [`fn withName(value)`](#fn-librarypanelwithname) - * [`fn withUid(value)`](#fn-librarypanelwithuid) -* [`obj options`](#obj-options) - * [`fn withAlignValue(value)`](#fn-optionswithalignvalue) - * [`fn withLegend(value)`](#fn-optionswithlegend) - * [`fn withLegendMixin(value)`](#fn-optionswithlegendmixin) - * [`fn withMergeValues(value=true)`](#fn-optionswithmergevalues) - * [`fn withRowHeight(value=0.9)`](#fn-optionswithrowheight) - * [`fn withShowValue(value)`](#fn-optionswithshowvalue) - * [`fn withTimezone(value)`](#fn-optionswithtimezone) - * [`fn withTimezoneMixin(value)`](#fn-optionswithtimezonemixin) - * [`fn withTooltip(value)`](#fn-optionswithtooltip) - * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) - * [`obj legend`](#obj-optionslegend) - * [`fn withAsTable(value)`](#fn-optionslegendwithastable) - * [`fn withCalcs(value)`](#fn-optionslegendwithcalcs) - * [`fn withCalcsMixin(value)`](#fn-optionslegendwithcalcsmixin) - * [`fn withDisplayMode(value)`](#fn-optionslegendwithdisplaymode) - * [`fn withIsVisible(value)`](#fn-optionslegendwithisvisible) - * [`fn withPlacement(value)`](#fn-optionslegendwithplacement) - * [`fn withShowLegend(value)`](#fn-optionslegendwithshowlegend) - * [`fn withSortBy(value)`](#fn-optionslegendwithsortby) - * [`fn withSortDesc(value)`](#fn-optionslegendwithsortdesc) - * [`fn withWidth(value)`](#fn-optionslegendwithwidth) - * [`obj tooltip`](#obj-optionstooltip) - * [`fn withMode(value)`](#fn-optionstooltipwithmode) - * [`fn withSort(value)`](#fn-optionstooltipwithsort) -* [`obj panelOptions`](#obj-paneloptions) - * [`fn withDescription(value)`](#fn-paneloptionswithdescription) - * [`fn withLinks(value)`](#fn-paneloptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) - * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) - * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) - * [`fn withTitle(value)`](#fn-paneloptionswithtitle) - * [`fn withTransparent(value=false)`](#fn-paneloptionswithtransparent) -* [`obj queryOptions`](#obj-queryoptions) - * [`fn withDatasource(value)`](#fn-queryoptionswithdatasource) - * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) - * [`fn withInterval(value)`](#fn-queryoptionswithinterval) - * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) - * [`fn withTargets(value)`](#fn-queryoptionswithtargets) - * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) - * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) - * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) - * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) - * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) -* [`obj standardOptions`](#obj-standardoptions) - * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) - * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) - * [`fn withLinks(value)`](#fn-standardoptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) - * [`fn withMappings(value)`](#fn-standardoptionswithmappings) - * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) - * [`fn withMax(value)`](#fn-standardoptionswithmax) - * [`fn withMin(value)`](#fn-standardoptionswithmin) - * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) - * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) - * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) - * [`fn withUnit(value)`](#fn-standardoptionswithunit) - * [`obj color`](#obj-standardoptionscolor) - * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) - * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) - * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) - * [`obj thresholds`](#obj-standardoptionsthresholds) - * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) - * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) - * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) - -## Fields - -### fn new - -```ts -new(title) -``` - -Creates a new stateTimeline panel with a title. - -### obj datasource - - -#### fn datasource.withType - -```ts -withType(value) -``` - - - -#### fn datasource.withUid - -```ts -withUid(value) -``` - - - -### obj fieldConfig - - -#### obj fieldConfig.defaults - - -##### obj fieldConfig.defaults.custom - - -###### fn fieldConfig.defaults.custom.withFillOpacity - -```ts -withFillOpacity(value=70) -``` - - - -###### fn fieldConfig.defaults.custom.withHideFrom - -```ts -withHideFrom(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withHideFromMixin - -```ts -withHideFromMixin(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withLineWidth - -```ts -withLineWidth(value=0) -``` - - - -###### obj fieldConfig.defaults.custom.hideFrom - - -####### fn fieldConfig.defaults.custom.hideFrom.withLegend - -```ts -withLegend(value) -``` - - - -####### fn fieldConfig.defaults.custom.hideFrom.withTooltip - -```ts -withTooltip(value) -``` - - - -####### fn fieldConfig.defaults.custom.hideFrom.withViz - -```ts -withViz(value) -``` - - - -### obj gridPos - - -#### fn gridPos.withH - -```ts -withH(value=9) -``` - -Panel - -#### fn gridPos.withStatic - -```ts -withStatic(value) -``` - -true if fixed - -#### fn gridPos.withW - -```ts -withW(value=12) -``` - -Panel - -#### fn gridPos.withX - -```ts -withX(value=0) -``` - -Panel x - -#### fn gridPos.withY - -```ts -withY(value=0) -``` - -Panel y - -### obj libraryPanel - - -#### fn libraryPanel.withName - -```ts -withName(value) -``` - - - -#### fn libraryPanel.withUid - -```ts -withUid(value) -``` - - - -### obj options - - -#### fn options.withAlignValue - -```ts -withAlignValue(value) -``` - -Controls value alignment on the timelines - -#### fn options.withLegend - -```ts -withLegend(value) -``` - -TODO docs - -#### fn options.withLegendMixin - -```ts -withLegendMixin(value) -``` - -TODO docs - -#### fn options.withMergeValues - -```ts -withMergeValues(value=true) -``` - -Merge equal consecutive values - -#### fn options.withRowHeight - -```ts -withRowHeight(value=0.9) -``` - -Controls the row height - -#### fn options.withShowValue - -```ts -withShowValue(value) -``` - -Show timeline values on chart - -#### fn options.withTimezone - -```ts -withTimezone(value) -``` - - - -#### fn options.withTimezoneMixin - -```ts -withTimezoneMixin(value) -``` - - - -#### fn options.withTooltip - -```ts -withTooltip(value) -``` - -TODO docs - -#### fn options.withTooltipMixin - -```ts -withTooltipMixin(value) -``` - -TODO docs - -#### obj options.legend - - -##### fn options.legend.withAsTable - -```ts -withAsTable(value) -``` - - - -##### fn options.legend.withCalcs - -```ts -withCalcs(value) -``` - - - -##### fn options.legend.withCalcsMixin - -```ts -withCalcsMixin(value) -``` - - - -##### fn options.legend.withDisplayMode - -```ts -withDisplayMode(value) -``` - -TODO docs -Note: "hidden" needs to remain as an option for plugins compatibility - -Accepted values for `value` are "list", "table", "hidden" - -##### fn options.legend.withIsVisible - -```ts -withIsVisible(value) -``` - - - -##### fn options.legend.withPlacement - -```ts -withPlacement(value) -``` - -TODO docs - -Accepted values for `value` are "bottom", "right" - -##### fn options.legend.withShowLegend - -```ts -withShowLegend(value) -``` - - - -##### fn options.legend.withSortBy - -```ts -withSortBy(value) -``` - - - -##### fn options.legend.withSortDesc - -```ts -withSortDesc(value) -``` - - - -##### fn options.legend.withWidth - -```ts -withWidth(value) -``` - - - -#### obj options.tooltip - - -##### fn options.tooltip.withMode - -```ts -withMode(value) -``` - -TODO docs - -Accepted values for `value` are "single", "multi", "none" - -##### fn options.tooltip.withSort - -```ts -withSort(value) -``` - -TODO docs - -Accepted values for `value` are "asc", "desc", "none" - -### obj panelOptions - - -#### fn panelOptions.withDescription - -```ts -withDescription(value) -``` - -Description. - -#### fn panelOptions.withLinks - -```ts -withLinks(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withRepeat - -```ts -withRepeat(value) -``` - -Name of template variable to repeat for. - -#### fn panelOptions.withRepeatDirection - -```ts -withRepeatDirection(value="h") -``` - -Direction to repeat in if 'repeat' is set. -"h" for horizontal, "v" for vertical. -TODO this is probably optional - -Accepted values for `value` are "h", "v" - -#### fn panelOptions.withTitle - -```ts -withTitle(value) -``` - -Panel title. - -#### fn panelOptions.withTransparent - -```ts -withTransparent(value=false) -``` - -Whether to display the panel without a background. - -### obj queryOptions - - -#### fn queryOptions.withDatasource - -```ts -withDatasource(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withDatasourceMixin - -```ts -withDatasourceMixin(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withInterval - -```ts -withInterval(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withMaxDataPoints - -```ts -withMaxDataPoints(value) -``` - -TODO docs - -#### fn queryOptions.withTargets - -```ts -withTargets(value) -``` - -TODO docs - -#### fn queryOptions.withTargetsMixin - -```ts -withTargetsMixin(value) -``` - -TODO docs - -#### fn queryOptions.withTimeFrom - -```ts -withTimeFrom(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTimeShift - -```ts -withTimeShift(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTransformations - -```ts -withTransformations(value) -``` - - - -#### fn queryOptions.withTransformationsMixin - -```ts -withTransformationsMixin(value) -``` - - - -### obj standardOptions - - -#### fn standardOptions.withDecimals - -```ts -withDecimals(value) -``` - -Significant digits (for display) - -#### fn standardOptions.withDisplayName - -```ts -withDisplayName(value) -``` - -The display value for this field. This supports template variables blank is auto - -#### fn standardOptions.withLinks - -```ts -withLinks(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withMappings - -```ts -withMappings(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMappingsMixin - -```ts -withMappingsMixin(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMax - -```ts -withMax(value) -``` - - - -#### fn standardOptions.withMin - -```ts -withMin(value) -``` - - - -#### fn standardOptions.withNoValue - -```ts -withNoValue(value) -``` - -Alternative to empty string - -#### fn standardOptions.withOverrides - -```ts -withOverrides(value) -``` - - - -#### fn standardOptions.withOverridesMixin - -```ts -withOverridesMixin(value) -``` - - - -#### fn standardOptions.withUnit - -```ts -withUnit(value) -``` - -Numeric Options - -#### obj standardOptions.color - - -##### fn standardOptions.color.withFixedColor - -```ts -withFixedColor(value) -``` - -Stores the fixed color value if mode is fixed - -##### fn standardOptions.color.withMode - -```ts -withMode(value) -``` - -The main color scheme mode - -##### fn standardOptions.color.withSeriesBy - -```ts -withSeriesBy(value) -``` - -TODO docs - -Accepted values for `value` are "min", "max", "last" - -#### obj standardOptions.thresholds - - -##### fn standardOptions.thresholds.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "absolute", "percentage" - -##### fn standardOptions.thresholds.withSteps - -```ts -withSteps(value) -``` - -Must be sorted by 'value', first value is always -Infinity - -##### fn standardOptions.thresholds.withStepsMixin - -```ts -withStepsMixin(value) -``` - -Must be sorted by 'value', first value is always -Infinity diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stateTimeline/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stateTimeline/link.md deleted file mode 100644 index 1a1d7c4..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stateTimeline/link.md +++ /dev/null @@ -1,109 +0,0 @@ -# link - - - -## Index - -* [`fn withAsDropdown(value=false)`](#fn-withasdropdown) -* [`fn withIcon(value)`](#fn-withicon) -* [`fn withIncludeVars(value=false)`](#fn-withincludevars) -* [`fn withKeepTime(value=false)`](#fn-withkeeptime) -* [`fn withTags(value)`](#fn-withtags) -* [`fn withTagsMixin(value)`](#fn-withtagsmixin) -* [`fn withTargetBlank(value=false)`](#fn-withtargetblank) -* [`fn withTitle(value)`](#fn-withtitle) -* [`fn withTooltip(value)`](#fn-withtooltip) -* [`fn withType(value)`](#fn-withtype) -* [`fn withUrl(value)`](#fn-withurl) - -## Fields - -### fn withAsDropdown - -```ts -withAsDropdown(value=false) -``` - - - -### fn withIcon - -```ts -withIcon(value) -``` - - - -### fn withIncludeVars - -```ts -withIncludeVars(value=false) -``` - - - -### fn withKeepTime - -```ts -withKeepTime(value=false) -``` - - - -### fn withTags - -```ts -withTags(value) -``` - - - -### fn withTagsMixin - -```ts -withTagsMixin(value) -``` - - - -### fn withTargetBlank - -```ts -withTargetBlank(value=false) -``` - - - -### fn withTitle - -```ts -withTitle(value) -``` - - - -### fn withTooltip - -```ts -withTooltip(value) -``` - - - -### fn withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "link", "dashboards" - -### fn withUrl - -```ts -withUrl(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stateTimeline/thresholdStep.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stateTimeline/thresholdStep.md deleted file mode 100644 index 9d6af42..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stateTimeline/thresholdStep.md +++ /dev/null @@ -1,47 +0,0 @@ -# thresholdStep - - - -## Index - -* [`fn withColor(value)`](#fn-withcolor) -* [`fn withIndex(value)`](#fn-withindex) -* [`fn withState(value)`](#fn-withstate) -* [`fn withValue(value)`](#fn-withvalue) - -## Fields - -### fn withColor - -```ts -withColor(value) -``` - -TODO docs - -### fn withIndex - -```ts -withIndex(value) -``` - -Threshold index, an old property that is not needed an should only appear in older dashboards - -### fn withState - -```ts -withState(value) -``` - -TODO docs -TODO are the values here enumerable into a disjunction? -Some seem to be listed in typescript comment - -### fn withValue - -```ts -withValue(value) -``` - -TODO docs -FIXME the corresponding typescript field is required/non-optional, but nulls currently appear here when serializing -Infinity to JSON diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stateTimeline/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stateTimeline/transformation.md deleted file mode 100644 index 3dac7e9..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stateTimeline/transformation.md +++ /dev/null @@ -1,76 +0,0 @@ -# transformation - - - -## Index - -* [`fn withDisabled(value)`](#fn-withdisabled) -* [`fn withFilter(value)`](#fn-withfilter) -* [`fn withFilterMixin(value)`](#fn-withfiltermixin) -* [`fn withId(value)`](#fn-withid) -* [`fn withOptions(value)`](#fn-withoptions) -* [`obj filter`](#obj-filter) - * [`fn withId(value="")`](#fn-filterwithid) - * [`fn withOptions(value)`](#fn-filterwithoptions) - -## Fields - -### fn withDisabled - -```ts -withDisabled(value) -``` - -Disabled transformations are skipped - -### fn withFilter - -```ts -withFilter(value) -``` - - - -### fn withFilterMixin - -```ts -withFilterMixin(value) -``` - - - -### fn withId - -```ts -withId(value) -``` - -Unique identifier of transformer - -### fn withOptions - -```ts -withOptions(value) -``` - -Options to be passed to the transformer -Valid options depend on the transformer id - -### obj filter - - -#### fn filter.withId - -```ts -withId(value="") -``` - - - -#### fn filter.withOptions - -```ts -withOptions(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stateTimeline/valueMapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stateTimeline/valueMapping.md deleted file mode 100644 index a6bbdb3..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/stateTimeline/valueMapping.md +++ /dev/null @@ -1,365 +0,0 @@ -# valueMapping - - - -## Index - -* [`obj RangeMap`](#obj-rangemap) - * [`fn withOptions(value)`](#fn-rangemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) - * [`obj options`](#obj-rangemapoptions) - * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) - * [`fn withResult(value)`](#fn-rangemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) - * [`fn withTo(value)`](#fn-rangemapoptionswithto) - * [`obj result`](#obj-rangemapoptionsresult) - * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) -* [`obj RegexMap`](#obj-regexmap) - * [`fn withOptions(value)`](#fn-regexmapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) - * [`obj options`](#obj-regexmapoptions) - * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) - * [`fn withResult(value)`](#fn-regexmapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) - * [`obj result`](#obj-regexmapoptionsresult) - * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) - * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) -* [`obj SpecialValueMap`](#obj-specialvaluemap) - * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) - * [`obj options`](#obj-specialvaluemapoptions) - * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) - * [`fn withPattern(value)`](#fn-specialvaluemapoptionswithpattern) - * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) - * [`obj result`](#obj-specialvaluemapoptionsresult) - * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) -* [`obj ValueMap`](#obj-valuemap) - * [`fn withOptions(value)`](#fn-valuemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) - -## Fields - -### obj RangeMap - - -#### fn RangeMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RangeMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RangeMap.withType - -```ts -withType(value) -``` - - - -#### obj RangeMap.options - - -##### fn RangeMap.options.withFrom - -```ts -withFrom(value) -``` - -to and from are `number | null` in current ts, really not sure what to do - -##### fn RangeMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RangeMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### fn RangeMap.options.withTo - -```ts -withTo(value) -``` - - - -##### obj RangeMap.options.result - - -###### fn RangeMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RangeMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RangeMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RangeMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj RegexMap - - -#### fn RegexMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RegexMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RegexMap.withType - -```ts -withType(value) -``` - - - -#### obj RegexMap.options - - -##### fn RegexMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn RegexMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RegexMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj RegexMap.options.result - - -###### fn RegexMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RegexMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RegexMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RegexMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj SpecialValueMap - - -#### fn SpecialValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn SpecialValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn SpecialValueMap.withType - -```ts -withType(value) -``` - - - -#### obj SpecialValueMap.options - - -##### fn SpecialValueMap.options.withMatch - -```ts -withMatch(value) -``` - - - -Accepted values for `value` are "true", "false" - -##### fn SpecialValueMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn SpecialValueMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn SpecialValueMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj SpecialValueMap.options.result - - -###### fn SpecialValueMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn SpecialValueMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn SpecialValueMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn SpecialValueMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj ValueMap - - -#### fn ValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn ValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn ValueMap.withType - -```ts -withType(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/statusHistory/fieldOverride.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/statusHistory/fieldOverride.md deleted file mode 100644 index 3e2667b..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/statusHistory/fieldOverride.md +++ /dev/null @@ -1,194 +0,0 @@ -# fieldOverride - -Overrides allow you to customize visualization settings for specific fields or -series. This is accomplished by adding an override rule that targets -a particular set of fields and that can each define multiple options. - -```jsonnet -fieldOverride.byType.new('number') -+ fieldOverride.byType.withPropertiesFromOptions( - panel.standardOptions.withDecimals(2) - + panel.standardOptions.withUnit('s') -) -``` - - -## Index - -* [`obj byName`](#obj-byname) - * [`fn new(value)`](#fn-bynamenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bynamewithproperty) -* [`obj byQuery`](#obj-byquery) - * [`fn new(value)`](#fn-byquerynew) - * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byquerywithproperty) -* [`obj byRegexp`](#obj-byregexp) - * [`fn new(value)`](#fn-byregexpnew) - * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) -* [`obj byType`](#obj-bytype) - * [`fn new(value)`](#fn-bytypenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bytypewithproperty) -* [`obj byValue`](#obj-byvalue) - * [`fn new(value)`](#fn-byvaluenew) - * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) - -## Fields - -### obj byName - - -#### fn byName.new - -```ts -new(value) -``` - -`new` creates a new override of type `byName`. - -#### fn byName.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byName.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byQuery - - -#### fn byQuery.new - -```ts -new(value) -``` - -`new` creates a new override of type `byQuery`. - -#### fn byQuery.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byQuery.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byRegexp - - -#### fn byRegexp.new - -```ts -new(value) -``` - -`new` creates a new override of type `byRegexp`. - -#### fn byRegexp.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byRegexp.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byType - - -#### fn byType.new - -```ts -new(value) -``` - -`new` creates a new override of type `byType`. - -#### fn byType.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byType.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byValue - - -#### fn byValue.new - -```ts -new(value) -``` - -`new` creates a new override of type `byValue`. - -#### fn byValue.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byValue.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/statusHistory/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/statusHistory/index.md deleted file mode 100644 index 6de8abc..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/statusHistory/index.md +++ /dev/null @@ -1,755 +0,0 @@ -# statusHistory - -grafonnet.panel.statusHistory - -## Subpackages - -* [fieldOverride](fieldOverride.md) -* [link](link.md) -* [thresholdStep](thresholdStep.md) -* [transformation](transformation.md) -* [valueMapping](valueMapping.md) - -## Index - -* [`fn new(title)`](#fn-new) -* [`obj datasource`](#obj-datasource) - * [`fn withType(value)`](#fn-datasourcewithtype) - * [`fn withUid(value)`](#fn-datasourcewithuid) -* [`obj fieldConfig`](#obj-fieldconfig) - * [`obj defaults`](#obj-fieldconfigdefaults) - * [`obj custom`](#obj-fieldconfigdefaultscustom) - * [`fn withFillOpacity(value=70)`](#fn-fieldconfigdefaultscustomwithfillopacity) - * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomwithhidefrom) - * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomwithhidefrommixin) - * [`fn withLineWidth(value=1)`](#fn-fieldconfigdefaultscustomwithlinewidth) - * [`obj hideFrom`](#obj-fieldconfigdefaultscustomhidefrom) - * [`fn withLegend(value)`](#fn-fieldconfigdefaultscustomhidefromwithlegend) - * [`fn withTooltip(value)`](#fn-fieldconfigdefaultscustomhidefromwithtooltip) - * [`fn withViz(value)`](#fn-fieldconfigdefaultscustomhidefromwithviz) -* [`obj gridPos`](#obj-gridpos) - * [`fn withH(value=9)`](#fn-gridposwithh) - * [`fn withStatic(value)`](#fn-gridposwithstatic) - * [`fn withW(value=12)`](#fn-gridposwithw) - * [`fn withX(value=0)`](#fn-gridposwithx) - * [`fn withY(value=0)`](#fn-gridposwithy) -* [`obj libraryPanel`](#obj-librarypanel) - * [`fn withName(value)`](#fn-librarypanelwithname) - * [`fn withUid(value)`](#fn-librarypanelwithuid) -* [`obj options`](#obj-options) - * [`fn withColWidth(value=0.9)`](#fn-optionswithcolwidth) - * [`fn withLegend(value)`](#fn-optionswithlegend) - * [`fn withLegendMixin(value)`](#fn-optionswithlegendmixin) - * [`fn withRowHeight(value=0.9)`](#fn-optionswithrowheight) - * [`fn withShowValue(value)`](#fn-optionswithshowvalue) - * [`fn withTimezone(value)`](#fn-optionswithtimezone) - * [`fn withTimezoneMixin(value)`](#fn-optionswithtimezonemixin) - * [`fn withTooltip(value)`](#fn-optionswithtooltip) - * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) - * [`obj legend`](#obj-optionslegend) - * [`fn withAsTable(value)`](#fn-optionslegendwithastable) - * [`fn withCalcs(value)`](#fn-optionslegendwithcalcs) - * [`fn withCalcsMixin(value)`](#fn-optionslegendwithcalcsmixin) - * [`fn withDisplayMode(value)`](#fn-optionslegendwithdisplaymode) - * [`fn withIsVisible(value)`](#fn-optionslegendwithisvisible) - * [`fn withPlacement(value)`](#fn-optionslegendwithplacement) - * [`fn withShowLegend(value)`](#fn-optionslegendwithshowlegend) - * [`fn withSortBy(value)`](#fn-optionslegendwithsortby) - * [`fn withSortDesc(value)`](#fn-optionslegendwithsortdesc) - * [`fn withWidth(value)`](#fn-optionslegendwithwidth) - * [`obj tooltip`](#obj-optionstooltip) - * [`fn withMode(value)`](#fn-optionstooltipwithmode) - * [`fn withSort(value)`](#fn-optionstooltipwithsort) -* [`obj panelOptions`](#obj-paneloptions) - * [`fn withDescription(value)`](#fn-paneloptionswithdescription) - * [`fn withLinks(value)`](#fn-paneloptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) - * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) - * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) - * [`fn withTitle(value)`](#fn-paneloptionswithtitle) - * [`fn withTransparent(value=false)`](#fn-paneloptionswithtransparent) -* [`obj queryOptions`](#obj-queryoptions) - * [`fn withDatasource(value)`](#fn-queryoptionswithdatasource) - * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) - * [`fn withInterval(value)`](#fn-queryoptionswithinterval) - * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) - * [`fn withTargets(value)`](#fn-queryoptionswithtargets) - * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) - * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) - * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) - * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) - * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) -* [`obj standardOptions`](#obj-standardoptions) - * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) - * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) - * [`fn withLinks(value)`](#fn-standardoptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) - * [`fn withMappings(value)`](#fn-standardoptionswithmappings) - * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) - * [`fn withMax(value)`](#fn-standardoptionswithmax) - * [`fn withMin(value)`](#fn-standardoptionswithmin) - * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) - * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) - * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) - * [`fn withUnit(value)`](#fn-standardoptionswithunit) - * [`obj color`](#obj-standardoptionscolor) - * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) - * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) - * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) - * [`obj thresholds`](#obj-standardoptionsthresholds) - * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) - * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) - * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) - -## Fields - -### fn new - -```ts -new(title) -``` - -Creates a new statusHistory panel with a title. - -### obj datasource - - -#### fn datasource.withType - -```ts -withType(value) -``` - - - -#### fn datasource.withUid - -```ts -withUid(value) -``` - - - -### obj fieldConfig - - -#### obj fieldConfig.defaults - - -##### obj fieldConfig.defaults.custom - - -###### fn fieldConfig.defaults.custom.withFillOpacity - -```ts -withFillOpacity(value=70) -``` - - - -###### fn fieldConfig.defaults.custom.withHideFrom - -```ts -withHideFrom(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withHideFromMixin - -```ts -withHideFromMixin(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withLineWidth - -```ts -withLineWidth(value=1) -``` - - - -###### obj fieldConfig.defaults.custom.hideFrom - - -####### fn fieldConfig.defaults.custom.hideFrom.withLegend - -```ts -withLegend(value) -``` - - - -####### fn fieldConfig.defaults.custom.hideFrom.withTooltip - -```ts -withTooltip(value) -``` - - - -####### fn fieldConfig.defaults.custom.hideFrom.withViz - -```ts -withViz(value) -``` - - - -### obj gridPos - - -#### fn gridPos.withH - -```ts -withH(value=9) -``` - -Panel - -#### fn gridPos.withStatic - -```ts -withStatic(value) -``` - -true if fixed - -#### fn gridPos.withW - -```ts -withW(value=12) -``` - -Panel - -#### fn gridPos.withX - -```ts -withX(value=0) -``` - -Panel x - -#### fn gridPos.withY - -```ts -withY(value=0) -``` - -Panel y - -### obj libraryPanel - - -#### fn libraryPanel.withName - -```ts -withName(value) -``` - - - -#### fn libraryPanel.withUid - -```ts -withUid(value) -``` - - - -### obj options - - -#### fn options.withColWidth - -```ts -withColWidth(value=0.9) -``` - -Controls the column width - -#### fn options.withLegend - -```ts -withLegend(value) -``` - -TODO docs - -#### fn options.withLegendMixin - -```ts -withLegendMixin(value) -``` - -TODO docs - -#### fn options.withRowHeight - -```ts -withRowHeight(value=0.9) -``` - -Set the height of the rows - -#### fn options.withShowValue - -```ts -withShowValue(value) -``` - -Show values on the columns - -#### fn options.withTimezone - -```ts -withTimezone(value) -``` - - - -#### fn options.withTimezoneMixin - -```ts -withTimezoneMixin(value) -``` - - - -#### fn options.withTooltip - -```ts -withTooltip(value) -``` - -TODO docs - -#### fn options.withTooltipMixin - -```ts -withTooltipMixin(value) -``` - -TODO docs - -#### obj options.legend - - -##### fn options.legend.withAsTable - -```ts -withAsTable(value) -``` - - - -##### fn options.legend.withCalcs - -```ts -withCalcs(value) -``` - - - -##### fn options.legend.withCalcsMixin - -```ts -withCalcsMixin(value) -``` - - - -##### fn options.legend.withDisplayMode - -```ts -withDisplayMode(value) -``` - -TODO docs -Note: "hidden" needs to remain as an option for plugins compatibility - -Accepted values for `value` are "list", "table", "hidden" - -##### fn options.legend.withIsVisible - -```ts -withIsVisible(value) -``` - - - -##### fn options.legend.withPlacement - -```ts -withPlacement(value) -``` - -TODO docs - -Accepted values for `value` are "bottom", "right" - -##### fn options.legend.withShowLegend - -```ts -withShowLegend(value) -``` - - - -##### fn options.legend.withSortBy - -```ts -withSortBy(value) -``` - - - -##### fn options.legend.withSortDesc - -```ts -withSortDesc(value) -``` - - - -##### fn options.legend.withWidth - -```ts -withWidth(value) -``` - - - -#### obj options.tooltip - - -##### fn options.tooltip.withMode - -```ts -withMode(value) -``` - -TODO docs - -Accepted values for `value` are "single", "multi", "none" - -##### fn options.tooltip.withSort - -```ts -withSort(value) -``` - -TODO docs - -Accepted values for `value` are "asc", "desc", "none" - -### obj panelOptions - - -#### fn panelOptions.withDescription - -```ts -withDescription(value) -``` - -Description. - -#### fn panelOptions.withLinks - -```ts -withLinks(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withRepeat - -```ts -withRepeat(value) -``` - -Name of template variable to repeat for. - -#### fn panelOptions.withRepeatDirection - -```ts -withRepeatDirection(value="h") -``` - -Direction to repeat in if 'repeat' is set. -"h" for horizontal, "v" for vertical. -TODO this is probably optional - -Accepted values for `value` are "h", "v" - -#### fn panelOptions.withTitle - -```ts -withTitle(value) -``` - -Panel title. - -#### fn panelOptions.withTransparent - -```ts -withTransparent(value=false) -``` - -Whether to display the panel without a background. - -### obj queryOptions - - -#### fn queryOptions.withDatasource - -```ts -withDatasource(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withDatasourceMixin - -```ts -withDatasourceMixin(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withInterval - -```ts -withInterval(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withMaxDataPoints - -```ts -withMaxDataPoints(value) -``` - -TODO docs - -#### fn queryOptions.withTargets - -```ts -withTargets(value) -``` - -TODO docs - -#### fn queryOptions.withTargetsMixin - -```ts -withTargetsMixin(value) -``` - -TODO docs - -#### fn queryOptions.withTimeFrom - -```ts -withTimeFrom(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTimeShift - -```ts -withTimeShift(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTransformations - -```ts -withTransformations(value) -``` - - - -#### fn queryOptions.withTransformationsMixin - -```ts -withTransformationsMixin(value) -``` - - - -### obj standardOptions - - -#### fn standardOptions.withDecimals - -```ts -withDecimals(value) -``` - -Significant digits (for display) - -#### fn standardOptions.withDisplayName - -```ts -withDisplayName(value) -``` - -The display value for this field. This supports template variables blank is auto - -#### fn standardOptions.withLinks - -```ts -withLinks(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withMappings - -```ts -withMappings(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMappingsMixin - -```ts -withMappingsMixin(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMax - -```ts -withMax(value) -``` - - - -#### fn standardOptions.withMin - -```ts -withMin(value) -``` - - - -#### fn standardOptions.withNoValue - -```ts -withNoValue(value) -``` - -Alternative to empty string - -#### fn standardOptions.withOverrides - -```ts -withOverrides(value) -``` - - - -#### fn standardOptions.withOverridesMixin - -```ts -withOverridesMixin(value) -``` - - - -#### fn standardOptions.withUnit - -```ts -withUnit(value) -``` - -Numeric Options - -#### obj standardOptions.color - - -##### fn standardOptions.color.withFixedColor - -```ts -withFixedColor(value) -``` - -Stores the fixed color value if mode is fixed - -##### fn standardOptions.color.withMode - -```ts -withMode(value) -``` - -The main color scheme mode - -##### fn standardOptions.color.withSeriesBy - -```ts -withSeriesBy(value) -``` - -TODO docs - -Accepted values for `value` are "min", "max", "last" - -#### obj standardOptions.thresholds - - -##### fn standardOptions.thresholds.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "absolute", "percentage" - -##### fn standardOptions.thresholds.withSteps - -```ts -withSteps(value) -``` - -Must be sorted by 'value', first value is always -Infinity - -##### fn standardOptions.thresholds.withStepsMixin - -```ts -withStepsMixin(value) -``` - -Must be sorted by 'value', first value is always -Infinity diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/statusHistory/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/statusHistory/link.md deleted file mode 100644 index 1a1d7c4..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/statusHistory/link.md +++ /dev/null @@ -1,109 +0,0 @@ -# link - - - -## Index - -* [`fn withAsDropdown(value=false)`](#fn-withasdropdown) -* [`fn withIcon(value)`](#fn-withicon) -* [`fn withIncludeVars(value=false)`](#fn-withincludevars) -* [`fn withKeepTime(value=false)`](#fn-withkeeptime) -* [`fn withTags(value)`](#fn-withtags) -* [`fn withTagsMixin(value)`](#fn-withtagsmixin) -* [`fn withTargetBlank(value=false)`](#fn-withtargetblank) -* [`fn withTitle(value)`](#fn-withtitle) -* [`fn withTooltip(value)`](#fn-withtooltip) -* [`fn withType(value)`](#fn-withtype) -* [`fn withUrl(value)`](#fn-withurl) - -## Fields - -### fn withAsDropdown - -```ts -withAsDropdown(value=false) -``` - - - -### fn withIcon - -```ts -withIcon(value) -``` - - - -### fn withIncludeVars - -```ts -withIncludeVars(value=false) -``` - - - -### fn withKeepTime - -```ts -withKeepTime(value=false) -``` - - - -### fn withTags - -```ts -withTags(value) -``` - - - -### fn withTagsMixin - -```ts -withTagsMixin(value) -``` - - - -### fn withTargetBlank - -```ts -withTargetBlank(value=false) -``` - - - -### fn withTitle - -```ts -withTitle(value) -``` - - - -### fn withTooltip - -```ts -withTooltip(value) -``` - - - -### fn withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "link", "dashboards" - -### fn withUrl - -```ts -withUrl(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/statusHistory/thresholdStep.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/statusHistory/thresholdStep.md deleted file mode 100644 index 9d6af42..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/statusHistory/thresholdStep.md +++ /dev/null @@ -1,47 +0,0 @@ -# thresholdStep - - - -## Index - -* [`fn withColor(value)`](#fn-withcolor) -* [`fn withIndex(value)`](#fn-withindex) -* [`fn withState(value)`](#fn-withstate) -* [`fn withValue(value)`](#fn-withvalue) - -## Fields - -### fn withColor - -```ts -withColor(value) -``` - -TODO docs - -### fn withIndex - -```ts -withIndex(value) -``` - -Threshold index, an old property that is not needed an should only appear in older dashboards - -### fn withState - -```ts -withState(value) -``` - -TODO docs -TODO are the values here enumerable into a disjunction? -Some seem to be listed in typescript comment - -### fn withValue - -```ts -withValue(value) -``` - -TODO docs -FIXME the corresponding typescript field is required/non-optional, but nulls currently appear here when serializing -Infinity to JSON diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/statusHistory/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/statusHistory/transformation.md deleted file mode 100644 index 3dac7e9..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/statusHistory/transformation.md +++ /dev/null @@ -1,76 +0,0 @@ -# transformation - - - -## Index - -* [`fn withDisabled(value)`](#fn-withdisabled) -* [`fn withFilter(value)`](#fn-withfilter) -* [`fn withFilterMixin(value)`](#fn-withfiltermixin) -* [`fn withId(value)`](#fn-withid) -* [`fn withOptions(value)`](#fn-withoptions) -* [`obj filter`](#obj-filter) - * [`fn withId(value="")`](#fn-filterwithid) - * [`fn withOptions(value)`](#fn-filterwithoptions) - -## Fields - -### fn withDisabled - -```ts -withDisabled(value) -``` - -Disabled transformations are skipped - -### fn withFilter - -```ts -withFilter(value) -``` - - - -### fn withFilterMixin - -```ts -withFilterMixin(value) -``` - - - -### fn withId - -```ts -withId(value) -``` - -Unique identifier of transformer - -### fn withOptions - -```ts -withOptions(value) -``` - -Options to be passed to the transformer -Valid options depend on the transformer id - -### obj filter - - -#### fn filter.withId - -```ts -withId(value="") -``` - - - -#### fn filter.withOptions - -```ts -withOptions(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/statusHistory/valueMapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/statusHistory/valueMapping.md deleted file mode 100644 index a6bbdb3..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/statusHistory/valueMapping.md +++ /dev/null @@ -1,365 +0,0 @@ -# valueMapping - - - -## Index - -* [`obj RangeMap`](#obj-rangemap) - * [`fn withOptions(value)`](#fn-rangemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) - * [`obj options`](#obj-rangemapoptions) - * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) - * [`fn withResult(value)`](#fn-rangemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) - * [`fn withTo(value)`](#fn-rangemapoptionswithto) - * [`obj result`](#obj-rangemapoptionsresult) - * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) -* [`obj RegexMap`](#obj-regexmap) - * [`fn withOptions(value)`](#fn-regexmapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) - * [`obj options`](#obj-regexmapoptions) - * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) - * [`fn withResult(value)`](#fn-regexmapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) - * [`obj result`](#obj-regexmapoptionsresult) - * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) - * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) -* [`obj SpecialValueMap`](#obj-specialvaluemap) - * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) - * [`obj options`](#obj-specialvaluemapoptions) - * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) - * [`fn withPattern(value)`](#fn-specialvaluemapoptionswithpattern) - * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) - * [`obj result`](#obj-specialvaluemapoptionsresult) - * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) -* [`obj ValueMap`](#obj-valuemap) - * [`fn withOptions(value)`](#fn-valuemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) - -## Fields - -### obj RangeMap - - -#### fn RangeMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RangeMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RangeMap.withType - -```ts -withType(value) -``` - - - -#### obj RangeMap.options - - -##### fn RangeMap.options.withFrom - -```ts -withFrom(value) -``` - -to and from are `number | null` in current ts, really not sure what to do - -##### fn RangeMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RangeMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### fn RangeMap.options.withTo - -```ts -withTo(value) -``` - - - -##### obj RangeMap.options.result - - -###### fn RangeMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RangeMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RangeMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RangeMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj RegexMap - - -#### fn RegexMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RegexMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RegexMap.withType - -```ts -withType(value) -``` - - - -#### obj RegexMap.options - - -##### fn RegexMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn RegexMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RegexMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj RegexMap.options.result - - -###### fn RegexMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RegexMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RegexMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RegexMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj SpecialValueMap - - -#### fn SpecialValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn SpecialValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn SpecialValueMap.withType - -```ts -withType(value) -``` - - - -#### obj SpecialValueMap.options - - -##### fn SpecialValueMap.options.withMatch - -```ts -withMatch(value) -``` - - - -Accepted values for `value` are "true", "false" - -##### fn SpecialValueMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn SpecialValueMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn SpecialValueMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj SpecialValueMap.options.result - - -###### fn SpecialValueMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn SpecialValueMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn SpecialValueMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn SpecialValueMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj ValueMap - - -#### fn ValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn ValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn ValueMap.withType - -```ts -withType(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/table/fieldOverride.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/table/fieldOverride.md deleted file mode 100644 index 3e2667b..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/table/fieldOverride.md +++ /dev/null @@ -1,194 +0,0 @@ -# fieldOverride - -Overrides allow you to customize visualization settings for specific fields or -series. This is accomplished by adding an override rule that targets -a particular set of fields and that can each define multiple options. - -```jsonnet -fieldOverride.byType.new('number') -+ fieldOverride.byType.withPropertiesFromOptions( - panel.standardOptions.withDecimals(2) - + panel.standardOptions.withUnit('s') -) -``` - - -## Index - -* [`obj byName`](#obj-byname) - * [`fn new(value)`](#fn-bynamenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bynamewithproperty) -* [`obj byQuery`](#obj-byquery) - * [`fn new(value)`](#fn-byquerynew) - * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byquerywithproperty) -* [`obj byRegexp`](#obj-byregexp) - * [`fn new(value)`](#fn-byregexpnew) - * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) -* [`obj byType`](#obj-bytype) - * [`fn new(value)`](#fn-bytypenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bytypewithproperty) -* [`obj byValue`](#obj-byvalue) - * [`fn new(value)`](#fn-byvaluenew) - * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) - -## Fields - -### obj byName - - -#### fn byName.new - -```ts -new(value) -``` - -`new` creates a new override of type `byName`. - -#### fn byName.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byName.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byQuery - - -#### fn byQuery.new - -```ts -new(value) -``` - -`new` creates a new override of type `byQuery`. - -#### fn byQuery.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byQuery.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byRegexp - - -#### fn byRegexp.new - -```ts -new(value) -``` - -`new` creates a new override of type `byRegexp`. - -#### fn byRegexp.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byRegexp.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byType - - -#### fn byType.new - -```ts -new(value) -``` - -`new` creates a new override of type `byType`. - -#### fn byType.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byType.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byValue - - -#### fn byValue.new - -```ts -new(value) -``` - -`new` creates a new override of type `byValue`. - -#### fn byValue.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byValue.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/table/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/table/index.md deleted file mode 100644 index fc39e41..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/table/index.md +++ /dev/null @@ -1,653 +0,0 @@ -# table - -grafonnet.panel.table - -## Subpackages - -* [fieldOverride](fieldOverride.md) -* [link](link.md) -* [thresholdStep](thresholdStep.md) -* [transformation](transformation.md) -* [valueMapping](valueMapping.md) - -## Index - -* [`fn new(title)`](#fn-new) -* [`obj datasource`](#obj-datasource) - * [`fn withType(value)`](#fn-datasourcewithtype) - * [`fn withUid(value)`](#fn-datasourcewithuid) -* [`obj gridPos`](#obj-gridpos) - * [`fn withH(value=9)`](#fn-gridposwithh) - * [`fn withStatic(value)`](#fn-gridposwithstatic) - * [`fn withW(value=12)`](#fn-gridposwithw) - * [`fn withX(value=0)`](#fn-gridposwithx) - * [`fn withY(value=0)`](#fn-gridposwithy) -* [`obj libraryPanel`](#obj-librarypanel) - * [`fn withName(value)`](#fn-librarypanelwithname) - * [`fn withUid(value)`](#fn-librarypanelwithuid) -* [`obj options`](#obj-options) - * [`fn withCellHeight(value)`](#fn-optionswithcellheight) - * [`fn withFooter(value={"countRows": false,"reducer": [],"show": false})`](#fn-optionswithfooter) - * [`fn withFooterMixin(value={"countRows": false,"reducer": [],"show": false})`](#fn-optionswithfootermixin) - * [`fn withFrameIndex(value=0)`](#fn-optionswithframeindex) - * [`fn withShowHeader(value=true)`](#fn-optionswithshowheader) - * [`fn withShowTypeIcons(value=false)`](#fn-optionswithshowtypeicons) - * [`fn withSortBy(value)`](#fn-optionswithsortby) - * [`fn withSortByMixin(value)`](#fn-optionswithsortbymixin) - * [`obj footer`](#obj-optionsfooter) - * [`fn withTableFooterOptions(value)`](#fn-optionsfooterwithtablefooteroptions) - * [`fn withTableFooterOptionsMixin(value)`](#fn-optionsfooterwithtablefooteroptionsmixin) - * [`obj TableFooterOptions`](#obj-optionsfootertablefooteroptions) - * [`fn withCountRows(value)`](#fn-optionsfootertablefooteroptionswithcountrows) - * [`fn withEnablePagination(value)`](#fn-optionsfootertablefooteroptionswithenablepagination) - * [`fn withFields(value)`](#fn-optionsfootertablefooteroptionswithfields) - * [`fn withFieldsMixin(value)`](#fn-optionsfootertablefooteroptionswithfieldsmixin) - * [`fn withReducer(value)`](#fn-optionsfootertablefooteroptionswithreducer) - * [`fn withReducerMixin(value)`](#fn-optionsfootertablefooteroptionswithreducermixin) - * [`fn withShow(value)`](#fn-optionsfootertablefooteroptionswithshow) - * [`obj sortBy`](#obj-optionssortby) - * [`fn withDesc(value)`](#fn-optionssortbywithdesc) - * [`fn withDisplayName(value)`](#fn-optionssortbywithdisplayname) -* [`obj panelOptions`](#obj-paneloptions) - * [`fn withDescription(value)`](#fn-paneloptionswithdescription) - * [`fn withLinks(value)`](#fn-paneloptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) - * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) - * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) - * [`fn withTitle(value)`](#fn-paneloptionswithtitle) - * [`fn withTransparent(value=false)`](#fn-paneloptionswithtransparent) -* [`obj queryOptions`](#obj-queryoptions) - * [`fn withDatasource(value)`](#fn-queryoptionswithdatasource) - * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) - * [`fn withInterval(value)`](#fn-queryoptionswithinterval) - * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) - * [`fn withTargets(value)`](#fn-queryoptionswithtargets) - * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) - * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) - * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) - * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) - * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) -* [`obj standardOptions`](#obj-standardoptions) - * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) - * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) - * [`fn withLinks(value)`](#fn-standardoptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) - * [`fn withMappings(value)`](#fn-standardoptionswithmappings) - * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) - * [`fn withMax(value)`](#fn-standardoptionswithmax) - * [`fn withMin(value)`](#fn-standardoptionswithmin) - * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) - * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) - * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) - * [`fn withUnit(value)`](#fn-standardoptionswithunit) - * [`obj color`](#obj-standardoptionscolor) - * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) - * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) - * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) - * [`obj thresholds`](#obj-standardoptionsthresholds) - * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) - * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) - * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) - -## Fields - -### fn new - -```ts -new(title) -``` - -Creates a new table panel with a title. - -### obj datasource - - -#### fn datasource.withType - -```ts -withType(value) -``` - - - -#### fn datasource.withUid - -```ts -withUid(value) -``` - - - -### obj gridPos - - -#### fn gridPos.withH - -```ts -withH(value=9) -``` - -Panel - -#### fn gridPos.withStatic - -```ts -withStatic(value) -``` - -true if fixed - -#### fn gridPos.withW - -```ts -withW(value=12) -``` - -Panel - -#### fn gridPos.withX - -```ts -withX(value=0) -``` - -Panel x - -#### fn gridPos.withY - -```ts -withY(value=0) -``` - -Panel y - -### obj libraryPanel - - -#### fn libraryPanel.withName - -```ts -withName(value) -``` - - - -#### fn libraryPanel.withUid - -```ts -withUid(value) -``` - - - -### obj options - - -#### fn options.withCellHeight - -```ts -withCellHeight(value) -``` - -Controls the height of the rows - -#### fn options.withFooter - -```ts -withFooter(value={"countRows": false,"reducer": [],"show": false}) -``` - -Controls footer options - -#### fn options.withFooterMixin - -```ts -withFooterMixin(value={"countRows": false,"reducer": [],"show": false}) -``` - -Controls footer options - -#### fn options.withFrameIndex - -```ts -withFrameIndex(value=0) -``` - -Represents the index of the selected frame - -#### fn options.withShowHeader - -```ts -withShowHeader(value=true) -``` - -Controls whether the panel should show the header - -#### fn options.withShowTypeIcons - -```ts -withShowTypeIcons(value=false) -``` - -Controls whether the header should show icons for the column types - -#### fn options.withSortBy - -```ts -withSortBy(value) -``` - -Used to control row sorting - -#### fn options.withSortByMixin - -```ts -withSortByMixin(value) -``` - -Used to control row sorting - -#### obj options.footer - - -##### fn options.footer.withTableFooterOptions - -```ts -withTableFooterOptions(value) -``` - -Footer options - -##### fn options.footer.withTableFooterOptionsMixin - -```ts -withTableFooterOptionsMixin(value) -``` - -Footer options - -##### obj options.footer.TableFooterOptions - - -###### fn options.footer.TableFooterOptions.withCountRows - -```ts -withCountRows(value) -``` - - - -###### fn options.footer.TableFooterOptions.withEnablePagination - -```ts -withEnablePagination(value) -``` - - - -###### fn options.footer.TableFooterOptions.withFields - -```ts -withFields(value) -``` - - - -###### fn options.footer.TableFooterOptions.withFieldsMixin - -```ts -withFieldsMixin(value) -``` - - - -###### fn options.footer.TableFooterOptions.withReducer - -```ts -withReducer(value) -``` - - - -###### fn options.footer.TableFooterOptions.withReducerMixin - -```ts -withReducerMixin(value) -``` - - - -###### fn options.footer.TableFooterOptions.withShow - -```ts -withShow(value) -``` - - - -#### obj options.sortBy - - -##### fn options.sortBy.withDesc - -```ts -withDesc(value) -``` - -Flag used to indicate descending sort order - -##### fn options.sortBy.withDisplayName - -```ts -withDisplayName(value) -``` - -Sets the display name of the field to sort by - -### obj panelOptions - - -#### fn panelOptions.withDescription - -```ts -withDescription(value) -``` - -Description. - -#### fn panelOptions.withLinks - -```ts -withLinks(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withRepeat - -```ts -withRepeat(value) -``` - -Name of template variable to repeat for. - -#### fn panelOptions.withRepeatDirection - -```ts -withRepeatDirection(value="h") -``` - -Direction to repeat in if 'repeat' is set. -"h" for horizontal, "v" for vertical. -TODO this is probably optional - -Accepted values for `value` are "h", "v" - -#### fn panelOptions.withTitle - -```ts -withTitle(value) -``` - -Panel title. - -#### fn panelOptions.withTransparent - -```ts -withTransparent(value=false) -``` - -Whether to display the panel without a background. - -### obj queryOptions - - -#### fn queryOptions.withDatasource - -```ts -withDatasource(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withDatasourceMixin - -```ts -withDatasourceMixin(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withInterval - -```ts -withInterval(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withMaxDataPoints - -```ts -withMaxDataPoints(value) -``` - -TODO docs - -#### fn queryOptions.withTargets - -```ts -withTargets(value) -``` - -TODO docs - -#### fn queryOptions.withTargetsMixin - -```ts -withTargetsMixin(value) -``` - -TODO docs - -#### fn queryOptions.withTimeFrom - -```ts -withTimeFrom(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTimeShift - -```ts -withTimeShift(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTransformations - -```ts -withTransformations(value) -``` - - - -#### fn queryOptions.withTransformationsMixin - -```ts -withTransformationsMixin(value) -``` - - - -### obj standardOptions - - -#### fn standardOptions.withDecimals - -```ts -withDecimals(value) -``` - -Significant digits (for display) - -#### fn standardOptions.withDisplayName - -```ts -withDisplayName(value) -``` - -The display value for this field. This supports template variables blank is auto - -#### fn standardOptions.withLinks - -```ts -withLinks(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withMappings - -```ts -withMappings(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMappingsMixin - -```ts -withMappingsMixin(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMax - -```ts -withMax(value) -``` - - - -#### fn standardOptions.withMin - -```ts -withMin(value) -``` - - - -#### fn standardOptions.withNoValue - -```ts -withNoValue(value) -``` - -Alternative to empty string - -#### fn standardOptions.withOverrides - -```ts -withOverrides(value) -``` - - - -#### fn standardOptions.withOverridesMixin - -```ts -withOverridesMixin(value) -``` - - - -#### fn standardOptions.withUnit - -```ts -withUnit(value) -``` - -Numeric Options - -#### obj standardOptions.color - - -##### fn standardOptions.color.withFixedColor - -```ts -withFixedColor(value) -``` - -Stores the fixed color value if mode is fixed - -##### fn standardOptions.color.withMode - -```ts -withMode(value) -``` - -The main color scheme mode - -##### fn standardOptions.color.withSeriesBy - -```ts -withSeriesBy(value) -``` - -TODO docs - -Accepted values for `value` are "min", "max", "last" - -#### obj standardOptions.thresholds - - -##### fn standardOptions.thresholds.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "absolute", "percentage" - -##### fn standardOptions.thresholds.withSteps - -```ts -withSteps(value) -``` - -Must be sorted by 'value', first value is always -Infinity - -##### fn standardOptions.thresholds.withStepsMixin - -```ts -withStepsMixin(value) -``` - -Must be sorted by 'value', first value is always -Infinity diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/table/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/table/link.md deleted file mode 100644 index 1a1d7c4..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/table/link.md +++ /dev/null @@ -1,109 +0,0 @@ -# link - - - -## Index - -* [`fn withAsDropdown(value=false)`](#fn-withasdropdown) -* [`fn withIcon(value)`](#fn-withicon) -* [`fn withIncludeVars(value=false)`](#fn-withincludevars) -* [`fn withKeepTime(value=false)`](#fn-withkeeptime) -* [`fn withTags(value)`](#fn-withtags) -* [`fn withTagsMixin(value)`](#fn-withtagsmixin) -* [`fn withTargetBlank(value=false)`](#fn-withtargetblank) -* [`fn withTitle(value)`](#fn-withtitle) -* [`fn withTooltip(value)`](#fn-withtooltip) -* [`fn withType(value)`](#fn-withtype) -* [`fn withUrl(value)`](#fn-withurl) - -## Fields - -### fn withAsDropdown - -```ts -withAsDropdown(value=false) -``` - - - -### fn withIcon - -```ts -withIcon(value) -``` - - - -### fn withIncludeVars - -```ts -withIncludeVars(value=false) -``` - - - -### fn withKeepTime - -```ts -withKeepTime(value=false) -``` - - - -### fn withTags - -```ts -withTags(value) -``` - - - -### fn withTagsMixin - -```ts -withTagsMixin(value) -``` - - - -### fn withTargetBlank - -```ts -withTargetBlank(value=false) -``` - - - -### fn withTitle - -```ts -withTitle(value) -``` - - - -### fn withTooltip - -```ts -withTooltip(value) -``` - - - -### fn withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "link", "dashboards" - -### fn withUrl - -```ts -withUrl(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/table/thresholdStep.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/table/thresholdStep.md deleted file mode 100644 index 9d6af42..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/table/thresholdStep.md +++ /dev/null @@ -1,47 +0,0 @@ -# thresholdStep - - - -## Index - -* [`fn withColor(value)`](#fn-withcolor) -* [`fn withIndex(value)`](#fn-withindex) -* [`fn withState(value)`](#fn-withstate) -* [`fn withValue(value)`](#fn-withvalue) - -## Fields - -### fn withColor - -```ts -withColor(value) -``` - -TODO docs - -### fn withIndex - -```ts -withIndex(value) -``` - -Threshold index, an old property that is not needed an should only appear in older dashboards - -### fn withState - -```ts -withState(value) -``` - -TODO docs -TODO are the values here enumerable into a disjunction? -Some seem to be listed in typescript comment - -### fn withValue - -```ts -withValue(value) -``` - -TODO docs -FIXME the corresponding typescript field is required/non-optional, but nulls currently appear here when serializing -Infinity to JSON diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/table/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/table/transformation.md deleted file mode 100644 index 3dac7e9..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/table/transformation.md +++ /dev/null @@ -1,76 +0,0 @@ -# transformation - - - -## Index - -* [`fn withDisabled(value)`](#fn-withdisabled) -* [`fn withFilter(value)`](#fn-withfilter) -* [`fn withFilterMixin(value)`](#fn-withfiltermixin) -* [`fn withId(value)`](#fn-withid) -* [`fn withOptions(value)`](#fn-withoptions) -* [`obj filter`](#obj-filter) - * [`fn withId(value="")`](#fn-filterwithid) - * [`fn withOptions(value)`](#fn-filterwithoptions) - -## Fields - -### fn withDisabled - -```ts -withDisabled(value) -``` - -Disabled transformations are skipped - -### fn withFilter - -```ts -withFilter(value) -``` - - - -### fn withFilterMixin - -```ts -withFilterMixin(value) -``` - - - -### fn withId - -```ts -withId(value) -``` - -Unique identifier of transformer - -### fn withOptions - -```ts -withOptions(value) -``` - -Options to be passed to the transformer -Valid options depend on the transformer id - -### obj filter - - -#### fn filter.withId - -```ts -withId(value="") -``` - - - -#### fn filter.withOptions - -```ts -withOptions(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/table/valueMapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/table/valueMapping.md deleted file mode 100644 index a6bbdb3..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/table/valueMapping.md +++ /dev/null @@ -1,365 +0,0 @@ -# valueMapping - - - -## Index - -* [`obj RangeMap`](#obj-rangemap) - * [`fn withOptions(value)`](#fn-rangemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) - * [`obj options`](#obj-rangemapoptions) - * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) - * [`fn withResult(value)`](#fn-rangemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) - * [`fn withTo(value)`](#fn-rangemapoptionswithto) - * [`obj result`](#obj-rangemapoptionsresult) - * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) -* [`obj RegexMap`](#obj-regexmap) - * [`fn withOptions(value)`](#fn-regexmapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) - * [`obj options`](#obj-regexmapoptions) - * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) - * [`fn withResult(value)`](#fn-regexmapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) - * [`obj result`](#obj-regexmapoptionsresult) - * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) - * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) -* [`obj SpecialValueMap`](#obj-specialvaluemap) - * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) - * [`obj options`](#obj-specialvaluemapoptions) - * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) - * [`fn withPattern(value)`](#fn-specialvaluemapoptionswithpattern) - * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) - * [`obj result`](#obj-specialvaluemapoptionsresult) - * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) -* [`obj ValueMap`](#obj-valuemap) - * [`fn withOptions(value)`](#fn-valuemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) - -## Fields - -### obj RangeMap - - -#### fn RangeMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RangeMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RangeMap.withType - -```ts -withType(value) -``` - - - -#### obj RangeMap.options - - -##### fn RangeMap.options.withFrom - -```ts -withFrom(value) -``` - -to and from are `number | null` in current ts, really not sure what to do - -##### fn RangeMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RangeMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### fn RangeMap.options.withTo - -```ts -withTo(value) -``` - - - -##### obj RangeMap.options.result - - -###### fn RangeMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RangeMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RangeMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RangeMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj RegexMap - - -#### fn RegexMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RegexMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RegexMap.withType - -```ts -withType(value) -``` - - - -#### obj RegexMap.options - - -##### fn RegexMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn RegexMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RegexMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj RegexMap.options.result - - -###### fn RegexMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RegexMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RegexMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RegexMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj SpecialValueMap - - -#### fn SpecialValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn SpecialValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn SpecialValueMap.withType - -```ts -withType(value) -``` - - - -#### obj SpecialValueMap.options - - -##### fn SpecialValueMap.options.withMatch - -```ts -withMatch(value) -``` - - - -Accepted values for `value` are "true", "false" - -##### fn SpecialValueMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn SpecialValueMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn SpecialValueMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj SpecialValueMap.options.result - - -###### fn SpecialValueMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn SpecialValueMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn SpecialValueMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn SpecialValueMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj ValueMap - - -#### fn ValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn ValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn ValueMap.withType - -```ts -withType(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/text/fieldOverride.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/text/fieldOverride.md deleted file mode 100644 index 3e2667b..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/text/fieldOverride.md +++ /dev/null @@ -1,194 +0,0 @@ -# fieldOverride - -Overrides allow you to customize visualization settings for specific fields or -series. This is accomplished by adding an override rule that targets -a particular set of fields and that can each define multiple options. - -```jsonnet -fieldOverride.byType.new('number') -+ fieldOverride.byType.withPropertiesFromOptions( - panel.standardOptions.withDecimals(2) - + panel.standardOptions.withUnit('s') -) -``` - - -## Index - -* [`obj byName`](#obj-byname) - * [`fn new(value)`](#fn-bynamenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bynamewithproperty) -* [`obj byQuery`](#obj-byquery) - * [`fn new(value)`](#fn-byquerynew) - * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byquerywithproperty) -* [`obj byRegexp`](#obj-byregexp) - * [`fn new(value)`](#fn-byregexpnew) - * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) -* [`obj byType`](#obj-bytype) - * [`fn new(value)`](#fn-bytypenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bytypewithproperty) -* [`obj byValue`](#obj-byvalue) - * [`fn new(value)`](#fn-byvaluenew) - * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) - -## Fields - -### obj byName - - -#### fn byName.new - -```ts -new(value) -``` - -`new` creates a new override of type `byName`. - -#### fn byName.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byName.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byQuery - - -#### fn byQuery.new - -```ts -new(value) -``` - -`new` creates a new override of type `byQuery`. - -#### fn byQuery.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byQuery.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byRegexp - - -#### fn byRegexp.new - -```ts -new(value) -``` - -`new` creates a new override of type `byRegexp`. - -#### fn byRegexp.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byRegexp.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byType - - -#### fn byType.new - -```ts -new(value) -``` - -`new` creates a new override of type `byType`. - -#### fn byType.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byType.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byValue - - -#### fn byValue.new - -```ts -new(value) -``` - -`new` creates a new override of type `byValue`. - -#### fn byValue.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byValue.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/text/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/text/index.md deleted file mode 100644 index 8660df9..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/text/index.md +++ /dev/null @@ -1,541 +0,0 @@ -# text - -grafonnet.panel.text - -## Subpackages - -* [fieldOverride](fieldOverride.md) -* [link](link.md) -* [thresholdStep](thresholdStep.md) -* [transformation](transformation.md) -* [valueMapping](valueMapping.md) - -## Index - -* [`fn new(title)`](#fn-new) -* [`obj datasource`](#obj-datasource) - * [`fn withType(value)`](#fn-datasourcewithtype) - * [`fn withUid(value)`](#fn-datasourcewithuid) -* [`obj gridPos`](#obj-gridpos) - * [`fn withH(value=9)`](#fn-gridposwithh) - * [`fn withStatic(value)`](#fn-gridposwithstatic) - * [`fn withW(value=12)`](#fn-gridposwithw) - * [`fn withX(value=0)`](#fn-gridposwithx) - * [`fn withY(value=0)`](#fn-gridposwithy) -* [`obj libraryPanel`](#obj-librarypanel) - * [`fn withName(value)`](#fn-librarypanelwithname) - * [`fn withUid(value)`](#fn-librarypanelwithuid) -* [`obj options`](#obj-options) - * [`fn withCode(value)`](#fn-optionswithcode) - * [`fn withCodeMixin(value)`](#fn-optionswithcodemixin) - * [`fn withContent(value="# Title\n\nFor markdown syntax help: [commonmark.org/help](https://commonmark.org/help/)")`](#fn-optionswithcontent) - * [`fn withMode(value)`](#fn-optionswithmode) - * [`obj code`](#obj-optionscode) - * [`fn withLanguage(value="plaintext")`](#fn-optionscodewithlanguage) - * [`fn withShowLineNumbers(value=false)`](#fn-optionscodewithshowlinenumbers) - * [`fn withShowMiniMap(value=false)`](#fn-optionscodewithshowminimap) -* [`obj panelOptions`](#obj-paneloptions) - * [`fn withDescription(value)`](#fn-paneloptionswithdescription) - * [`fn withLinks(value)`](#fn-paneloptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) - * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) - * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) - * [`fn withTitle(value)`](#fn-paneloptionswithtitle) - * [`fn withTransparent(value=false)`](#fn-paneloptionswithtransparent) -* [`obj queryOptions`](#obj-queryoptions) - * [`fn withDatasource(value)`](#fn-queryoptionswithdatasource) - * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) - * [`fn withInterval(value)`](#fn-queryoptionswithinterval) - * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) - * [`fn withTargets(value)`](#fn-queryoptionswithtargets) - * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) - * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) - * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) - * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) - * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) -* [`obj standardOptions`](#obj-standardoptions) - * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) - * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) - * [`fn withLinks(value)`](#fn-standardoptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) - * [`fn withMappings(value)`](#fn-standardoptionswithmappings) - * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) - * [`fn withMax(value)`](#fn-standardoptionswithmax) - * [`fn withMin(value)`](#fn-standardoptionswithmin) - * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) - * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) - * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) - * [`fn withUnit(value)`](#fn-standardoptionswithunit) - * [`obj color`](#obj-standardoptionscolor) - * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) - * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) - * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) - * [`obj thresholds`](#obj-standardoptionsthresholds) - * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) - * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) - * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) - -## Fields - -### fn new - -```ts -new(title) -``` - -Creates a new text panel with a title. - -### obj datasource - - -#### fn datasource.withType - -```ts -withType(value) -``` - - - -#### fn datasource.withUid - -```ts -withUid(value) -``` - - - -### obj gridPos - - -#### fn gridPos.withH - -```ts -withH(value=9) -``` - -Panel - -#### fn gridPos.withStatic - -```ts -withStatic(value) -``` - -true if fixed - -#### fn gridPos.withW - -```ts -withW(value=12) -``` - -Panel - -#### fn gridPos.withX - -```ts -withX(value=0) -``` - -Panel x - -#### fn gridPos.withY - -```ts -withY(value=0) -``` - -Panel y - -### obj libraryPanel - - -#### fn libraryPanel.withName - -```ts -withName(value) -``` - - - -#### fn libraryPanel.withUid - -```ts -withUid(value) -``` - - - -### obj options - - -#### fn options.withCode - -```ts -withCode(value) -``` - - - -#### fn options.withCodeMixin - -```ts -withCodeMixin(value) -``` - - - -#### fn options.withContent - -```ts -withContent(value="# Title\n\nFor markdown syntax help: [commonmark.org/help](https://commonmark.org/help/)") -``` - - - -#### fn options.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "html", "markdown", "code" - -#### obj options.code - - -##### fn options.code.withLanguage - -```ts -withLanguage(value="plaintext") -``` - - - -Accepted values for `value` are "plaintext", "yaml", "xml", "typescript", "sql", "go", "markdown", "html", "json" - -##### fn options.code.withShowLineNumbers - -```ts -withShowLineNumbers(value=false) -``` - - - -##### fn options.code.withShowMiniMap - -```ts -withShowMiniMap(value=false) -``` - - - -### obj panelOptions - - -#### fn panelOptions.withDescription - -```ts -withDescription(value) -``` - -Description. - -#### fn panelOptions.withLinks - -```ts -withLinks(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withRepeat - -```ts -withRepeat(value) -``` - -Name of template variable to repeat for. - -#### fn panelOptions.withRepeatDirection - -```ts -withRepeatDirection(value="h") -``` - -Direction to repeat in if 'repeat' is set. -"h" for horizontal, "v" for vertical. -TODO this is probably optional - -Accepted values for `value` are "h", "v" - -#### fn panelOptions.withTitle - -```ts -withTitle(value) -``` - -Panel title. - -#### fn panelOptions.withTransparent - -```ts -withTransparent(value=false) -``` - -Whether to display the panel without a background. - -### obj queryOptions - - -#### fn queryOptions.withDatasource - -```ts -withDatasource(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withDatasourceMixin - -```ts -withDatasourceMixin(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withInterval - -```ts -withInterval(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withMaxDataPoints - -```ts -withMaxDataPoints(value) -``` - -TODO docs - -#### fn queryOptions.withTargets - -```ts -withTargets(value) -``` - -TODO docs - -#### fn queryOptions.withTargetsMixin - -```ts -withTargetsMixin(value) -``` - -TODO docs - -#### fn queryOptions.withTimeFrom - -```ts -withTimeFrom(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTimeShift - -```ts -withTimeShift(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTransformations - -```ts -withTransformations(value) -``` - - - -#### fn queryOptions.withTransformationsMixin - -```ts -withTransformationsMixin(value) -``` - - - -### obj standardOptions - - -#### fn standardOptions.withDecimals - -```ts -withDecimals(value) -``` - -Significant digits (for display) - -#### fn standardOptions.withDisplayName - -```ts -withDisplayName(value) -``` - -The display value for this field. This supports template variables blank is auto - -#### fn standardOptions.withLinks - -```ts -withLinks(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withMappings - -```ts -withMappings(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMappingsMixin - -```ts -withMappingsMixin(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMax - -```ts -withMax(value) -``` - - - -#### fn standardOptions.withMin - -```ts -withMin(value) -``` - - - -#### fn standardOptions.withNoValue - -```ts -withNoValue(value) -``` - -Alternative to empty string - -#### fn standardOptions.withOverrides - -```ts -withOverrides(value) -``` - - - -#### fn standardOptions.withOverridesMixin - -```ts -withOverridesMixin(value) -``` - - - -#### fn standardOptions.withUnit - -```ts -withUnit(value) -``` - -Numeric Options - -#### obj standardOptions.color - - -##### fn standardOptions.color.withFixedColor - -```ts -withFixedColor(value) -``` - -Stores the fixed color value if mode is fixed - -##### fn standardOptions.color.withMode - -```ts -withMode(value) -``` - -The main color scheme mode - -##### fn standardOptions.color.withSeriesBy - -```ts -withSeriesBy(value) -``` - -TODO docs - -Accepted values for `value` are "min", "max", "last" - -#### obj standardOptions.thresholds - - -##### fn standardOptions.thresholds.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "absolute", "percentage" - -##### fn standardOptions.thresholds.withSteps - -```ts -withSteps(value) -``` - -Must be sorted by 'value', first value is always -Infinity - -##### fn standardOptions.thresholds.withStepsMixin - -```ts -withStepsMixin(value) -``` - -Must be sorted by 'value', first value is always -Infinity diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/text/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/text/link.md deleted file mode 100644 index 1a1d7c4..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/text/link.md +++ /dev/null @@ -1,109 +0,0 @@ -# link - - - -## Index - -* [`fn withAsDropdown(value=false)`](#fn-withasdropdown) -* [`fn withIcon(value)`](#fn-withicon) -* [`fn withIncludeVars(value=false)`](#fn-withincludevars) -* [`fn withKeepTime(value=false)`](#fn-withkeeptime) -* [`fn withTags(value)`](#fn-withtags) -* [`fn withTagsMixin(value)`](#fn-withtagsmixin) -* [`fn withTargetBlank(value=false)`](#fn-withtargetblank) -* [`fn withTitle(value)`](#fn-withtitle) -* [`fn withTooltip(value)`](#fn-withtooltip) -* [`fn withType(value)`](#fn-withtype) -* [`fn withUrl(value)`](#fn-withurl) - -## Fields - -### fn withAsDropdown - -```ts -withAsDropdown(value=false) -``` - - - -### fn withIcon - -```ts -withIcon(value) -``` - - - -### fn withIncludeVars - -```ts -withIncludeVars(value=false) -``` - - - -### fn withKeepTime - -```ts -withKeepTime(value=false) -``` - - - -### fn withTags - -```ts -withTags(value) -``` - - - -### fn withTagsMixin - -```ts -withTagsMixin(value) -``` - - - -### fn withTargetBlank - -```ts -withTargetBlank(value=false) -``` - - - -### fn withTitle - -```ts -withTitle(value) -``` - - - -### fn withTooltip - -```ts -withTooltip(value) -``` - - - -### fn withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "link", "dashboards" - -### fn withUrl - -```ts -withUrl(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/text/thresholdStep.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/text/thresholdStep.md deleted file mode 100644 index 9d6af42..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/text/thresholdStep.md +++ /dev/null @@ -1,47 +0,0 @@ -# thresholdStep - - - -## Index - -* [`fn withColor(value)`](#fn-withcolor) -* [`fn withIndex(value)`](#fn-withindex) -* [`fn withState(value)`](#fn-withstate) -* [`fn withValue(value)`](#fn-withvalue) - -## Fields - -### fn withColor - -```ts -withColor(value) -``` - -TODO docs - -### fn withIndex - -```ts -withIndex(value) -``` - -Threshold index, an old property that is not needed an should only appear in older dashboards - -### fn withState - -```ts -withState(value) -``` - -TODO docs -TODO are the values here enumerable into a disjunction? -Some seem to be listed in typescript comment - -### fn withValue - -```ts -withValue(value) -``` - -TODO docs -FIXME the corresponding typescript field is required/non-optional, but nulls currently appear here when serializing -Infinity to JSON diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/text/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/text/transformation.md deleted file mode 100644 index 3dac7e9..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/text/transformation.md +++ /dev/null @@ -1,76 +0,0 @@ -# transformation - - - -## Index - -* [`fn withDisabled(value)`](#fn-withdisabled) -* [`fn withFilter(value)`](#fn-withfilter) -* [`fn withFilterMixin(value)`](#fn-withfiltermixin) -* [`fn withId(value)`](#fn-withid) -* [`fn withOptions(value)`](#fn-withoptions) -* [`obj filter`](#obj-filter) - * [`fn withId(value="")`](#fn-filterwithid) - * [`fn withOptions(value)`](#fn-filterwithoptions) - -## Fields - -### fn withDisabled - -```ts -withDisabled(value) -``` - -Disabled transformations are skipped - -### fn withFilter - -```ts -withFilter(value) -``` - - - -### fn withFilterMixin - -```ts -withFilterMixin(value) -``` - - - -### fn withId - -```ts -withId(value) -``` - -Unique identifier of transformer - -### fn withOptions - -```ts -withOptions(value) -``` - -Options to be passed to the transformer -Valid options depend on the transformer id - -### obj filter - - -#### fn filter.withId - -```ts -withId(value="") -``` - - - -#### fn filter.withOptions - -```ts -withOptions(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/text/valueMapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/text/valueMapping.md deleted file mode 100644 index a6bbdb3..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/text/valueMapping.md +++ /dev/null @@ -1,365 +0,0 @@ -# valueMapping - - - -## Index - -* [`obj RangeMap`](#obj-rangemap) - * [`fn withOptions(value)`](#fn-rangemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) - * [`obj options`](#obj-rangemapoptions) - * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) - * [`fn withResult(value)`](#fn-rangemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) - * [`fn withTo(value)`](#fn-rangemapoptionswithto) - * [`obj result`](#obj-rangemapoptionsresult) - * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) -* [`obj RegexMap`](#obj-regexmap) - * [`fn withOptions(value)`](#fn-regexmapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) - * [`obj options`](#obj-regexmapoptions) - * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) - * [`fn withResult(value)`](#fn-regexmapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) - * [`obj result`](#obj-regexmapoptionsresult) - * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) - * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) -* [`obj SpecialValueMap`](#obj-specialvaluemap) - * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) - * [`obj options`](#obj-specialvaluemapoptions) - * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) - * [`fn withPattern(value)`](#fn-specialvaluemapoptionswithpattern) - * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) - * [`obj result`](#obj-specialvaluemapoptionsresult) - * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) -* [`obj ValueMap`](#obj-valuemap) - * [`fn withOptions(value)`](#fn-valuemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) - -## Fields - -### obj RangeMap - - -#### fn RangeMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RangeMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RangeMap.withType - -```ts -withType(value) -``` - - - -#### obj RangeMap.options - - -##### fn RangeMap.options.withFrom - -```ts -withFrom(value) -``` - -to and from are `number | null` in current ts, really not sure what to do - -##### fn RangeMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RangeMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### fn RangeMap.options.withTo - -```ts -withTo(value) -``` - - - -##### obj RangeMap.options.result - - -###### fn RangeMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RangeMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RangeMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RangeMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj RegexMap - - -#### fn RegexMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RegexMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RegexMap.withType - -```ts -withType(value) -``` - - - -#### obj RegexMap.options - - -##### fn RegexMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn RegexMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RegexMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj RegexMap.options.result - - -###### fn RegexMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RegexMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RegexMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RegexMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj SpecialValueMap - - -#### fn SpecialValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn SpecialValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn SpecialValueMap.withType - -```ts -withType(value) -``` - - - -#### obj SpecialValueMap.options - - -##### fn SpecialValueMap.options.withMatch - -```ts -withMatch(value) -``` - - - -Accepted values for `value` are "true", "false" - -##### fn SpecialValueMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn SpecialValueMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn SpecialValueMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj SpecialValueMap.options.result - - -###### fn SpecialValueMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn SpecialValueMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn SpecialValueMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn SpecialValueMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj ValueMap - - -#### fn ValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn ValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn ValueMap.withType - -```ts -withType(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/timeSeries/fieldOverride.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/timeSeries/fieldOverride.md deleted file mode 100644 index 3e2667b..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/timeSeries/fieldOverride.md +++ /dev/null @@ -1,194 +0,0 @@ -# fieldOverride - -Overrides allow you to customize visualization settings for specific fields or -series. This is accomplished by adding an override rule that targets -a particular set of fields and that can each define multiple options. - -```jsonnet -fieldOverride.byType.new('number') -+ fieldOverride.byType.withPropertiesFromOptions( - panel.standardOptions.withDecimals(2) - + panel.standardOptions.withUnit('s') -) -``` - - -## Index - -* [`obj byName`](#obj-byname) - * [`fn new(value)`](#fn-bynamenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bynamewithproperty) -* [`obj byQuery`](#obj-byquery) - * [`fn new(value)`](#fn-byquerynew) - * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byquerywithproperty) -* [`obj byRegexp`](#obj-byregexp) - * [`fn new(value)`](#fn-byregexpnew) - * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) -* [`obj byType`](#obj-bytype) - * [`fn new(value)`](#fn-bytypenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bytypewithproperty) -* [`obj byValue`](#obj-byvalue) - * [`fn new(value)`](#fn-byvaluenew) - * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) - -## Fields - -### obj byName - - -#### fn byName.new - -```ts -new(value) -``` - -`new` creates a new override of type `byName`. - -#### fn byName.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byName.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byQuery - - -#### fn byQuery.new - -```ts -new(value) -``` - -`new` creates a new override of type `byQuery`. - -#### fn byQuery.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byQuery.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byRegexp - - -#### fn byRegexp.new - -```ts -new(value) -``` - -`new` creates a new override of type `byRegexp`. - -#### fn byRegexp.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byRegexp.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byType - - -#### fn byType.new - -```ts -new(value) -``` - -`new` creates a new override of type `byType`. - -#### fn byType.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byType.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byValue - - -#### fn byValue.new - -```ts -new(value) -``` - -`new` creates a new override of type `byValue`. - -#### fn byValue.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byValue.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/timeSeries/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/timeSeries/index.md deleted file mode 100644 index c2cb3fa..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/timeSeries/index.md +++ /dev/null @@ -1,1141 +0,0 @@ -# timeSeries - -grafonnet.panel.timeSeries - -## Subpackages - -* [fieldOverride](fieldOverride.md) -* [link](link.md) -* [thresholdStep](thresholdStep.md) -* [transformation](transformation.md) -* [valueMapping](valueMapping.md) - -## Index - -* [`fn new(title)`](#fn-new) -* [`obj datasource`](#obj-datasource) - * [`fn withType(value)`](#fn-datasourcewithtype) - * [`fn withUid(value)`](#fn-datasourcewithuid) -* [`obj fieldConfig`](#obj-fieldconfig) - * [`obj defaults`](#obj-fieldconfigdefaults) - * [`obj custom`](#obj-fieldconfigdefaultscustom) - * [`fn withAxisCenteredZero(value)`](#fn-fieldconfigdefaultscustomwithaxiscenteredzero) - * [`fn withAxisColorMode(value)`](#fn-fieldconfigdefaultscustomwithaxiscolormode) - * [`fn withAxisGridShow(value)`](#fn-fieldconfigdefaultscustomwithaxisgridshow) - * [`fn withAxisLabel(value)`](#fn-fieldconfigdefaultscustomwithaxislabel) - * [`fn withAxisPlacement(value)`](#fn-fieldconfigdefaultscustomwithaxisplacement) - * [`fn withAxisSoftMax(value)`](#fn-fieldconfigdefaultscustomwithaxissoftmax) - * [`fn withAxisSoftMin(value)`](#fn-fieldconfigdefaultscustomwithaxissoftmin) - * [`fn withAxisWidth(value)`](#fn-fieldconfigdefaultscustomwithaxiswidth) - * [`fn withBarAlignment(value)`](#fn-fieldconfigdefaultscustomwithbaralignment) - * [`fn withBarMaxWidth(value)`](#fn-fieldconfigdefaultscustomwithbarmaxwidth) - * [`fn withBarWidthFactor(value)`](#fn-fieldconfigdefaultscustomwithbarwidthfactor) - * [`fn withDrawStyle(value)`](#fn-fieldconfigdefaultscustomwithdrawstyle) - * [`fn withFillBelowTo(value)`](#fn-fieldconfigdefaultscustomwithfillbelowto) - * [`fn withFillColor(value)`](#fn-fieldconfigdefaultscustomwithfillcolor) - * [`fn withFillOpacity(value)`](#fn-fieldconfigdefaultscustomwithfillopacity) - * [`fn withGradientMode(value)`](#fn-fieldconfigdefaultscustomwithgradientmode) - * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomwithhidefrom) - * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomwithhidefrommixin) - * [`fn withLineColor(value)`](#fn-fieldconfigdefaultscustomwithlinecolor) - * [`fn withLineInterpolation(value)`](#fn-fieldconfigdefaultscustomwithlineinterpolation) - * [`fn withLineStyle(value)`](#fn-fieldconfigdefaultscustomwithlinestyle) - * [`fn withLineStyleMixin(value)`](#fn-fieldconfigdefaultscustomwithlinestylemixin) - * [`fn withLineWidth(value)`](#fn-fieldconfigdefaultscustomwithlinewidth) - * [`fn withPointColor(value)`](#fn-fieldconfigdefaultscustomwithpointcolor) - * [`fn withPointSize(value)`](#fn-fieldconfigdefaultscustomwithpointsize) - * [`fn withPointSymbol(value)`](#fn-fieldconfigdefaultscustomwithpointsymbol) - * [`fn withScaleDistribution(value)`](#fn-fieldconfigdefaultscustomwithscaledistribution) - * [`fn withScaleDistributionMixin(value)`](#fn-fieldconfigdefaultscustomwithscaledistributionmixin) - * [`fn withShowPoints(value)`](#fn-fieldconfigdefaultscustomwithshowpoints) - * [`fn withSpanNulls(value)`](#fn-fieldconfigdefaultscustomwithspannulls) - * [`fn withSpanNullsMixin(value)`](#fn-fieldconfigdefaultscustomwithspannullsmixin) - * [`fn withStacking(value)`](#fn-fieldconfigdefaultscustomwithstacking) - * [`fn withStackingMixin(value)`](#fn-fieldconfigdefaultscustomwithstackingmixin) - * [`fn withThresholdsStyle(value)`](#fn-fieldconfigdefaultscustomwiththresholdsstyle) - * [`fn withThresholdsStyleMixin(value)`](#fn-fieldconfigdefaultscustomwiththresholdsstylemixin) - * [`fn withTransform(value)`](#fn-fieldconfigdefaultscustomwithtransform) - * [`obj hideFrom`](#obj-fieldconfigdefaultscustomhidefrom) - * [`fn withLegend(value)`](#fn-fieldconfigdefaultscustomhidefromwithlegend) - * [`fn withTooltip(value)`](#fn-fieldconfigdefaultscustomhidefromwithtooltip) - * [`fn withViz(value)`](#fn-fieldconfigdefaultscustomhidefromwithviz) - * [`obj lineStyle`](#obj-fieldconfigdefaultscustomlinestyle) - * [`fn withDash(value)`](#fn-fieldconfigdefaultscustomlinestylewithdash) - * [`fn withDashMixin(value)`](#fn-fieldconfigdefaultscustomlinestylewithdashmixin) - * [`fn withFill(value)`](#fn-fieldconfigdefaultscustomlinestylewithfill) - * [`obj scaleDistribution`](#obj-fieldconfigdefaultscustomscaledistribution) - * [`fn withLinearThreshold(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlinearthreshold) - * [`fn withLog(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlog) - * [`fn withType(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithtype) - * [`obj stacking`](#obj-fieldconfigdefaultscustomstacking) - * [`fn withGroup(value)`](#fn-fieldconfigdefaultscustomstackingwithgroup) - * [`fn withMode(value)`](#fn-fieldconfigdefaultscustomstackingwithmode) - * [`obj thresholdsStyle`](#obj-fieldconfigdefaultscustomthresholdsstyle) - * [`fn withMode(value)`](#fn-fieldconfigdefaultscustomthresholdsstylewithmode) -* [`obj gridPos`](#obj-gridpos) - * [`fn withH(value=9)`](#fn-gridposwithh) - * [`fn withStatic(value)`](#fn-gridposwithstatic) - * [`fn withW(value=12)`](#fn-gridposwithw) - * [`fn withX(value=0)`](#fn-gridposwithx) - * [`fn withY(value=0)`](#fn-gridposwithy) -* [`obj libraryPanel`](#obj-librarypanel) - * [`fn withName(value)`](#fn-librarypanelwithname) - * [`fn withUid(value)`](#fn-librarypanelwithuid) -* [`obj options`](#obj-options) - * [`fn withLegend(value)`](#fn-optionswithlegend) - * [`fn withLegendMixin(value)`](#fn-optionswithlegendmixin) - * [`fn withTimezone(value)`](#fn-optionswithtimezone) - * [`fn withTimezoneMixin(value)`](#fn-optionswithtimezonemixin) - * [`fn withTooltip(value)`](#fn-optionswithtooltip) - * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) - * [`obj legend`](#obj-optionslegend) - * [`fn withAsTable(value)`](#fn-optionslegendwithastable) - * [`fn withCalcs(value)`](#fn-optionslegendwithcalcs) - * [`fn withCalcsMixin(value)`](#fn-optionslegendwithcalcsmixin) - * [`fn withDisplayMode(value)`](#fn-optionslegendwithdisplaymode) - * [`fn withIsVisible(value)`](#fn-optionslegendwithisvisible) - * [`fn withPlacement(value)`](#fn-optionslegendwithplacement) - * [`fn withShowLegend(value)`](#fn-optionslegendwithshowlegend) - * [`fn withSortBy(value)`](#fn-optionslegendwithsortby) - * [`fn withSortDesc(value)`](#fn-optionslegendwithsortdesc) - * [`fn withWidth(value)`](#fn-optionslegendwithwidth) - * [`obj tooltip`](#obj-optionstooltip) - * [`fn withMode(value)`](#fn-optionstooltipwithmode) - * [`fn withSort(value)`](#fn-optionstooltipwithsort) -* [`obj panelOptions`](#obj-paneloptions) - * [`fn withDescription(value)`](#fn-paneloptionswithdescription) - * [`fn withLinks(value)`](#fn-paneloptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) - * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) - * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) - * [`fn withTitle(value)`](#fn-paneloptionswithtitle) - * [`fn withTransparent(value=false)`](#fn-paneloptionswithtransparent) -* [`obj queryOptions`](#obj-queryoptions) - * [`fn withDatasource(value)`](#fn-queryoptionswithdatasource) - * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) - * [`fn withInterval(value)`](#fn-queryoptionswithinterval) - * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) - * [`fn withTargets(value)`](#fn-queryoptionswithtargets) - * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) - * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) - * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) - * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) - * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) -* [`obj standardOptions`](#obj-standardoptions) - * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) - * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) - * [`fn withLinks(value)`](#fn-standardoptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) - * [`fn withMappings(value)`](#fn-standardoptionswithmappings) - * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) - * [`fn withMax(value)`](#fn-standardoptionswithmax) - * [`fn withMin(value)`](#fn-standardoptionswithmin) - * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) - * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) - * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) - * [`fn withUnit(value)`](#fn-standardoptionswithunit) - * [`obj color`](#obj-standardoptionscolor) - * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) - * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) - * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) - * [`obj thresholds`](#obj-standardoptionsthresholds) - * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) - * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) - * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) - -## Fields - -### fn new - -```ts -new(title) -``` - -Creates a new timeSeries panel with a title. - -### obj datasource - - -#### fn datasource.withType - -```ts -withType(value) -``` - - - -#### fn datasource.withUid - -```ts -withUid(value) -``` - - - -### obj fieldConfig - - -#### obj fieldConfig.defaults - - -##### obj fieldConfig.defaults.custom - - -###### fn fieldConfig.defaults.custom.withAxisCenteredZero - -```ts -withAxisCenteredZero(value) -``` - - - -###### fn fieldConfig.defaults.custom.withAxisColorMode - -```ts -withAxisColorMode(value) -``` - -TODO docs - -Accepted values for `value` are "text", "series" - -###### fn fieldConfig.defaults.custom.withAxisGridShow - -```ts -withAxisGridShow(value) -``` - - - -###### fn fieldConfig.defaults.custom.withAxisLabel - -```ts -withAxisLabel(value) -``` - - - -###### fn fieldConfig.defaults.custom.withAxisPlacement - -```ts -withAxisPlacement(value) -``` - -TODO docs - -Accepted values for `value` are "auto", "top", "right", "bottom", "left", "hidden" - -###### fn fieldConfig.defaults.custom.withAxisSoftMax - -```ts -withAxisSoftMax(value) -``` - - - -###### fn fieldConfig.defaults.custom.withAxisSoftMin - -```ts -withAxisSoftMin(value) -``` - - - -###### fn fieldConfig.defaults.custom.withAxisWidth - -```ts -withAxisWidth(value) -``` - - - -###### fn fieldConfig.defaults.custom.withBarAlignment - -```ts -withBarAlignment(value) -``` - -TODO docs - -Accepted values for `value` are -1, 0, 1 - -###### fn fieldConfig.defaults.custom.withBarMaxWidth - -```ts -withBarMaxWidth(value) -``` - - - -###### fn fieldConfig.defaults.custom.withBarWidthFactor - -```ts -withBarWidthFactor(value) -``` - - - -###### fn fieldConfig.defaults.custom.withDrawStyle - -```ts -withDrawStyle(value) -``` - -TODO docs - -Accepted values for `value` are "line", "bars", "points" - -###### fn fieldConfig.defaults.custom.withFillBelowTo - -```ts -withFillBelowTo(value) -``` - - - -###### fn fieldConfig.defaults.custom.withFillColor - -```ts -withFillColor(value) -``` - - - -###### fn fieldConfig.defaults.custom.withFillOpacity - -```ts -withFillOpacity(value) -``` - - - -###### fn fieldConfig.defaults.custom.withGradientMode - -```ts -withGradientMode(value) -``` - -TODO docs - -Accepted values for `value` are "none", "opacity", "hue", "scheme" - -###### fn fieldConfig.defaults.custom.withHideFrom - -```ts -withHideFrom(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withHideFromMixin - -```ts -withHideFromMixin(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withLineColor - -```ts -withLineColor(value) -``` - - - -###### fn fieldConfig.defaults.custom.withLineInterpolation - -```ts -withLineInterpolation(value) -``` - -TODO docs - -Accepted values for `value` are "linear", "smooth", "stepBefore", "stepAfter" - -###### fn fieldConfig.defaults.custom.withLineStyle - -```ts -withLineStyle(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withLineStyleMixin - -```ts -withLineStyleMixin(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withLineWidth - -```ts -withLineWidth(value) -``` - - - -###### fn fieldConfig.defaults.custom.withPointColor - -```ts -withPointColor(value) -``` - - - -###### fn fieldConfig.defaults.custom.withPointSize - -```ts -withPointSize(value) -``` - - - -###### fn fieldConfig.defaults.custom.withPointSymbol - -```ts -withPointSymbol(value) -``` - - - -###### fn fieldConfig.defaults.custom.withScaleDistribution - -```ts -withScaleDistribution(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withScaleDistributionMixin - -```ts -withScaleDistributionMixin(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withShowPoints - -```ts -withShowPoints(value) -``` - -TODO docs - -Accepted values for `value` are "auto", "never", "always" - -###### fn fieldConfig.defaults.custom.withSpanNulls - -```ts -withSpanNulls(value) -``` - -Indicate if null values should be treated as gaps or connected. -When the value is a number, it represents the maximum delta in the -X axis that should be considered connected. For timeseries, this is milliseconds - -###### fn fieldConfig.defaults.custom.withSpanNullsMixin - -```ts -withSpanNullsMixin(value) -``` - -Indicate if null values should be treated as gaps or connected. -When the value is a number, it represents the maximum delta in the -X axis that should be considered connected. For timeseries, this is milliseconds - -###### fn fieldConfig.defaults.custom.withStacking - -```ts -withStacking(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withStackingMixin - -```ts -withStackingMixin(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withThresholdsStyle - -```ts -withThresholdsStyle(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withThresholdsStyleMixin - -```ts -withThresholdsStyleMixin(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withTransform - -```ts -withTransform(value) -``` - -TODO docs - -Accepted values for `value` are "constant", "negative-Y" - -###### obj fieldConfig.defaults.custom.hideFrom - - -####### fn fieldConfig.defaults.custom.hideFrom.withLegend - -```ts -withLegend(value) -``` - - - -####### fn fieldConfig.defaults.custom.hideFrom.withTooltip - -```ts -withTooltip(value) -``` - - - -####### fn fieldConfig.defaults.custom.hideFrom.withViz - -```ts -withViz(value) -``` - - - -###### obj fieldConfig.defaults.custom.lineStyle - - -####### fn fieldConfig.defaults.custom.lineStyle.withDash - -```ts -withDash(value) -``` - - - -####### fn fieldConfig.defaults.custom.lineStyle.withDashMixin - -```ts -withDashMixin(value) -``` - - - -####### fn fieldConfig.defaults.custom.lineStyle.withFill - -```ts -withFill(value) -``` - - - -Accepted values for `value` are "solid", "dash", "dot", "square" - -###### obj fieldConfig.defaults.custom.scaleDistribution - - -####### fn fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold - -```ts -withLinearThreshold(value) -``` - - - -####### fn fieldConfig.defaults.custom.scaleDistribution.withLog - -```ts -withLog(value) -``` - - - -####### fn fieldConfig.defaults.custom.scaleDistribution.withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "linear", "log", "ordinal", "symlog" - -###### obj fieldConfig.defaults.custom.stacking - - -####### fn fieldConfig.defaults.custom.stacking.withGroup - -```ts -withGroup(value) -``` - - - -####### fn fieldConfig.defaults.custom.stacking.withMode - -```ts -withMode(value) -``` - -TODO docs - -Accepted values for `value` are "none", "normal", "percent" - -###### obj fieldConfig.defaults.custom.thresholdsStyle - - -####### fn fieldConfig.defaults.custom.thresholdsStyle.withMode - -```ts -withMode(value) -``` - -TODO docs - -Accepted values for `value` are "off", "line", "dashed", "area", "line+area", "dashed+area", "series" - -### obj gridPos - - -#### fn gridPos.withH - -```ts -withH(value=9) -``` - -Panel - -#### fn gridPos.withStatic - -```ts -withStatic(value) -``` - -true if fixed - -#### fn gridPos.withW - -```ts -withW(value=12) -``` - -Panel - -#### fn gridPos.withX - -```ts -withX(value=0) -``` - -Panel x - -#### fn gridPos.withY - -```ts -withY(value=0) -``` - -Panel y - -### obj libraryPanel - - -#### fn libraryPanel.withName - -```ts -withName(value) -``` - - - -#### fn libraryPanel.withUid - -```ts -withUid(value) -``` - - - -### obj options - - -#### fn options.withLegend - -```ts -withLegend(value) -``` - -TODO docs - -#### fn options.withLegendMixin - -```ts -withLegendMixin(value) -``` - -TODO docs - -#### fn options.withTimezone - -```ts -withTimezone(value) -``` - - - -#### fn options.withTimezoneMixin - -```ts -withTimezoneMixin(value) -``` - - - -#### fn options.withTooltip - -```ts -withTooltip(value) -``` - -TODO docs - -#### fn options.withTooltipMixin - -```ts -withTooltipMixin(value) -``` - -TODO docs - -#### obj options.legend - - -##### fn options.legend.withAsTable - -```ts -withAsTable(value) -``` - - - -##### fn options.legend.withCalcs - -```ts -withCalcs(value) -``` - - - -##### fn options.legend.withCalcsMixin - -```ts -withCalcsMixin(value) -``` - - - -##### fn options.legend.withDisplayMode - -```ts -withDisplayMode(value) -``` - -TODO docs -Note: "hidden" needs to remain as an option for plugins compatibility - -Accepted values for `value` are "list", "table", "hidden" - -##### fn options.legend.withIsVisible - -```ts -withIsVisible(value) -``` - - - -##### fn options.legend.withPlacement - -```ts -withPlacement(value) -``` - -TODO docs - -Accepted values for `value` are "bottom", "right" - -##### fn options.legend.withShowLegend - -```ts -withShowLegend(value) -``` - - - -##### fn options.legend.withSortBy - -```ts -withSortBy(value) -``` - - - -##### fn options.legend.withSortDesc - -```ts -withSortDesc(value) -``` - - - -##### fn options.legend.withWidth - -```ts -withWidth(value) -``` - - - -#### obj options.tooltip - - -##### fn options.tooltip.withMode - -```ts -withMode(value) -``` - -TODO docs - -Accepted values for `value` are "single", "multi", "none" - -##### fn options.tooltip.withSort - -```ts -withSort(value) -``` - -TODO docs - -Accepted values for `value` are "asc", "desc", "none" - -### obj panelOptions - - -#### fn panelOptions.withDescription - -```ts -withDescription(value) -``` - -Description. - -#### fn panelOptions.withLinks - -```ts -withLinks(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withRepeat - -```ts -withRepeat(value) -``` - -Name of template variable to repeat for. - -#### fn panelOptions.withRepeatDirection - -```ts -withRepeatDirection(value="h") -``` - -Direction to repeat in if 'repeat' is set. -"h" for horizontal, "v" for vertical. -TODO this is probably optional - -Accepted values for `value` are "h", "v" - -#### fn panelOptions.withTitle - -```ts -withTitle(value) -``` - -Panel title. - -#### fn panelOptions.withTransparent - -```ts -withTransparent(value=false) -``` - -Whether to display the panel without a background. - -### obj queryOptions - - -#### fn queryOptions.withDatasource - -```ts -withDatasource(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withDatasourceMixin - -```ts -withDatasourceMixin(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withInterval - -```ts -withInterval(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withMaxDataPoints - -```ts -withMaxDataPoints(value) -``` - -TODO docs - -#### fn queryOptions.withTargets - -```ts -withTargets(value) -``` - -TODO docs - -#### fn queryOptions.withTargetsMixin - -```ts -withTargetsMixin(value) -``` - -TODO docs - -#### fn queryOptions.withTimeFrom - -```ts -withTimeFrom(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTimeShift - -```ts -withTimeShift(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTransformations - -```ts -withTransformations(value) -``` - - - -#### fn queryOptions.withTransformationsMixin - -```ts -withTransformationsMixin(value) -``` - - - -### obj standardOptions - - -#### fn standardOptions.withDecimals - -```ts -withDecimals(value) -``` - -Significant digits (for display) - -#### fn standardOptions.withDisplayName - -```ts -withDisplayName(value) -``` - -The display value for this field. This supports template variables blank is auto - -#### fn standardOptions.withLinks - -```ts -withLinks(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withMappings - -```ts -withMappings(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMappingsMixin - -```ts -withMappingsMixin(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMax - -```ts -withMax(value) -``` - - - -#### fn standardOptions.withMin - -```ts -withMin(value) -``` - - - -#### fn standardOptions.withNoValue - -```ts -withNoValue(value) -``` - -Alternative to empty string - -#### fn standardOptions.withOverrides - -```ts -withOverrides(value) -``` - - - -#### fn standardOptions.withOverridesMixin - -```ts -withOverridesMixin(value) -``` - - - -#### fn standardOptions.withUnit - -```ts -withUnit(value) -``` - -Numeric Options - -#### obj standardOptions.color - - -##### fn standardOptions.color.withFixedColor - -```ts -withFixedColor(value) -``` - -Stores the fixed color value if mode is fixed - -##### fn standardOptions.color.withMode - -```ts -withMode(value) -``` - -The main color scheme mode - -##### fn standardOptions.color.withSeriesBy - -```ts -withSeriesBy(value) -``` - -TODO docs - -Accepted values for `value` are "min", "max", "last" - -#### obj standardOptions.thresholds - - -##### fn standardOptions.thresholds.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "absolute", "percentage" - -##### fn standardOptions.thresholds.withSteps - -```ts -withSteps(value) -``` - -Must be sorted by 'value', first value is always -Infinity - -##### fn standardOptions.thresholds.withStepsMixin - -```ts -withStepsMixin(value) -``` - -Must be sorted by 'value', first value is always -Infinity diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/timeSeries/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/timeSeries/link.md deleted file mode 100644 index 1a1d7c4..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/timeSeries/link.md +++ /dev/null @@ -1,109 +0,0 @@ -# link - - - -## Index - -* [`fn withAsDropdown(value=false)`](#fn-withasdropdown) -* [`fn withIcon(value)`](#fn-withicon) -* [`fn withIncludeVars(value=false)`](#fn-withincludevars) -* [`fn withKeepTime(value=false)`](#fn-withkeeptime) -* [`fn withTags(value)`](#fn-withtags) -* [`fn withTagsMixin(value)`](#fn-withtagsmixin) -* [`fn withTargetBlank(value=false)`](#fn-withtargetblank) -* [`fn withTitle(value)`](#fn-withtitle) -* [`fn withTooltip(value)`](#fn-withtooltip) -* [`fn withType(value)`](#fn-withtype) -* [`fn withUrl(value)`](#fn-withurl) - -## Fields - -### fn withAsDropdown - -```ts -withAsDropdown(value=false) -``` - - - -### fn withIcon - -```ts -withIcon(value) -``` - - - -### fn withIncludeVars - -```ts -withIncludeVars(value=false) -``` - - - -### fn withKeepTime - -```ts -withKeepTime(value=false) -``` - - - -### fn withTags - -```ts -withTags(value) -``` - - - -### fn withTagsMixin - -```ts -withTagsMixin(value) -``` - - - -### fn withTargetBlank - -```ts -withTargetBlank(value=false) -``` - - - -### fn withTitle - -```ts -withTitle(value) -``` - - - -### fn withTooltip - -```ts -withTooltip(value) -``` - - - -### fn withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "link", "dashboards" - -### fn withUrl - -```ts -withUrl(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/timeSeries/thresholdStep.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/timeSeries/thresholdStep.md deleted file mode 100644 index 9d6af42..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/timeSeries/thresholdStep.md +++ /dev/null @@ -1,47 +0,0 @@ -# thresholdStep - - - -## Index - -* [`fn withColor(value)`](#fn-withcolor) -* [`fn withIndex(value)`](#fn-withindex) -* [`fn withState(value)`](#fn-withstate) -* [`fn withValue(value)`](#fn-withvalue) - -## Fields - -### fn withColor - -```ts -withColor(value) -``` - -TODO docs - -### fn withIndex - -```ts -withIndex(value) -``` - -Threshold index, an old property that is not needed an should only appear in older dashboards - -### fn withState - -```ts -withState(value) -``` - -TODO docs -TODO are the values here enumerable into a disjunction? -Some seem to be listed in typescript comment - -### fn withValue - -```ts -withValue(value) -``` - -TODO docs -FIXME the corresponding typescript field is required/non-optional, but nulls currently appear here when serializing -Infinity to JSON diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/timeSeries/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/timeSeries/transformation.md deleted file mode 100644 index 3dac7e9..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/timeSeries/transformation.md +++ /dev/null @@ -1,76 +0,0 @@ -# transformation - - - -## Index - -* [`fn withDisabled(value)`](#fn-withdisabled) -* [`fn withFilter(value)`](#fn-withfilter) -* [`fn withFilterMixin(value)`](#fn-withfiltermixin) -* [`fn withId(value)`](#fn-withid) -* [`fn withOptions(value)`](#fn-withoptions) -* [`obj filter`](#obj-filter) - * [`fn withId(value="")`](#fn-filterwithid) - * [`fn withOptions(value)`](#fn-filterwithoptions) - -## Fields - -### fn withDisabled - -```ts -withDisabled(value) -``` - -Disabled transformations are skipped - -### fn withFilter - -```ts -withFilter(value) -``` - - - -### fn withFilterMixin - -```ts -withFilterMixin(value) -``` - - - -### fn withId - -```ts -withId(value) -``` - -Unique identifier of transformer - -### fn withOptions - -```ts -withOptions(value) -``` - -Options to be passed to the transformer -Valid options depend on the transformer id - -### obj filter - - -#### fn filter.withId - -```ts -withId(value="") -``` - - - -#### fn filter.withOptions - -```ts -withOptions(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/timeSeries/valueMapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/timeSeries/valueMapping.md deleted file mode 100644 index a6bbdb3..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/timeSeries/valueMapping.md +++ /dev/null @@ -1,365 +0,0 @@ -# valueMapping - - - -## Index - -* [`obj RangeMap`](#obj-rangemap) - * [`fn withOptions(value)`](#fn-rangemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) - * [`obj options`](#obj-rangemapoptions) - * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) - * [`fn withResult(value)`](#fn-rangemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) - * [`fn withTo(value)`](#fn-rangemapoptionswithto) - * [`obj result`](#obj-rangemapoptionsresult) - * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) -* [`obj RegexMap`](#obj-regexmap) - * [`fn withOptions(value)`](#fn-regexmapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) - * [`obj options`](#obj-regexmapoptions) - * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) - * [`fn withResult(value)`](#fn-regexmapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) - * [`obj result`](#obj-regexmapoptionsresult) - * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) - * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) -* [`obj SpecialValueMap`](#obj-specialvaluemap) - * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) - * [`obj options`](#obj-specialvaluemapoptions) - * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) - * [`fn withPattern(value)`](#fn-specialvaluemapoptionswithpattern) - * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) - * [`obj result`](#obj-specialvaluemapoptionsresult) - * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) -* [`obj ValueMap`](#obj-valuemap) - * [`fn withOptions(value)`](#fn-valuemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) - -## Fields - -### obj RangeMap - - -#### fn RangeMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RangeMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RangeMap.withType - -```ts -withType(value) -``` - - - -#### obj RangeMap.options - - -##### fn RangeMap.options.withFrom - -```ts -withFrom(value) -``` - -to and from are `number | null` in current ts, really not sure what to do - -##### fn RangeMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RangeMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### fn RangeMap.options.withTo - -```ts -withTo(value) -``` - - - -##### obj RangeMap.options.result - - -###### fn RangeMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RangeMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RangeMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RangeMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj RegexMap - - -#### fn RegexMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RegexMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RegexMap.withType - -```ts -withType(value) -``` - - - -#### obj RegexMap.options - - -##### fn RegexMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn RegexMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RegexMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj RegexMap.options.result - - -###### fn RegexMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RegexMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RegexMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RegexMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj SpecialValueMap - - -#### fn SpecialValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn SpecialValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn SpecialValueMap.withType - -```ts -withType(value) -``` - - - -#### obj SpecialValueMap.options - - -##### fn SpecialValueMap.options.withMatch - -```ts -withMatch(value) -``` - - - -Accepted values for `value` are "true", "false" - -##### fn SpecialValueMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn SpecialValueMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn SpecialValueMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj SpecialValueMap.options.result - - -###### fn SpecialValueMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn SpecialValueMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn SpecialValueMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn SpecialValueMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj ValueMap - - -#### fn ValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn ValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn ValueMap.withType - -```ts -withType(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/trend/fieldOverride.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/trend/fieldOverride.md deleted file mode 100644 index 3e2667b..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/trend/fieldOverride.md +++ /dev/null @@ -1,194 +0,0 @@ -# fieldOverride - -Overrides allow you to customize visualization settings for specific fields or -series. This is accomplished by adding an override rule that targets -a particular set of fields and that can each define multiple options. - -```jsonnet -fieldOverride.byType.new('number') -+ fieldOverride.byType.withPropertiesFromOptions( - panel.standardOptions.withDecimals(2) - + panel.standardOptions.withUnit('s') -) -``` - - -## Index - -* [`obj byName`](#obj-byname) - * [`fn new(value)`](#fn-bynamenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bynamewithproperty) -* [`obj byQuery`](#obj-byquery) - * [`fn new(value)`](#fn-byquerynew) - * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byquerywithproperty) -* [`obj byRegexp`](#obj-byregexp) - * [`fn new(value)`](#fn-byregexpnew) - * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) -* [`obj byType`](#obj-bytype) - * [`fn new(value)`](#fn-bytypenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bytypewithproperty) -* [`obj byValue`](#obj-byvalue) - * [`fn new(value)`](#fn-byvaluenew) - * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) - -## Fields - -### obj byName - - -#### fn byName.new - -```ts -new(value) -``` - -`new` creates a new override of type `byName`. - -#### fn byName.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byName.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byQuery - - -#### fn byQuery.new - -```ts -new(value) -``` - -`new` creates a new override of type `byQuery`. - -#### fn byQuery.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byQuery.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byRegexp - - -#### fn byRegexp.new - -```ts -new(value) -``` - -`new` creates a new override of type `byRegexp`. - -#### fn byRegexp.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byRegexp.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byType - - -#### fn byType.new - -```ts -new(value) -``` - -`new` creates a new override of type `byType`. - -#### fn byType.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byType.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byValue - - -#### fn byValue.new - -```ts -new(value) -``` - -`new` creates a new override of type `byValue`. - -#### fn byValue.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byValue.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/trend/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/trend/index.md deleted file mode 100644 index b9feb7b..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/trend/index.md +++ /dev/null @@ -1,1132 +0,0 @@ -# trend - -grafonnet.panel.trend - -## Subpackages - -* [fieldOverride](fieldOverride.md) -* [link](link.md) -* [thresholdStep](thresholdStep.md) -* [transformation](transformation.md) -* [valueMapping](valueMapping.md) - -## Index - -* [`fn new(title)`](#fn-new) -* [`obj datasource`](#obj-datasource) - * [`fn withType(value)`](#fn-datasourcewithtype) - * [`fn withUid(value)`](#fn-datasourcewithuid) -* [`obj fieldConfig`](#obj-fieldconfig) - * [`obj defaults`](#obj-fieldconfigdefaults) - * [`obj custom`](#obj-fieldconfigdefaultscustom) - * [`fn withAxisCenteredZero(value)`](#fn-fieldconfigdefaultscustomwithaxiscenteredzero) - * [`fn withAxisColorMode(value)`](#fn-fieldconfigdefaultscustomwithaxiscolormode) - * [`fn withAxisGridShow(value)`](#fn-fieldconfigdefaultscustomwithaxisgridshow) - * [`fn withAxisLabel(value)`](#fn-fieldconfigdefaultscustomwithaxislabel) - * [`fn withAxisPlacement(value)`](#fn-fieldconfigdefaultscustomwithaxisplacement) - * [`fn withAxisSoftMax(value)`](#fn-fieldconfigdefaultscustomwithaxissoftmax) - * [`fn withAxisSoftMin(value)`](#fn-fieldconfigdefaultscustomwithaxissoftmin) - * [`fn withAxisWidth(value)`](#fn-fieldconfigdefaultscustomwithaxiswidth) - * [`fn withBarAlignment(value)`](#fn-fieldconfigdefaultscustomwithbaralignment) - * [`fn withBarMaxWidth(value)`](#fn-fieldconfigdefaultscustomwithbarmaxwidth) - * [`fn withBarWidthFactor(value)`](#fn-fieldconfigdefaultscustomwithbarwidthfactor) - * [`fn withDrawStyle(value)`](#fn-fieldconfigdefaultscustomwithdrawstyle) - * [`fn withFillBelowTo(value)`](#fn-fieldconfigdefaultscustomwithfillbelowto) - * [`fn withFillColor(value)`](#fn-fieldconfigdefaultscustomwithfillcolor) - * [`fn withFillOpacity(value)`](#fn-fieldconfigdefaultscustomwithfillopacity) - * [`fn withGradientMode(value)`](#fn-fieldconfigdefaultscustomwithgradientmode) - * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomwithhidefrom) - * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomwithhidefrommixin) - * [`fn withLineColor(value)`](#fn-fieldconfigdefaultscustomwithlinecolor) - * [`fn withLineInterpolation(value)`](#fn-fieldconfigdefaultscustomwithlineinterpolation) - * [`fn withLineStyle(value)`](#fn-fieldconfigdefaultscustomwithlinestyle) - * [`fn withLineStyleMixin(value)`](#fn-fieldconfigdefaultscustomwithlinestylemixin) - * [`fn withLineWidth(value)`](#fn-fieldconfigdefaultscustomwithlinewidth) - * [`fn withPointColor(value)`](#fn-fieldconfigdefaultscustomwithpointcolor) - * [`fn withPointSize(value)`](#fn-fieldconfigdefaultscustomwithpointsize) - * [`fn withPointSymbol(value)`](#fn-fieldconfigdefaultscustomwithpointsymbol) - * [`fn withScaleDistribution(value)`](#fn-fieldconfigdefaultscustomwithscaledistribution) - * [`fn withScaleDistributionMixin(value)`](#fn-fieldconfigdefaultscustomwithscaledistributionmixin) - * [`fn withShowPoints(value)`](#fn-fieldconfigdefaultscustomwithshowpoints) - * [`fn withSpanNulls(value)`](#fn-fieldconfigdefaultscustomwithspannulls) - * [`fn withSpanNullsMixin(value)`](#fn-fieldconfigdefaultscustomwithspannullsmixin) - * [`fn withStacking(value)`](#fn-fieldconfigdefaultscustomwithstacking) - * [`fn withStackingMixin(value)`](#fn-fieldconfigdefaultscustomwithstackingmixin) - * [`fn withThresholdsStyle(value)`](#fn-fieldconfigdefaultscustomwiththresholdsstyle) - * [`fn withThresholdsStyleMixin(value)`](#fn-fieldconfigdefaultscustomwiththresholdsstylemixin) - * [`fn withTransform(value)`](#fn-fieldconfigdefaultscustomwithtransform) - * [`obj hideFrom`](#obj-fieldconfigdefaultscustomhidefrom) - * [`fn withLegend(value)`](#fn-fieldconfigdefaultscustomhidefromwithlegend) - * [`fn withTooltip(value)`](#fn-fieldconfigdefaultscustomhidefromwithtooltip) - * [`fn withViz(value)`](#fn-fieldconfigdefaultscustomhidefromwithviz) - * [`obj lineStyle`](#obj-fieldconfigdefaultscustomlinestyle) - * [`fn withDash(value)`](#fn-fieldconfigdefaultscustomlinestylewithdash) - * [`fn withDashMixin(value)`](#fn-fieldconfigdefaultscustomlinestylewithdashmixin) - * [`fn withFill(value)`](#fn-fieldconfigdefaultscustomlinestylewithfill) - * [`obj scaleDistribution`](#obj-fieldconfigdefaultscustomscaledistribution) - * [`fn withLinearThreshold(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlinearthreshold) - * [`fn withLog(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlog) - * [`fn withType(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithtype) - * [`obj stacking`](#obj-fieldconfigdefaultscustomstacking) - * [`fn withGroup(value)`](#fn-fieldconfigdefaultscustomstackingwithgroup) - * [`fn withMode(value)`](#fn-fieldconfigdefaultscustomstackingwithmode) - * [`obj thresholdsStyle`](#obj-fieldconfigdefaultscustomthresholdsstyle) - * [`fn withMode(value)`](#fn-fieldconfigdefaultscustomthresholdsstylewithmode) -* [`obj gridPos`](#obj-gridpos) - * [`fn withH(value=9)`](#fn-gridposwithh) - * [`fn withStatic(value)`](#fn-gridposwithstatic) - * [`fn withW(value=12)`](#fn-gridposwithw) - * [`fn withX(value=0)`](#fn-gridposwithx) - * [`fn withY(value=0)`](#fn-gridposwithy) -* [`obj libraryPanel`](#obj-librarypanel) - * [`fn withName(value)`](#fn-librarypanelwithname) - * [`fn withUid(value)`](#fn-librarypanelwithuid) -* [`obj options`](#obj-options) - * [`fn withLegend(value)`](#fn-optionswithlegend) - * [`fn withLegendMixin(value)`](#fn-optionswithlegendmixin) - * [`fn withTooltip(value)`](#fn-optionswithtooltip) - * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) - * [`fn withXField(value)`](#fn-optionswithxfield) - * [`obj legend`](#obj-optionslegend) - * [`fn withAsTable(value)`](#fn-optionslegendwithastable) - * [`fn withCalcs(value)`](#fn-optionslegendwithcalcs) - * [`fn withCalcsMixin(value)`](#fn-optionslegendwithcalcsmixin) - * [`fn withDisplayMode(value)`](#fn-optionslegendwithdisplaymode) - * [`fn withIsVisible(value)`](#fn-optionslegendwithisvisible) - * [`fn withPlacement(value)`](#fn-optionslegendwithplacement) - * [`fn withShowLegend(value)`](#fn-optionslegendwithshowlegend) - * [`fn withSortBy(value)`](#fn-optionslegendwithsortby) - * [`fn withSortDesc(value)`](#fn-optionslegendwithsortdesc) - * [`fn withWidth(value)`](#fn-optionslegendwithwidth) - * [`obj tooltip`](#obj-optionstooltip) - * [`fn withMode(value)`](#fn-optionstooltipwithmode) - * [`fn withSort(value)`](#fn-optionstooltipwithsort) -* [`obj panelOptions`](#obj-paneloptions) - * [`fn withDescription(value)`](#fn-paneloptionswithdescription) - * [`fn withLinks(value)`](#fn-paneloptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) - * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) - * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) - * [`fn withTitle(value)`](#fn-paneloptionswithtitle) - * [`fn withTransparent(value=false)`](#fn-paneloptionswithtransparent) -* [`obj queryOptions`](#obj-queryoptions) - * [`fn withDatasource(value)`](#fn-queryoptionswithdatasource) - * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) - * [`fn withInterval(value)`](#fn-queryoptionswithinterval) - * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) - * [`fn withTargets(value)`](#fn-queryoptionswithtargets) - * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) - * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) - * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) - * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) - * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) -* [`obj standardOptions`](#obj-standardoptions) - * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) - * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) - * [`fn withLinks(value)`](#fn-standardoptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) - * [`fn withMappings(value)`](#fn-standardoptionswithmappings) - * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) - * [`fn withMax(value)`](#fn-standardoptionswithmax) - * [`fn withMin(value)`](#fn-standardoptionswithmin) - * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) - * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) - * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) - * [`fn withUnit(value)`](#fn-standardoptionswithunit) - * [`obj color`](#obj-standardoptionscolor) - * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) - * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) - * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) - * [`obj thresholds`](#obj-standardoptionsthresholds) - * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) - * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) - * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) - -## Fields - -### fn new - -```ts -new(title) -``` - -Creates a new trend panel with a title. - -### obj datasource - - -#### fn datasource.withType - -```ts -withType(value) -``` - - - -#### fn datasource.withUid - -```ts -withUid(value) -``` - - - -### obj fieldConfig - - -#### obj fieldConfig.defaults - - -##### obj fieldConfig.defaults.custom - - -###### fn fieldConfig.defaults.custom.withAxisCenteredZero - -```ts -withAxisCenteredZero(value) -``` - - - -###### fn fieldConfig.defaults.custom.withAxisColorMode - -```ts -withAxisColorMode(value) -``` - -TODO docs - -Accepted values for `value` are "text", "series" - -###### fn fieldConfig.defaults.custom.withAxisGridShow - -```ts -withAxisGridShow(value) -``` - - - -###### fn fieldConfig.defaults.custom.withAxisLabel - -```ts -withAxisLabel(value) -``` - - - -###### fn fieldConfig.defaults.custom.withAxisPlacement - -```ts -withAxisPlacement(value) -``` - -TODO docs - -Accepted values for `value` are "auto", "top", "right", "bottom", "left", "hidden" - -###### fn fieldConfig.defaults.custom.withAxisSoftMax - -```ts -withAxisSoftMax(value) -``` - - - -###### fn fieldConfig.defaults.custom.withAxisSoftMin - -```ts -withAxisSoftMin(value) -``` - - - -###### fn fieldConfig.defaults.custom.withAxisWidth - -```ts -withAxisWidth(value) -``` - - - -###### fn fieldConfig.defaults.custom.withBarAlignment - -```ts -withBarAlignment(value) -``` - -TODO docs - -Accepted values for `value` are -1, 0, 1 - -###### fn fieldConfig.defaults.custom.withBarMaxWidth - -```ts -withBarMaxWidth(value) -``` - - - -###### fn fieldConfig.defaults.custom.withBarWidthFactor - -```ts -withBarWidthFactor(value) -``` - - - -###### fn fieldConfig.defaults.custom.withDrawStyle - -```ts -withDrawStyle(value) -``` - -TODO docs - -Accepted values for `value` are "line", "bars", "points" - -###### fn fieldConfig.defaults.custom.withFillBelowTo - -```ts -withFillBelowTo(value) -``` - - - -###### fn fieldConfig.defaults.custom.withFillColor - -```ts -withFillColor(value) -``` - - - -###### fn fieldConfig.defaults.custom.withFillOpacity - -```ts -withFillOpacity(value) -``` - - - -###### fn fieldConfig.defaults.custom.withGradientMode - -```ts -withGradientMode(value) -``` - -TODO docs - -Accepted values for `value` are "none", "opacity", "hue", "scheme" - -###### fn fieldConfig.defaults.custom.withHideFrom - -```ts -withHideFrom(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withHideFromMixin - -```ts -withHideFromMixin(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withLineColor - -```ts -withLineColor(value) -``` - - - -###### fn fieldConfig.defaults.custom.withLineInterpolation - -```ts -withLineInterpolation(value) -``` - -TODO docs - -Accepted values for `value` are "linear", "smooth", "stepBefore", "stepAfter" - -###### fn fieldConfig.defaults.custom.withLineStyle - -```ts -withLineStyle(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withLineStyleMixin - -```ts -withLineStyleMixin(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withLineWidth - -```ts -withLineWidth(value) -``` - - - -###### fn fieldConfig.defaults.custom.withPointColor - -```ts -withPointColor(value) -``` - - - -###### fn fieldConfig.defaults.custom.withPointSize - -```ts -withPointSize(value) -``` - - - -###### fn fieldConfig.defaults.custom.withPointSymbol - -```ts -withPointSymbol(value) -``` - - - -###### fn fieldConfig.defaults.custom.withScaleDistribution - -```ts -withScaleDistribution(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withScaleDistributionMixin - -```ts -withScaleDistributionMixin(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withShowPoints - -```ts -withShowPoints(value) -``` - -TODO docs - -Accepted values for `value` are "auto", "never", "always" - -###### fn fieldConfig.defaults.custom.withSpanNulls - -```ts -withSpanNulls(value) -``` - -Indicate if null values should be treated as gaps or connected. -When the value is a number, it represents the maximum delta in the -X axis that should be considered connected. For timeseries, this is milliseconds - -###### fn fieldConfig.defaults.custom.withSpanNullsMixin - -```ts -withSpanNullsMixin(value) -``` - -Indicate if null values should be treated as gaps or connected. -When the value is a number, it represents the maximum delta in the -X axis that should be considered connected. For timeseries, this is milliseconds - -###### fn fieldConfig.defaults.custom.withStacking - -```ts -withStacking(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withStackingMixin - -```ts -withStackingMixin(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withThresholdsStyle - -```ts -withThresholdsStyle(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withThresholdsStyleMixin - -```ts -withThresholdsStyleMixin(value) -``` - -TODO docs - -###### fn fieldConfig.defaults.custom.withTransform - -```ts -withTransform(value) -``` - -TODO docs - -Accepted values for `value` are "constant", "negative-Y" - -###### obj fieldConfig.defaults.custom.hideFrom - - -####### fn fieldConfig.defaults.custom.hideFrom.withLegend - -```ts -withLegend(value) -``` - - - -####### fn fieldConfig.defaults.custom.hideFrom.withTooltip - -```ts -withTooltip(value) -``` - - - -####### fn fieldConfig.defaults.custom.hideFrom.withViz - -```ts -withViz(value) -``` - - - -###### obj fieldConfig.defaults.custom.lineStyle - - -####### fn fieldConfig.defaults.custom.lineStyle.withDash - -```ts -withDash(value) -``` - - - -####### fn fieldConfig.defaults.custom.lineStyle.withDashMixin - -```ts -withDashMixin(value) -``` - - - -####### fn fieldConfig.defaults.custom.lineStyle.withFill - -```ts -withFill(value) -``` - - - -Accepted values for `value` are "solid", "dash", "dot", "square" - -###### obj fieldConfig.defaults.custom.scaleDistribution - - -####### fn fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold - -```ts -withLinearThreshold(value) -``` - - - -####### fn fieldConfig.defaults.custom.scaleDistribution.withLog - -```ts -withLog(value) -``` - - - -####### fn fieldConfig.defaults.custom.scaleDistribution.withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "linear", "log", "ordinal", "symlog" - -###### obj fieldConfig.defaults.custom.stacking - - -####### fn fieldConfig.defaults.custom.stacking.withGroup - -```ts -withGroup(value) -``` - - - -####### fn fieldConfig.defaults.custom.stacking.withMode - -```ts -withMode(value) -``` - -TODO docs - -Accepted values for `value` are "none", "normal", "percent" - -###### obj fieldConfig.defaults.custom.thresholdsStyle - - -####### fn fieldConfig.defaults.custom.thresholdsStyle.withMode - -```ts -withMode(value) -``` - -TODO docs - -Accepted values for `value` are "off", "line", "dashed", "area", "line+area", "dashed+area", "series" - -### obj gridPos - - -#### fn gridPos.withH - -```ts -withH(value=9) -``` - -Panel - -#### fn gridPos.withStatic - -```ts -withStatic(value) -``` - -true if fixed - -#### fn gridPos.withW - -```ts -withW(value=12) -``` - -Panel - -#### fn gridPos.withX - -```ts -withX(value=0) -``` - -Panel x - -#### fn gridPos.withY - -```ts -withY(value=0) -``` - -Panel y - -### obj libraryPanel - - -#### fn libraryPanel.withName - -```ts -withName(value) -``` - - - -#### fn libraryPanel.withUid - -```ts -withUid(value) -``` - - - -### obj options - - -#### fn options.withLegend - -```ts -withLegend(value) -``` - -TODO docs - -#### fn options.withLegendMixin - -```ts -withLegendMixin(value) -``` - -TODO docs - -#### fn options.withTooltip - -```ts -withTooltip(value) -``` - -TODO docs - -#### fn options.withTooltipMixin - -```ts -withTooltipMixin(value) -``` - -TODO docs - -#### fn options.withXField - -```ts -withXField(value) -``` - -Name of the x field to use (defaults to first number) - -#### obj options.legend - - -##### fn options.legend.withAsTable - -```ts -withAsTable(value) -``` - - - -##### fn options.legend.withCalcs - -```ts -withCalcs(value) -``` - - - -##### fn options.legend.withCalcsMixin - -```ts -withCalcsMixin(value) -``` - - - -##### fn options.legend.withDisplayMode - -```ts -withDisplayMode(value) -``` - -TODO docs -Note: "hidden" needs to remain as an option for plugins compatibility - -Accepted values for `value` are "list", "table", "hidden" - -##### fn options.legend.withIsVisible - -```ts -withIsVisible(value) -``` - - - -##### fn options.legend.withPlacement - -```ts -withPlacement(value) -``` - -TODO docs - -Accepted values for `value` are "bottom", "right" - -##### fn options.legend.withShowLegend - -```ts -withShowLegend(value) -``` - - - -##### fn options.legend.withSortBy - -```ts -withSortBy(value) -``` - - - -##### fn options.legend.withSortDesc - -```ts -withSortDesc(value) -``` - - - -##### fn options.legend.withWidth - -```ts -withWidth(value) -``` - - - -#### obj options.tooltip - - -##### fn options.tooltip.withMode - -```ts -withMode(value) -``` - -TODO docs - -Accepted values for `value` are "single", "multi", "none" - -##### fn options.tooltip.withSort - -```ts -withSort(value) -``` - -TODO docs - -Accepted values for `value` are "asc", "desc", "none" - -### obj panelOptions - - -#### fn panelOptions.withDescription - -```ts -withDescription(value) -``` - -Description. - -#### fn panelOptions.withLinks - -```ts -withLinks(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withRepeat - -```ts -withRepeat(value) -``` - -Name of template variable to repeat for. - -#### fn panelOptions.withRepeatDirection - -```ts -withRepeatDirection(value="h") -``` - -Direction to repeat in if 'repeat' is set. -"h" for horizontal, "v" for vertical. -TODO this is probably optional - -Accepted values for `value` are "h", "v" - -#### fn panelOptions.withTitle - -```ts -withTitle(value) -``` - -Panel title. - -#### fn panelOptions.withTransparent - -```ts -withTransparent(value=false) -``` - -Whether to display the panel without a background. - -### obj queryOptions - - -#### fn queryOptions.withDatasource - -```ts -withDatasource(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withDatasourceMixin - -```ts -withDatasourceMixin(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withInterval - -```ts -withInterval(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withMaxDataPoints - -```ts -withMaxDataPoints(value) -``` - -TODO docs - -#### fn queryOptions.withTargets - -```ts -withTargets(value) -``` - -TODO docs - -#### fn queryOptions.withTargetsMixin - -```ts -withTargetsMixin(value) -``` - -TODO docs - -#### fn queryOptions.withTimeFrom - -```ts -withTimeFrom(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTimeShift - -```ts -withTimeShift(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTransformations - -```ts -withTransformations(value) -``` - - - -#### fn queryOptions.withTransformationsMixin - -```ts -withTransformationsMixin(value) -``` - - - -### obj standardOptions - - -#### fn standardOptions.withDecimals - -```ts -withDecimals(value) -``` - -Significant digits (for display) - -#### fn standardOptions.withDisplayName - -```ts -withDisplayName(value) -``` - -The display value for this field. This supports template variables blank is auto - -#### fn standardOptions.withLinks - -```ts -withLinks(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withMappings - -```ts -withMappings(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMappingsMixin - -```ts -withMappingsMixin(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMax - -```ts -withMax(value) -``` - - - -#### fn standardOptions.withMin - -```ts -withMin(value) -``` - - - -#### fn standardOptions.withNoValue - -```ts -withNoValue(value) -``` - -Alternative to empty string - -#### fn standardOptions.withOverrides - -```ts -withOverrides(value) -``` - - - -#### fn standardOptions.withOverridesMixin - -```ts -withOverridesMixin(value) -``` - - - -#### fn standardOptions.withUnit - -```ts -withUnit(value) -``` - -Numeric Options - -#### obj standardOptions.color - - -##### fn standardOptions.color.withFixedColor - -```ts -withFixedColor(value) -``` - -Stores the fixed color value if mode is fixed - -##### fn standardOptions.color.withMode - -```ts -withMode(value) -``` - -The main color scheme mode - -##### fn standardOptions.color.withSeriesBy - -```ts -withSeriesBy(value) -``` - -TODO docs - -Accepted values for `value` are "min", "max", "last" - -#### obj standardOptions.thresholds - - -##### fn standardOptions.thresholds.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "absolute", "percentage" - -##### fn standardOptions.thresholds.withSteps - -```ts -withSteps(value) -``` - -Must be sorted by 'value', first value is always -Infinity - -##### fn standardOptions.thresholds.withStepsMixin - -```ts -withStepsMixin(value) -``` - -Must be sorted by 'value', first value is always -Infinity diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/trend/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/trend/link.md deleted file mode 100644 index 1a1d7c4..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/trend/link.md +++ /dev/null @@ -1,109 +0,0 @@ -# link - - - -## Index - -* [`fn withAsDropdown(value=false)`](#fn-withasdropdown) -* [`fn withIcon(value)`](#fn-withicon) -* [`fn withIncludeVars(value=false)`](#fn-withincludevars) -* [`fn withKeepTime(value=false)`](#fn-withkeeptime) -* [`fn withTags(value)`](#fn-withtags) -* [`fn withTagsMixin(value)`](#fn-withtagsmixin) -* [`fn withTargetBlank(value=false)`](#fn-withtargetblank) -* [`fn withTitle(value)`](#fn-withtitle) -* [`fn withTooltip(value)`](#fn-withtooltip) -* [`fn withType(value)`](#fn-withtype) -* [`fn withUrl(value)`](#fn-withurl) - -## Fields - -### fn withAsDropdown - -```ts -withAsDropdown(value=false) -``` - - - -### fn withIcon - -```ts -withIcon(value) -``` - - - -### fn withIncludeVars - -```ts -withIncludeVars(value=false) -``` - - - -### fn withKeepTime - -```ts -withKeepTime(value=false) -``` - - - -### fn withTags - -```ts -withTags(value) -``` - - - -### fn withTagsMixin - -```ts -withTagsMixin(value) -``` - - - -### fn withTargetBlank - -```ts -withTargetBlank(value=false) -``` - - - -### fn withTitle - -```ts -withTitle(value) -``` - - - -### fn withTooltip - -```ts -withTooltip(value) -``` - - - -### fn withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "link", "dashboards" - -### fn withUrl - -```ts -withUrl(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/trend/thresholdStep.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/trend/thresholdStep.md deleted file mode 100644 index 9d6af42..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/trend/thresholdStep.md +++ /dev/null @@ -1,47 +0,0 @@ -# thresholdStep - - - -## Index - -* [`fn withColor(value)`](#fn-withcolor) -* [`fn withIndex(value)`](#fn-withindex) -* [`fn withState(value)`](#fn-withstate) -* [`fn withValue(value)`](#fn-withvalue) - -## Fields - -### fn withColor - -```ts -withColor(value) -``` - -TODO docs - -### fn withIndex - -```ts -withIndex(value) -``` - -Threshold index, an old property that is not needed an should only appear in older dashboards - -### fn withState - -```ts -withState(value) -``` - -TODO docs -TODO are the values here enumerable into a disjunction? -Some seem to be listed in typescript comment - -### fn withValue - -```ts -withValue(value) -``` - -TODO docs -FIXME the corresponding typescript field is required/non-optional, but nulls currently appear here when serializing -Infinity to JSON diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/trend/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/trend/transformation.md deleted file mode 100644 index 3dac7e9..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/trend/transformation.md +++ /dev/null @@ -1,76 +0,0 @@ -# transformation - - - -## Index - -* [`fn withDisabled(value)`](#fn-withdisabled) -* [`fn withFilter(value)`](#fn-withfilter) -* [`fn withFilterMixin(value)`](#fn-withfiltermixin) -* [`fn withId(value)`](#fn-withid) -* [`fn withOptions(value)`](#fn-withoptions) -* [`obj filter`](#obj-filter) - * [`fn withId(value="")`](#fn-filterwithid) - * [`fn withOptions(value)`](#fn-filterwithoptions) - -## Fields - -### fn withDisabled - -```ts -withDisabled(value) -``` - -Disabled transformations are skipped - -### fn withFilter - -```ts -withFilter(value) -``` - - - -### fn withFilterMixin - -```ts -withFilterMixin(value) -``` - - - -### fn withId - -```ts -withId(value) -``` - -Unique identifier of transformer - -### fn withOptions - -```ts -withOptions(value) -``` - -Options to be passed to the transformer -Valid options depend on the transformer id - -### obj filter - - -#### fn filter.withId - -```ts -withId(value="") -``` - - - -#### fn filter.withOptions - -```ts -withOptions(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/trend/valueMapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/trend/valueMapping.md deleted file mode 100644 index a6bbdb3..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/trend/valueMapping.md +++ /dev/null @@ -1,365 +0,0 @@ -# valueMapping - - - -## Index - -* [`obj RangeMap`](#obj-rangemap) - * [`fn withOptions(value)`](#fn-rangemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) - * [`obj options`](#obj-rangemapoptions) - * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) - * [`fn withResult(value)`](#fn-rangemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) - * [`fn withTo(value)`](#fn-rangemapoptionswithto) - * [`obj result`](#obj-rangemapoptionsresult) - * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) -* [`obj RegexMap`](#obj-regexmap) - * [`fn withOptions(value)`](#fn-regexmapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) - * [`obj options`](#obj-regexmapoptions) - * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) - * [`fn withResult(value)`](#fn-regexmapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) - * [`obj result`](#obj-regexmapoptionsresult) - * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) - * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) -* [`obj SpecialValueMap`](#obj-specialvaluemap) - * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) - * [`obj options`](#obj-specialvaluemapoptions) - * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) - * [`fn withPattern(value)`](#fn-specialvaluemapoptionswithpattern) - * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) - * [`obj result`](#obj-specialvaluemapoptionsresult) - * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) -* [`obj ValueMap`](#obj-valuemap) - * [`fn withOptions(value)`](#fn-valuemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) - -## Fields - -### obj RangeMap - - -#### fn RangeMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RangeMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RangeMap.withType - -```ts -withType(value) -``` - - - -#### obj RangeMap.options - - -##### fn RangeMap.options.withFrom - -```ts -withFrom(value) -``` - -to and from are `number | null` in current ts, really not sure what to do - -##### fn RangeMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RangeMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### fn RangeMap.options.withTo - -```ts -withTo(value) -``` - - - -##### obj RangeMap.options.result - - -###### fn RangeMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RangeMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RangeMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RangeMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj RegexMap - - -#### fn RegexMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RegexMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RegexMap.withType - -```ts -withType(value) -``` - - - -#### obj RegexMap.options - - -##### fn RegexMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn RegexMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RegexMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj RegexMap.options.result - - -###### fn RegexMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RegexMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RegexMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RegexMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj SpecialValueMap - - -#### fn SpecialValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn SpecialValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn SpecialValueMap.withType - -```ts -withType(value) -``` - - - -#### obj SpecialValueMap.options - - -##### fn SpecialValueMap.options.withMatch - -```ts -withMatch(value) -``` - - - -Accepted values for `value` are "true", "false" - -##### fn SpecialValueMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn SpecialValueMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn SpecialValueMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj SpecialValueMap.options.result - - -###### fn SpecialValueMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn SpecialValueMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn SpecialValueMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn SpecialValueMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj ValueMap - - -#### fn ValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn ValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn ValueMap.withType - -```ts -withType(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/xyChart/fieldOverride.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/xyChart/fieldOverride.md deleted file mode 100644 index 3e2667b..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/xyChart/fieldOverride.md +++ /dev/null @@ -1,194 +0,0 @@ -# fieldOverride - -Overrides allow you to customize visualization settings for specific fields or -series. This is accomplished by adding an override rule that targets -a particular set of fields and that can each define multiple options. - -```jsonnet -fieldOverride.byType.new('number') -+ fieldOverride.byType.withPropertiesFromOptions( - panel.standardOptions.withDecimals(2) - + panel.standardOptions.withUnit('s') -) -``` - - -## Index - -* [`obj byName`](#obj-byname) - * [`fn new(value)`](#fn-bynamenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bynamewithproperty) -* [`obj byQuery`](#obj-byquery) - * [`fn new(value)`](#fn-byquerynew) - * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byquerywithproperty) -* [`obj byRegexp`](#obj-byregexp) - * [`fn new(value)`](#fn-byregexpnew) - * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) -* [`obj byType`](#obj-bytype) - * [`fn new(value)`](#fn-bytypenew) - * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-bytypewithproperty) -* [`obj byValue`](#obj-byvalue) - * [`fn new(value)`](#fn-byvaluenew) - * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) - * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) - -## Fields - -### obj byName - - -#### fn byName.new - -```ts -new(value) -``` - -`new` creates a new override of type `byName`. - -#### fn byName.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byName.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byQuery - - -#### fn byQuery.new - -```ts -new(value) -``` - -`new` creates a new override of type `byQuery`. - -#### fn byQuery.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byQuery.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byRegexp - - -#### fn byRegexp.new - -```ts -new(value) -``` - -`new` creates a new override of type `byRegexp`. - -#### fn byRegexp.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byRegexp.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byType - - -#### fn byType.new - -```ts -new(value) -``` - -`new` creates a new override of type `byType`. - -#### fn byType.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byType.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - - -### obj byValue - - -#### fn byValue.new - -```ts -new(value) -``` - -`new` creates a new override of type `byValue`. - -#### fn byValue.withPropertiesFromOptions - -```ts -withPropertiesFromOptions(options) -``` - -`withPropertiesFromOptions` takes an object with properties that need to be -overridden. See example code above. - - -#### fn byValue.withProperty - -```ts -withProperty(id, value) -``` - -`withProperty` adds a property that needs to be overridden. This function can -be called multiple time, adding more properties. - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/xyChart/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/xyChart/index.md deleted file mode 100644 index d58e181..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/xyChart/index.md +++ /dev/null @@ -1,1207 +0,0 @@ -# xyChart - -grafonnet.panel.xyChart - -## Subpackages - -* [fieldOverride](fieldOverride.md) -* [link](link.md) -* [thresholdStep](thresholdStep.md) -* [transformation](transformation.md) -* [valueMapping](valueMapping.md) - -## Index - -* [`fn new(title)`](#fn-new) -* [`obj datasource`](#obj-datasource) - * [`fn withType(value)`](#fn-datasourcewithtype) - * [`fn withUid(value)`](#fn-datasourcewithuid) -* [`obj gridPos`](#obj-gridpos) - * [`fn withH(value=9)`](#fn-gridposwithh) - * [`fn withStatic(value)`](#fn-gridposwithstatic) - * [`fn withW(value=12)`](#fn-gridposwithw) - * [`fn withX(value=0)`](#fn-gridposwithx) - * [`fn withY(value=0)`](#fn-gridposwithy) -* [`obj libraryPanel`](#obj-librarypanel) - * [`fn withName(value)`](#fn-librarypanelwithname) - * [`fn withUid(value)`](#fn-librarypanelwithuid) -* [`obj options`](#obj-options) - * [`fn withDims(value)`](#fn-optionswithdims) - * [`fn withDimsMixin(value)`](#fn-optionswithdimsmixin) - * [`fn withLegend(value)`](#fn-optionswithlegend) - * [`fn withLegendMixin(value)`](#fn-optionswithlegendmixin) - * [`fn withSeries(value)`](#fn-optionswithseries) - * [`fn withSeriesMapping(value)`](#fn-optionswithseriesmapping) - * [`fn withSeriesMixin(value)`](#fn-optionswithseriesmixin) - * [`fn withTooltip(value)`](#fn-optionswithtooltip) - * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) - * [`obj dims`](#obj-optionsdims) - * [`fn withExclude(value)`](#fn-optionsdimswithexclude) - * [`fn withExcludeMixin(value)`](#fn-optionsdimswithexcludemixin) - * [`fn withFrame(value)`](#fn-optionsdimswithframe) - * [`fn withX(value)`](#fn-optionsdimswithx) - * [`obj legend`](#obj-optionslegend) - * [`fn withAsTable(value)`](#fn-optionslegendwithastable) - * [`fn withCalcs(value)`](#fn-optionslegendwithcalcs) - * [`fn withCalcsMixin(value)`](#fn-optionslegendwithcalcsmixin) - * [`fn withDisplayMode(value)`](#fn-optionslegendwithdisplaymode) - * [`fn withIsVisible(value)`](#fn-optionslegendwithisvisible) - * [`fn withPlacement(value)`](#fn-optionslegendwithplacement) - * [`fn withShowLegend(value)`](#fn-optionslegendwithshowlegend) - * [`fn withSortBy(value)`](#fn-optionslegendwithsortby) - * [`fn withSortDesc(value)`](#fn-optionslegendwithsortdesc) - * [`fn withWidth(value)`](#fn-optionslegendwithwidth) - * [`obj series`](#obj-optionsseries) - * [`fn withAxisCenteredZero(value)`](#fn-optionsserieswithaxiscenteredzero) - * [`fn withAxisColorMode(value)`](#fn-optionsserieswithaxiscolormode) - * [`fn withAxisGridShow(value)`](#fn-optionsserieswithaxisgridshow) - * [`fn withAxisLabel(value)`](#fn-optionsserieswithaxislabel) - * [`fn withAxisPlacement(value)`](#fn-optionsserieswithaxisplacement) - * [`fn withAxisSoftMax(value)`](#fn-optionsserieswithaxissoftmax) - * [`fn withAxisSoftMin(value)`](#fn-optionsserieswithaxissoftmin) - * [`fn withAxisWidth(value)`](#fn-optionsserieswithaxiswidth) - * [`fn withHideFrom(value)`](#fn-optionsserieswithhidefrom) - * [`fn withHideFromMixin(value)`](#fn-optionsserieswithhidefrommixin) - * [`fn withLabel(value)`](#fn-optionsserieswithlabel) - * [`fn withLabelValue(value)`](#fn-optionsserieswithlabelvalue) - * [`fn withLabelValueMixin(value)`](#fn-optionsserieswithlabelvaluemixin) - * [`fn withLineColor(value)`](#fn-optionsserieswithlinecolor) - * [`fn withLineColorMixin(value)`](#fn-optionsserieswithlinecolormixin) - * [`fn withLineStyle(value)`](#fn-optionsserieswithlinestyle) - * [`fn withLineStyleMixin(value)`](#fn-optionsserieswithlinestylemixin) - * [`fn withLineWidth(value)`](#fn-optionsserieswithlinewidth) - * [`fn withName(value)`](#fn-optionsserieswithname) - * [`fn withPointColor(value)`](#fn-optionsserieswithpointcolor) - * [`fn withPointColorMixin(value)`](#fn-optionsserieswithpointcolormixin) - * [`fn withPointSize(value)`](#fn-optionsserieswithpointsize) - * [`fn withPointSizeMixin(value)`](#fn-optionsserieswithpointsizemixin) - * [`fn withScaleDistribution(value)`](#fn-optionsserieswithscaledistribution) - * [`fn withScaleDistributionMixin(value)`](#fn-optionsserieswithscaledistributionmixin) - * [`fn withShow(value)`](#fn-optionsserieswithshow) - * [`fn withX(value)`](#fn-optionsserieswithx) - * [`fn withY(value)`](#fn-optionsserieswithy) - * [`obj hideFrom`](#obj-optionsserieshidefrom) - * [`fn withLegend(value)`](#fn-optionsserieshidefromwithlegend) - * [`fn withTooltip(value)`](#fn-optionsserieshidefromwithtooltip) - * [`fn withViz(value)`](#fn-optionsserieshidefromwithviz) - * [`obj labelValue`](#obj-optionsserieslabelvalue) - * [`fn withField(value)`](#fn-optionsserieslabelvaluewithfield) - * [`fn withFixed(value)`](#fn-optionsserieslabelvaluewithfixed) - * [`fn withMode(value)`](#fn-optionsserieslabelvaluewithmode) - * [`obj lineColor`](#obj-optionsserieslinecolor) - * [`fn withField(value)`](#fn-optionsserieslinecolorwithfield) - * [`fn withFixed(value)`](#fn-optionsserieslinecolorwithfixed) - * [`obj lineStyle`](#obj-optionsserieslinestyle) - * [`fn withDash(value)`](#fn-optionsserieslinestylewithdash) - * [`fn withDashMixin(value)`](#fn-optionsserieslinestylewithdashmixin) - * [`fn withFill(value)`](#fn-optionsserieslinestylewithfill) - * [`obj pointColor`](#obj-optionsseriespointcolor) - * [`fn withField(value)`](#fn-optionsseriespointcolorwithfield) - * [`fn withFixed(value)`](#fn-optionsseriespointcolorwithfixed) - * [`obj pointSize`](#obj-optionsseriespointsize) - * [`fn withField(value)`](#fn-optionsseriespointsizewithfield) - * [`fn withFixed(value)`](#fn-optionsseriespointsizewithfixed) - * [`fn withMax(value)`](#fn-optionsseriespointsizewithmax) - * [`fn withMin(value)`](#fn-optionsseriespointsizewithmin) - * [`fn withMode(value)`](#fn-optionsseriespointsizewithmode) - * [`obj scaleDistribution`](#obj-optionsseriesscaledistribution) - * [`fn withLinearThreshold(value)`](#fn-optionsseriesscaledistributionwithlinearthreshold) - * [`fn withLog(value)`](#fn-optionsseriesscaledistributionwithlog) - * [`fn withType(value)`](#fn-optionsseriesscaledistributionwithtype) - * [`obj tooltip`](#obj-optionstooltip) - * [`fn withMode(value)`](#fn-optionstooltipwithmode) - * [`fn withSort(value)`](#fn-optionstooltipwithsort) -* [`obj panelOptions`](#obj-paneloptions) - * [`fn withDescription(value)`](#fn-paneloptionswithdescription) - * [`fn withLinks(value)`](#fn-paneloptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) - * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) - * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) - * [`fn withTitle(value)`](#fn-paneloptionswithtitle) - * [`fn withTransparent(value=false)`](#fn-paneloptionswithtransparent) -* [`obj queryOptions`](#obj-queryoptions) - * [`fn withDatasource(value)`](#fn-queryoptionswithdatasource) - * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) - * [`fn withInterval(value)`](#fn-queryoptionswithinterval) - * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) - * [`fn withTargets(value)`](#fn-queryoptionswithtargets) - * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) - * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) - * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) - * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) - * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) -* [`obj standardOptions`](#obj-standardoptions) - * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) - * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) - * [`fn withLinks(value)`](#fn-standardoptionswithlinks) - * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) - * [`fn withMappings(value)`](#fn-standardoptionswithmappings) - * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) - * [`fn withMax(value)`](#fn-standardoptionswithmax) - * [`fn withMin(value)`](#fn-standardoptionswithmin) - * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) - * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) - * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) - * [`fn withUnit(value)`](#fn-standardoptionswithunit) - * [`obj color`](#obj-standardoptionscolor) - * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) - * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) - * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) - * [`obj thresholds`](#obj-standardoptionsthresholds) - * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) - * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) - * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) - -## Fields - -### fn new - -```ts -new(title) -``` - -Creates a new xyChart panel with a title. - -### obj datasource - - -#### fn datasource.withType - -```ts -withType(value) -``` - - - -#### fn datasource.withUid - -```ts -withUid(value) -``` - - - -### obj gridPos - - -#### fn gridPos.withH - -```ts -withH(value=9) -``` - -Panel - -#### fn gridPos.withStatic - -```ts -withStatic(value) -``` - -true if fixed - -#### fn gridPos.withW - -```ts -withW(value=12) -``` - -Panel - -#### fn gridPos.withX - -```ts -withX(value=0) -``` - -Panel x - -#### fn gridPos.withY - -```ts -withY(value=0) -``` - -Panel y - -### obj libraryPanel - - -#### fn libraryPanel.withName - -```ts -withName(value) -``` - - - -#### fn libraryPanel.withUid - -```ts -withUid(value) -``` - - - -### obj options - - -#### fn options.withDims - -```ts -withDims(value) -``` - - - -#### fn options.withDimsMixin - -```ts -withDimsMixin(value) -``` - - - -#### fn options.withLegend - -```ts -withLegend(value) -``` - -TODO docs - -#### fn options.withLegendMixin - -```ts -withLegendMixin(value) -``` - -TODO docs - -#### fn options.withSeries - -```ts -withSeries(value) -``` - - - -#### fn options.withSeriesMapping - -```ts -withSeriesMapping(value) -``` - - - -Accepted values for `value` are "auto", "manual" - -#### fn options.withSeriesMixin - -```ts -withSeriesMixin(value) -``` - - - -#### fn options.withTooltip - -```ts -withTooltip(value) -``` - -TODO docs - -#### fn options.withTooltipMixin - -```ts -withTooltipMixin(value) -``` - -TODO docs - -#### obj options.dims - - -##### fn options.dims.withExclude - -```ts -withExclude(value) -``` - - - -##### fn options.dims.withExcludeMixin - -```ts -withExcludeMixin(value) -``` - - - -##### fn options.dims.withFrame - -```ts -withFrame(value) -``` - - - -##### fn options.dims.withX - -```ts -withX(value) -``` - - - -#### obj options.legend - - -##### fn options.legend.withAsTable - -```ts -withAsTable(value) -``` - - - -##### fn options.legend.withCalcs - -```ts -withCalcs(value) -``` - - - -##### fn options.legend.withCalcsMixin - -```ts -withCalcsMixin(value) -``` - - - -##### fn options.legend.withDisplayMode - -```ts -withDisplayMode(value) -``` - -TODO docs -Note: "hidden" needs to remain as an option for plugins compatibility - -Accepted values for `value` are "list", "table", "hidden" - -##### fn options.legend.withIsVisible - -```ts -withIsVisible(value) -``` - - - -##### fn options.legend.withPlacement - -```ts -withPlacement(value) -``` - -TODO docs - -Accepted values for `value` are "bottom", "right" - -##### fn options.legend.withShowLegend - -```ts -withShowLegend(value) -``` - - - -##### fn options.legend.withSortBy - -```ts -withSortBy(value) -``` - - - -##### fn options.legend.withSortDesc - -```ts -withSortDesc(value) -``` - - - -##### fn options.legend.withWidth - -```ts -withWidth(value) -``` - - - -#### obj options.series - - -##### fn options.series.withAxisCenteredZero - -```ts -withAxisCenteredZero(value) -``` - - - -##### fn options.series.withAxisColorMode - -```ts -withAxisColorMode(value) -``` - -TODO docs - -Accepted values for `value` are "text", "series" - -##### fn options.series.withAxisGridShow - -```ts -withAxisGridShow(value) -``` - - - -##### fn options.series.withAxisLabel - -```ts -withAxisLabel(value) -``` - - - -##### fn options.series.withAxisPlacement - -```ts -withAxisPlacement(value) -``` - -TODO docs - -Accepted values for `value` are "auto", "top", "right", "bottom", "left", "hidden" - -##### fn options.series.withAxisSoftMax - -```ts -withAxisSoftMax(value) -``` - - - -##### fn options.series.withAxisSoftMin - -```ts -withAxisSoftMin(value) -``` - - - -##### fn options.series.withAxisWidth - -```ts -withAxisWidth(value) -``` - - - -##### fn options.series.withHideFrom - -```ts -withHideFrom(value) -``` - -TODO docs - -##### fn options.series.withHideFromMixin - -```ts -withHideFromMixin(value) -``` - -TODO docs - -##### fn options.series.withLabel - -```ts -withLabel(value) -``` - -TODO docs - -Accepted values for `value` are "auto", "never", "always" - -##### fn options.series.withLabelValue - -```ts -withLabelValue(value) -``` - - - -##### fn options.series.withLabelValueMixin - -```ts -withLabelValueMixin(value) -``` - - - -##### fn options.series.withLineColor - -```ts -withLineColor(value) -``` - - - -##### fn options.series.withLineColorMixin - -```ts -withLineColorMixin(value) -``` - - - -##### fn options.series.withLineStyle - -```ts -withLineStyle(value) -``` - -TODO docs - -##### fn options.series.withLineStyleMixin - -```ts -withLineStyleMixin(value) -``` - -TODO docs - -##### fn options.series.withLineWidth - -```ts -withLineWidth(value) -``` - - - -##### fn options.series.withName - -```ts -withName(value) -``` - - - -##### fn options.series.withPointColor - -```ts -withPointColor(value) -``` - - - -##### fn options.series.withPointColorMixin - -```ts -withPointColorMixin(value) -``` - - - -##### fn options.series.withPointSize - -```ts -withPointSize(value) -``` - - - -##### fn options.series.withPointSizeMixin - -```ts -withPointSizeMixin(value) -``` - - - -##### fn options.series.withScaleDistribution - -```ts -withScaleDistribution(value) -``` - -TODO docs - -##### fn options.series.withScaleDistributionMixin - -```ts -withScaleDistributionMixin(value) -``` - -TODO docs - -##### fn options.series.withShow - -```ts -withShow(value) -``` - - - -Accepted values for `value` are "points", "lines", "points+lines" - -##### fn options.series.withX - -```ts -withX(value) -``` - - - -##### fn options.series.withY - -```ts -withY(value) -``` - - - -##### obj options.series.hideFrom - - -###### fn options.series.hideFrom.withLegend - -```ts -withLegend(value) -``` - - - -###### fn options.series.hideFrom.withTooltip - -```ts -withTooltip(value) -``` - - - -###### fn options.series.hideFrom.withViz - -```ts -withViz(value) -``` - - - -##### obj options.series.labelValue - - -###### fn options.series.labelValue.withField - -```ts -withField(value) -``` - -fixed: T -- will be added by each element - -###### fn options.series.labelValue.withFixed - -```ts -withFixed(value) -``` - - - -###### fn options.series.labelValue.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "fixed", "field", "template" - -##### obj options.series.lineColor - - -###### fn options.series.lineColor.withField - -```ts -withField(value) -``` - -fixed: T -- will be added by each element - -###### fn options.series.lineColor.withFixed - -```ts -withFixed(value) -``` - - - -##### obj options.series.lineStyle - - -###### fn options.series.lineStyle.withDash - -```ts -withDash(value) -``` - - - -###### fn options.series.lineStyle.withDashMixin - -```ts -withDashMixin(value) -``` - - - -###### fn options.series.lineStyle.withFill - -```ts -withFill(value) -``` - - - -Accepted values for `value` are "solid", "dash", "dot", "square" - -##### obj options.series.pointColor - - -###### fn options.series.pointColor.withField - -```ts -withField(value) -``` - -fixed: T -- will be added by each element - -###### fn options.series.pointColor.withFixed - -```ts -withFixed(value) -``` - - - -##### obj options.series.pointSize - - -###### fn options.series.pointSize.withField - -```ts -withField(value) -``` - -fixed: T -- will be added by each element - -###### fn options.series.pointSize.withFixed - -```ts -withFixed(value) -``` - - - -###### fn options.series.pointSize.withMax - -```ts -withMax(value) -``` - - - -###### fn options.series.pointSize.withMin - -```ts -withMin(value) -``` - - - -###### fn options.series.pointSize.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "linear", "quad" - -##### obj options.series.scaleDistribution - - -###### fn options.series.scaleDistribution.withLinearThreshold - -```ts -withLinearThreshold(value) -``` - - - -###### fn options.series.scaleDistribution.withLog - -```ts -withLog(value) -``` - - - -###### fn options.series.scaleDistribution.withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "linear", "log", "ordinal", "symlog" - -#### obj options.tooltip - - -##### fn options.tooltip.withMode - -```ts -withMode(value) -``` - -TODO docs - -Accepted values for `value` are "single", "multi", "none" - -##### fn options.tooltip.withSort - -```ts -withSort(value) -``` - -TODO docs - -Accepted values for `value` are "asc", "desc", "none" - -### obj panelOptions - - -#### fn panelOptions.withDescription - -```ts -withDescription(value) -``` - -Description. - -#### fn panelOptions.withLinks - -```ts -withLinks(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -Panel links. -TODO fill this out - seems there are a couple variants? - -#### fn panelOptions.withRepeat - -```ts -withRepeat(value) -``` - -Name of template variable to repeat for. - -#### fn panelOptions.withRepeatDirection - -```ts -withRepeatDirection(value="h") -``` - -Direction to repeat in if 'repeat' is set. -"h" for horizontal, "v" for vertical. -TODO this is probably optional - -Accepted values for `value` are "h", "v" - -#### fn panelOptions.withTitle - -```ts -withTitle(value) -``` - -Panel title. - -#### fn panelOptions.withTransparent - -```ts -withTransparent(value=false) -``` - -Whether to display the panel without a background. - -### obj queryOptions - - -#### fn queryOptions.withDatasource - -```ts -withDatasource(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withDatasourceMixin - -```ts -withDatasourceMixin(value) -``` - -The datasource used in all targets. - -#### fn queryOptions.withInterval - -```ts -withInterval(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withMaxDataPoints - -```ts -withMaxDataPoints(value) -``` - -TODO docs - -#### fn queryOptions.withTargets - -```ts -withTargets(value) -``` - -TODO docs - -#### fn queryOptions.withTargetsMixin - -```ts -withTargetsMixin(value) -``` - -TODO docs - -#### fn queryOptions.withTimeFrom - -```ts -withTimeFrom(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTimeShift - -```ts -withTimeShift(value) -``` - -TODO docs -TODO tighter constraint - -#### fn queryOptions.withTransformations - -```ts -withTransformations(value) -``` - - - -#### fn queryOptions.withTransformationsMixin - -```ts -withTransformationsMixin(value) -``` - - - -### obj standardOptions - - -#### fn standardOptions.withDecimals - -```ts -withDecimals(value) -``` - -Significant digits (for display) - -#### fn standardOptions.withDisplayName - -```ts -withDisplayName(value) -``` - -The display value for this field. This supports template variables blank is auto - -#### fn standardOptions.withLinks - -```ts -withLinks(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withLinksMixin - -```ts -withLinksMixin(value) -``` - -The behavior when clicking on a result - -#### fn standardOptions.withMappings - -```ts -withMappings(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMappingsMixin - -```ts -withMappingsMixin(value) -``` - -Convert input values into a display string - -#### fn standardOptions.withMax - -```ts -withMax(value) -``` - - - -#### fn standardOptions.withMin - -```ts -withMin(value) -``` - - - -#### fn standardOptions.withNoValue - -```ts -withNoValue(value) -``` - -Alternative to empty string - -#### fn standardOptions.withOverrides - -```ts -withOverrides(value) -``` - - - -#### fn standardOptions.withOverridesMixin - -```ts -withOverridesMixin(value) -``` - - - -#### fn standardOptions.withUnit - -```ts -withUnit(value) -``` - -Numeric Options - -#### obj standardOptions.color - - -##### fn standardOptions.color.withFixedColor - -```ts -withFixedColor(value) -``` - -Stores the fixed color value if mode is fixed - -##### fn standardOptions.color.withMode - -```ts -withMode(value) -``` - -The main color scheme mode - -##### fn standardOptions.color.withSeriesBy - -```ts -withSeriesBy(value) -``` - -TODO docs - -Accepted values for `value` are "min", "max", "last" - -#### obj standardOptions.thresholds - - -##### fn standardOptions.thresholds.withMode - -```ts -withMode(value) -``` - - - -Accepted values for `value` are "absolute", "percentage" - -##### fn standardOptions.thresholds.withSteps - -```ts -withSteps(value) -``` - -Must be sorted by 'value', first value is always -Infinity - -##### fn standardOptions.thresholds.withStepsMixin - -```ts -withStepsMixin(value) -``` - -Must be sorted by 'value', first value is always -Infinity diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/xyChart/link.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/xyChart/link.md deleted file mode 100644 index 1a1d7c4..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/xyChart/link.md +++ /dev/null @@ -1,109 +0,0 @@ -# link - - - -## Index - -* [`fn withAsDropdown(value=false)`](#fn-withasdropdown) -* [`fn withIcon(value)`](#fn-withicon) -* [`fn withIncludeVars(value=false)`](#fn-withincludevars) -* [`fn withKeepTime(value=false)`](#fn-withkeeptime) -* [`fn withTags(value)`](#fn-withtags) -* [`fn withTagsMixin(value)`](#fn-withtagsmixin) -* [`fn withTargetBlank(value=false)`](#fn-withtargetblank) -* [`fn withTitle(value)`](#fn-withtitle) -* [`fn withTooltip(value)`](#fn-withtooltip) -* [`fn withType(value)`](#fn-withtype) -* [`fn withUrl(value)`](#fn-withurl) - -## Fields - -### fn withAsDropdown - -```ts -withAsDropdown(value=false) -``` - - - -### fn withIcon - -```ts -withIcon(value) -``` - - - -### fn withIncludeVars - -```ts -withIncludeVars(value=false) -``` - - - -### fn withKeepTime - -```ts -withKeepTime(value=false) -``` - - - -### fn withTags - -```ts -withTags(value) -``` - - - -### fn withTagsMixin - -```ts -withTagsMixin(value) -``` - - - -### fn withTargetBlank - -```ts -withTargetBlank(value=false) -``` - - - -### fn withTitle - -```ts -withTitle(value) -``` - - - -### fn withTooltip - -```ts -withTooltip(value) -``` - - - -### fn withType - -```ts -withType(value) -``` - -TODO docs - -Accepted values for `value` are "link", "dashboards" - -### fn withUrl - -```ts -withUrl(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/xyChart/thresholdStep.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/xyChart/thresholdStep.md deleted file mode 100644 index 9d6af42..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/xyChart/thresholdStep.md +++ /dev/null @@ -1,47 +0,0 @@ -# thresholdStep - - - -## Index - -* [`fn withColor(value)`](#fn-withcolor) -* [`fn withIndex(value)`](#fn-withindex) -* [`fn withState(value)`](#fn-withstate) -* [`fn withValue(value)`](#fn-withvalue) - -## Fields - -### fn withColor - -```ts -withColor(value) -``` - -TODO docs - -### fn withIndex - -```ts -withIndex(value) -``` - -Threshold index, an old property that is not needed an should only appear in older dashboards - -### fn withState - -```ts -withState(value) -``` - -TODO docs -TODO are the values here enumerable into a disjunction? -Some seem to be listed in typescript comment - -### fn withValue - -```ts -withValue(value) -``` - -TODO docs -FIXME the corresponding typescript field is required/non-optional, but nulls currently appear here when serializing -Infinity to JSON diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/xyChart/transformation.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/xyChart/transformation.md deleted file mode 100644 index 3dac7e9..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/xyChart/transformation.md +++ /dev/null @@ -1,76 +0,0 @@ -# transformation - - - -## Index - -* [`fn withDisabled(value)`](#fn-withdisabled) -* [`fn withFilter(value)`](#fn-withfilter) -* [`fn withFilterMixin(value)`](#fn-withfiltermixin) -* [`fn withId(value)`](#fn-withid) -* [`fn withOptions(value)`](#fn-withoptions) -* [`obj filter`](#obj-filter) - * [`fn withId(value="")`](#fn-filterwithid) - * [`fn withOptions(value)`](#fn-filterwithoptions) - -## Fields - -### fn withDisabled - -```ts -withDisabled(value) -``` - -Disabled transformations are skipped - -### fn withFilter - -```ts -withFilter(value) -``` - - - -### fn withFilterMixin - -```ts -withFilterMixin(value) -``` - - - -### fn withId - -```ts -withId(value) -``` - -Unique identifier of transformer - -### fn withOptions - -```ts -withOptions(value) -``` - -Options to be passed to the transformer -Valid options depend on the transformer id - -### obj filter - - -#### fn filter.withId - -```ts -withId(value="") -``` - - - -#### fn filter.withOptions - -```ts -withOptions(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/xyChart/valueMapping.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/xyChart/valueMapping.md deleted file mode 100644 index a6bbdb3..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/panel/xyChart/valueMapping.md +++ /dev/null @@ -1,365 +0,0 @@ -# valueMapping - - - -## Index - -* [`obj RangeMap`](#obj-rangemap) - * [`fn withOptions(value)`](#fn-rangemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) - * [`fn withType(value)`](#fn-rangemapwithtype) - * [`obj options`](#obj-rangemapoptions) - * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) - * [`fn withResult(value)`](#fn-rangemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) - * [`fn withTo(value)`](#fn-rangemapoptionswithto) - * [`obj result`](#obj-rangemapoptionsresult) - * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) -* [`obj RegexMap`](#obj-regexmap) - * [`fn withOptions(value)`](#fn-regexmapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) - * [`fn withType(value)`](#fn-regexmapwithtype) - * [`obj options`](#obj-regexmapoptions) - * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) - * [`fn withResult(value)`](#fn-regexmapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) - * [`obj result`](#obj-regexmapoptionsresult) - * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) - * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) -* [`obj SpecialValueMap`](#obj-specialvaluemap) - * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) - * [`fn withType(value)`](#fn-specialvaluemapwithtype) - * [`obj options`](#obj-specialvaluemapoptions) - * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) - * [`fn withPattern(value)`](#fn-specialvaluemapoptionswithpattern) - * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) - * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) - * [`obj result`](#obj-specialvaluemapoptionsresult) - * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) - * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) - * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) - * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) -* [`obj ValueMap`](#obj-valuemap) - * [`fn withOptions(value)`](#fn-valuemapwithoptions) - * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) - * [`fn withType(value)`](#fn-valuemapwithtype) - -## Fields - -### obj RangeMap - - -#### fn RangeMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RangeMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RangeMap.withType - -```ts -withType(value) -``` - - - -#### obj RangeMap.options - - -##### fn RangeMap.options.withFrom - -```ts -withFrom(value) -``` - -to and from are `number | null` in current ts, really not sure what to do - -##### fn RangeMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RangeMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### fn RangeMap.options.withTo - -```ts -withTo(value) -``` - - - -##### obj RangeMap.options.result - - -###### fn RangeMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RangeMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RangeMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RangeMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj RegexMap - - -#### fn RegexMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn RegexMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn RegexMap.withType - -```ts -withType(value) -``` - - - -#### obj RegexMap.options - - -##### fn RegexMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn RegexMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn RegexMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj RegexMap.options.result - - -###### fn RegexMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn RegexMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn RegexMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn RegexMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj SpecialValueMap - - -#### fn SpecialValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn SpecialValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn SpecialValueMap.withType - -```ts -withType(value) -``` - - - -#### obj SpecialValueMap.options - - -##### fn SpecialValueMap.options.withMatch - -```ts -withMatch(value) -``` - - - -Accepted values for `value` are "true", "false" - -##### fn SpecialValueMap.options.withPattern - -```ts -withPattern(value) -``` - - - -##### fn SpecialValueMap.options.withResult - -```ts -withResult(value) -``` - -TODO docs - -##### fn SpecialValueMap.options.withResultMixin - -```ts -withResultMixin(value) -``` - -TODO docs - -##### obj SpecialValueMap.options.result - - -###### fn SpecialValueMap.options.result.withColor - -```ts -withColor(value) -``` - - - -###### fn SpecialValueMap.options.result.withIcon - -```ts -withIcon(value) -``` - - - -###### fn SpecialValueMap.options.result.withIndex - -```ts -withIndex(value) -``` - - - -###### fn SpecialValueMap.options.result.withText - -```ts -withText(value) -``` - - - -### obj ValueMap - - -#### fn ValueMap.withOptions - -```ts -withOptions(value) -``` - - - -#### fn ValueMap.withOptionsMixin - -```ts -withOptionsMixin(value) -``` - - - -#### fn ValueMap.withType - -```ts -withType(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/playlist.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/playlist.md deleted file mode 100644 index f4b3dba..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/playlist.md +++ /dev/null @@ -1,97 +0,0 @@ -# playlist - -grafonnet.playlist - -## Index - -* [`fn withInterval(value="5m")`](#fn-withinterval) -* [`fn withItems(value)`](#fn-withitems) -* [`fn withItemsMixin(value)`](#fn-withitemsmixin) -* [`fn withName(value)`](#fn-withname) -* [`fn withUid(value)`](#fn-withuid) -* [`obj items`](#obj-items) - * [`fn withTitle(value)`](#fn-itemswithtitle) - * [`fn withType(value)`](#fn-itemswithtype) - * [`fn withValue(value)`](#fn-itemswithvalue) - -## Fields - -### fn withInterval - -```ts -withInterval(value="5m") -``` - -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? - -### fn withItems - -```ts -withItems(value) -``` - -The ordered list of items that the playlist will iterate over. -FIXME! This should not be optional, but changing it makes the godegen awkward - -### fn withItemsMixin - -```ts -withItemsMixin(value) -``` - -The ordered list of items that the playlist will iterate over. -FIXME! This should not be optional, but changing it makes the godegen awkward - -### fn withName - -```ts -withName(value) -``` - -Name of the playlist. - -### fn withUid - -```ts -withUid(value) -``` - -Unique playlist identifier. Generated on creation, either by the -creator of the playlist of by the application. - -### obj items - - -#### fn items.withTitle - -```ts -withTitle(value) -``` - -Title is an unused property -- it will be removed in the future - -#### fn items.withType - -```ts -withType(value) -``` - -Type of the item. - -Accepted values for `value` are "dashboard_by_uid", "dashboard_by_id", "dashboard_by_tag" - -#### fn items.withValue - -```ts -withValue(value) -``` - -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 diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/preferences.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/preferences.md deleted file mode 100644 index b1f8ca7..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/preferences.md +++ /dev/null @@ -1,85 +0,0 @@ -# preferences - -grafonnet.preferences - -## Index - -* [`fn withHomeDashboardUID(value)`](#fn-withhomedashboarduid) -* [`fn withLanguage(value)`](#fn-withlanguage) -* [`fn withQueryHistory(value)`](#fn-withqueryhistory) -* [`fn withQueryHistoryMixin(value)`](#fn-withqueryhistorymixin) -* [`fn withTheme(value)`](#fn-withtheme) -* [`fn withTimezone(value)`](#fn-withtimezone) -* [`fn withWeekStart(value)`](#fn-withweekstart) -* [`obj queryHistory`](#obj-queryhistory) - * [`fn withHomeTab(value)`](#fn-queryhistorywithhometab) - -## Fields - -### fn withHomeDashboardUID - -```ts -withHomeDashboardUID(value) -``` - -UID for the home dashboard - -### fn withLanguage - -```ts -withLanguage(value) -``` - -Selected language (beta) - -### fn withQueryHistory - -```ts -withQueryHistory(value) -``` - - - -### fn withQueryHistoryMixin - -```ts -withQueryHistoryMixin(value) -``` - - - -### fn withTheme - -```ts -withTheme(value) -``` - -light, dark, empty is default - -### fn withTimezone - -```ts -withTimezone(value) -``` - -The timezone selection -TODO: this should use the timezone defined in common - -### fn withWeekStart - -```ts -withWeekStart(value) -``` - -day of the week (sunday, monday, etc) - -### obj queryHistory - - -#### fn queryHistory.withHomeTab - -```ts -withHomeTab(value) -``` - -one of: '' | 'query' | 'starred'; diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/publicdashboard.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/publicdashboard.md deleted file mode 100644 index 0fc2cde..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/publicdashboard.md +++ /dev/null @@ -1,62 +0,0 @@ -# publicdashboard - -grafonnet.publicdashboard - -## Index - -* [`fn withAccessToken(value)`](#fn-withaccesstoken) -* [`fn withAnnotationsEnabled(value)`](#fn-withannotationsenabled) -* [`fn withDashboardUid(value)`](#fn-withdashboarduid) -* [`fn withIsEnabled(value)`](#fn-withisenabled) -* [`fn withTimeSelectionEnabled(value)`](#fn-withtimeselectionenabled) -* [`fn withUid(value)`](#fn-withuid) - -## Fields - -### fn withAccessToken - -```ts -withAccessToken(value) -``` - -Unique public access token - -### fn withAnnotationsEnabled - -```ts -withAnnotationsEnabled(value) -``` - -Flag that indicates if annotations are enabled - -### fn withDashboardUid - -```ts -withDashboardUid(value) -``` - -Dashboard unique identifier referenced by this public dashboard - -### fn withIsEnabled - -```ts -withIsEnabled(value) -``` - -Flag that indicates if the public dashboard is enabled - -### fn withTimeSelectionEnabled - -```ts -withTimeSelectionEnabled(value) -``` - -Flag that indicates if the time range picker is enabled - -### fn withUid - -```ts -withUid(value) -``` - -Unique public dashboard identifier diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/azureMonitor.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/azureMonitor.md deleted file mode 100644 index fdac5da..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/azureMonitor.md +++ /dev/null @@ -1,1294 +0,0 @@ -# azureMonitor - -grafonnet.query.azureMonitor - -## Index - -* [`fn withAzureLogAnalytics(value)`](#fn-withazureloganalytics) -* [`fn withAzureLogAnalyticsMixin(value)`](#fn-withazureloganalyticsmixin) -* [`fn withAzureMonitor(value)`](#fn-withazuremonitor) -* [`fn withAzureMonitorMixin(value)`](#fn-withazuremonitormixin) -* [`fn withAzureResourceGraph(value)`](#fn-withazureresourcegraph) -* [`fn withAzureResourceGraphMixin(value)`](#fn-withazureresourcegraphmixin) -* [`fn withAzureTraces(value)`](#fn-withazuretraces) -* [`fn withAzureTracesMixin(value)`](#fn-withazuretracesmixin) -* [`fn withDatasource(value)`](#fn-withdatasource) -* [`fn withGrafanaTemplateVariableFn(value)`](#fn-withgrafanatemplatevariablefn) -* [`fn withGrafanaTemplateVariableFnMixin(value)`](#fn-withgrafanatemplatevariablefnmixin) -* [`fn withHide(value)`](#fn-withhide) -* [`fn withNamespace(value)`](#fn-withnamespace) -* [`fn withQueryType(value)`](#fn-withquerytype) -* [`fn withRefId(value)`](#fn-withrefid) -* [`fn withRegion(value)`](#fn-withregion) -* [`fn withResource(value)`](#fn-withresource) -* [`fn withResourceGroup(value)`](#fn-withresourcegroup) -* [`fn withSubscription(value)`](#fn-withsubscription) -* [`fn withSubscriptions(value)`](#fn-withsubscriptions) -* [`fn withSubscriptionsMixin(value)`](#fn-withsubscriptionsmixin) -* [`obj azureLogAnalytics`](#obj-azureloganalytics) - * [`fn withQuery(value)`](#fn-azureloganalyticswithquery) - * [`fn withResource(value)`](#fn-azureloganalyticswithresource) - * [`fn withResources(value)`](#fn-azureloganalyticswithresources) - * [`fn withResourcesMixin(value)`](#fn-azureloganalyticswithresourcesmixin) - * [`fn withResultFormat(value)`](#fn-azureloganalyticswithresultformat) - * [`fn withWorkspace(value)`](#fn-azureloganalyticswithworkspace) -* [`obj azureMonitor`](#obj-azuremonitor) - * [`fn withAggregation(value)`](#fn-azuremonitorwithaggregation) - * [`fn withAlias(value)`](#fn-azuremonitorwithalias) - * [`fn withAllowedTimeGrainsMs(value)`](#fn-azuremonitorwithallowedtimegrainsms) - * [`fn withAllowedTimeGrainsMsMixin(value)`](#fn-azuremonitorwithallowedtimegrainsmsmixin) - * [`fn withCustomNamespace(value)`](#fn-azuremonitorwithcustomnamespace) - * [`fn withDimension(value)`](#fn-azuremonitorwithdimension) - * [`fn withDimensionFilter(value)`](#fn-azuremonitorwithdimensionfilter) - * [`fn withDimensionFilters(value)`](#fn-azuremonitorwithdimensionfilters) - * [`fn withDimensionFiltersMixin(value)`](#fn-azuremonitorwithdimensionfiltersmixin) - * [`fn withMetricDefinition(value)`](#fn-azuremonitorwithmetricdefinition) - * [`fn withMetricName(value)`](#fn-azuremonitorwithmetricname) - * [`fn withMetricNamespace(value)`](#fn-azuremonitorwithmetricnamespace) - * [`fn withRegion(value)`](#fn-azuremonitorwithregion) - * [`fn withResourceGroup(value)`](#fn-azuremonitorwithresourcegroup) - * [`fn withResourceName(value)`](#fn-azuremonitorwithresourcename) - * [`fn withResourceUri(value)`](#fn-azuremonitorwithresourceuri) - * [`fn withResources(value)`](#fn-azuremonitorwithresources) - * [`fn withResourcesMixin(value)`](#fn-azuremonitorwithresourcesmixin) - * [`fn withTimeGrain(value)`](#fn-azuremonitorwithtimegrain) - * [`fn withTimeGrainUnit(value)`](#fn-azuremonitorwithtimegrainunit) - * [`fn withTop(value)`](#fn-azuremonitorwithtop) - * [`obj dimensionFilters`](#obj-azuremonitordimensionfilters) - * [`fn withDimension(value)`](#fn-azuremonitordimensionfilterswithdimension) - * [`fn withFilter(value)`](#fn-azuremonitordimensionfilterswithfilter) - * [`fn withFilters(value)`](#fn-azuremonitordimensionfilterswithfilters) - * [`fn withFiltersMixin(value)`](#fn-azuremonitordimensionfilterswithfiltersmixin) - * [`fn withOperator(value)`](#fn-azuremonitordimensionfilterswithoperator) - * [`obj resources`](#obj-azuremonitorresources) - * [`fn withMetricNamespace(value)`](#fn-azuremonitorresourceswithmetricnamespace) - * [`fn withRegion(value)`](#fn-azuremonitorresourceswithregion) - * [`fn withResourceGroup(value)`](#fn-azuremonitorresourceswithresourcegroup) - * [`fn withResourceName(value)`](#fn-azuremonitorresourceswithresourcename) - * [`fn withSubscription(value)`](#fn-azuremonitorresourceswithsubscription) -* [`obj azureResourceGraph`](#obj-azureresourcegraph) - * [`fn withQuery(value)`](#fn-azureresourcegraphwithquery) - * [`fn withResultFormat(value)`](#fn-azureresourcegraphwithresultformat) -* [`obj azureTraces`](#obj-azuretraces) - * [`fn withFilters(value)`](#fn-azuretraceswithfilters) - * [`fn withFiltersMixin(value)`](#fn-azuretraceswithfiltersmixin) - * [`fn withOperationId(value)`](#fn-azuretraceswithoperationid) - * [`fn withQuery(value)`](#fn-azuretraceswithquery) - * [`fn withResources(value)`](#fn-azuretraceswithresources) - * [`fn withResourcesMixin(value)`](#fn-azuretraceswithresourcesmixin) - * [`fn withResultFormat(value)`](#fn-azuretraceswithresultformat) - * [`fn withTraceTypes(value)`](#fn-azuretraceswithtracetypes) - * [`fn withTraceTypesMixin(value)`](#fn-azuretraceswithtracetypesmixin) - * [`obj filters`](#obj-azuretracesfilters) - * [`fn withFilters(value)`](#fn-azuretracesfilterswithfilters) - * [`fn withFiltersMixin(value)`](#fn-azuretracesfilterswithfiltersmixin) - * [`fn withOperation(value)`](#fn-azuretracesfilterswithoperation) - * [`fn withProperty(value)`](#fn-azuretracesfilterswithproperty) -* [`obj grafanaTemplateVariableFn`](#obj-grafanatemplatevariablefn) - * [`fn withAppInsightsGroupByQuery(value)`](#fn-grafanatemplatevariablefnwithappinsightsgroupbyquery) - * [`fn withAppInsightsGroupByQueryMixin(value)`](#fn-grafanatemplatevariablefnwithappinsightsgroupbyquerymixin) - * [`fn withAppInsightsMetricNameQuery(value)`](#fn-grafanatemplatevariablefnwithappinsightsmetricnamequery) - * [`fn withAppInsightsMetricNameQueryMixin(value)`](#fn-grafanatemplatevariablefnwithappinsightsmetricnamequerymixin) - * [`fn withMetricDefinitionsQuery(value)`](#fn-grafanatemplatevariablefnwithmetricdefinitionsquery) - * [`fn withMetricDefinitionsQueryMixin(value)`](#fn-grafanatemplatevariablefnwithmetricdefinitionsquerymixin) - * [`fn withMetricNamesQuery(value)`](#fn-grafanatemplatevariablefnwithmetricnamesquery) - * [`fn withMetricNamesQueryMixin(value)`](#fn-grafanatemplatevariablefnwithmetricnamesquerymixin) - * [`fn withMetricNamespaceQuery(value)`](#fn-grafanatemplatevariablefnwithmetricnamespacequery) - * [`fn withMetricNamespaceQueryMixin(value)`](#fn-grafanatemplatevariablefnwithmetricnamespacequerymixin) - * [`fn withResourceGroupsQuery(value)`](#fn-grafanatemplatevariablefnwithresourcegroupsquery) - * [`fn withResourceGroupsQueryMixin(value)`](#fn-grafanatemplatevariablefnwithresourcegroupsquerymixin) - * [`fn withResourceNamesQuery(value)`](#fn-grafanatemplatevariablefnwithresourcenamesquery) - * [`fn withResourceNamesQueryMixin(value)`](#fn-grafanatemplatevariablefnwithresourcenamesquerymixin) - * [`fn withSubscriptionsQuery(value)`](#fn-grafanatemplatevariablefnwithsubscriptionsquery) - * [`fn withSubscriptionsQueryMixin(value)`](#fn-grafanatemplatevariablefnwithsubscriptionsquerymixin) - * [`fn withUnknownQuery(value)`](#fn-grafanatemplatevariablefnwithunknownquery) - * [`fn withUnknownQueryMixin(value)`](#fn-grafanatemplatevariablefnwithunknownquerymixin) - * [`fn withWorkspacesQuery(value)`](#fn-grafanatemplatevariablefnwithworkspacesquery) - * [`fn withWorkspacesQueryMixin(value)`](#fn-grafanatemplatevariablefnwithworkspacesquerymixin) - * [`obj AppInsightsGroupByQuery`](#obj-grafanatemplatevariablefnappinsightsgroupbyquery) - * [`fn withKind(value)`](#fn-grafanatemplatevariablefnappinsightsgroupbyquerywithkind) - * [`fn withMetricName(value)`](#fn-grafanatemplatevariablefnappinsightsgroupbyquerywithmetricname) - * [`fn withRawQuery(value)`](#fn-grafanatemplatevariablefnappinsightsgroupbyquerywithrawquery) - * [`obj AppInsightsMetricNameQuery`](#obj-grafanatemplatevariablefnappinsightsmetricnamequery) - * [`fn withKind(value)`](#fn-grafanatemplatevariablefnappinsightsmetricnamequerywithkind) - * [`fn withRawQuery(value)`](#fn-grafanatemplatevariablefnappinsightsmetricnamequerywithrawquery) - * [`obj MetricDefinitionsQuery`](#obj-grafanatemplatevariablefnmetricdefinitionsquery) - * [`fn withKind(value)`](#fn-grafanatemplatevariablefnmetricdefinitionsquerywithkind) - * [`fn withMetricNamespace(value)`](#fn-grafanatemplatevariablefnmetricdefinitionsquerywithmetricnamespace) - * [`fn withRawQuery(value)`](#fn-grafanatemplatevariablefnmetricdefinitionsquerywithrawquery) - * [`fn withResourceGroup(value)`](#fn-grafanatemplatevariablefnmetricdefinitionsquerywithresourcegroup) - * [`fn withResourceName(value)`](#fn-grafanatemplatevariablefnmetricdefinitionsquerywithresourcename) - * [`fn withSubscription(value)`](#fn-grafanatemplatevariablefnmetricdefinitionsquerywithsubscription) - * [`obj MetricNamesQuery`](#obj-grafanatemplatevariablefnmetricnamesquery) - * [`fn withKind(value)`](#fn-grafanatemplatevariablefnmetricnamesquerywithkind) - * [`fn withMetricNamespace(value)`](#fn-grafanatemplatevariablefnmetricnamesquerywithmetricnamespace) - * [`fn withRawQuery(value)`](#fn-grafanatemplatevariablefnmetricnamesquerywithrawquery) - * [`fn withResourceGroup(value)`](#fn-grafanatemplatevariablefnmetricnamesquerywithresourcegroup) - * [`fn withResourceName(value)`](#fn-grafanatemplatevariablefnmetricnamesquerywithresourcename) - * [`fn withSubscription(value)`](#fn-grafanatemplatevariablefnmetricnamesquerywithsubscription) - * [`obj MetricNamespaceQuery`](#obj-grafanatemplatevariablefnmetricnamespacequery) - * [`fn withKind(value)`](#fn-grafanatemplatevariablefnmetricnamespacequerywithkind) - * [`fn withMetricNamespace(value)`](#fn-grafanatemplatevariablefnmetricnamespacequerywithmetricnamespace) - * [`fn withRawQuery(value)`](#fn-grafanatemplatevariablefnmetricnamespacequerywithrawquery) - * [`fn withResourceGroup(value)`](#fn-grafanatemplatevariablefnmetricnamespacequerywithresourcegroup) - * [`fn withResourceName(value)`](#fn-grafanatemplatevariablefnmetricnamespacequerywithresourcename) - * [`fn withSubscription(value)`](#fn-grafanatemplatevariablefnmetricnamespacequerywithsubscription) - * [`obj ResourceGroupsQuery`](#obj-grafanatemplatevariablefnresourcegroupsquery) - * [`fn withKind(value)`](#fn-grafanatemplatevariablefnresourcegroupsquerywithkind) - * [`fn withRawQuery(value)`](#fn-grafanatemplatevariablefnresourcegroupsquerywithrawquery) - * [`fn withSubscription(value)`](#fn-grafanatemplatevariablefnresourcegroupsquerywithsubscription) - * [`obj ResourceNamesQuery`](#obj-grafanatemplatevariablefnresourcenamesquery) - * [`fn withKind(value)`](#fn-grafanatemplatevariablefnresourcenamesquerywithkind) - * [`fn withMetricNamespace(value)`](#fn-grafanatemplatevariablefnresourcenamesquerywithmetricnamespace) - * [`fn withRawQuery(value)`](#fn-grafanatemplatevariablefnresourcenamesquerywithrawquery) - * [`fn withResourceGroup(value)`](#fn-grafanatemplatevariablefnresourcenamesquerywithresourcegroup) - * [`fn withSubscription(value)`](#fn-grafanatemplatevariablefnresourcenamesquerywithsubscription) - * [`obj SubscriptionsQuery`](#obj-grafanatemplatevariablefnsubscriptionsquery) - * [`fn withKind(value)`](#fn-grafanatemplatevariablefnsubscriptionsquerywithkind) - * [`fn withRawQuery(value)`](#fn-grafanatemplatevariablefnsubscriptionsquerywithrawquery) - * [`obj UnknownQuery`](#obj-grafanatemplatevariablefnunknownquery) - * [`fn withKind(value)`](#fn-grafanatemplatevariablefnunknownquerywithkind) - * [`fn withRawQuery(value)`](#fn-grafanatemplatevariablefnunknownquerywithrawquery) - * [`obj WorkspacesQuery`](#obj-grafanatemplatevariablefnworkspacesquery) - * [`fn withKind(value)`](#fn-grafanatemplatevariablefnworkspacesquerywithkind) - * [`fn withRawQuery(value)`](#fn-grafanatemplatevariablefnworkspacesquerywithrawquery) - * [`fn withSubscription(value)`](#fn-grafanatemplatevariablefnworkspacesquerywithsubscription) - -## Fields - -### fn withAzureLogAnalytics - -```ts -withAzureLogAnalytics(value) -``` - -Azure Monitor Logs sub-query properties - -### fn withAzureLogAnalyticsMixin - -```ts -withAzureLogAnalyticsMixin(value) -``` - -Azure Monitor Logs sub-query properties - -### fn withAzureMonitor - -```ts -withAzureMonitor(value) -``` - - - -### fn withAzureMonitorMixin - -```ts -withAzureMonitorMixin(value) -``` - - - -### fn withAzureResourceGraph - -```ts -withAzureResourceGraph(value) -``` - - - -### fn withAzureResourceGraphMixin - -```ts -withAzureResourceGraphMixin(value) -``` - - - -### fn withAzureTraces - -```ts -withAzureTraces(value) -``` - -Application Insights Traces sub-query properties - -### fn withAzureTracesMixin - -```ts -withAzureTracesMixin(value) -``` - -Application Insights Traces sub-query properties - -### fn withDatasource - -```ts -withDatasource(value) -``` - -For mixed data sources the selected datasource is on the query level. -For non mixed scenarios this is undefined. -TODO find a better way to do this ^ that's friendly to schema -TODO this shouldn't be unknown but DataSourceRef | null - -### fn withGrafanaTemplateVariableFn - -```ts -withGrafanaTemplateVariableFn(value) -``` - - - -### fn withGrafanaTemplateVariableFnMixin - -```ts -withGrafanaTemplateVariableFnMixin(value) -``` - - - -### fn withHide - -```ts -withHide(value) -``` - -true if query is disabled (ie should not be returned to the dashboard) -Note this does not always imply that the query should not be executed since -the results from a hidden query may be used as the input to other queries (SSE etc) - -### fn withNamespace - -```ts -withNamespace(value) -``` - - - -### fn withQueryType - -```ts -withQueryType(value) -``` - -Specify the query flavor -TODO make this required and give it a default - -### fn withRefId - -```ts -withRefId(value) -``` - -A unique identifier for the query within the list of targets. -In server side expressions, the refId is used as a variable name to identify results. -By default, the UI will assign A->Z; however setting meaningful names may be useful. - -### fn withRegion - -```ts -withRegion(value) -``` - -Azure Monitor query type. -queryType: #AzureQueryType - -### fn withResource - -```ts -withResource(value) -``` - - - -### fn withResourceGroup - -```ts -withResourceGroup(value) -``` - -Template variables params. These exist for backwards compatiblity with legacy template variables. - -### fn withSubscription - -```ts -withSubscription(value) -``` - -Azure subscription containing the resource(s) to be queried. - -### fn withSubscriptions - -```ts -withSubscriptions(value) -``` - -Subscriptions to be queried via Azure Resource Graph. - -### fn withSubscriptionsMixin - -```ts -withSubscriptionsMixin(value) -``` - -Subscriptions to be queried via Azure Resource Graph. - -### obj azureLogAnalytics - - -#### fn azureLogAnalytics.withQuery - -```ts -withQuery(value) -``` - -KQL query to be executed. - -#### fn azureLogAnalytics.withResource - -```ts -withResource(value) -``` - -@deprecated Use resources instead - -#### fn azureLogAnalytics.withResources - -```ts -withResources(value) -``` - -Array of resource URIs to be queried. - -#### fn azureLogAnalytics.withResourcesMixin - -```ts -withResourcesMixin(value) -``` - -Array of resource URIs to be queried. - -#### fn azureLogAnalytics.withResultFormat - -```ts -withResultFormat(value) -``` - - - -Accepted values for `value` are "table", "time_series", "trace" - -#### fn azureLogAnalytics.withWorkspace - -```ts -withWorkspace(value) -``` - -Workspace ID. This was removed in Grafana 8, but remains for backwards compat - -### obj azureMonitor - - -#### fn azureMonitor.withAggregation - -```ts -withAggregation(value) -``` - -The aggregation to be used within the query. Defaults to the primaryAggregationType defined by the metric. - -#### fn azureMonitor.withAlias - -```ts -withAlias(value) -``` - -Aliases can be set to modify the legend labels. e.g. {{ resourceGroup }}. See docs for more detail. - -#### fn azureMonitor.withAllowedTimeGrainsMs - -```ts -withAllowedTimeGrainsMs(value) -``` - -Time grains that are supported by the metric. - -#### fn azureMonitor.withAllowedTimeGrainsMsMixin - -```ts -withAllowedTimeGrainsMsMixin(value) -``` - -Time grains that are supported by the metric. - -#### fn azureMonitor.withCustomNamespace - -```ts -withCustomNamespace(value) -``` - -Used as the value for the metricNamespace property when it's different from the resource namespace. - -#### fn azureMonitor.withDimension - -```ts -withDimension(value) -``` - -@deprecated This property was migrated to dimensionFilters and should only be accessed in the migration - -#### fn azureMonitor.withDimensionFilter - -```ts -withDimensionFilter(value) -``` - -@deprecated This property was migrated to dimensionFilters and should only be accessed in the migration - -#### fn azureMonitor.withDimensionFilters - -```ts -withDimensionFilters(value) -``` - -Filters to reduce the set of data returned. Dimensions that can be filtered on are defined by the metric. - -#### fn azureMonitor.withDimensionFiltersMixin - -```ts -withDimensionFiltersMixin(value) -``` - -Filters to reduce the set of data returned. Dimensions that can be filtered on are defined by the metric. - -#### fn azureMonitor.withMetricDefinition - -```ts -withMetricDefinition(value) -``` - -@deprecated Use metricNamespace instead - -#### fn azureMonitor.withMetricName - -```ts -withMetricName(value) -``` - -The metric to query data for within the specified metricNamespace. e.g. UsedCapacity - -#### fn azureMonitor.withMetricNamespace - -```ts -withMetricNamespace(value) -``` - -metricNamespace is used as the resource type (or resource namespace). -It's usually equal to the target metric namespace. e.g. microsoft.storage/storageaccounts -Kept the name of the variable as metricNamespace to avoid backward incompatibility issues. - -#### fn azureMonitor.withRegion - -```ts -withRegion(value) -``` - -The Azure region containing the resource(s). - -#### fn azureMonitor.withResourceGroup - -```ts -withResourceGroup(value) -``` - -@deprecated Use resources instead - -#### fn azureMonitor.withResourceName - -```ts -withResourceName(value) -``` - -@deprecated Use resources instead - -#### fn azureMonitor.withResourceUri - -```ts -withResourceUri(value) -``` - -@deprecated Use resourceGroup, resourceName and metricNamespace instead - -#### fn azureMonitor.withResources - -```ts -withResources(value) -``` - -Array of resource URIs to be queried. - -#### fn azureMonitor.withResourcesMixin - -```ts -withResourcesMixin(value) -``` - -Array of resource URIs to be queried. - -#### fn azureMonitor.withTimeGrain - -```ts -withTimeGrain(value) -``` - -The granularity of data points to be queried. Defaults to auto. - -#### fn azureMonitor.withTimeGrainUnit - -```ts -withTimeGrainUnit(value) -``` - -@deprecated - -#### fn azureMonitor.withTop - -```ts -withTop(value) -``` - -Maximum number of records to return. Defaults to 10. - -#### obj azureMonitor.dimensionFilters - - -##### fn azureMonitor.dimensionFilters.withDimension - -```ts -withDimension(value) -``` - -Name of Dimension to be filtered on. - -##### fn azureMonitor.dimensionFilters.withFilter - -```ts -withFilter(value) -``` - -@deprecated filter is deprecated in favour of filters to support multiselect. - -##### fn azureMonitor.dimensionFilters.withFilters - -```ts -withFilters(value) -``` - -Values to match with the filter. - -##### fn azureMonitor.dimensionFilters.withFiltersMixin - -```ts -withFiltersMixin(value) -``` - -Values to match with the filter. - -##### fn azureMonitor.dimensionFilters.withOperator - -```ts -withOperator(value) -``` - -String denoting the filter operation. Supports 'eq' - equals,'ne' - not equals, 'sw' - starts with. Note that some dimensions may not support all operators. - -#### obj azureMonitor.resources - - -##### fn azureMonitor.resources.withMetricNamespace - -```ts -withMetricNamespace(value) -``` - - - -##### fn azureMonitor.resources.withRegion - -```ts -withRegion(value) -``` - - - -##### fn azureMonitor.resources.withResourceGroup - -```ts -withResourceGroup(value) -``` - - - -##### fn azureMonitor.resources.withResourceName - -```ts -withResourceName(value) -``` - - - -##### fn azureMonitor.resources.withSubscription - -```ts -withSubscription(value) -``` - - - -### obj azureResourceGraph - - -#### fn azureResourceGraph.withQuery - -```ts -withQuery(value) -``` - -Azure Resource Graph KQL query to be executed. - -#### fn azureResourceGraph.withResultFormat - -```ts -withResultFormat(value) -``` - -Specifies the format results should be returned as. Defaults to table. - -### obj azureTraces - - -#### fn azureTraces.withFilters - -```ts -withFilters(value) -``` - -Filters for property values. - -#### fn azureTraces.withFiltersMixin - -```ts -withFiltersMixin(value) -``` - -Filters for property values. - -#### fn azureTraces.withOperationId - -```ts -withOperationId(value) -``` - -Operation ID. Used only for Traces queries. - -#### fn azureTraces.withQuery - -```ts -withQuery(value) -``` - -KQL query to be executed. - -#### fn azureTraces.withResources - -```ts -withResources(value) -``` - -Array of resource URIs to be queried. - -#### fn azureTraces.withResourcesMixin - -```ts -withResourcesMixin(value) -``` - -Array of resource URIs to be queried. - -#### fn azureTraces.withResultFormat - -```ts -withResultFormat(value) -``` - - - -Accepted values for `value` are "table", "time_series", "trace" - -#### fn azureTraces.withTraceTypes - -```ts -withTraceTypes(value) -``` - -Types of events to filter by. - -#### fn azureTraces.withTraceTypesMixin - -```ts -withTraceTypesMixin(value) -``` - -Types of events to filter by. - -#### obj azureTraces.filters - - -##### fn azureTraces.filters.withFilters - -```ts -withFilters(value) -``` - -Values to filter by. - -##### fn azureTraces.filters.withFiltersMixin - -```ts -withFiltersMixin(value) -``` - -Values to filter by. - -##### fn azureTraces.filters.withOperation - -```ts -withOperation(value) -``` - -Comparison operator to use. Either equals or not equals. - -##### fn azureTraces.filters.withProperty - -```ts -withProperty(value) -``` - -Property name, auto-populated based on available traces. - -### obj grafanaTemplateVariableFn - - -#### fn grafanaTemplateVariableFn.withAppInsightsGroupByQuery - -```ts -withAppInsightsGroupByQuery(value) -``` - - - -#### fn grafanaTemplateVariableFn.withAppInsightsGroupByQueryMixin - -```ts -withAppInsightsGroupByQueryMixin(value) -``` - - - -#### fn grafanaTemplateVariableFn.withAppInsightsMetricNameQuery - -```ts -withAppInsightsMetricNameQuery(value) -``` - - - -#### fn grafanaTemplateVariableFn.withAppInsightsMetricNameQueryMixin - -```ts -withAppInsightsMetricNameQueryMixin(value) -``` - - - -#### fn grafanaTemplateVariableFn.withMetricDefinitionsQuery - -```ts -withMetricDefinitionsQuery(value) -``` - -@deprecated Use MetricNamespaceQuery instead - -#### fn grafanaTemplateVariableFn.withMetricDefinitionsQueryMixin - -```ts -withMetricDefinitionsQueryMixin(value) -``` - -@deprecated Use MetricNamespaceQuery instead - -#### fn grafanaTemplateVariableFn.withMetricNamesQuery - -```ts -withMetricNamesQuery(value) -``` - - - -#### fn grafanaTemplateVariableFn.withMetricNamesQueryMixin - -```ts -withMetricNamesQueryMixin(value) -``` - - - -#### fn grafanaTemplateVariableFn.withMetricNamespaceQuery - -```ts -withMetricNamespaceQuery(value) -``` - - - -#### fn grafanaTemplateVariableFn.withMetricNamespaceQueryMixin - -```ts -withMetricNamespaceQueryMixin(value) -``` - - - -#### fn grafanaTemplateVariableFn.withResourceGroupsQuery - -```ts -withResourceGroupsQuery(value) -``` - - - -#### fn grafanaTemplateVariableFn.withResourceGroupsQueryMixin - -```ts -withResourceGroupsQueryMixin(value) -``` - - - -#### fn grafanaTemplateVariableFn.withResourceNamesQuery - -```ts -withResourceNamesQuery(value) -``` - - - -#### fn grafanaTemplateVariableFn.withResourceNamesQueryMixin - -```ts -withResourceNamesQueryMixin(value) -``` - - - -#### fn grafanaTemplateVariableFn.withSubscriptionsQuery - -```ts -withSubscriptionsQuery(value) -``` - - - -#### fn grafanaTemplateVariableFn.withSubscriptionsQueryMixin - -```ts -withSubscriptionsQueryMixin(value) -``` - - - -#### fn grafanaTemplateVariableFn.withUnknownQuery - -```ts -withUnknownQuery(value) -``` - - - -#### fn grafanaTemplateVariableFn.withUnknownQueryMixin - -```ts -withUnknownQueryMixin(value) -``` - - - -#### fn grafanaTemplateVariableFn.withWorkspacesQuery - -```ts -withWorkspacesQuery(value) -``` - - - -#### fn grafanaTemplateVariableFn.withWorkspacesQueryMixin - -```ts -withWorkspacesQueryMixin(value) -``` - - - -#### obj grafanaTemplateVariableFn.AppInsightsGroupByQuery - - -##### fn grafanaTemplateVariableFn.AppInsightsGroupByQuery.withKind - -```ts -withKind(value) -``` - - - -Accepted values for `value` are "AppInsightsGroupByQuery" - -##### fn grafanaTemplateVariableFn.AppInsightsGroupByQuery.withMetricName - -```ts -withMetricName(value) -``` - - - -##### fn grafanaTemplateVariableFn.AppInsightsGroupByQuery.withRawQuery - -```ts -withRawQuery(value) -``` - - - -#### obj grafanaTemplateVariableFn.AppInsightsMetricNameQuery - - -##### fn grafanaTemplateVariableFn.AppInsightsMetricNameQuery.withKind - -```ts -withKind(value) -``` - - - -Accepted values for `value` are "AppInsightsMetricNameQuery" - -##### fn grafanaTemplateVariableFn.AppInsightsMetricNameQuery.withRawQuery - -```ts -withRawQuery(value) -``` - - - -#### obj grafanaTemplateVariableFn.MetricDefinitionsQuery - - -##### fn grafanaTemplateVariableFn.MetricDefinitionsQuery.withKind - -```ts -withKind(value) -``` - - - -Accepted values for `value` are "MetricDefinitionsQuery" - -##### fn grafanaTemplateVariableFn.MetricDefinitionsQuery.withMetricNamespace - -```ts -withMetricNamespace(value) -``` - - - -##### fn grafanaTemplateVariableFn.MetricDefinitionsQuery.withRawQuery - -```ts -withRawQuery(value) -``` - - - -##### fn grafanaTemplateVariableFn.MetricDefinitionsQuery.withResourceGroup - -```ts -withResourceGroup(value) -``` - - - -##### fn grafanaTemplateVariableFn.MetricDefinitionsQuery.withResourceName - -```ts -withResourceName(value) -``` - - - -##### fn grafanaTemplateVariableFn.MetricDefinitionsQuery.withSubscription - -```ts -withSubscription(value) -``` - - - -#### obj grafanaTemplateVariableFn.MetricNamesQuery - - -##### fn grafanaTemplateVariableFn.MetricNamesQuery.withKind - -```ts -withKind(value) -``` - - - -Accepted values for `value` are "MetricNamesQuery" - -##### fn grafanaTemplateVariableFn.MetricNamesQuery.withMetricNamespace - -```ts -withMetricNamespace(value) -``` - - - -##### fn grafanaTemplateVariableFn.MetricNamesQuery.withRawQuery - -```ts -withRawQuery(value) -``` - - - -##### fn grafanaTemplateVariableFn.MetricNamesQuery.withResourceGroup - -```ts -withResourceGroup(value) -``` - - - -##### fn grafanaTemplateVariableFn.MetricNamesQuery.withResourceName - -```ts -withResourceName(value) -``` - - - -##### fn grafanaTemplateVariableFn.MetricNamesQuery.withSubscription - -```ts -withSubscription(value) -``` - - - -#### obj grafanaTemplateVariableFn.MetricNamespaceQuery - - -##### fn grafanaTemplateVariableFn.MetricNamespaceQuery.withKind - -```ts -withKind(value) -``` - - - -Accepted values for `value` are "MetricNamespaceQuery" - -##### fn grafanaTemplateVariableFn.MetricNamespaceQuery.withMetricNamespace - -```ts -withMetricNamespace(value) -``` - - - -##### fn grafanaTemplateVariableFn.MetricNamespaceQuery.withRawQuery - -```ts -withRawQuery(value) -``` - - - -##### fn grafanaTemplateVariableFn.MetricNamespaceQuery.withResourceGroup - -```ts -withResourceGroup(value) -``` - - - -##### fn grafanaTemplateVariableFn.MetricNamespaceQuery.withResourceName - -```ts -withResourceName(value) -``` - - - -##### fn grafanaTemplateVariableFn.MetricNamespaceQuery.withSubscription - -```ts -withSubscription(value) -``` - - - -#### obj grafanaTemplateVariableFn.ResourceGroupsQuery - - -##### fn grafanaTemplateVariableFn.ResourceGroupsQuery.withKind - -```ts -withKind(value) -``` - - - -Accepted values for `value` are "ResourceGroupsQuery" - -##### fn grafanaTemplateVariableFn.ResourceGroupsQuery.withRawQuery - -```ts -withRawQuery(value) -``` - - - -##### fn grafanaTemplateVariableFn.ResourceGroupsQuery.withSubscription - -```ts -withSubscription(value) -``` - - - -#### obj grafanaTemplateVariableFn.ResourceNamesQuery - - -##### fn grafanaTemplateVariableFn.ResourceNamesQuery.withKind - -```ts -withKind(value) -``` - - - -Accepted values for `value` are "ResourceNamesQuery" - -##### fn grafanaTemplateVariableFn.ResourceNamesQuery.withMetricNamespace - -```ts -withMetricNamespace(value) -``` - - - -##### fn grafanaTemplateVariableFn.ResourceNamesQuery.withRawQuery - -```ts -withRawQuery(value) -``` - - - -##### fn grafanaTemplateVariableFn.ResourceNamesQuery.withResourceGroup - -```ts -withResourceGroup(value) -``` - - - -##### fn grafanaTemplateVariableFn.ResourceNamesQuery.withSubscription - -```ts -withSubscription(value) -``` - - - -#### obj grafanaTemplateVariableFn.SubscriptionsQuery - - -##### fn grafanaTemplateVariableFn.SubscriptionsQuery.withKind - -```ts -withKind(value) -``` - - - -Accepted values for `value` are "SubscriptionsQuery" - -##### fn grafanaTemplateVariableFn.SubscriptionsQuery.withRawQuery - -```ts -withRawQuery(value) -``` - - - -#### obj grafanaTemplateVariableFn.UnknownQuery - - -##### fn grafanaTemplateVariableFn.UnknownQuery.withKind - -```ts -withKind(value) -``` - - - -Accepted values for `value` are "UnknownQuery" - -##### fn grafanaTemplateVariableFn.UnknownQuery.withRawQuery - -```ts -withRawQuery(value) -``` - - - -#### obj grafanaTemplateVariableFn.WorkspacesQuery - - -##### fn grafanaTemplateVariableFn.WorkspacesQuery.withKind - -```ts -withKind(value) -``` - - - -Accepted values for `value` are "WorkspacesQuery" - -##### fn grafanaTemplateVariableFn.WorkspacesQuery.withRawQuery - -```ts -withRawQuery(value) -``` - - - -##### fn grafanaTemplateVariableFn.WorkspacesQuery.withSubscription - -```ts -withSubscription(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/cloudWatch.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/cloudWatch.md deleted file mode 100644 index 340899f..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/cloudWatch.md +++ /dev/null @@ -1,1082 +0,0 @@ -# cloudWatch - -grafonnet.query.cloudWatch - -## Index - -* [`obj CloudWatchAnnotationQuery`](#obj-cloudwatchannotationquery) - * [`fn withAccountId(value)`](#fn-cloudwatchannotationquerywithaccountid) - * [`fn withActionPrefix(value)`](#fn-cloudwatchannotationquerywithactionprefix) - * [`fn withAlarmNamePrefix(value)`](#fn-cloudwatchannotationquerywithalarmnameprefix) - * [`fn withDatasource(value)`](#fn-cloudwatchannotationquerywithdatasource) - * [`fn withDimensions(value)`](#fn-cloudwatchannotationquerywithdimensions) - * [`fn withDimensionsMixin(value)`](#fn-cloudwatchannotationquerywithdimensionsmixin) - * [`fn withHide(value)`](#fn-cloudwatchannotationquerywithhide) - * [`fn withMatchExact(value)`](#fn-cloudwatchannotationquerywithmatchexact) - * [`fn withMetricName(value)`](#fn-cloudwatchannotationquerywithmetricname) - * [`fn withNamespace(value)`](#fn-cloudwatchannotationquerywithnamespace) - * [`fn withPeriod(value)`](#fn-cloudwatchannotationquerywithperiod) - * [`fn withPrefixMatching(value)`](#fn-cloudwatchannotationquerywithprefixmatching) - * [`fn withQueryMode(value)`](#fn-cloudwatchannotationquerywithquerymode) - * [`fn withQueryType(value)`](#fn-cloudwatchannotationquerywithquerytype) - * [`fn withRefId(value)`](#fn-cloudwatchannotationquerywithrefid) - * [`fn withRegion(value)`](#fn-cloudwatchannotationquerywithregion) - * [`fn withStatistic(value)`](#fn-cloudwatchannotationquerywithstatistic) - * [`fn withStatistics(value)`](#fn-cloudwatchannotationquerywithstatistics) - * [`fn withStatisticsMixin(value)`](#fn-cloudwatchannotationquerywithstatisticsmixin) -* [`obj CloudWatchLogsQuery`](#obj-cloudwatchlogsquery) - * [`fn withDatasource(value)`](#fn-cloudwatchlogsquerywithdatasource) - * [`fn withExpression(value)`](#fn-cloudwatchlogsquerywithexpression) - * [`fn withHide(value)`](#fn-cloudwatchlogsquerywithhide) - * [`fn withId(value)`](#fn-cloudwatchlogsquerywithid) - * [`fn withLogGroupNames(value)`](#fn-cloudwatchlogsquerywithloggroupnames) - * [`fn withLogGroupNamesMixin(value)`](#fn-cloudwatchlogsquerywithloggroupnamesmixin) - * [`fn withLogGroups(value)`](#fn-cloudwatchlogsquerywithloggroups) - * [`fn withLogGroupsMixin(value)`](#fn-cloudwatchlogsquerywithloggroupsmixin) - * [`fn withQueryMode(value)`](#fn-cloudwatchlogsquerywithquerymode) - * [`fn withQueryType(value)`](#fn-cloudwatchlogsquerywithquerytype) - * [`fn withRefId(value)`](#fn-cloudwatchlogsquerywithrefid) - * [`fn withRegion(value)`](#fn-cloudwatchlogsquerywithregion) - * [`fn withStatsGroups(value)`](#fn-cloudwatchlogsquerywithstatsgroups) - * [`fn withStatsGroupsMixin(value)`](#fn-cloudwatchlogsquerywithstatsgroupsmixin) - * [`obj logGroups`](#obj-cloudwatchlogsqueryloggroups) - * [`fn withAccountId(value)`](#fn-cloudwatchlogsqueryloggroupswithaccountid) - * [`fn withAccountLabel(value)`](#fn-cloudwatchlogsqueryloggroupswithaccountlabel) - * [`fn withArn(value)`](#fn-cloudwatchlogsqueryloggroupswitharn) - * [`fn withName(value)`](#fn-cloudwatchlogsqueryloggroupswithname) -* [`obj CloudWatchMetricsQuery`](#obj-cloudwatchmetricsquery) - * [`fn withAccountId(value)`](#fn-cloudwatchmetricsquerywithaccountid) - * [`fn withAlias(value)`](#fn-cloudwatchmetricsquerywithalias) - * [`fn withDatasource(value)`](#fn-cloudwatchmetricsquerywithdatasource) - * [`fn withDimensions(value)`](#fn-cloudwatchmetricsquerywithdimensions) - * [`fn withDimensionsMixin(value)`](#fn-cloudwatchmetricsquerywithdimensionsmixin) - * [`fn withExpression(value)`](#fn-cloudwatchmetricsquerywithexpression) - * [`fn withHide(value)`](#fn-cloudwatchmetricsquerywithhide) - * [`fn withId(value)`](#fn-cloudwatchmetricsquerywithid) - * [`fn withLabel(value)`](#fn-cloudwatchmetricsquerywithlabel) - * [`fn withMatchExact(value)`](#fn-cloudwatchmetricsquerywithmatchexact) - * [`fn withMetricEditorMode(value)`](#fn-cloudwatchmetricsquerywithmetriceditormode) - * [`fn withMetricName(value)`](#fn-cloudwatchmetricsquerywithmetricname) - * [`fn withMetricQueryType(value)`](#fn-cloudwatchmetricsquerywithmetricquerytype) - * [`fn withNamespace(value)`](#fn-cloudwatchmetricsquerywithnamespace) - * [`fn withPeriod(value)`](#fn-cloudwatchmetricsquerywithperiod) - * [`fn withQueryMode(value)`](#fn-cloudwatchmetricsquerywithquerymode) - * [`fn withQueryType(value)`](#fn-cloudwatchmetricsquerywithquerytype) - * [`fn withRefId(value)`](#fn-cloudwatchmetricsquerywithrefid) - * [`fn withRegion(value)`](#fn-cloudwatchmetricsquerywithregion) - * [`fn withSql(value)`](#fn-cloudwatchmetricsquerywithsql) - * [`fn withSqlExpression(value)`](#fn-cloudwatchmetricsquerywithsqlexpression) - * [`fn withSqlMixin(value)`](#fn-cloudwatchmetricsquerywithsqlmixin) - * [`fn withStatistic(value)`](#fn-cloudwatchmetricsquerywithstatistic) - * [`fn withStatistics(value)`](#fn-cloudwatchmetricsquerywithstatistics) - * [`fn withStatisticsMixin(value)`](#fn-cloudwatchmetricsquerywithstatisticsmixin) - * [`obj sql`](#obj-cloudwatchmetricsquerysql) - * [`fn withFrom(value)`](#fn-cloudwatchmetricsquerysqlwithfrom) - * [`fn withFromMixin(value)`](#fn-cloudwatchmetricsquerysqlwithfrommixin) - * [`fn withGroupBy(value)`](#fn-cloudwatchmetricsquerysqlwithgroupby) - * [`fn withGroupByMixin(value)`](#fn-cloudwatchmetricsquerysqlwithgroupbymixin) - * [`fn withLimit(value)`](#fn-cloudwatchmetricsquerysqlwithlimit) - * [`fn withOrderBy(value)`](#fn-cloudwatchmetricsquerysqlwithorderby) - * [`fn withOrderByDirection(value)`](#fn-cloudwatchmetricsquerysqlwithorderbydirection) - * [`fn withOrderByMixin(value)`](#fn-cloudwatchmetricsquerysqlwithorderbymixin) - * [`fn withSelect(value)`](#fn-cloudwatchmetricsquerysqlwithselect) - * [`fn withSelectMixin(value)`](#fn-cloudwatchmetricsquerysqlwithselectmixin) - * [`fn withWhere(value)`](#fn-cloudwatchmetricsquerysqlwithwhere) - * [`fn withWhereMixin(value)`](#fn-cloudwatchmetricsquerysqlwithwheremixin) - * [`obj from`](#obj-cloudwatchmetricsquerysqlfrom) - * [`fn withQueryEditorFunctionExpression(value)`](#fn-cloudwatchmetricsquerysqlfromwithqueryeditorfunctionexpression) - * [`fn withQueryEditorFunctionExpressionMixin(value)`](#fn-cloudwatchmetricsquerysqlfromwithqueryeditorfunctionexpressionmixin) - * [`fn withQueryEditorPropertyExpression(value)`](#fn-cloudwatchmetricsquerysqlfromwithqueryeditorpropertyexpression) - * [`fn withQueryEditorPropertyExpressionMixin(value)`](#fn-cloudwatchmetricsquerysqlfromwithqueryeditorpropertyexpressionmixin) - * [`obj QueryEditorFunctionExpression`](#obj-cloudwatchmetricsquerysqlfromqueryeditorfunctionexpression) - * [`fn withName(value)`](#fn-cloudwatchmetricsquerysqlfromqueryeditorfunctionexpressionwithname) - * [`fn withParameters(value)`](#fn-cloudwatchmetricsquerysqlfromqueryeditorfunctionexpressionwithparameters) - * [`fn withParametersMixin(value)`](#fn-cloudwatchmetricsquerysqlfromqueryeditorfunctionexpressionwithparametersmixin) - * [`fn withType(value)`](#fn-cloudwatchmetricsquerysqlfromqueryeditorfunctionexpressionwithtype) - * [`obj parameters`](#obj-cloudwatchmetricsquerysqlfromqueryeditorfunctionexpressionparameters) - * [`fn withName(value)`](#fn-cloudwatchmetricsquerysqlfromqueryeditorfunctionexpressionparameterswithname) - * [`fn withType(value)`](#fn-cloudwatchmetricsquerysqlfromqueryeditorfunctionexpressionparameterswithtype) - * [`obj QueryEditorPropertyExpression`](#obj-cloudwatchmetricsquerysqlfromqueryeditorpropertyexpression) - * [`fn withProperty(value)`](#fn-cloudwatchmetricsquerysqlfromqueryeditorpropertyexpressionwithproperty) - * [`fn withPropertyMixin(value)`](#fn-cloudwatchmetricsquerysqlfromqueryeditorpropertyexpressionwithpropertymixin) - * [`fn withType(value)`](#fn-cloudwatchmetricsquerysqlfromqueryeditorpropertyexpressionwithtype) - * [`obj property`](#obj-cloudwatchmetricsquerysqlfromqueryeditorpropertyexpressionproperty) - * [`fn withName(value)`](#fn-cloudwatchmetricsquerysqlfromqueryeditorpropertyexpressionpropertywithname) - * [`fn withType(value)`](#fn-cloudwatchmetricsquerysqlfromqueryeditorpropertyexpressionpropertywithtype) - * [`obj groupBy`](#obj-cloudwatchmetricsquerysqlgroupby) - * [`fn withExpressions(value)`](#fn-cloudwatchmetricsquerysqlgroupbywithexpressions) - * [`fn withExpressionsMixin(value)`](#fn-cloudwatchmetricsquerysqlgroupbywithexpressionsmixin) - * [`fn withType(value)`](#fn-cloudwatchmetricsquerysqlgroupbywithtype) - * [`obj orderBy`](#obj-cloudwatchmetricsquerysqlorderby) - * [`fn withName(value)`](#fn-cloudwatchmetricsquerysqlorderbywithname) - * [`fn withParameters(value)`](#fn-cloudwatchmetricsquerysqlorderbywithparameters) - * [`fn withParametersMixin(value)`](#fn-cloudwatchmetricsquerysqlorderbywithparametersmixin) - * [`fn withType(value)`](#fn-cloudwatchmetricsquerysqlorderbywithtype) - * [`obj parameters`](#obj-cloudwatchmetricsquerysqlorderbyparameters) - * [`fn withName(value)`](#fn-cloudwatchmetricsquerysqlorderbyparameterswithname) - * [`fn withType(value)`](#fn-cloudwatchmetricsquerysqlorderbyparameterswithtype) - * [`obj select`](#obj-cloudwatchmetricsquerysqlselect) - * [`fn withName(value)`](#fn-cloudwatchmetricsquerysqlselectwithname) - * [`fn withParameters(value)`](#fn-cloudwatchmetricsquerysqlselectwithparameters) - * [`fn withParametersMixin(value)`](#fn-cloudwatchmetricsquerysqlselectwithparametersmixin) - * [`fn withType(value)`](#fn-cloudwatchmetricsquerysqlselectwithtype) - * [`obj parameters`](#obj-cloudwatchmetricsquerysqlselectparameters) - * [`fn withName(value)`](#fn-cloudwatchmetricsquerysqlselectparameterswithname) - * [`fn withType(value)`](#fn-cloudwatchmetricsquerysqlselectparameterswithtype) - * [`obj where`](#obj-cloudwatchmetricsquerysqlwhere) - * [`fn withExpressions(value)`](#fn-cloudwatchmetricsquerysqlwherewithexpressions) - * [`fn withExpressionsMixin(value)`](#fn-cloudwatchmetricsquerysqlwherewithexpressionsmixin) - * [`fn withType(value)`](#fn-cloudwatchmetricsquerysqlwherewithtype) - -## Fields - -### obj CloudWatchAnnotationQuery - - -#### fn CloudWatchAnnotationQuery.withAccountId - -```ts -withAccountId(value) -``` - -The ID of the AWS account to query for the metric, specifying `all` will query all accounts that the monitoring account is permitted to query. - -#### fn CloudWatchAnnotationQuery.withActionPrefix - -```ts -withActionPrefix(value) -``` - -Use this parameter to filter the results of the operation to only those alarms -that use a certain alarm action. For example, you could specify the ARN of -an SNS topic to find all alarms that send notifications to that topic. -e.g. `arn:aws:sns:us-east-1:123456789012:my-app-` would match `arn:aws:sns:us-east-1:123456789012:my-app-action` -but not match `arn:aws:sns:us-east-1:123456789012:your-app-action` - -#### fn CloudWatchAnnotationQuery.withAlarmNamePrefix - -```ts -withAlarmNamePrefix(value) -``` - -An alarm name prefix. If you specify this parameter, you receive information -about all alarms that have names that start with this prefix. -e.g. `my-team-service-` would match `my-team-service-high-cpu` but not match `your-team-service-high-cpu` - -#### fn CloudWatchAnnotationQuery.withDatasource - -```ts -withDatasource(value) -``` - -For mixed data sources the selected datasource is on the query level. -For non mixed scenarios this is undefined. -TODO find a better way to do this ^ that's friendly to schema -TODO this shouldn't be unknown but DataSourceRef | null - -#### fn CloudWatchAnnotationQuery.withDimensions - -```ts -withDimensions(value) -``` - -A name/value pair that is part of the identity of a metric. For example, you can get statistics for a specific EC2 instance by specifying the InstanceId dimension when you search for metrics. - -#### fn CloudWatchAnnotationQuery.withDimensionsMixin - -```ts -withDimensionsMixin(value) -``` - -A name/value pair that is part of the identity of a metric. For example, you can get statistics for a specific EC2 instance by specifying the InstanceId dimension when you search for metrics. - -#### fn CloudWatchAnnotationQuery.withHide - -```ts -withHide(value) -``` - -true if query is disabled (ie should not be returned to the dashboard) -Note this does not always imply that the query should not be executed since -the results from a hidden query may be used as the input to other queries (SSE etc) - -#### fn CloudWatchAnnotationQuery.withMatchExact - -```ts -withMatchExact(value) -``` - -Only show metrics that exactly match all defined dimension names. - -#### fn CloudWatchAnnotationQuery.withMetricName - -```ts -withMetricName(value) -``` - -Name of the metric - -#### fn CloudWatchAnnotationQuery.withNamespace - -```ts -withNamespace(value) -``` - -A namespace is a container for CloudWatch metrics. Metrics in different namespaces are isolated from each other, so that metrics from different applications are not mistakenly aggregated into the same statistics. For example, Amazon EC2 uses the AWS/EC2 namespace. - -#### fn CloudWatchAnnotationQuery.withPeriod - -```ts -withPeriod(value) -``` - -The length of time associated with a specific Amazon CloudWatch statistic. Can be specified by a number of seconds, 'auto', or as a duration string e.g. '15m' being 15 minutes - -#### fn CloudWatchAnnotationQuery.withPrefixMatching - -```ts -withPrefixMatching(value) -``` - -Enable matching on the prefix of the action name or alarm name, specify the prefixes with actionPrefix and/or alarmNamePrefix - -#### fn CloudWatchAnnotationQuery.withQueryMode - -```ts -withQueryMode(value) -``` - - - -Accepted values for `value` are "Metrics", "Logs", "Annotations" - -#### fn CloudWatchAnnotationQuery.withQueryType - -```ts -withQueryType(value) -``` - -Specify the query flavor -TODO make this required and give it a default - -#### fn CloudWatchAnnotationQuery.withRefId - -```ts -withRefId(value) -``` - -A unique identifier for the query within the list of targets. -In server side expressions, the refId is used as a variable name to identify results. -By default, the UI will assign A->Z; however setting meaningful names may be useful. - -#### fn CloudWatchAnnotationQuery.withRegion - -```ts -withRegion(value) -``` - -AWS region to query for the metric - -#### fn CloudWatchAnnotationQuery.withStatistic - -```ts -withStatistic(value) -``` - -Metric data aggregations over specified periods of time. For detailed definitions of the statistics supported by CloudWatch, see https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html. - -#### fn CloudWatchAnnotationQuery.withStatistics - -```ts -withStatistics(value) -``` - -@deprecated use statistic - -#### fn CloudWatchAnnotationQuery.withStatisticsMixin - -```ts -withStatisticsMixin(value) -``` - -@deprecated use statistic - -### obj CloudWatchLogsQuery - - -#### fn CloudWatchLogsQuery.withDatasource - -```ts -withDatasource(value) -``` - -For mixed data sources the selected datasource is on the query level. -For non mixed scenarios this is undefined. -TODO find a better way to do this ^ that's friendly to schema -TODO this shouldn't be unknown but DataSourceRef | null - -#### fn CloudWatchLogsQuery.withExpression - -```ts -withExpression(value) -``` - -The CloudWatch Logs Insights query to execute - -#### fn CloudWatchLogsQuery.withHide - -```ts -withHide(value) -``` - -true if query is disabled (ie should not be returned to the dashboard) -Note this does not always imply that the query should not be executed since -the results from a hidden query may be used as the input to other queries (SSE etc) - -#### fn CloudWatchLogsQuery.withId - -```ts -withId(value) -``` - - - -#### fn CloudWatchLogsQuery.withLogGroupNames - -```ts -withLogGroupNames(value) -``` - -@deprecated use logGroups - -#### fn CloudWatchLogsQuery.withLogGroupNamesMixin - -```ts -withLogGroupNamesMixin(value) -``` - -@deprecated use logGroups - -#### fn CloudWatchLogsQuery.withLogGroups - -```ts -withLogGroups(value) -``` - -Log groups to query - -#### fn CloudWatchLogsQuery.withLogGroupsMixin - -```ts -withLogGroupsMixin(value) -``` - -Log groups to query - -#### fn CloudWatchLogsQuery.withQueryMode - -```ts -withQueryMode(value) -``` - - - -Accepted values for `value` are "Metrics", "Logs", "Annotations" - -#### fn CloudWatchLogsQuery.withQueryType - -```ts -withQueryType(value) -``` - -Specify the query flavor -TODO make this required and give it a default - -#### fn CloudWatchLogsQuery.withRefId - -```ts -withRefId(value) -``` - -A unique identifier for the query within the list of targets. -In server side expressions, the refId is used as a variable name to identify results. -By default, the UI will assign A->Z; however setting meaningful names may be useful. - -#### fn CloudWatchLogsQuery.withRegion - -```ts -withRegion(value) -``` - -AWS region to query for the logs - -#### fn CloudWatchLogsQuery.withStatsGroups - -```ts -withStatsGroups(value) -``` - -Fields to group the results by, this field is automatically populated whenever the query is updated - -#### fn CloudWatchLogsQuery.withStatsGroupsMixin - -```ts -withStatsGroupsMixin(value) -``` - -Fields to group the results by, this field is automatically populated whenever the query is updated - -#### obj CloudWatchLogsQuery.logGroups - - -##### fn CloudWatchLogsQuery.logGroups.withAccountId - -```ts -withAccountId(value) -``` - -AccountId of the log group - -##### fn CloudWatchLogsQuery.logGroups.withAccountLabel - -```ts -withAccountLabel(value) -``` - -Label of the log group - -##### fn CloudWatchLogsQuery.logGroups.withArn - -```ts -withArn(value) -``` - -ARN of the log group - -##### fn CloudWatchLogsQuery.logGroups.withName - -```ts -withName(value) -``` - -Name of the log group - -### obj CloudWatchMetricsQuery - - -#### fn CloudWatchMetricsQuery.withAccountId - -```ts -withAccountId(value) -``` - -The ID of the AWS account to query for the metric, specifying `all` will query all accounts that the monitoring account is permitted to query. - -#### fn CloudWatchMetricsQuery.withAlias - -```ts -withAlias(value) -``` - -Deprecated: use label -@deprecated use label - -#### fn CloudWatchMetricsQuery.withDatasource - -```ts -withDatasource(value) -``` - -For mixed data sources the selected datasource is on the query level. -For non mixed scenarios this is undefined. -TODO find a better way to do this ^ that's friendly to schema -TODO this shouldn't be unknown but DataSourceRef | null - -#### fn CloudWatchMetricsQuery.withDimensions - -```ts -withDimensions(value) -``` - -A name/value pair that is part of the identity of a metric. For example, you can get statistics for a specific EC2 instance by specifying the InstanceId dimension when you search for metrics. - -#### fn CloudWatchMetricsQuery.withDimensionsMixin - -```ts -withDimensionsMixin(value) -``` - -A name/value pair that is part of the identity of a metric. For example, you can get statistics for a specific EC2 instance by specifying the InstanceId dimension when you search for metrics. - -#### fn CloudWatchMetricsQuery.withExpression - -```ts -withExpression(value) -``` - -Math expression query - -#### fn CloudWatchMetricsQuery.withHide - -```ts -withHide(value) -``` - -true if query is disabled (ie should not be returned to the dashboard) -Note this does not always imply that the query should not be executed since -the results from a hidden query may be used as the input to other queries (SSE etc) - -#### fn CloudWatchMetricsQuery.withId - -```ts -withId(value) -``` - -ID can be used to reference other queries in math expressions. The ID can include numbers, letters, and underscore, and must start with a lowercase letter. - -#### fn CloudWatchMetricsQuery.withLabel - -```ts -withLabel(value) -``` - -Change the time series legend names using dynamic labels. See https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html for more details. - -#### fn CloudWatchMetricsQuery.withMatchExact - -```ts -withMatchExact(value) -``` - -Only show metrics that exactly match all defined dimension names. - -#### fn CloudWatchMetricsQuery.withMetricEditorMode - -```ts -withMetricEditorMode(value) -``` - - - -Accepted values for `value` are 0, 1 - -#### fn CloudWatchMetricsQuery.withMetricName - -```ts -withMetricName(value) -``` - -Name of the metric - -#### fn CloudWatchMetricsQuery.withMetricQueryType - -```ts -withMetricQueryType(value) -``` - - - -Accepted values for `value` are 0, 1 - -#### fn CloudWatchMetricsQuery.withNamespace - -```ts -withNamespace(value) -``` - -A namespace is a container for CloudWatch metrics. Metrics in different namespaces are isolated from each other, so that metrics from different applications are not mistakenly aggregated into the same statistics. For example, Amazon EC2 uses the AWS/EC2 namespace. - -#### fn CloudWatchMetricsQuery.withPeriod - -```ts -withPeriod(value) -``` - -The length of time associated with a specific Amazon CloudWatch statistic. Can be specified by a number of seconds, 'auto', or as a duration string e.g. '15m' being 15 minutes - -#### fn CloudWatchMetricsQuery.withQueryMode - -```ts -withQueryMode(value) -``` - - - -Accepted values for `value` are "Metrics", "Logs", "Annotations" - -#### fn CloudWatchMetricsQuery.withQueryType - -```ts -withQueryType(value) -``` - -Specify the query flavor -TODO make this required and give it a default - -#### fn CloudWatchMetricsQuery.withRefId - -```ts -withRefId(value) -``` - -A unique identifier for the query within the list of targets. -In server side expressions, the refId is used as a variable name to identify results. -By default, the UI will assign A->Z; however setting meaningful names may be useful. - -#### fn CloudWatchMetricsQuery.withRegion - -```ts -withRegion(value) -``` - -AWS region to query for the metric - -#### fn CloudWatchMetricsQuery.withSql - -```ts -withSql(value) -``` - - - -#### fn CloudWatchMetricsQuery.withSqlExpression - -```ts -withSqlExpression(value) -``` - -When the metric query type is `metricQueryType` is set to `Query`, this field is used to specify the query string. - -#### fn CloudWatchMetricsQuery.withSqlMixin - -```ts -withSqlMixin(value) -``` - - - -#### fn CloudWatchMetricsQuery.withStatistic - -```ts -withStatistic(value) -``` - -Metric data aggregations over specified periods of time. For detailed definitions of the statistics supported by CloudWatch, see https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html. - -#### fn CloudWatchMetricsQuery.withStatistics - -```ts -withStatistics(value) -``` - -@deprecated use statistic - -#### fn CloudWatchMetricsQuery.withStatisticsMixin - -```ts -withStatisticsMixin(value) -``` - -@deprecated use statistic - -#### obj CloudWatchMetricsQuery.sql - - -##### fn CloudWatchMetricsQuery.sql.withFrom - -```ts -withFrom(value) -``` - -FROM part of the SQL expression - -##### fn CloudWatchMetricsQuery.sql.withFromMixin - -```ts -withFromMixin(value) -``` - -FROM part of the SQL expression - -##### fn CloudWatchMetricsQuery.sql.withGroupBy - -```ts -withGroupBy(value) -``` - - - -##### fn CloudWatchMetricsQuery.sql.withGroupByMixin - -```ts -withGroupByMixin(value) -``` - - - -##### fn CloudWatchMetricsQuery.sql.withLimit - -```ts -withLimit(value) -``` - -LIMIT part of the SQL expression - -##### fn CloudWatchMetricsQuery.sql.withOrderBy - -```ts -withOrderBy(value) -``` - - - -##### fn CloudWatchMetricsQuery.sql.withOrderByDirection - -```ts -withOrderByDirection(value) -``` - -The sort order of the SQL expression, `ASC` or `DESC` - -##### fn CloudWatchMetricsQuery.sql.withOrderByMixin - -```ts -withOrderByMixin(value) -``` - - - -##### fn CloudWatchMetricsQuery.sql.withSelect - -```ts -withSelect(value) -``` - - - -##### fn CloudWatchMetricsQuery.sql.withSelectMixin - -```ts -withSelectMixin(value) -``` - - - -##### fn CloudWatchMetricsQuery.sql.withWhere - -```ts -withWhere(value) -``` - - - -##### fn CloudWatchMetricsQuery.sql.withWhereMixin - -```ts -withWhereMixin(value) -``` - - - -##### obj CloudWatchMetricsQuery.sql.from - - -###### fn CloudWatchMetricsQuery.sql.from.withQueryEditorFunctionExpression - -```ts -withQueryEditorFunctionExpression(value) -``` - - - -###### fn CloudWatchMetricsQuery.sql.from.withQueryEditorFunctionExpressionMixin - -```ts -withQueryEditorFunctionExpressionMixin(value) -``` - - - -###### fn CloudWatchMetricsQuery.sql.from.withQueryEditorPropertyExpression - -```ts -withQueryEditorPropertyExpression(value) -``` - - - -###### fn CloudWatchMetricsQuery.sql.from.withQueryEditorPropertyExpressionMixin - -```ts -withQueryEditorPropertyExpressionMixin(value) -``` - - - -###### obj CloudWatchMetricsQuery.sql.from.QueryEditorFunctionExpression - - -####### fn CloudWatchMetricsQuery.sql.from.QueryEditorFunctionExpression.withName - -```ts -withName(value) -``` - - - -####### fn CloudWatchMetricsQuery.sql.from.QueryEditorFunctionExpression.withParameters - -```ts -withParameters(value) -``` - - - -####### fn CloudWatchMetricsQuery.sql.from.QueryEditorFunctionExpression.withParametersMixin - -```ts -withParametersMixin(value) -``` - - - -####### fn CloudWatchMetricsQuery.sql.from.QueryEditorFunctionExpression.withType - -```ts -withType(value) -``` - - - -####### obj CloudWatchMetricsQuery.sql.from.QueryEditorFunctionExpression.parameters - - -######## fn CloudWatchMetricsQuery.sql.from.QueryEditorFunctionExpression.parameters.withName - -```ts -withName(value) -``` - - - -######## fn CloudWatchMetricsQuery.sql.from.QueryEditorFunctionExpression.parameters.withType - -```ts -withType(value) -``` - - - -###### obj CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression - - -####### fn CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression.withProperty - -```ts -withProperty(value) -``` - - - -####### fn CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression.withPropertyMixin - -```ts -withPropertyMixin(value) -``` - - - -####### fn CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression.withType - -```ts -withType(value) -``` - - - -####### obj CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression.property - - -######## fn CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression.property.withName - -```ts -withName(value) -``` - - - -######## fn CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression.property.withType - -```ts -withType(value) -``` - - - -Accepted values for `value` are "string" - -##### obj CloudWatchMetricsQuery.sql.groupBy - - -###### fn CloudWatchMetricsQuery.sql.groupBy.withExpressions - -```ts -withExpressions(value) -``` - - - -###### fn CloudWatchMetricsQuery.sql.groupBy.withExpressionsMixin - -```ts -withExpressionsMixin(value) -``` - - - -###### fn CloudWatchMetricsQuery.sql.groupBy.withType - -```ts -withType(value) -``` - - - -Accepted values for `value` are "and", "or" - -##### obj CloudWatchMetricsQuery.sql.orderBy - - -###### fn CloudWatchMetricsQuery.sql.orderBy.withName - -```ts -withName(value) -``` - - - -###### fn CloudWatchMetricsQuery.sql.orderBy.withParameters - -```ts -withParameters(value) -``` - - - -###### fn CloudWatchMetricsQuery.sql.orderBy.withParametersMixin - -```ts -withParametersMixin(value) -``` - - - -###### fn CloudWatchMetricsQuery.sql.orderBy.withType - -```ts -withType(value) -``` - - - -###### obj CloudWatchMetricsQuery.sql.orderBy.parameters - - -####### fn CloudWatchMetricsQuery.sql.orderBy.parameters.withName - -```ts -withName(value) -``` - - - -####### fn CloudWatchMetricsQuery.sql.orderBy.parameters.withType - -```ts -withType(value) -``` - - - -##### obj CloudWatchMetricsQuery.sql.select - - -###### fn CloudWatchMetricsQuery.sql.select.withName - -```ts -withName(value) -``` - - - -###### fn CloudWatchMetricsQuery.sql.select.withParameters - -```ts -withParameters(value) -``` - - - -###### fn CloudWatchMetricsQuery.sql.select.withParametersMixin - -```ts -withParametersMixin(value) -``` - - - -###### fn CloudWatchMetricsQuery.sql.select.withType - -```ts -withType(value) -``` - - - -###### obj CloudWatchMetricsQuery.sql.select.parameters - - -####### fn CloudWatchMetricsQuery.sql.select.parameters.withName - -```ts -withName(value) -``` - - - -####### fn CloudWatchMetricsQuery.sql.select.parameters.withType - -```ts -withType(value) -``` - - - -##### obj CloudWatchMetricsQuery.sql.where - - -###### fn CloudWatchMetricsQuery.sql.where.withExpressions - -```ts -withExpressions(value) -``` - - - -###### fn CloudWatchMetricsQuery.sql.where.withExpressionsMixin - -```ts -withExpressionsMixin(value) -``` - - - -###### fn CloudWatchMetricsQuery.sql.where.withType - -```ts -withType(value) -``` - - - -Accepted values for `value` are "and", "or" diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/elasticsearch.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/elasticsearch.md deleted file mode 100644 index e801793..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/elasticsearch.md +++ /dev/null @@ -1,2620 +0,0 @@ -# elasticsearch - -grafonnet.query.elasticsearch - -## Index - -* [`fn withAlias(value)`](#fn-withalias) -* [`fn withBucketAggs(value)`](#fn-withbucketaggs) -* [`fn withBucketAggsMixin(value)`](#fn-withbucketaggsmixin) -* [`fn withDatasource(value)`](#fn-withdatasource) -* [`fn withHide(value)`](#fn-withhide) -* [`fn withMetrics(value)`](#fn-withmetrics) -* [`fn withMetricsMixin(value)`](#fn-withmetricsmixin) -* [`fn withQuery(value)`](#fn-withquery) -* [`fn withQueryType(value)`](#fn-withquerytype) -* [`fn withRefId(value)`](#fn-withrefid) -* [`fn withTimeField(value)`](#fn-withtimefield) -* [`obj bucketAggs`](#obj-bucketaggs) - * [`obj DateHistogram`](#obj-bucketaggsdatehistogram) - * [`fn withField(value)`](#fn-bucketaggsdatehistogramwithfield) - * [`fn withId(value)`](#fn-bucketaggsdatehistogramwithid) - * [`fn withSettings(value)`](#fn-bucketaggsdatehistogramwithsettings) - * [`fn withSettingsMixin(value)`](#fn-bucketaggsdatehistogramwithsettingsmixin) - * [`fn withType(value)`](#fn-bucketaggsdatehistogramwithtype) - * [`obj settings`](#obj-bucketaggsdatehistogramsettings) - * [`fn withInterval(value)`](#fn-bucketaggsdatehistogramsettingswithinterval) - * [`fn withMinDocCount(value)`](#fn-bucketaggsdatehistogramsettingswithmindoccount) - * [`fn withOffset(value)`](#fn-bucketaggsdatehistogramsettingswithoffset) - * [`fn withTimeZone(value)`](#fn-bucketaggsdatehistogramsettingswithtimezone) - * [`fn withTrimEdges(value)`](#fn-bucketaggsdatehistogramsettingswithtrimedges) - * [`obj Filters`](#obj-bucketaggsfilters) - * [`fn withId(value)`](#fn-bucketaggsfilterswithid) - * [`fn withSettings(value)`](#fn-bucketaggsfilterswithsettings) - * [`fn withSettingsMixin(value)`](#fn-bucketaggsfilterswithsettingsmixin) - * [`fn withType(value)`](#fn-bucketaggsfilterswithtype) - * [`obj settings`](#obj-bucketaggsfilterssettings) - * [`fn withFilters(value)`](#fn-bucketaggsfilterssettingswithfilters) - * [`fn withFiltersMixin(value)`](#fn-bucketaggsfilterssettingswithfiltersmixin) - * [`obj filters`](#obj-bucketaggsfilterssettingsfilters) - * [`fn withLabel(value)`](#fn-bucketaggsfilterssettingsfilterswithlabel) - * [`fn withQuery(value)`](#fn-bucketaggsfilterssettingsfilterswithquery) - * [`obj GeoHashGrid`](#obj-bucketaggsgeohashgrid) - * [`fn withField(value)`](#fn-bucketaggsgeohashgridwithfield) - * [`fn withId(value)`](#fn-bucketaggsgeohashgridwithid) - * [`fn withSettings(value)`](#fn-bucketaggsgeohashgridwithsettings) - * [`fn withSettingsMixin(value)`](#fn-bucketaggsgeohashgridwithsettingsmixin) - * [`fn withType(value)`](#fn-bucketaggsgeohashgridwithtype) - * [`obj settings`](#obj-bucketaggsgeohashgridsettings) - * [`fn withPrecision(value)`](#fn-bucketaggsgeohashgridsettingswithprecision) - * [`obj Histogram`](#obj-bucketaggshistogram) - * [`fn withField(value)`](#fn-bucketaggshistogramwithfield) - * [`fn withId(value)`](#fn-bucketaggshistogramwithid) - * [`fn withSettings(value)`](#fn-bucketaggshistogramwithsettings) - * [`fn withSettingsMixin(value)`](#fn-bucketaggshistogramwithsettingsmixin) - * [`fn withType(value)`](#fn-bucketaggshistogramwithtype) - * [`obj settings`](#obj-bucketaggshistogramsettings) - * [`fn withInterval(value)`](#fn-bucketaggshistogramsettingswithinterval) - * [`fn withMinDocCount(value)`](#fn-bucketaggshistogramsettingswithmindoccount) - * [`obj Nested`](#obj-bucketaggsnested) - * [`fn withField(value)`](#fn-bucketaggsnestedwithfield) - * [`fn withId(value)`](#fn-bucketaggsnestedwithid) - * [`fn withSettings(value)`](#fn-bucketaggsnestedwithsettings) - * [`fn withSettingsMixin(value)`](#fn-bucketaggsnestedwithsettingsmixin) - * [`fn withType(value)`](#fn-bucketaggsnestedwithtype) - * [`obj Terms`](#obj-bucketaggsterms) - * [`fn withField(value)`](#fn-bucketaggstermswithfield) - * [`fn withId(value)`](#fn-bucketaggstermswithid) - * [`fn withSettings(value)`](#fn-bucketaggstermswithsettings) - * [`fn withSettingsMixin(value)`](#fn-bucketaggstermswithsettingsmixin) - * [`fn withType(value)`](#fn-bucketaggstermswithtype) - * [`obj settings`](#obj-bucketaggstermssettings) - * [`fn withMinDocCount(value)`](#fn-bucketaggstermssettingswithmindoccount) - * [`fn withMissing(value)`](#fn-bucketaggstermssettingswithmissing) - * [`fn withOrder(value)`](#fn-bucketaggstermssettingswithorder) - * [`fn withOrderBy(value)`](#fn-bucketaggstermssettingswithorderby) - * [`fn withSize(value)`](#fn-bucketaggstermssettingswithsize) -* [`obj metrics`](#obj-metrics) - * [`obj Count`](#obj-metricscount) - * [`fn withHide(value)`](#fn-metricscountwithhide) - * [`fn withId(value)`](#fn-metricscountwithid) - * [`fn withType(value)`](#fn-metricscountwithtype) - * [`obj MetricAggregationWithSettings`](#obj-metricsmetricaggregationwithsettings) - * [`obj Average`](#obj-metricsmetricaggregationwithsettingsaverage) - * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingsaveragewithfield) - * [`fn withHide(value)`](#fn-metricsmetricaggregationwithsettingsaveragewithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsaveragewithid) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsaveragewithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsaveragewithsettingsmixin) - * [`fn withType(value)`](#fn-metricsmetricaggregationwithsettingsaveragewithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingsaveragesettings) - * [`fn withMissing(value)`](#fn-metricsmetricaggregationwithsettingsaveragesettingswithmissing) - * [`fn withScript(value)`](#fn-metricsmetricaggregationwithsettingsaveragesettingswithscript) - * [`fn withScriptMixin(value)`](#fn-metricsmetricaggregationwithsettingsaveragesettingswithscriptmixin) - * [`obj script`](#obj-metricsmetricaggregationwithsettingsaveragesettingsscript) - * [`fn withInline(value)`](#fn-metricsmetricaggregationwithsettingsaveragesettingsscriptwithinline) - * [`obj BucketScript`](#obj-metricsmetricaggregationwithsettingsbucketscript) - * [`fn withHide(value)`](#fn-metricsmetricaggregationwithsettingsbucketscriptwithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsbucketscriptwithid) - * [`fn withPipelineVariables(value)`](#fn-metricsmetricaggregationwithsettingsbucketscriptwithpipelinevariables) - * [`fn withPipelineVariablesMixin(value)`](#fn-metricsmetricaggregationwithsettingsbucketscriptwithpipelinevariablesmixin) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsbucketscriptwithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsbucketscriptwithsettingsmixin) - * [`fn withType(value)`](#fn-metricsmetricaggregationwithsettingsbucketscriptwithtype) - * [`obj pipelineVariables`](#obj-metricsmetricaggregationwithsettingsbucketscriptpipelinevariables) - * [`fn withName(value)`](#fn-metricsmetricaggregationwithsettingsbucketscriptpipelinevariableswithname) - * [`fn withPipelineAgg(value)`](#fn-metricsmetricaggregationwithsettingsbucketscriptpipelinevariableswithpipelineagg) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingsbucketscriptsettings) - * [`fn withScript(value)`](#fn-metricsmetricaggregationwithsettingsbucketscriptsettingswithscript) - * [`fn withScriptMixin(value)`](#fn-metricsmetricaggregationwithsettingsbucketscriptsettingswithscriptmixin) - * [`obj script`](#obj-metricsmetricaggregationwithsettingsbucketscriptsettingsscript) - * [`fn withInline(value)`](#fn-metricsmetricaggregationwithsettingsbucketscriptsettingsscriptwithinline) - * [`obj CumulativeSum`](#obj-metricsmetricaggregationwithsettingscumulativesum) - * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingscumulativesumwithfield) - * [`fn withHide(value)`](#fn-metricsmetricaggregationwithsettingscumulativesumwithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingscumulativesumwithid) - * [`fn withPipelineAgg(value)`](#fn-metricsmetricaggregationwithsettingscumulativesumwithpipelineagg) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingscumulativesumwithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingscumulativesumwithsettingsmixin) - * [`fn withType(value)`](#fn-metricsmetricaggregationwithsettingscumulativesumwithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingscumulativesumsettings) - * [`fn withFormat(value)`](#fn-metricsmetricaggregationwithsettingscumulativesumsettingswithformat) - * [`obj Derivative`](#obj-metricsmetricaggregationwithsettingsderivative) - * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingsderivativewithfield) - * [`fn withHide(value)`](#fn-metricsmetricaggregationwithsettingsderivativewithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsderivativewithid) - * [`fn withPipelineAgg(value)`](#fn-metricsmetricaggregationwithsettingsderivativewithpipelineagg) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsderivativewithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsderivativewithsettingsmixin) - * [`fn withType(value)`](#fn-metricsmetricaggregationwithsettingsderivativewithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingsderivativesettings) - * [`fn withUnit(value)`](#fn-metricsmetricaggregationwithsettingsderivativesettingswithunit) - * [`obj ExtendedStats`](#obj-metricsmetricaggregationwithsettingsextendedstats) - * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatswithfield) - * [`fn withHide(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatswithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatswithid) - * [`fn withMeta(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatswithmeta) - * [`fn withMetaMixin(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatswithmetamixin) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatswithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatswithsettingsmixin) - * [`fn withType(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatswithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingsextendedstatssettings) - * [`fn withMissing(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatssettingswithmissing) - * [`fn withScript(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatssettingswithscript) - * [`fn withScriptMixin(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatssettingswithscriptmixin) - * [`fn withSigma(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatssettingswithsigma) - * [`obj script`](#obj-metricsmetricaggregationwithsettingsextendedstatssettingsscript) - * [`fn withInline(value)`](#fn-metricsmetricaggregationwithsettingsextendedstatssettingsscriptwithinline) - * [`obj Logs`](#obj-metricsmetricaggregationwithsettingslogs) - * [`fn withHide(value)`](#fn-metricsmetricaggregationwithsettingslogswithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingslogswithid) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingslogswithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingslogswithsettingsmixin) - * [`fn withType(value)`](#fn-metricsmetricaggregationwithsettingslogswithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingslogssettings) - * [`fn withLimit(value)`](#fn-metricsmetricaggregationwithsettingslogssettingswithlimit) - * [`obj Max`](#obj-metricsmetricaggregationwithsettingsmax) - * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingsmaxwithfield) - * [`fn withHide(value)`](#fn-metricsmetricaggregationwithsettingsmaxwithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsmaxwithid) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsmaxwithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsmaxwithsettingsmixin) - * [`fn withType(value)`](#fn-metricsmetricaggregationwithsettingsmaxwithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingsmaxsettings) - * [`fn withMissing(value)`](#fn-metricsmetricaggregationwithsettingsmaxsettingswithmissing) - * [`fn withScript(value)`](#fn-metricsmetricaggregationwithsettingsmaxsettingswithscript) - * [`fn withScriptMixin(value)`](#fn-metricsmetricaggregationwithsettingsmaxsettingswithscriptmixin) - * [`obj script`](#obj-metricsmetricaggregationwithsettingsmaxsettingsscript) - * [`fn withInline(value)`](#fn-metricsmetricaggregationwithsettingsmaxsettingsscriptwithinline) - * [`obj Min`](#obj-metricsmetricaggregationwithsettingsmin) - * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingsminwithfield) - * [`fn withHide(value)`](#fn-metricsmetricaggregationwithsettingsminwithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsminwithid) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsminwithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsminwithsettingsmixin) - * [`fn withType(value)`](#fn-metricsmetricaggregationwithsettingsminwithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingsminsettings) - * [`fn withMissing(value)`](#fn-metricsmetricaggregationwithsettingsminsettingswithmissing) - * [`fn withScript(value)`](#fn-metricsmetricaggregationwithsettingsminsettingswithscript) - * [`fn withScriptMixin(value)`](#fn-metricsmetricaggregationwithsettingsminsettingswithscriptmixin) - * [`obj script`](#obj-metricsmetricaggregationwithsettingsminsettingsscript) - * [`fn withInline(value)`](#fn-metricsmetricaggregationwithsettingsminsettingsscriptwithinline) - * [`obj MovingAverage`](#obj-metricsmetricaggregationwithsettingsmovingaverage) - * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingsmovingaveragewithfield) - * [`fn withHide(value)`](#fn-metricsmetricaggregationwithsettingsmovingaveragewithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsmovingaveragewithid) - * [`fn withPipelineAgg(value)`](#fn-metricsmetricaggregationwithsettingsmovingaveragewithpipelineagg) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsmovingaveragewithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsmovingaveragewithsettingsmixin) - * [`fn withType(value)`](#fn-metricsmetricaggregationwithsettingsmovingaveragewithtype) - * [`obj MovingFunction`](#obj-metricsmetricaggregationwithsettingsmovingfunction) - * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionwithfield) - * [`fn withHide(value)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionwithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionwithid) - * [`fn withPipelineAgg(value)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionwithpipelineagg) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionwithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionwithsettingsmixin) - * [`fn withType(value)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionwithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingsmovingfunctionsettings) - * [`fn withScript(value)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionsettingswithscript) - * [`fn withScriptMixin(value)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionsettingswithscriptmixin) - * [`fn withShift(value)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionsettingswithshift) - * [`fn withWindow(value)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionsettingswithwindow) - * [`obj script`](#obj-metricsmetricaggregationwithsettingsmovingfunctionsettingsscript) - * [`fn withInline(value)`](#fn-metricsmetricaggregationwithsettingsmovingfunctionsettingsscriptwithinline) - * [`obj Percentiles`](#obj-metricsmetricaggregationwithsettingspercentiles) - * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingspercentileswithfield) - * [`fn withHide(value)`](#fn-metricsmetricaggregationwithsettingspercentileswithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingspercentileswithid) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingspercentileswithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingspercentileswithsettingsmixin) - * [`fn withType(value)`](#fn-metricsmetricaggregationwithsettingspercentileswithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingspercentilessettings) - * [`fn withMissing(value)`](#fn-metricsmetricaggregationwithsettingspercentilessettingswithmissing) - * [`fn withPercents(value)`](#fn-metricsmetricaggregationwithsettingspercentilessettingswithpercents) - * [`fn withPercentsMixin(value)`](#fn-metricsmetricaggregationwithsettingspercentilessettingswithpercentsmixin) - * [`fn withScript(value)`](#fn-metricsmetricaggregationwithsettingspercentilessettingswithscript) - * [`fn withScriptMixin(value)`](#fn-metricsmetricaggregationwithsettingspercentilessettingswithscriptmixin) - * [`obj script`](#obj-metricsmetricaggregationwithsettingspercentilessettingsscript) - * [`fn withInline(value)`](#fn-metricsmetricaggregationwithsettingspercentilessettingsscriptwithinline) - * [`obj Rate`](#obj-metricsmetricaggregationwithsettingsrate) - * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingsratewithfield) - * [`fn withHide(value)`](#fn-metricsmetricaggregationwithsettingsratewithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsratewithid) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsratewithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsratewithsettingsmixin) - * [`fn withType(value)`](#fn-metricsmetricaggregationwithsettingsratewithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingsratesettings) - * [`fn withMode(value)`](#fn-metricsmetricaggregationwithsettingsratesettingswithmode) - * [`fn withUnit(value)`](#fn-metricsmetricaggregationwithsettingsratesettingswithunit) - * [`obj RawData`](#obj-metricsmetricaggregationwithsettingsrawdata) - * [`fn withHide(value)`](#fn-metricsmetricaggregationwithsettingsrawdatawithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsrawdatawithid) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsrawdatawithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsrawdatawithsettingsmixin) - * [`fn withType(value)`](#fn-metricsmetricaggregationwithsettingsrawdatawithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingsrawdatasettings) - * [`fn withSize(value)`](#fn-metricsmetricaggregationwithsettingsrawdatasettingswithsize) - * [`obj RawDocument`](#obj-metricsmetricaggregationwithsettingsrawdocument) - * [`fn withHide(value)`](#fn-metricsmetricaggregationwithsettingsrawdocumentwithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsrawdocumentwithid) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsrawdocumentwithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsrawdocumentwithsettingsmixin) - * [`fn withType(value)`](#fn-metricsmetricaggregationwithsettingsrawdocumentwithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingsrawdocumentsettings) - * [`fn withSize(value)`](#fn-metricsmetricaggregationwithsettingsrawdocumentsettingswithsize) - * [`obj SerialDiff`](#obj-metricsmetricaggregationwithsettingsserialdiff) - * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingsserialdiffwithfield) - * [`fn withHide(value)`](#fn-metricsmetricaggregationwithsettingsserialdiffwithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsserialdiffwithid) - * [`fn withPipelineAgg(value)`](#fn-metricsmetricaggregationwithsettingsserialdiffwithpipelineagg) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsserialdiffwithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsserialdiffwithsettingsmixin) - * [`fn withType(value)`](#fn-metricsmetricaggregationwithsettingsserialdiffwithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingsserialdiffsettings) - * [`fn withLag(value)`](#fn-metricsmetricaggregationwithsettingsserialdiffsettingswithlag) - * [`obj Sum`](#obj-metricsmetricaggregationwithsettingssum) - * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingssumwithfield) - * [`fn withHide(value)`](#fn-metricsmetricaggregationwithsettingssumwithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingssumwithid) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingssumwithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingssumwithsettingsmixin) - * [`fn withType(value)`](#fn-metricsmetricaggregationwithsettingssumwithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingssumsettings) - * [`fn withMissing(value)`](#fn-metricsmetricaggregationwithsettingssumsettingswithmissing) - * [`fn withScript(value)`](#fn-metricsmetricaggregationwithsettingssumsettingswithscript) - * [`fn withScriptMixin(value)`](#fn-metricsmetricaggregationwithsettingssumsettingswithscriptmixin) - * [`obj script`](#obj-metricsmetricaggregationwithsettingssumsettingsscript) - * [`fn withInline(value)`](#fn-metricsmetricaggregationwithsettingssumsettingsscriptwithinline) - * [`obj TopMetrics`](#obj-metricsmetricaggregationwithsettingstopmetrics) - * [`fn withHide(value)`](#fn-metricsmetricaggregationwithsettingstopmetricswithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingstopmetricswithid) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingstopmetricswithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingstopmetricswithsettingsmixin) - * [`fn withType(value)`](#fn-metricsmetricaggregationwithsettingstopmetricswithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingstopmetricssettings) - * [`fn withMetrics(value)`](#fn-metricsmetricaggregationwithsettingstopmetricssettingswithmetrics) - * [`fn withMetricsMixin(value)`](#fn-metricsmetricaggregationwithsettingstopmetricssettingswithmetricsmixin) - * [`fn withOrder(value)`](#fn-metricsmetricaggregationwithsettingstopmetricssettingswithorder) - * [`fn withOrderBy(value)`](#fn-metricsmetricaggregationwithsettingstopmetricssettingswithorderby) - * [`obj UniqueCount`](#obj-metricsmetricaggregationwithsettingsuniquecount) - * [`fn withField(value)`](#fn-metricsmetricaggregationwithsettingsuniquecountwithfield) - * [`fn withHide(value)`](#fn-metricsmetricaggregationwithsettingsuniquecountwithhide) - * [`fn withId(value)`](#fn-metricsmetricaggregationwithsettingsuniquecountwithid) - * [`fn withSettings(value)`](#fn-metricsmetricaggregationwithsettingsuniquecountwithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricsmetricaggregationwithsettingsuniquecountwithsettingsmixin) - * [`fn withType(value)`](#fn-metricsmetricaggregationwithsettingsuniquecountwithtype) - * [`obj settings`](#obj-metricsmetricaggregationwithsettingsuniquecountsettings) - * [`fn withMissing(value)`](#fn-metricsmetricaggregationwithsettingsuniquecountsettingswithmissing) - * [`fn withPrecisionThreshold(value)`](#fn-metricsmetricaggregationwithsettingsuniquecountsettingswithprecisionthreshold) - * [`obj PipelineMetricAggregation`](#obj-metricspipelinemetricaggregation) - * [`obj BucketScript`](#obj-metricspipelinemetricaggregationbucketscript) - * [`fn withHide(value)`](#fn-metricspipelinemetricaggregationbucketscriptwithhide) - * [`fn withId(value)`](#fn-metricspipelinemetricaggregationbucketscriptwithid) - * [`fn withPipelineVariables(value)`](#fn-metricspipelinemetricaggregationbucketscriptwithpipelinevariables) - * [`fn withPipelineVariablesMixin(value)`](#fn-metricspipelinemetricaggregationbucketscriptwithpipelinevariablesmixin) - * [`fn withSettings(value)`](#fn-metricspipelinemetricaggregationbucketscriptwithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricspipelinemetricaggregationbucketscriptwithsettingsmixin) - * [`fn withType(value)`](#fn-metricspipelinemetricaggregationbucketscriptwithtype) - * [`obj pipelineVariables`](#obj-metricspipelinemetricaggregationbucketscriptpipelinevariables) - * [`fn withName(value)`](#fn-metricspipelinemetricaggregationbucketscriptpipelinevariableswithname) - * [`fn withPipelineAgg(value)`](#fn-metricspipelinemetricaggregationbucketscriptpipelinevariableswithpipelineagg) - * [`obj settings`](#obj-metricspipelinemetricaggregationbucketscriptsettings) - * [`fn withScript(value)`](#fn-metricspipelinemetricaggregationbucketscriptsettingswithscript) - * [`fn withScriptMixin(value)`](#fn-metricspipelinemetricaggregationbucketscriptsettingswithscriptmixin) - * [`obj script`](#obj-metricspipelinemetricaggregationbucketscriptsettingsscript) - * [`fn withInline(value)`](#fn-metricspipelinemetricaggregationbucketscriptsettingsscriptwithinline) - * [`obj CumulativeSum`](#obj-metricspipelinemetricaggregationcumulativesum) - * [`fn withField(value)`](#fn-metricspipelinemetricaggregationcumulativesumwithfield) - * [`fn withHide(value)`](#fn-metricspipelinemetricaggregationcumulativesumwithhide) - * [`fn withId(value)`](#fn-metricspipelinemetricaggregationcumulativesumwithid) - * [`fn withPipelineAgg(value)`](#fn-metricspipelinemetricaggregationcumulativesumwithpipelineagg) - * [`fn withSettings(value)`](#fn-metricspipelinemetricaggregationcumulativesumwithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricspipelinemetricaggregationcumulativesumwithsettingsmixin) - * [`fn withType(value)`](#fn-metricspipelinemetricaggregationcumulativesumwithtype) - * [`obj settings`](#obj-metricspipelinemetricaggregationcumulativesumsettings) - * [`fn withFormat(value)`](#fn-metricspipelinemetricaggregationcumulativesumsettingswithformat) - * [`obj Derivative`](#obj-metricspipelinemetricaggregationderivative) - * [`fn withField(value)`](#fn-metricspipelinemetricaggregationderivativewithfield) - * [`fn withHide(value)`](#fn-metricspipelinemetricaggregationderivativewithhide) - * [`fn withId(value)`](#fn-metricspipelinemetricaggregationderivativewithid) - * [`fn withPipelineAgg(value)`](#fn-metricspipelinemetricaggregationderivativewithpipelineagg) - * [`fn withSettings(value)`](#fn-metricspipelinemetricaggregationderivativewithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricspipelinemetricaggregationderivativewithsettingsmixin) - * [`fn withType(value)`](#fn-metricspipelinemetricaggregationderivativewithtype) - * [`obj settings`](#obj-metricspipelinemetricaggregationderivativesettings) - * [`fn withUnit(value)`](#fn-metricspipelinemetricaggregationderivativesettingswithunit) - * [`obj MovingAverage`](#obj-metricspipelinemetricaggregationmovingaverage) - * [`fn withField(value)`](#fn-metricspipelinemetricaggregationmovingaveragewithfield) - * [`fn withHide(value)`](#fn-metricspipelinemetricaggregationmovingaveragewithhide) - * [`fn withId(value)`](#fn-metricspipelinemetricaggregationmovingaveragewithid) - * [`fn withPipelineAgg(value)`](#fn-metricspipelinemetricaggregationmovingaveragewithpipelineagg) - * [`fn withSettings(value)`](#fn-metricspipelinemetricaggregationmovingaveragewithsettings) - * [`fn withSettingsMixin(value)`](#fn-metricspipelinemetricaggregationmovingaveragewithsettingsmixin) - * [`fn withType(value)`](#fn-metricspipelinemetricaggregationmovingaveragewithtype) - -## Fields - -### fn withAlias - -```ts -withAlias(value) -``` - -Alias pattern - -### fn withBucketAggs - -```ts -withBucketAggs(value) -``` - -List of bucket aggregations - -### fn withBucketAggsMixin - -```ts -withBucketAggsMixin(value) -``` - -List of bucket aggregations - -### fn withDatasource - -```ts -withDatasource(value) -``` - -For mixed data sources the selected datasource is on the query level. -For non mixed scenarios this is undefined. -TODO find a better way to do this ^ that's friendly to schema -TODO this shouldn't be unknown but DataSourceRef | null - -### fn withHide - -```ts -withHide(value) -``` - -true if query is disabled (ie should not be returned to the dashboard) -Note this does not always imply that the query should not be executed since -the results from a hidden query may be used as the input to other queries (SSE etc) - -### fn withMetrics - -```ts -withMetrics(value) -``` - -List of metric aggregations - -### fn withMetricsMixin - -```ts -withMetricsMixin(value) -``` - -List of metric aggregations - -### fn withQuery - -```ts -withQuery(value) -``` - -Lucene query - -### fn withQueryType - -```ts -withQueryType(value) -``` - -Specify the query flavor -TODO make this required and give it a default - -### fn withRefId - -```ts -withRefId(value) -``` - -A unique identifier for the query within the list of targets. -In server side expressions, the refId is used as a variable name to identify results. -By default, the UI will assign A->Z; however setting meaningful names may be useful. - -### fn withTimeField - -```ts -withTimeField(value) -``` - -Name of time field - -### obj bucketAggs - - -#### obj bucketAggs.DateHistogram - - -##### fn bucketAggs.DateHistogram.withField - -```ts -withField(value) -``` - - - -##### fn bucketAggs.DateHistogram.withId - -```ts -withId(value) -``` - - - -##### fn bucketAggs.DateHistogram.withSettings - -```ts -withSettings(value) -``` - - - -##### fn bucketAggs.DateHistogram.withSettingsMixin - -```ts -withSettingsMixin(value) -``` - - - -##### fn bucketAggs.DateHistogram.withType - -```ts -withType(value) -``` - - - -##### obj bucketAggs.DateHistogram.settings - - -###### fn bucketAggs.DateHistogram.settings.withInterval - -```ts -withInterval(value) -``` - - - -###### fn bucketAggs.DateHistogram.settings.withMinDocCount - -```ts -withMinDocCount(value) -``` - - - -###### fn bucketAggs.DateHistogram.settings.withOffset - -```ts -withOffset(value) -``` - - - -###### fn bucketAggs.DateHistogram.settings.withTimeZone - -```ts -withTimeZone(value) -``` - - - -###### fn bucketAggs.DateHistogram.settings.withTrimEdges - -```ts -withTrimEdges(value) -``` - - - -#### obj bucketAggs.Filters - - -##### fn bucketAggs.Filters.withId - -```ts -withId(value) -``` - - - -##### fn bucketAggs.Filters.withSettings - -```ts -withSettings(value) -``` - - - -##### fn bucketAggs.Filters.withSettingsMixin - -```ts -withSettingsMixin(value) -``` - - - -##### fn bucketAggs.Filters.withType - -```ts -withType(value) -``` - - - -##### obj bucketAggs.Filters.settings - - -###### fn bucketAggs.Filters.settings.withFilters - -```ts -withFilters(value) -``` - - - -###### fn bucketAggs.Filters.settings.withFiltersMixin - -```ts -withFiltersMixin(value) -``` - - - -###### obj bucketAggs.Filters.settings.filters - - -####### fn bucketAggs.Filters.settings.filters.withLabel - -```ts -withLabel(value) -``` - - - -####### fn bucketAggs.Filters.settings.filters.withQuery - -```ts -withQuery(value) -``` - - - -#### obj bucketAggs.GeoHashGrid - - -##### fn bucketAggs.GeoHashGrid.withField - -```ts -withField(value) -``` - - - -##### fn bucketAggs.GeoHashGrid.withId - -```ts -withId(value) -``` - - - -##### fn bucketAggs.GeoHashGrid.withSettings - -```ts -withSettings(value) -``` - - - -##### fn bucketAggs.GeoHashGrid.withSettingsMixin - -```ts -withSettingsMixin(value) -``` - - - -##### fn bucketAggs.GeoHashGrid.withType - -```ts -withType(value) -``` - - - -##### obj bucketAggs.GeoHashGrid.settings - - -###### fn bucketAggs.GeoHashGrid.settings.withPrecision - -```ts -withPrecision(value) -``` - - - -#### obj bucketAggs.Histogram - - -##### fn bucketAggs.Histogram.withField - -```ts -withField(value) -``` - - - -##### fn bucketAggs.Histogram.withId - -```ts -withId(value) -``` - - - -##### fn bucketAggs.Histogram.withSettings - -```ts -withSettings(value) -``` - - - -##### fn bucketAggs.Histogram.withSettingsMixin - -```ts -withSettingsMixin(value) -``` - - - -##### fn bucketAggs.Histogram.withType - -```ts -withType(value) -``` - - - -##### obj bucketAggs.Histogram.settings - - -###### fn bucketAggs.Histogram.settings.withInterval - -```ts -withInterval(value) -``` - - - -###### fn bucketAggs.Histogram.settings.withMinDocCount - -```ts -withMinDocCount(value) -``` - - - -#### obj bucketAggs.Nested - - -##### fn bucketAggs.Nested.withField - -```ts -withField(value) -``` - - - -##### fn bucketAggs.Nested.withId - -```ts -withId(value) -``` - - - -##### fn bucketAggs.Nested.withSettings - -```ts -withSettings(value) -``` - - - -##### fn bucketAggs.Nested.withSettingsMixin - -```ts -withSettingsMixin(value) -``` - - - -##### fn bucketAggs.Nested.withType - -```ts -withType(value) -``` - - - -#### obj bucketAggs.Terms - - -##### fn bucketAggs.Terms.withField - -```ts -withField(value) -``` - - - -##### fn bucketAggs.Terms.withId - -```ts -withId(value) -``` - - - -##### fn bucketAggs.Terms.withSettings - -```ts -withSettings(value) -``` - - - -##### fn bucketAggs.Terms.withSettingsMixin - -```ts -withSettingsMixin(value) -``` - - - -##### fn bucketAggs.Terms.withType - -```ts -withType(value) -``` - - - -##### obj bucketAggs.Terms.settings - - -###### fn bucketAggs.Terms.settings.withMinDocCount - -```ts -withMinDocCount(value) -``` - - - -###### fn bucketAggs.Terms.settings.withMissing - -```ts -withMissing(value) -``` - - - -###### fn bucketAggs.Terms.settings.withOrder - -```ts -withOrder(value) -``` - - - -Accepted values for `value` are "desc", "asc" - -###### fn bucketAggs.Terms.settings.withOrderBy - -```ts -withOrderBy(value) -``` - - - -###### fn bucketAggs.Terms.settings.withSize - -```ts -withSize(value) -``` - - - -### obj metrics - - -#### obj metrics.Count - - -##### fn metrics.Count.withHide - -```ts -withHide(value) -``` - - - -##### fn metrics.Count.withId - -```ts -withId(value) -``` - - - -##### fn metrics.Count.withType - -```ts -withType(value) -``` - - - -#### obj metrics.MetricAggregationWithSettings - - -##### obj metrics.MetricAggregationWithSettings.Average - - -###### fn metrics.MetricAggregationWithSettings.Average.withField - -```ts -withField(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Average.withHide - -```ts -withHide(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Average.withId - -```ts -withId(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Average.withSettings - -```ts -withSettings(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Average.withSettingsMixin - -```ts -withSettingsMixin(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Average.withType - -```ts -withType(value) -``` - - - -###### obj metrics.MetricAggregationWithSettings.Average.settings - - -####### fn metrics.MetricAggregationWithSettings.Average.settings.withMissing - -```ts -withMissing(value) -``` - - - -####### fn metrics.MetricAggregationWithSettings.Average.settings.withScript - -```ts -withScript(value) -``` - - - -####### fn metrics.MetricAggregationWithSettings.Average.settings.withScriptMixin - -```ts -withScriptMixin(value) -``` - - - -####### obj metrics.MetricAggregationWithSettings.Average.settings.script - - -######## fn metrics.MetricAggregationWithSettings.Average.settings.script.withInline - -```ts -withInline(value) -``` - - - -##### obj metrics.MetricAggregationWithSettings.BucketScript - - -###### fn metrics.MetricAggregationWithSettings.BucketScript.withHide - -```ts -withHide(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.BucketScript.withId - -```ts -withId(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.BucketScript.withPipelineVariables - -```ts -withPipelineVariables(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.BucketScript.withPipelineVariablesMixin - -```ts -withPipelineVariablesMixin(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.BucketScript.withSettings - -```ts -withSettings(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.BucketScript.withSettingsMixin - -```ts -withSettingsMixin(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.BucketScript.withType - -```ts -withType(value) -``` - - - -###### obj metrics.MetricAggregationWithSettings.BucketScript.pipelineVariables - - -####### fn metrics.MetricAggregationWithSettings.BucketScript.pipelineVariables.withName - -```ts -withName(value) -``` - - - -####### fn metrics.MetricAggregationWithSettings.BucketScript.pipelineVariables.withPipelineAgg - -```ts -withPipelineAgg(value) -``` - - - -###### obj metrics.MetricAggregationWithSettings.BucketScript.settings - - -####### fn metrics.MetricAggregationWithSettings.BucketScript.settings.withScript - -```ts -withScript(value) -``` - - - -####### fn metrics.MetricAggregationWithSettings.BucketScript.settings.withScriptMixin - -```ts -withScriptMixin(value) -``` - - - -####### obj metrics.MetricAggregationWithSettings.BucketScript.settings.script - - -######## fn metrics.MetricAggregationWithSettings.BucketScript.settings.script.withInline - -```ts -withInline(value) -``` - - - -##### obj metrics.MetricAggregationWithSettings.CumulativeSum - - -###### fn metrics.MetricAggregationWithSettings.CumulativeSum.withField - -```ts -withField(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.CumulativeSum.withHide - -```ts -withHide(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.CumulativeSum.withId - -```ts -withId(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.CumulativeSum.withPipelineAgg - -```ts -withPipelineAgg(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.CumulativeSum.withSettings - -```ts -withSettings(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.CumulativeSum.withSettingsMixin - -```ts -withSettingsMixin(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.CumulativeSum.withType - -```ts -withType(value) -``` - - - -###### obj metrics.MetricAggregationWithSettings.CumulativeSum.settings - - -####### fn metrics.MetricAggregationWithSettings.CumulativeSum.settings.withFormat - -```ts -withFormat(value) -``` - - - -##### obj metrics.MetricAggregationWithSettings.Derivative - - -###### fn metrics.MetricAggregationWithSettings.Derivative.withField - -```ts -withField(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Derivative.withHide - -```ts -withHide(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Derivative.withId - -```ts -withId(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Derivative.withPipelineAgg - -```ts -withPipelineAgg(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Derivative.withSettings - -```ts -withSettings(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Derivative.withSettingsMixin - -```ts -withSettingsMixin(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Derivative.withType - -```ts -withType(value) -``` - - - -###### obj metrics.MetricAggregationWithSettings.Derivative.settings - - -####### fn metrics.MetricAggregationWithSettings.Derivative.settings.withUnit - -```ts -withUnit(value) -``` - - - -##### obj metrics.MetricAggregationWithSettings.ExtendedStats - - -###### fn metrics.MetricAggregationWithSettings.ExtendedStats.withField - -```ts -withField(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.ExtendedStats.withHide - -```ts -withHide(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.ExtendedStats.withId - -```ts -withId(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.ExtendedStats.withMeta - -```ts -withMeta(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.ExtendedStats.withMetaMixin - -```ts -withMetaMixin(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.ExtendedStats.withSettings - -```ts -withSettings(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.ExtendedStats.withSettingsMixin - -```ts -withSettingsMixin(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.ExtendedStats.withType - -```ts -withType(value) -``` - - - -###### obj metrics.MetricAggregationWithSettings.ExtendedStats.settings - - -####### fn metrics.MetricAggregationWithSettings.ExtendedStats.settings.withMissing - -```ts -withMissing(value) -``` - - - -####### fn metrics.MetricAggregationWithSettings.ExtendedStats.settings.withScript - -```ts -withScript(value) -``` - - - -####### fn metrics.MetricAggregationWithSettings.ExtendedStats.settings.withScriptMixin - -```ts -withScriptMixin(value) -``` - - - -####### fn metrics.MetricAggregationWithSettings.ExtendedStats.settings.withSigma - -```ts -withSigma(value) -``` - - - -####### obj metrics.MetricAggregationWithSettings.ExtendedStats.settings.script - - -######## fn metrics.MetricAggregationWithSettings.ExtendedStats.settings.script.withInline - -```ts -withInline(value) -``` - - - -##### obj metrics.MetricAggregationWithSettings.Logs - - -###### fn metrics.MetricAggregationWithSettings.Logs.withHide - -```ts -withHide(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Logs.withId - -```ts -withId(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Logs.withSettings - -```ts -withSettings(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Logs.withSettingsMixin - -```ts -withSettingsMixin(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Logs.withType - -```ts -withType(value) -``` - - - -###### obj metrics.MetricAggregationWithSettings.Logs.settings - - -####### fn metrics.MetricAggregationWithSettings.Logs.settings.withLimit - -```ts -withLimit(value) -``` - - - -##### obj metrics.MetricAggregationWithSettings.Max - - -###### fn metrics.MetricAggregationWithSettings.Max.withField - -```ts -withField(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Max.withHide - -```ts -withHide(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Max.withId - -```ts -withId(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Max.withSettings - -```ts -withSettings(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Max.withSettingsMixin - -```ts -withSettingsMixin(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Max.withType - -```ts -withType(value) -``` - - - -###### obj metrics.MetricAggregationWithSettings.Max.settings - - -####### fn metrics.MetricAggregationWithSettings.Max.settings.withMissing - -```ts -withMissing(value) -``` - - - -####### fn metrics.MetricAggregationWithSettings.Max.settings.withScript - -```ts -withScript(value) -``` - - - -####### fn metrics.MetricAggregationWithSettings.Max.settings.withScriptMixin - -```ts -withScriptMixin(value) -``` - - - -####### obj metrics.MetricAggregationWithSettings.Max.settings.script - - -######## fn metrics.MetricAggregationWithSettings.Max.settings.script.withInline - -```ts -withInline(value) -``` - - - -##### obj metrics.MetricAggregationWithSettings.Min - - -###### fn metrics.MetricAggregationWithSettings.Min.withField - -```ts -withField(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Min.withHide - -```ts -withHide(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Min.withId - -```ts -withId(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Min.withSettings - -```ts -withSettings(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Min.withSettingsMixin - -```ts -withSettingsMixin(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Min.withType - -```ts -withType(value) -``` - - - -###### obj metrics.MetricAggregationWithSettings.Min.settings - - -####### fn metrics.MetricAggregationWithSettings.Min.settings.withMissing - -```ts -withMissing(value) -``` - - - -####### fn metrics.MetricAggregationWithSettings.Min.settings.withScript - -```ts -withScript(value) -``` - - - -####### fn metrics.MetricAggregationWithSettings.Min.settings.withScriptMixin - -```ts -withScriptMixin(value) -``` - - - -####### obj metrics.MetricAggregationWithSettings.Min.settings.script - - -######## fn metrics.MetricAggregationWithSettings.Min.settings.script.withInline - -```ts -withInline(value) -``` - - - -##### obj metrics.MetricAggregationWithSettings.MovingAverage - - -###### fn metrics.MetricAggregationWithSettings.MovingAverage.withField - -```ts -withField(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.MovingAverage.withHide - -```ts -withHide(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.MovingAverage.withId - -```ts -withId(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.MovingAverage.withPipelineAgg - -```ts -withPipelineAgg(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.MovingAverage.withSettings - -```ts -withSettings(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.MovingAverage.withSettingsMixin - -```ts -withSettingsMixin(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.MovingAverage.withType - -```ts -withType(value) -``` - - - -##### obj metrics.MetricAggregationWithSettings.MovingFunction - - -###### fn metrics.MetricAggregationWithSettings.MovingFunction.withField - -```ts -withField(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.MovingFunction.withHide - -```ts -withHide(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.MovingFunction.withId - -```ts -withId(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.MovingFunction.withPipelineAgg - -```ts -withPipelineAgg(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.MovingFunction.withSettings - -```ts -withSettings(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.MovingFunction.withSettingsMixin - -```ts -withSettingsMixin(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.MovingFunction.withType - -```ts -withType(value) -``` - - - -###### obj metrics.MetricAggregationWithSettings.MovingFunction.settings - - -####### fn metrics.MetricAggregationWithSettings.MovingFunction.settings.withScript - -```ts -withScript(value) -``` - - - -####### fn metrics.MetricAggregationWithSettings.MovingFunction.settings.withScriptMixin - -```ts -withScriptMixin(value) -``` - - - -####### fn metrics.MetricAggregationWithSettings.MovingFunction.settings.withShift - -```ts -withShift(value) -``` - - - -####### fn metrics.MetricAggregationWithSettings.MovingFunction.settings.withWindow - -```ts -withWindow(value) -``` - - - -####### obj metrics.MetricAggregationWithSettings.MovingFunction.settings.script - - -######## fn metrics.MetricAggregationWithSettings.MovingFunction.settings.script.withInline - -```ts -withInline(value) -``` - - - -##### obj metrics.MetricAggregationWithSettings.Percentiles - - -###### fn metrics.MetricAggregationWithSettings.Percentiles.withField - -```ts -withField(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Percentiles.withHide - -```ts -withHide(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Percentiles.withId - -```ts -withId(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Percentiles.withSettings - -```ts -withSettings(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Percentiles.withSettingsMixin - -```ts -withSettingsMixin(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Percentiles.withType - -```ts -withType(value) -``` - - - -###### obj metrics.MetricAggregationWithSettings.Percentiles.settings - - -####### fn metrics.MetricAggregationWithSettings.Percentiles.settings.withMissing - -```ts -withMissing(value) -``` - - - -####### fn metrics.MetricAggregationWithSettings.Percentiles.settings.withPercents - -```ts -withPercents(value) -``` - - - -####### fn metrics.MetricAggregationWithSettings.Percentiles.settings.withPercentsMixin - -```ts -withPercentsMixin(value) -``` - - - -####### fn metrics.MetricAggregationWithSettings.Percentiles.settings.withScript - -```ts -withScript(value) -``` - - - -####### fn metrics.MetricAggregationWithSettings.Percentiles.settings.withScriptMixin - -```ts -withScriptMixin(value) -``` - - - -####### obj metrics.MetricAggregationWithSettings.Percentiles.settings.script - - -######## fn metrics.MetricAggregationWithSettings.Percentiles.settings.script.withInline - -```ts -withInline(value) -``` - - - -##### obj metrics.MetricAggregationWithSettings.Rate - - -###### fn metrics.MetricAggregationWithSettings.Rate.withField - -```ts -withField(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Rate.withHide - -```ts -withHide(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Rate.withId - -```ts -withId(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Rate.withSettings - -```ts -withSettings(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Rate.withSettingsMixin - -```ts -withSettingsMixin(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Rate.withType - -```ts -withType(value) -``` - - - -###### obj metrics.MetricAggregationWithSettings.Rate.settings - - -####### fn metrics.MetricAggregationWithSettings.Rate.settings.withMode - -```ts -withMode(value) -``` - - - -####### fn metrics.MetricAggregationWithSettings.Rate.settings.withUnit - -```ts -withUnit(value) -``` - - - -##### obj metrics.MetricAggregationWithSettings.RawData - - -###### fn metrics.MetricAggregationWithSettings.RawData.withHide - -```ts -withHide(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.RawData.withId - -```ts -withId(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.RawData.withSettings - -```ts -withSettings(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.RawData.withSettingsMixin - -```ts -withSettingsMixin(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.RawData.withType - -```ts -withType(value) -``` - - - -###### obj metrics.MetricAggregationWithSettings.RawData.settings - - -####### fn metrics.MetricAggregationWithSettings.RawData.settings.withSize - -```ts -withSize(value) -``` - - - -##### obj metrics.MetricAggregationWithSettings.RawDocument - - -###### fn metrics.MetricAggregationWithSettings.RawDocument.withHide - -```ts -withHide(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.RawDocument.withId - -```ts -withId(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.RawDocument.withSettings - -```ts -withSettings(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.RawDocument.withSettingsMixin - -```ts -withSettingsMixin(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.RawDocument.withType - -```ts -withType(value) -``` - - - -###### obj metrics.MetricAggregationWithSettings.RawDocument.settings - - -####### fn metrics.MetricAggregationWithSettings.RawDocument.settings.withSize - -```ts -withSize(value) -``` - - - -##### obj metrics.MetricAggregationWithSettings.SerialDiff - - -###### fn metrics.MetricAggregationWithSettings.SerialDiff.withField - -```ts -withField(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.SerialDiff.withHide - -```ts -withHide(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.SerialDiff.withId - -```ts -withId(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.SerialDiff.withPipelineAgg - -```ts -withPipelineAgg(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.SerialDiff.withSettings - -```ts -withSettings(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.SerialDiff.withSettingsMixin - -```ts -withSettingsMixin(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.SerialDiff.withType - -```ts -withType(value) -``` - - - -###### obj metrics.MetricAggregationWithSettings.SerialDiff.settings - - -####### fn metrics.MetricAggregationWithSettings.SerialDiff.settings.withLag - -```ts -withLag(value) -``` - - - -##### obj metrics.MetricAggregationWithSettings.Sum - - -###### fn metrics.MetricAggregationWithSettings.Sum.withField - -```ts -withField(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Sum.withHide - -```ts -withHide(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Sum.withId - -```ts -withId(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Sum.withSettings - -```ts -withSettings(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Sum.withSettingsMixin - -```ts -withSettingsMixin(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.Sum.withType - -```ts -withType(value) -``` - - - -###### obj metrics.MetricAggregationWithSettings.Sum.settings - - -####### fn metrics.MetricAggregationWithSettings.Sum.settings.withMissing - -```ts -withMissing(value) -``` - - - -####### fn metrics.MetricAggregationWithSettings.Sum.settings.withScript - -```ts -withScript(value) -``` - - - -####### fn metrics.MetricAggregationWithSettings.Sum.settings.withScriptMixin - -```ts -withScriptMixin(value) -``` - - - -####### obj metrics.MetricAggregationWithSettings.Sum.settings.script - - -######## fn metrics.MetricAggregationWithSettings.Sum.settings.script.withInline - -```ts -withInline(value) -``` - - - -##### obj metrics.MetricAggregationWithSettings.TopMetrics - - -###### fn metrics.MetricAggregationWithSettings.TopMetrics.withHide - -```ts -withHide(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.TopMetrics.withId - -```ts -withId(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.TopMetrics.withSettings - -```ts -withSettings(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.TopMetrics.withSettingsMixin - -```ts -withSettingsMixin(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.TopMetrics.withType - -```ts -withType(value) -``` - - - -###### obj metrics.MetricAggregationWithSettings.TopMetrics.settings - - -####### fn metrics.MetricAggregationWithSettings.TopMetrics.settings.withMetrics - -```ts -withMetrics(value) -``` - - - -####### fn metrics.MetricAggregationWithSettings.TopMetrics.settings.withMetricsMixin - -```ts -withMetricsMixin(value) -``` - - - -####### fn metrics.MetricAggregationWithSettings.TopMetrics.settings.withOrder - -```ts -withOrder(value) -``` - - - -####### fn metrics.MetricAggregationWithSettings.TopMetrics.settings.withOrderBy - -```ts -withOrderBy(value) -``` - - - -##### obj metrics.MetricAggregationWithSettings.UniqueCount - - -###### fn metrics.MetricAggregationWithSettings.UniqueCount.withField - -```ts -withField(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.UniqueCount.withHide - -```ts -withHide(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.UniqueCount.withId - -```ts -withId(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.UniqueCount.withSettings - -```ts -withSettings(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.UniqueCount.withSettingsMixin - -```ts -withSettingsMixin(value) -``` - - - -###### fn metrics.MetricAggregationWithSettings.UniqueCount.withType - -```ts -withType(value) -``` - - - -###### obj metrics.MetricAggregationWithSettings.UniqueCount.settings - - -####### fn metrics.MetricAggregationWithSettings.UniqueCount.settings.withMissing - -```ts -withMissing(value) -``` - - - -####### fn metrics.MetricAggregationWithSettings.UniqueCount.settings.withPrecisionThreshold - -```ts -withPrecisionThreshold(value) -``` - - - -#### obj metrics.PipelineMetricAggregation - - -##### obj metrics.PipelineMetricAggregation.BucketScript - - -###### fn metrics.PipelineMetricAggregation.BucketScript.withHide - -```ts -withHide(value) -``` - - - -###### fn metrics.PipelineMetricAggregation.BucketScript.withId - -```ts -withId(value) -``` - - - -###### fn metrics.PipelineMetricAggregation.BucketScript.withPipelineVariables - -```ts -withPipelineVariables(value) -``` - - - -###### fn metrics.PipelineMetricAggregation.BucketScript.withPipelineVariablesMixin - -```ts -withPipelineVariablesMixin(value) -``` - - - -###### fn metrics.PipelineMetricAggregation.BucketScript.withSettings - -```ts -withSettings(value) -``` - - - -###### fn metrics.PipelineMetricAggregation.BucketScript.withSettingsMixin - -```ts -withSettingsMixin(value) -``` - - - -###### fn metrics.PipelineMetricAggregation.BucketScript.withType - -```ts -withType(value) -``` - - - -###### obj metrics.PipelineMetricAggregation.BucketScript.pipelineVariables - - -####### fn metrics.PipelineMetricAggregation.BucketScript.pipelineVariables.withName - -```ts -withName(value) -``` - - - -####### fn metrics.PipelineMetricAggregation.BucketScript.pipelineVariables.withPipelineAgg - -```ts -withPipelineAgg(value) -``` - - - -###### obj metrics.PipelineMetricAggregation.BucketScript.settings - - -####### fn metrics.PipelineMetricAggregation.BucketScript.settings.withScript - -```ts -withScript(value) -``` - - - -####### fn metrics.PipelineMetricAggregation.BucketScript.settings.withScriptMixin - -```ts -withScriptMixin(value) -``` - - - -####### obj metrics.PipelineMetricAggregation.BucketScript.settings.script - - -######## fn metrics.PipelineMetricAggregation.BucketScript.settings.script.withInline - -```ts -withInline(value) -``` - - - -##### obj metrics.PipelineMetricAggregation.CumulativeSum - - -###### fn metrics.PipelineMetricAggregation.CumulativeSum.withField - -```ts -withField(value) -``` - - - -###### fn metrics.PipelineMetricAggregation.CumulativeSum.withHide - -```ts -withHide(value) -``` - - - -###### fn metrics.PipelineMetricAggregation.CumulativeSum.withId - -```ts -withId(value) -``` - - - -###### fn metrics.PipelineMetricAggregation.CumulativeSum.withPipelineAgg - -```ts -withPipelineAgg(value) -``` - - - -###### fn metrics.PipelineMetricAggregation.CumulativeSum.withSettings - -```ts -withSettings(value) -``` - - - -###### fn metrics.PipelineMetricAggregation.CumulativeSum.withSettingsMixin - -```ts -withSettingsMixin(value) -``` - - - -###### fn metrics.PipelineMetricAggregation.CumulativeSum.withType - -```ts -withType(value) -``` - - - -###### obj metrics.PipelineMetricAggregation.CumulativeSum.settings - - -####### fn metrics.PipelineMetricAggregation.CumulativeSum.settings.withFormat - -```ts -withFormat(value) -``` - - - -##### obj metrics.PipelineMetricAggregation.Derivative - - -###### fn metrics.PipelineMetricAggregation.Derivative.withField - -```ts -withField(value) -``` - - - -###### fn metrics.PipelineMetricAggregation.Derivative.withHide - -```ts -withHide(value) -``` - - - -###### fn metrics.PipelineMetricAggregation.Derivative.withId - -```ts -withId(value) -``` - - - -###### fn metrics.PipelineMetricAggregation.Derivative.withPipelineAgg - -```ts -withPipelineAgg(value) -``` - - - -###### fn metrics.PipelineMetricAggregation.Derivative.withSettings - -```ts -withSettings(value) -``` - - - -###### fn metrics.PipelineMetricAggregation.Derivative.withSettingsMixin - -```ts -withSettingsMixin(value) -``` - - - -###### fn metrics.PipelineMetricAggregation.Derivative.withType - -```ts -withType(value) -``` - - - -###### obj metrics.PipelineMetricAggregation.Derivative.settings - - -####### fn metrics.PipelineMetricAggregation.Derivative.settings.withUnit - -```ts -withUnit(value) -``` - - - -##### obj metrics.PipelineMetricAggregation.MovingAverage - - -###### fn metrics.PipelineMetricAggregation.MovingAverage.withField - -```ts -withField(value) -``` - - - -###### fn metrics.PipelineMetricAggregation.MovingAverage.withHide - -```ts -withHide(value) -``` - - - -###### fn metrics.PipelineMetricAggregation.MovingAverage.withId - -```ts -withId(value) -``` - - - -###### fn metrics.PipelineMetricAggregation.MovingAverage.withPipelineAgg - -```ts -withPipelineAgg(value) -``` - - - -###### fn metrics.PipelineMetricAggregation.MovingAverage.withSettings - -```ts -withSettings(value) -``` - - - -###### fn metrics.PipelineMetricAggregation.MovingAverage.withSettingsMixin - -```ts -withSettingsMixin(value) -``` - - - -###### fn metrics.PipelineMetricAggregation.MovingAverage.withType - -```ts -withType(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/grafanaPyroscope.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/grafanaPyroscope.md deleted file mode 100644 index 3436973..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/grafanaPyroscope.md +++ /dev/null @@ -1,97 +0,0 @@ -# grafanaPyroscope - -grafonnet.query.grafanaPyroscope - -## Index - -* [`fn withDatasource(value)`](#fn-withdatasource) -* [`fn withGroupBy(value)`](#fn-withgroupby) -* [`fn withGroupByMixin(value)`](#fn-withgroupbymixin) -* [`fn withHide(value)`](#fn-withhide) -* [`fn withLabelSelector(value="{}")`](#fn-withlabelselector) -* [`fn withMaxNodes(value)`](#fn-withmaxnodes) -* [`fn withProfileTypeId(value)`](#fn-withprofiletypeid) -* [`fn withQueryType(value)`](#fn-withquerytype) -* [`fn withRefId(value)`](#fn-withrefid) - -## Fields - -### fn withDatasource - -```ts -withDatasource(value) -``` - -For mixed data sources the selected datasource is on the query level. -For non mixed scenarios this is undefined. -TODO find a better way to do this ^ that's friendly to schema -TODO this shouldn't be unknown but DataSourceRef | null - -### fn withGroupBy - -```ts -withGroupBy(value) -``` - -Allows to group the results. - -### fn withGroupByMixin - -```ts -withGroupByMixin(value) -``` - -Allows to group the results. - -### fn withHide - -```ts -withHide(value) -``` - -true if query is disabled (ie should not be returned to the dashboard) -Note this does not always imply that the query should not be executed since -the results from a hidden query may be used as the input to other queries (SSE etc) - -### fn withLabelSelector - -```ts -withLabelSelector(value="{}") -``` - -Specifies the query label selectors. - -### fn withMaxNodes - -```ts -withMaxNodes(value) -``` - -Sets the maximum number of nodes in the flamegraph. - -### fn withProfileTypeId - -```ts -withProfileTypeId(value) -``` - -Specifies the type of profile to query. - -### fn withQueryType - -```ts -withQueryType(value) -``` - -Specify the query flavor -TODO make this required and give it a default - -### fn withRefId - -```ts -withRefId(value) -``` - -A unique identifier for the query within the list of targets. -In server side expressions, the refId is used as a variable name to identify results. -By default, the UI will assign A->Z; however setting meaningful names may be useful. diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/index.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/index.md deleted file mode 100644 index 1ad7c17..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/index.md +++ /dev/null @@ -1,16 +0,0 @@ -# query - -grafonnet.query - -## Subpackages - -* [azureMonitor](azureMonitor.md) -* [cloudWatch](cloudWatch.md) -* [elasticsearch](elasticsearch.md) -* [grafanaPyroscope](grafanaPyroscope.md) -* [loki](loki.md) -* [parca](parca.md) -* [prometheus](prometheus.md) -* [tempo](tempo.md) -* [testData](testData.md) - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/loki.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/loki.md deleted file mode 100644 index 5a048b8..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/loki.md +++ /dev/null @@ -1,123 +0,0 @@ -# loki - -grafonnet.query.loki - -## Index - -* [`fn new(datasource, expr)`](#fn-new) -* [`fn withDatasource(value)`](#fn-withdatasource) -* [`fn withEditorMode(value)`](#fn-witheditormode) -* [`fn withExpr(value)`](#fn-withexpr) -* [`fn withHide(value)`](#fn-withhide) -* [`fn withInstant(value)`](#fn-withinstant) -* [`fn withLegendFormat(value)`](#fn-withlegendformat) -* [`fn withMaxLines(value)`](#fn-withmaxlines) -* [`fn withQueryType(value)`](#fn-withquerytype) -* [`fn withRange(value)`](#fn-withrange) -* [`fn withRefId(value)`](#fn-withrefid) -* [`fn withResolution(value)`](#fn-withresolution) - -## Fields - -### fn new - -```ts -new(datasource, expr) -``` - -Creates a new loki query target for panels. - -### fn withDatasource - -```ts -withDatasource(value) -``` - -Set the datasource for this query. - -### fn withEditorMode - -```ts -withEditorMode(value) -``` - - - -Accepted values for `value` are "code", "builder" - -### fn withExpr - -```ts -withExpr(value) -``` - -The LogQL query. - -### fn withHide - -```ts -withHide(value) -``` - -true if query is disabled (ie should not be returned to the dashboard) -Note this does not always imply that the query should not be executed since -the results from a hidden query may be used as the input to other queries (SSE etc) - -### fn withInstant - -```ts -withInstant(value) -``` - -@deprecated, now use queryType. - -### fn withLegendFormat - -```ts -withLegendFormat(value) -``` - -Used to override the name of the series. - -### fn withMaxLines - -```ts -withMaxLines(value) -``` - -Used to limit the number of log rows returned. - -### fn withQueryType - -```ts -withQueryType(value) -``` - -Specify the query flavor -TODO make this required and give it a default - -### fn withRange - -```ts -withRange(value) -``` - -@deprecated, now use queryType. - -### fn withRefId - -```ts -withRefId(value) -``` - -A unique identifier for the query within the list of targets. -In server side expressions, the refId is used as a variable name to identify results. -By default, the UI will assign A->Z; however setting meaningful names may be useful. - -### fn withResolution - -```ts -withResolution(value) -``` - -Used to scale the interval value. diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/parca.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/parca.md deleted file mode 100644 index 1d52589..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/parca.md +++ /dev/null @@ -1,70 +0,0 @@ -# parca - -grafonnet.query.parca - -## Index - -* [`fn withDatasource(value)`](#fn-withdatasource) -* [`fn withHide(value)`](#fn-withhide) -* [`fn withLabelSelector(value="{}")`](#fn-withlabelselector) -* [`fn withProfileTypeId(value)`](#fn-withprofiletypeid) -* [`fn withQueryType(value)`](#fn-withquerytype) -* [`fn withRefId(value)`](#fn-withrefid) - -## Fields - -### fn withDatasource - -```ts -withDatasource(value) -``` - -For mixed data sources the selected datasource is on the query level. -For non mixed scenarios this is undefined. -TODO find a better way to do this ^ that's friendly to schema -TODO this shouldn't be unknown but DataSourceRef | null - -### fn withHide - -```ts -withHide(value) -``` - -true if query is disabled (ie should not be returned to the dashboard) -Note this does not always imply that the query should not be executed since -the results from a hidden query may be used as the input to other queries (SSE etc) - -### fn withLabelSelector - -```ts -withLabelSelector(value="{}") -``` - -Specifies the query label selectors. - -### fn withProfileTypeId - -```ts -withProfileTypeId(value) -``` - -Specifies the type of profile to query. - -### fn withQueryType - -```ts -withQueryType(value) -``` - -Specify the query flavor -TODO make this required and give it a default - -### fn withRefId - -```ts -withRefId(value) -``` - -A unique identifier for the query within the list of targets. -In server side expressions, the refId is used as a variable name to identify results. -By default, the UI will assign A->Z; however setting meaningful names may be useful. diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/prometheus.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/prometheus.md deleted file mode 100644 index a8d5275..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/prometheus.md +++ /dev/null @@ -1,134 +0,0 @@ -# prometheus - -grafonnet.query.prometheus - -## Index - -* [`fn new(datasource, expr)`](#fn-new) -* [`fn withDatasource(value)`](#fn-withdatasource) -* [`fn withEditorMode(value)`](#fn-witheditormode) -* [`fn withExemplar(value)`](#fn-withexemplar) -* [`fn withExpr(value)`](#fn-withexpr) -* [`fn withFormat(value)`](#fn-withformat) -* [`fn withHide(value)`](#fn-withhide) -* [`fn withInstant(value)`](#fn-withinstant) -* [`fn withIntervalFactor(value)`](#fn-withintervalfactor) -* [`fn withLegendFormat(value)`](#fn-withlegendformat) -* [`fn withQueryType(value)`](#fn-withquerytype) -* [`fn withRange(value)`](#fn-withrange) -* [`fn withRefId(value)`](#fn-withrefid) - -## Fields - -### fn new - -```ts -new(datasource, expr) -``` - -Creates a new prometheus query target for panels. - -### fn withDatasource - -```ts -withDatasource(value) -``` - -Set the datasource for this query. - -### fn withEditorMode - -```ts -withEditorMode(value) -``` - - - -Accepted values for `value` are "code", "builder" - -### fn withExemplar - -```ts -withExemplar(value) -``` - -Execute an additional query to identify interesting raw samples relevant for the given expr - -### fn withExpr - -```ts -withExpr(value) -``` - -The actual expression/query that will be evaluated by Prometheus - -### fn withFormat - -```ts -withFormat(value) -``` - - - -Accepted values for `value` are "time_series", "table", "heatmap" - -### fn withHide - -```ts -withHide(value) -``` - -true if query is disabled (ie should not be returned to the dashboard) -Note this does not always imply that the query should not be executed since -the results from a hidden query may be used as the input to other queries (SSE etc) - -### fn withInstant - -```ts -withInstant(value) -``` - -Returns only the latest value that Prometheus has scraped for the requested time series - -### fn withIntervalFactor - -```ts -withIntervalFactor(value) -``` - -Set the interval factor for this query. - -### fn withLegendFormat - -```ts -withLegendFormat(value) -``` - -Set the legend format for this query. - -### fn withQueryType - -```ts -withQueryType(value) -``` - -Specify the query flavor -TODO make this required and give it a default - -### fn withRange - -```ts -withRange(value) -``` - -Returns a Range vector, comprised of a set of time series containing a range of data points over time for each time series - -### fn withRefId - -```ts -withRefId(value) -``` - -A unique identifier for the query within the list of targets. -In server side expressions, the refId is used as a variable name to identify results. -By default, the UI will assign A->Z; however setting meaningful names may be useful. diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/tempo.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/tempo.md deleted file mode 100644 index b39f57d..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/tempo.md +++ /dev/null @@ -1,217 +0,0 @@ -# tempo - -grafonnet.query.tempo - -## Index - -* [`fn new(datasource, query, filters)`](#fn-new) -* [`fn withDatasource(value)`](#fn-withdatasource) -* [`fn withFilters(value)`](#fn-withfilters) -* [`fn withFiltersMixin(value)`](#fn-withfiltersmixin) -* [`fn withHide(value)`](#fn-withhide) -* [`fn withLimit(value)`](#fn-withlimit) -* [`fn withMaxDuration(value)`](#fn-withmaxduration) -* [`fn withMinDuration(value)`](#fn-withminduration) -* [`fn withQuery(value)`](#fn-withquery) -* [`fn withQueryType(value)`](#fn-withquerytype) -* [`fn withRefId(value)`](#fn-withrefid) -* [`fn withSearch(value)`](#fn-withsearch) -* [`fn withServiceMapQuery(value)`](#fn-withservicemapquery) -* [`fn withServiceName(value)`](#fn-withservicename) -* [`fn withSpanName(value)`](#fn-withspanname) -* [`obj filters`](#obj-filters) - * [`fn withId(value)`](#fn-filterswithid) - * [`fn withOperator(value)`](#fn-filterswithoperator) - * [`fn withScope(value)`](#fn-filterswithscope) - * [`fn withTag(value)`](#fn-filterswithtag) - * [`fn withValue(value)`](#fn-filterswithvalue) - * [`fn withValueMixin(value)`](#fn-filterswithvaluemixin) - * [`fn withValueType(value)`](#fn-filterswithvaluetype) - -## Fields - -### fn new - -```ts -new(datasource, query, filters) -``` - -Creates a new tempo query target for panels. - -### fn withDatasource - -```ts -withDatasource(value) -``` - -Set the datasource for this query. - -### fn withFilters - -```ts -withFilters(value) -``` - - - -### fn withFiltersMixin - -```ts -withFiltersMixin(value) -``` - - - -### fn withHide - -```ts -withHide(value) -``` - -true if query is disabled (ie should not be returned to the dashboard) -Note this does not always imply that the query should not be executed since -the results from a hidden query may be used as the input to other queries (SSE etc) - -### fn withLimit - -```ts -withLimit(value) -``` - -Defines the maximum number of traces that are returned from Tempo - -### fn withMaxDuration - -```ts -withMaxDuration(value) -``` - -Define the maximum duration to select traces. Use duration format, for example: 1.2s, 100ms - -### fn withMinDuration - -```ts -withMinDuration(value) -``` - -Define the minimum duration to select traces. Use duration format, for example: 1.2s, 100ms - -### fn withQuery - -```ts -withQuery(value) -``` - -TraceQL query or trace ID - -### fn withQueryType - -```ts -withQueryType(value) -``` - -Specify the query flavor -TODO make this required and give it a default - -### fn withRefId - -```ts -withRefId(value) -``` - -A unique identifier for the query within the list of targets. -In server side expressions, the refId is used as a variable name to identify results. -By default, the UI will assign A->Z; however setting meaningful names may be useful. - -### fn withSearch - -```ts -withSearch(value) -``` - -Logfmt query to filter traces by their tags. Example: http.status_code=200 error=true - -### fn withServiceMapQuery - -```ts -withServiceMapQuery(value) -``` - -Filters to be included in a PromQL query to select data for the service graph. Example: {client="app",service="app"} - -### fn withServiceName - -```ts -withServiceName(value) -``` - -Query traces by service name - -### fn withSpanName - -```ts -withSpanName(value) -``` - -Query traces by span name - -### obj filters - - -#### fn filters.withId - -```ts -withId(value) -``` - -Uniquely identify the filter, will not be used in the query generation - -#### fn filters.withOperator - -```ts -withOperator(value) -``` - -The operator that connects the tag to the value, for example: =, >, !=, =~ - -#### fn filters.withScope - -```ts -withScope(value) -``` - -static fields are pre-set in the UI, dynamic fields are added by the user - -Accepted values for `value` are "unscoped", "resource", "span" - -#### fn filters.withTag - -```ts -withTag(value) -``` - -The tag for the search filter, for example: .http.status_code, .service.name, status - -#### fn filters.withValue - -```ts -withValue(value) -``` - -The value for the search filter - -#### fn filters.withValueMixin - -```ts -withValueMixin(value) -``` - -The value for the search filter - -#### fn filters.withValueType - -```ts -withValueType(value) -``` - -The type of the value, used for example to check whether we need to wrap the value in quotes when generating the query diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/testData.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/testData.md deleted file mode 100644 index 2915428..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/query/testData.md +++ /dev/null @@ -1,619 +0,0 @@ -# testData - -grafonnet.query.testData - -## Index - -* [`fn withAlias(value)`](#fn-withalias) -* [`fn withChannel(value)`](#fn-withchannel) -* [`fn withCsvContent(value)`](#fn-withcsvcontent) -* [`fn withCsvFileName(value)`](#fn-withcsvfilename) -* [`fn withCsvWave(value)`](#fn-withcsvwave) -* [`fn withCsvWaveMixin(value)`](#fn-withcsvwavemixin) -* [`fn withDatasource(value)`](#fn-withdatasource) -* [`fn withErrorType(value)`](#fn-witherrortype) -* [`fn withHide(value)`](#fn-withhide) -* [`fn withLabels(value)`](#fn-withlabels) -* [`fn withLevelColumn(value)`](#fn-withlevelcolumn) -* [`fn withLines(value)`](#fn-withlines) -* [`fn withNodes(value)`](#fn-withnodes) -* [`fn withNodesMixin(value)`](#fn-withnodesmixin) -* [`fn withPoints(value)`](#fn-withpoints) -* [`fn withPointsMixin(value)`](#fn-withpointsmixin) -* [`fn withPulseWave(value)`](#fn-withpulsewave) -* [`fn withPulseWaveMixin(value)`](#fn-withpulsewavemixin) -* [`fn withQueryType(value)`](#fn-withquerytype) -* [`fn withRawFrameContent(value)`](#fn-withrawframecontent) -* [`fn withRefId(value)`](#fn-withrefid) -* [`fn withScenarioId(value)`](#fn-withscenarioid) -* [`fn withSeriesCount(value)`](#fn-withseriescount) -* [`fn withSim(value)`](#fn-withsim) -* [`fn withSimMixin(value)`](#fn-withsimmixin) -* [`fn withSpanCount(value)`](#fn-withspancount) -* [`fn withStream(value)`](#fn-withstream) -* [`fn withStreamMixin(value)`](#fn-withstreammixin) -* [`fn withStringInput(value)`](#fn-withstringinput) -* [`fn withUsa(value)`](#fn-withusa) -* [`fn withUsaMixin(value)`](#fn-withusamixin) -* [`obj csvWave`](#obj-csvwave) - * [`fn withLabels(value)`](#fn-csvwavewithlabels) - * [`fn withName(value)`](#fn-csvwavewithname) - * [`fn withTimeStep(value)`](#fn-csvwavewithtimestep) - * [`fn withValuesCSV(value)`](#fn-csvwavewithvaluescsv) -* [`obj nodes`](#obj-nodes) - * [`fn withCount(value)`](#fn-nodeswithcount) - * [`fn withType(value)`](#fn-nodeswithtype) -* [`obj pulseWave`](#obj-pulsewave) - * [`fn withOffCount(value)`](#fn-pulsewavewithoffcount) - * [`fn withOffValue(value)`](#fn-pulsewavewithoffvalue) - * [`fn withOnCount(value)`](#fn-pulsewavewithoncount) - * [`fn withOnValue(value)`](#fn-pulsewavewithonvalue) - * [`fn withTimeStep(value)`](#fn-pulsewavewithtimestep) -* [`obj sim`](#obj-sim) - * [`fn withConfig(value)`](#fn-simwithconfig) - * [`fn withConfigMixin(value)`](#fn-simwithconfigmixin) - * [`fn withKey(value)`](#fn-simwithkey) - * [`fn withKeyMixin(value)`](#fn-simwithkeymixin) - * [`fn withLast(value)`](#fn-simwithlast) - * [`fn withStream(value)`](#fn-simwithstream) - * [`obj key`](#obj-simkey) - * [`fn withTick(value)`](#fn-simkeywithtick) - * [`fn withType(value)`](#fn-simkeywithtype) - * [`fn withUid(value)`](#fn-simkeywithuid) -* [`obj stream`](#obj-stream) - * [`fn withBands(value)`](#fn-streamwithbands) - * [`fn withNoise(value)`](#fn-streamwithnoise) - * [`fn withSpeed(value)`](#fn-streamwithspeed) - * [`fn withSpread(value)`](#fn-streamwithspread) - * [`fn withType(value)`](#fn-streamwithtype) - * [`fn withUrl(value)`](#fn-streamwithurl) -* [`obj usa`](#obj-usa) - * [`fn withFields(value)`](#fn-usawithfields) - * [`fn withFieldsMixin(value)`](#fn-usawithfieldsmixin) - * [`fn withMode(value)`](#fn-usawithmode) - * [`fn withPeriod(value)`](#fn-usawithperiod) - * [`fn withStates(value)`](#fn-usawithstates) - * [`fn withStatesMixin(value)`](#fn-usawithstatesmixin) - -## Fields - -### fn withAlias - -```ts -withAlias(value) -``` - - - -### fn withChannel - -```ts -withChannel(value) -``` - - - -### fn withCsvContent - -```ts -withCsvContent(value) -``` - - - -### fn withCsvFileName - -```ts -withCsvFileName(value) -``` - - - -### fn withCsvWave - -```ts -withCsvWave(value) -``` - - - -### fn withCsvWaveMixin - -```ts -withCsvWaveMixin(value) -``` - - - -### fn withDatasource - -```ts -withDatasource(value) -``` - -For mixed data sources the selected datasource is on the query level. -For non mixed scenarios this is undefined. -TODO find a better way to do this ^ that's friendly to schema -TODO this shouldn't be unknown but DataSourceRef | null - -### fn withErrorType - -```ts -withErrorType(value) -``` - - - -Accepted values for `value` are "server_panic", "frontend_exception", "frontend_observable" - -### fn withHide - -```ts -withHide(value) -``` - -true if query is disabled (ie should not be returned to the dashboard) -Note this does not always imply that the query should not be executed since -the results from a hidden query may be used as the input to other queries (SSE etc) - -### fn withLabels - -```ts -withLabels(value) -``` - - - -### fn withLevelColumn - -```ts -withLevelColumn(value) -``` - - - -### fn withLines - -```ts -withLines(value) -``` - - - -### fn withNodes - -```ts -withNodes(value) -``` - - - -### fn withNodesMixin - -```ts -withNodesMixin(value) -``` - - - -### fn withPoints - -```ts -withPoints(value) -``` - - - -### fn withPointsMixin - -```ts -withPointsMixin(value) -``` - - - -### fn withPulseWave - -```ts -withPulseWave(value) -``` - - - -### fn withPulseWaveMixin - -```ts -withPulseWaveMixin(value) -``` - - - -### fn withQueryType - -```ts -withQueryType(value) -``` - -Specify the query flavor -TODO make this required and give it a default - -### fn withRawFrameContent - -```ts -withRawFrameContent(value) -``` - - - -### fn withRefId - -```ts -withRefId(value) -``` - -A unique identifier for the query within the list of targets. -In server side expressions, the refId is used as a variable name to identify results. -By default, the UI will assign A->Z; however setting meaningful names may be useful. - -### fn withScenarioId - -```ts -withScenarioId(value) -``` - - - -Accepted values for `value` are "random_walk", "slow_query", "random_walk_with_error", "random_walk_table", "exponential_heatmap_bucket_data", "linear_heatmap_bucket_data", "no_data_points", "datapoints_outside_range", "csv_metric_values", "predictable_pulse", "predictable_csv_wave", "streaming_client", "simulation", "usa", "live", "grafana_api", "arrow", "annotations", "table_static", "server_error_500", "logs", "node_graph", "flame_graph", "raw_frame", "csv_file", "csv_content", "trace", "manual_entry", "variables-query" - -### fn withSeriesCount - -```ts -withSeriesCount(value) -``` - - - -### fn withSim - -```ts -withSim(value) -``` - - - -### fn withSimMixin - -```ts -withSimMixin(value) -``` - - - -### fn withSpanCount - -```ts -withSpanCount(value) -``` - - - -### fn withStream - -```ts -withStream(value) -``` - - - -### fn withStreamMixin - -```ts -withStreamMixin(value) -``` - - - -### fn withStringInput - -```ts -withStringInput(value) -``` - - - -### fn withUsa - -```ts -withUsa(value) -``` - - - -### fn withUsaMixin - -```ts -withUsaMixin(value) -``` - - - -### obj csvWave - - -#### fn csvWave.withLabels - -```ts -withLabels(value) -``` - - - -#### fn csvWave.withName - -```ts -withName(value) -``` - - - -#### fn csvWave.withTimeStep - -```ts -withTimeStep(value) -``` - - - -#### fn csvWave.withValuesCSV - -```ts -withValuesCSV(value) -``` - - - -### obj nodes - - -#### fn nodes.withCount - -```ts -withCount(value) -``` - - - -#### fn nodes.withType - -```ts -withType(value) -``` - - - -Accepted values for `value` are "random", "response", "random edges" - -### obj pulseWave - - -#### fn pulseWave.withOffCount - -```ts -withOffCount(value) -``` - - - -#### fn pulseWave.withOffValue - -```ts -withOffValue(value) -``` - - - -#### fn pulseWave.withOnCount - -```ts -withOnCount(value) -``` - - - -#### fn pulseWave.withOnValue - -```ts -withOnValue(value) -``` - - - -#### fn pulseWave.withTimeStep - -```ts -withTimeStep(value) -``` - - - -### obj sim - - -#### fn sim.withConfig - -```ts -withConfig(value) -``` - - - -#### fn sim.withConfigMixin - -```ts -withConfigMixin(value) -``` - - - -#### fn sim.withKey - -```ts -withKey(value) -``` - - - -#### fn sim.withKeyMixin - -```ts -withKeyMixin(value) -``` - - - -#### fn sim.withLast - -```ts -withLast(value) -``` - - - -#### fn sim.withStream - -```ts -withStream(value) -``` - - - -#### obj sim.key - - -##### fn sim.key.withTick - -```ts -withTick(value) -``` - - - -##### fn sim.key.withType - -```ts -withType(value) -``` - - - -##### fn sim.key.withUid - -```ts -withUid(value) -``` - - - -### obj stream - - -#### fn stream.withBands - -```ts -withBands(value) -``` - - - -#### fn stream.withNoise - -```ts -withNoise(value) -``` - - - -#### fn stream.withSpeed - -```ts -withSpeed(value) -``` - - - -#### fn stream.withSpread - -```ts -withSpread(value) -``` - - - -#### fn stream.withType - -```ts -withType(value) -``` - - - -Accepted values for `value` are "signal", "logs", "fetch" - -#### fn stream.withUrl - -```ts -withUrl(value) -``` - - - -### obj usa - - -#### fn usa.withFields - -```ts -withFields(value) -``` - - - -#### fn usa.withFieldsMixin - -```ts -withFieldsMixin(value) -``` - - - -#### fn usa.withMode - -```ts -withMode(value) -``` - - - -#### fn usa.withPeriod - -```ts -withPeriod(value) -``` - - - -#### fn usa.withStates - -```ts -withStates(value) -``` - - - -#### fn usa.withStatesMixin - -```ts -withStatesMixin(value) -``` - - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/serviceaccount.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/serviceaccount.md deleted file mode 100644 index 8b3bbee..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/serviceaccount.md +++ /dev/null @@ -1,120 +0,0 @@ -# serviceaccount - -grafonnet.serviceaccount - -## Index - -* [`fn withAccessControl(value)`](#fn-withaccesscontrol) -* [`fn withAccessControlMixin(value)`](#fn-withaccesscontrolmixin) -* [`fn withAvatarUrl(value)`](#fn-withavatarurl) -* [`fn withId(value)`](#fn-withid) -* [`fn withIsDisabled(value)`](#fn-withisdisabled) -* [`fn withLogin(value)`](#fn-withlogin) -* [`fn withName(value)`](#fn-withname) -* [`fn withOrgId(value)`](#fn-withorgid) -* [`fn withRole(value)`](#fn-withrole) -* [`fn withTeams(value)`](#fn-withteams) -* [`fn withTeamsMixin(value)`](#fn-withteamsmixin) -* [`fn withTokens(value)`](#fn-withtokens) - -## Fields - -### fn withAccessControl - -```ts -withAccessControl(value) -``` - -AccessControl metadata associated with a given resource. - -### fn withAccessControlMixin - -```ts -withAccessControlMixin(value) -``` - -AccessControl metadata associated with a given resource. - -### fn withAvatarUrl - -```ts -withAvatarUrl(value) -``` - -AvatarUrl is the service account's avatar URL. It allows the frontend to display a picture in front -of the service account. - -### fn withId - -```ts -withId(value) -``` - -ID is the unique identifier of the service account in the database. - -### fn withIsDisabled - -```ts -withIsDisabled(value) -``` - -IsDisabled indicates if the service account is disabled. - -### fn withLogin - -```ts -withLogin(value) -``` - -Login of the service account. - -### fn withName - -```ts -withName(value) -``` - -Name of the service account. - -### fn withOrgId - -```ts -withOrgId(value) -``` - -OrgId is the ID of an organisation the service account belongs to. - -### fn withRole - -```ts -withRole(value) -``` - -OrgRole is a Grafana Organization Role which can be 'Viewer', 'Editor', 'Admin'. - -Accepted values for `value` are "Admin", "Editor", "Viewer" - -### fn withTeams - -```ts -withTeams(value) -``` - -Teams is a list of teams the service account belongs to. - -### fn withTeamsMixin - -```ts -withTeamsMixin(value) -``` - -Teams is a list of teams the service account belongs to. - -### fn withTokens - -```ts -withTokens(value) -``` - -Tokens is the number of active tokens for the service account. -Tokens are used to authenticate the service account against Grafana. diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/team.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/team.md deleted file mode 100644 index d9b935f..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/team.md +++ /dev/null @@ -1,82 +0,0 @@ -# team - -grafonnet.team - -## Index - -* [`fn withAccessControl(value)`](#fn-withaccesscontrol) -* [`fn withAccessControlMixin(value)`](#fn-withaccesscontrolmixin) -* [`fn withAvatarUrl(value)`](#fn-withavatarurl) -* [`fn withEmail(value)`](#fn-withemail) -* [`fn withMemberCount(value)`](#fn-withmembercount) -* [`fn withName(value)`](#fn-withname) -* [`fn withOrgId(value)`](#fn-withorgid) -* [`fn withPermission(value)`](#fn-withpermission) - -## Fields - -### fn withAccessControl - -```ts -withAccessControl(value) -``` - -AccessControl metadata associated with a given resource. - -### fn withAccessControlMixin - -```ts -withAccessControlMixin(value) -``` - -AccessControl metadata associated with a given resource. - -### fn withAvatarUrl - -```ts -withAvatarUrl(value) -``` - -AvatarUrl is the team's avatar URL. - -### fn withEmail - -```ts -withEmail(value) -``` - -Email of the team. - -### fn withMemberCount - -```ts -withMemberCount(value) -``` - -MemberCount is the number of the team members. - -### fn withName - -```ts -withName(value) -``` - -Name of the team. - -### fn withOrgId - -```ts -withOrgId(value) -``` - -OrgId is the ID of an organisation the team belongs to. - -### fn withPermission - -```ts -withPermission(value) -``` - - - -Accepted values for `value` are 0, 1, 2, 4 diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/util.md b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/util.md deleted file mode 100644 index b7f621f..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/docs/grafonnet/util.md +++ /dev/null @@ -1,82 +0,0 @@ -# util - -Helper functions that work well with Grafonnet. - -## Index - -* [`obj dashboard`](#obj-dashboard) - * [`fn getOptionsForCustomQuery(query)`](#fn-dashboardgetoptionsforcustomquery) -* [`obj grid`](#obj-grid) - * [`fn makeGrid(panels, panelWidth, panelHeight)`](#fn-gridmakegrid) -* [`obj panel`](#obj-panel) - * [`fn setPanelIDs(panels)`](#fn-panelsetpanelids) -* [`obj string`](#obj-string) - * [`fn slugify(string)`](#fn-stringslugify) - -## Fields - -### obj dashboard - - -#### fn dashboard.getOptionsForCustomQuery - -```ts -getOptionsForCustomQuery(query) -``` - -`getOptionsForCustomQuery` provides values for the `options` and `current` fields. -These are required for template variables of type 'custom'but do not automatically -get populated by Grafana when importing a dashboard from JSON. - -This is a bit of a hack and should always be called on functions that set `type` on -a template variable (see the dashboard.templating.list veneer). Ideally Grafana -populates these fields from the `query` value but this provides a backwards -compatible solution. - - -### obj grid - - -#### fn grid.makeGrid - -```ts -makeGrid(panels, panelWidth, panelHeight) -``` - -`makeGrid` returns an array of `panels` organized in a grid with equal `panelWidth` -and `panelHeight`. Row panels are used as "linebreaks", if a Row panel is collapsed, -then all panels below it will be folded into the row. - -This function will use the full grid of 24 columns, setting `panelWidth` to a value -that can divide 24 into equal parts will fill up the page nicely. (1, 2, 3, 4, 6, 8, 12) -Other value for `panelWidth` will leave a gap on the far right. - - -### obj panel - - -#### fn panel.setPanelIDs - -```ts -setPanelIDs(panels) -``` - -`setPanelIDs` ensures that all `panels` have a unique ID, this functions is used in -`dashboard.withPanels` and `dashboard.withPanelsMixin` to provide a consistent -experience. - -used in ../veneer/dashboard.libsonnet - - -### obj string - - -#### fn string.slugify - -```ts -slugify(string) -``` - -`slugify` will create a simple slug from `string`, keeping only alphanumeric -characters and replacing spaces with dashes. - diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/grafana-version b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/grafana-version deleted file mode 100644 index b2a2d23..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/grafana-version +++ /dev/null @@ -1 +0,0 @@ -v10.0.0 \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/jsonnetfile.json b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/jsonnetfile.json deleted file mode 100644 index c3b22b3..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/jsonnetfile.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "dependencies": [ - { - "source": { - "git": { - "remote": "https://github.com/grafana/grafonnet.git", - "subdir": "grafonnet-base" - } - }, - "version": "main" - }, - { - "source": { - "git": { - "remote": "https://github.com/grafana/grok.git", - "subdir": "jsonnet/v10.0.0" - } - }, - "version": "main" - } - ], - "legacyImports": false, - "version": 1 -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/main.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/main.libsonnet deleted file mode 100644 index fb60978..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/main.libsonnet +++ /dev/null @@ -1,4 +0,0 @@ -local grafonnet = import 'github.com/grafana/grafonnet/grafonnet-base/main.libsonnet'; -local schemas = import './schemas.libsonnet'; -local version = importstr './grafana-version'; -grafonnet.new(schemas, version) diff --git a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/schemas.libsonnet b/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/schemas.libsonnet deleted file mode 100644 index ae7c8fe..0000000 --- a/vendor/github.com/grafana/grafonnet/gen/grafonnet-v10.0.0/schemas.libsonnet +++ /dev/null @@ -1 +0,0 @@ -import 'github.com/grafana/grok/jsonnet/v10.0.0/imports.libsonnet' diff --git a/vendor/github.com/grafana/grafonnet/grafonnet-base/helpers.libsonnet b/vendor/github.com/grafana/grafonnet/grafonnet-base/helpers.libsonnet deleted file mode 100644 index 28d85b4..0000000 --- a/vendor/github.com/grafana/grafonnet/grafonnet-base/helpers.libsonnet +++ /dev/null @@ -1,173 +0,0 @@ -local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; -local xtd = import 'github.com/jsonnet-libs/xtd/main.libsonnet'; - -{ - local root = self, - - // Grabs last item in an array - last(arr): xtd.array.slice(arr, -1)[0], - - // Returns the whole array except the last item - allButLast(arr): xtd.array.slice(arr, 0, -1), - - // Gets the content from source on a specified JSONPath - getContent(source, path): - xtd.jsonpath.getJSONPath(source, path), - - // Sets the content on a specified ~JSONPath - setContent(content, path): - std.foldr( - function(k, acc) - { [k]+: acc }, - xtd.string.splitEscape(path, '.'), - content - ), - - // Hides the content in source on a specified ~JSONPath - hideContent(source, path): - local splitPath = xtd.string.splitEscape(path, '.'); - local content = root.getContent(source, path); - std.foldr( - function(k, acc) - { [k]+: acc }, - root.allButLast(splitPath), - { [root.last(splitPath)]:: content } - ), - - // Removes the content in source on a specified ~JSONPath - removeContent(source, path): - local splitPath = xtd.string.splitEscape(path, '.'); - std.foldr( - function(k, acc) - { [k]+: acc }, - root.allButLast(splitPath), - { [root.last(splitPath)]:: {} } - ), - - // Transform moves the content from JSONPath `from` to JSONPath `to` in `source` - transform(source, from, to): - local content = root.getContent(source, from); - if content == null - then {} - else root.setContent(content, to) - , - - // This functions transforms the canonical groupings representation to an array that can - // be processed by `transform()`. Example groupings object: - // local groupings = { - // toPath: [ - // 'from.path.one', - // 'from.path.two', - // ], - // }, - groupingsToTransformArray(groupings, keyPrefix='', keySuffix='', separator='.'): - [ - { - local splitFromPath = xtd.string.splitEscape(fromPath, '.'), - local lastKey = - keyPrefix - + root.last(splitFromPath) - + keySuffix, - - from: - std.join( - separator, - root.allButLast(splitFromPath) - + [lastKey], - ), - to: - toPath - + separator - + lastKey, - } - for toPath in std.objectFields(groupings) - for fromPath in groupings[toPath] - ], - - // Transforms a groupings object from source, including their docstring counterparts - group(source, groupings): - std.foldl( - function(acc, mapping) - acc - + root.transform(source, mapping.from, mapping.to), - root.groupingsToTransformArray(groupings) - + root.groupingsToTransformArray(groupings, '#'), // also regroup docstrings - {} - ), - - // Transforms a groupings object from source, including their docstring counterparts - // Regroup means it gets merged with the `source`. - regroup(source, groupings, base=source): - std.foldl( - function(acc, mapping) - acc - + root.transform( - source, - mapping.from, - mapping.to - ), - root.groupingsToTransformArray(groupings) - + root.groupingsToTransformArray(groupings, '#'), // also regroup docstrings - base - ) - + std.foldl( - function(acc, mapping) - acc - + root.removeContent( - source, - mapping.from - ), - root.groupingsToTransformArray(groupings, '#'), - base - ), - - // Creates a (docs) subpackage from `source` and places it at `to`. - makeSubpackage(source, from, to, docstring=''): - local splitFrom = xtd.string.splitEscape(from, '.'); - local splitTo = xtd.string.splitEscape(to, '.'); - local content = { - '#':: d.package.newSub(root.last(splitTo), docstring), - }; - - root.removeContent( // Hide docstring on root - source, - std.join( - '.', - root.allButLast(splitFrom) - + ['#' + root.last(splitFrom)], - ) - ) - + root.transform(source, from, to) - + root.setContent(content, to), - - // Repackages a field from `source` according to the mapping data. - // local data = [ - // { - // from: 'fromPath', - // to: 'toPath', - // docstring: '', - // }, - // ], - repackage(source, data): - std.foldl( - function(acc, mapping) - acc + - root.makeSubpackage( - source, - mapping.from, - mapping.to, - mapping.docstring - ), - data, - {} - ), - - // Remove fields from `source`, `paths` is an array of path strings - removePaths(source, paths): - std.foldl( - function(acc, path) - acc + root.removeContent(source, path), - paths, - {} - ), -} diff --git a/vendor/github.com/grafana/grafonnet/grafonnet-base/jsonnetfile.json b/vendor/github.com/grafana/grafonnet/grafonnet-base/jsonnetfile.json deleted file mode 100644 index fa63410..0000000 --- a/vendor/github.com/grafana/grafonnet/grafonnet-base/jsonnetfile.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "version": 1, - "dependencies": [ - { - "source": { - "git": { - "remote": "https://github.com/crdsonnet/crdsonnet.git", - "subdir": "crdsonnet" - } - }, - "version": "master" - } - ], - "legacyImports": true -} diff --git a/vendor/github.com/grafana/grafonnet/grafonnet-base/main.libsonnet b/vendor/github.com/grafana/grafonnet/grafonnet-base/main.libsonnet deleted file mode 100644 index 625e285..0000000 --- a/vendor/github.com/grafana/grafonnet/grafonnet-base/main.libsonnet +++ /dev/null @@ -1,346 +0,0 @@ -local crdsonnet = import 'github.com/crdsonnet/crdsonnet/crdsonnet/main.libsonnet'; -local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; -local xtd = import 'github.com/jsonnet-libs/xtd/main.libsonnet'; - -local util = import './util/main.libsonnet'; -local veneer = import './veneer/main.libsonnet'; - -{ - local root = self, - - // Some plugins are named differently, this has been resolved in the Grafana code base - // but no reflected in the JSON schema. - // source: https://github.com/grafana/grafana/blob/0ee9d11a9148f517fed57bd4c9b840480993cf42/pkg/kindsys/report.go#L285 - local irregularPluginNames = { - // Panel - alertgroups: 'alertGroups', - annotationslist: 'annolist', - dashboardlist: 'dashlist', - nodegraph: 'nodeGraph', - statetimeline: 'state-timeline', - statushistory: 'status-history', - tableold: 'table-old', - // Datasource - googlecloudmonitoring: 'cloud-monitoring', - azuremonitor: 'grafana-azure-monitor-datasource', - microsoftsqlserver: 'mssql', - postgresql: 'postgres', - }, - - // Used to fake render missing schemas - local genericSchema(title) = - root.restructure({ - info: { - title: title, - }, - components: { - schemas: { - [title]: { - type: 'object', - }, - }, - }, - }), - - new(schemas, version): - local dashboardSchema = std.filter( - function(schema) schema.info.title == 'dashboard', - schemas - )[0]; - - local allSchemaTitles = std.map(function(x) x.info.title, schemas); - - local filteredSchemas = { - core: std.filterMap( - function(schema) - !std.endsWith(schema.info.title, 'PanelCfg') - && !std.endsWith(schema.info.title, 'DataQuery'), - function(schema) root.restructure(schema), - schemas - ), - - local missingPanelSchemas = [ - 'CandlestickPanelCfg', - 'CanvasPanelCfg', - ], - panel: - [ - genericSchema(title) - for title in missingPanelSchemas - if !std.member(allSchemaTitles, title) - ] - + std.filterMap( - function(schema) std.endsWith(schema.info.title, 'PanelCfg'), - function(schema) root.restructure(schema), - schemas - ), - - query: std.filterMap( - function(schema) std.endsWith(schema.info.title, 'DataQuery'), - function(schema) root.restructure(schema), - schemas, - ), - }; - - { - [schema.info.title]: - root.coreLib.new(schema) - for schema in filteredSchemas.core - } - + { - [k]: - { - [schema.info.title]: - root[k + 'Lib'].new(dashboardSchema, schema) - for schema in filteredSchemas[k] - } - + root.packageDocMixin(k, '') - for k in std.objectFields(filteredSchemas) - if k != 'core' - } - + { - panel+: { - row: - root.rowPanelLib.new(dashboardSchema), - }, - - // Add docs - '#': - d.package.new( - 'grafonnet', - 'github.com/grafana/grafonnet/gen/grafonnet-%s' % version, - 'Jsonnet library for rendering Grafana resources', - 'main.libsonnet', - 'main', - ), - - // Add util functions - util: util, - }, - - - packageDocMixin(name, path): - { - '#': - d.package.newSub( - name, - 'grafonnet.%(path)s%(name)s' % { name: name, path: path } - ), - }, - - formatPanelName(name): - local woDataQuery = std.strReplace(name, 'DataQuery', ''); - local woPanelCfg = std.strReplace(woDataQuery, 'PanelCfg', ''); - local split = xtd.camelcase.split(woPanelCfg); - std.join( - '', - [std.asciiLower(split[0])] - + split[1:] - ), - - restructure(schema): - local title = schema.info.title; - local formatted = root.formatPanelName(title); - - local schemaFixes = { - CloudWatchDataQuery: { - [formatted]: { - type: 'object', - oneOf: [ - { '$ref': '#/components/schemas/CloudWatchAnnotationQuery' }, - { '$ref': '#/components/schemas/CloudWatchLogsQuery' }, - { '$ref': '#/components/schemas/CloudWatchMetricsQuery' }, - ], - }, - - QueryEditorArrayExpression+: { - properties+: { - // Prevent infinite recursion - expressions+: { items: {} }, - }, - }, - }, - AzureMonitorDataQuery: { - [formatted]: { - '$ref': '#/components/schemas/AzureMonitorQuery', - }, - }, - TempoDataQuery: { - [formatted]: { - '$ref': '#/components/schemas/TempoQuery', - }, - }, - }; - - schema { - info+: { - title: formatted, - }, - components+: { - schemas+: - // FIXME: Some schemas follow a different structure, temporarily covering for this. - std.get( - schemaFixes, - title, - { [formatted]: super[title] } - ), - }, - } - , - - docs(main): - d.render(main), - - coreLib: { - new(schema): - local title = schema.info.title; - local spec = - if 'spec' in schema.components.schemas[title].properties - then schema.components.schemas[title].properties.spec - else schema.components.schemas[title]; - - local render = crdsonnet.fromOpenAPI( - 'lib', - spec, - schema, - render='dynamic', - ); - if 'lib' in render - then - render.lib - + root.packageDocMixin(title, '') - + veneer.core(title) - else {}, - }, - - queryLib: { - new(dashboardSchema, schema): - local title = schema.info.title; - local render = crdsonnet.fromOpenAPI( - 'lib', - schema.components.schemas[title], - schema, - render='dynamic', - ); - if 'lib' in render - then - render.lib - + root.packageDocMixin(title, 'query.') - + veneer.query(title) - else {}, - }, - - panelLib: { - // The panelSchema has PanelOptions and PanelFieldConfig that need to replace certain - // fiels in the upstream Panel schema This function fits these schemas in the right - // place for CRDsonnet. - new(dashboardSchema, panelSchema): - local title = panelSchema.info.title; - local subSchema = panelSchema.components.schemas[panelSchema.info.title]; - local customSubSchema = - panelSchema.components.schemas[panelSchema.info.title] { - type: 'object', - [if 'properties' in subSchema then 'properties']+: { - [if 'PanelOptions' in subSchema.properties then 'options']: - subSchema.properties.PanelOptions, - [if 'PanelFieldConfig' in subSchema.properties then 'fieldConfig']: { - type: 'object', - properties+: { - defaults+: { - type: 'object', - properties+: { - custom: subSchema.properties.PanelFieldConfig, - }, - }, - }, - }, - }, - }; - - local customPanelSchema = - dashboardSchema.components.schemas.Panel { - properties+: { - type: { - const: - std.get( - irregularPluginNames, - std.asciiLower(title), - std.asciiLower(title), - ), - }, - }, - }; - - local parsed = - crdsonnet.fromOpenAPI( - 'customLib', - customSubSchema, - panelSchema, - render='dynamic', - ) - + crdsonnet.fromOpenAPI( - 'panelLib', - customPanelSchema, - dashboardSchema, - render='dynamic', - ); - - local panel = parsed.panelLib + ( - if 'customLib' in parsed - then { - [if 'options' in parsed.customLib then 'options']: - parsed.customLib.options, - [if 'fieldConfig' in parsed.customLib then 'fieldConfig']+: { - defaults+: { - [if 'custom' in parsed.customLib.fieldConfig.defaults then 'custom']: - parsed.customLib.fieldConfig.defaults.custom, - }, - }, - } - else {} - ); - - panel - + root.packageDocMixin(title, 'panel.') - + veneer.panel(title, panel), - }, - - rowPanelLib: { - new(dashboardSchema): - // Move rowPanel schema to panels - local schema = - root.restructure({ - info: { - title: 'RowPanelCfg', - }, - components: { - schemas: - dashboardSchema.components.schemas - { - RowPanelCfg: - dashboardSchema.components.schemas.RowPanel - { properties+: { - type: { const: 'row' }, - panels+: { items: {} }, - } }, - }, - }, - }); - - - local title = schema.info.title; - local render = crdsonnet.fromOpenAPI( - 'lib', - schema.components.schemas[title], - schema, - render='dynamic', - ); - if 'lib' in render - then - local panel = render.lib; - panel - + root.packageDocMixin(title, 'panel.') - + veneer.row('row', panel) - else {}, - }, -} diff --git a/vendor/github.com/grafana/grafonnet/grafonnet-base/util/dashboard.libsonnet b/vendor/github.com/grafana/grafonnet/grafonnet-base/util/dashboard.libsonnet deleted file mode 100644 index 17f7c85..0000000 --- a/vendor/github.com/grafana/grafonnet/grafonnet-base/util/dashboard.libsonnet +++ /dev/null @@ -1,56 +0,0 @@ -local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; -local xtd = import 'github.com/jsonnet-libs/xtd/main.libsonnet'; - -{ - local root = self, - - '#getOptionsForCustomQuery':: d.func.new( - ||| - `getOptionsForCustomQuery` provides values for the `options` and `current` fields. - These are required for template variables of type 'custom'but do not automatically - get populated by Grafana when importing a dashboard from JSON. - - This is a bit of a hack and should always be called on functions that set `type` on - a template variable (see the dashboard.templating.list veneer). Ideally Grafana - populates these fields from the `query` value but this provides a backwards - compatible solution. - |||, - args=[d.arg('query', d.T.string)], - ), - getOptionsForCustomQuery(query): { - local values = root.parseCustomQuery(query), - current: root.getCurrentFromValues(values), - options: root.getOptionsFromValues(values), - }, - - getCurrentFromValues(values): { - selected: false, - text: values[0].key, - value: values[0].value, - }, - - getOptionsFromValues(values): - std.mapWithIndex( - function(i, item) { - selected: i == 0, - text: item.key, - value: item.value, - }, - values - ), - - parseCustomQuery(query): - std.map( - function(v) - // Split items into key:value pairs - local split = std.splitLimit(v, ' : ', 1); - { - key: std.stripChars(split[0], ' '), - value: - if std.length(split) == 2 - then std.stripChars(split[1], ' ') - else self.key, - }, - xtd.string.splitEscape(query, ',') // Split query by comma, unless the comma is escaped - ), -} diff --git a/vendor/github.com/grafana/grafonnet/grafonnet-base/util/grid.libsonnet b/vendor/github.com/grafana/grafonnet/grafonnet-base/util/grid.libsonnet deleted file mode 100644 index 6ee05ce..0000000 --- a/vendor/github.com/grafana/grafonnet/grafonnet-base/util/grid.libsonnet +++ /dev/null @@ -1,134 +0,0 @@ -local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; - -{ - local root = self, - - local rowPanelHeight = 1, - local gridWidth = 24, - - // Calculates the number of rows for a set of panels. - countRows(panels, panelWidth): - std.ceil(std.length(panels) / std.floor(gridWidth / panelWidth)), - - // Calculates gridPos for a panel based on its index, width and height. - gridPosForIndex(index, panelWidth, panelHeight, startY): { - local panelsPerRow = std.floor(gridWidth / panelWidth), - local row = std.floor(index / panelsPerRow), - local col = std.mod(index, panelsPerRow), - gridPos: { - w: panelWidth, - h: panelHeight, - x: panelWidth * col, - y: startY + (panelHeight * row) + row, - }, - }, - - // Configures gridPos for each panel in a grid with equal width and equal height. - makePanelGrid(panels, panelWidth, panelHeight, startY): - std.mapWithIndex( - function(i, panel) - panel + root.gridPosForIndex(i, panelWidth, panelHeight, startY), - panels - ), - - '#makeGrid':: d.func.new( - ||| - `makeGrid` returns an array of `panels` organized in a grid with equal `panelWidth` - and `panelHeight`. Row panels are used as "linebreaks", if a Row panel is collapsed, - then all panels below it will be folded into the row. - - This function will use the full grid of 24 columns, setting `panelWidth` to a value - that can divide 24 into equal parts will fill up the page nicely. (1, 2, 3, 4, 6, 8, 12) - Other value for `panelWidth` will leave a gap on the far right. - |||, - args=[ - d.arg('panels', d.T.array), - d.arg('panelWidth', d.T.number), - d.arg('panelHeight', d.T.number), - ], - ), - makeGrid(panels, panelWidth=8, panelHeight=8): - // Get indexes for all Row panels - local rowIndexes = [ - i - for i in std.range(0, std.length(panels) - 1) - if panels[i].type == 'row' - ]; - - // Group panels below each Row panel - local rowGroups = - std.mapWithIndex( - function(i, r) { - header: - { - // Set initial values to ensure a value is set - // may be overridden at per Row panel - collapsed: false, - panels: [], - } - + panels[r], - panels: - self.header.panels // prepend panels that are part of the Row panel - + (if i == std.length(rowIndexes) - 1 // last rowIndex - then panels[r + 1:] - else panels[r + 1:rowIndexes[i + 1]]), - rows: root.countRows(self.panels, panelWidth), - }, - rowIndexes - ); - - // Loop over rowGroups - std.foldl( - function(acc, rowGroup) acc { - local y = acc.nexty, - nexty: y // previous y - + (rowGroup.rows * panelHeight) // height of all rows - + rowGroup.rows // plus 1 for each row - + acc.lastRowPanelHeight, - - lastRowPanelHeight: rowPanelHeight, // set height for next round - - // Create a grid per group - local panels = root.makePanelGrid(rowGroup.panels, panelWidth, panelHeight, y + 1), - - panels+: - [ - // Add row header aka the Row panel - rowGroup.header { - gridPos: { - w: gridWidth, // always full length - h: rowPanelHeight, // always 1 height - x: 0, // always at beginning - y: y, - }, - panels: - // If row is collapsed, then store panels inside Row panel - if rowGroup.header.collapsed - then panels - else [], - }, - ] - + ( - // If row is not collapsed, then expose panels directly - if !rowGroup.header.collapsed - then panels - else [] - ), - }, - rowGroups, - { - // Get panels that come before the rowGroups - local panelsBeforeRowGroups = - if std.length(rowIndexes) != 0 - then panels[0:rowIndexes[0]] - else panels, // matches all panels if no Row panels found - local rows = root.countRows(panelsBeforeRowGroups, panelWidth), - nexty: (rows * panelHeight) + rows, - - lastRowPanelHeight: 0, // starts without a row panel - - // Create a grid for the panels that come before the rowGroups - panels: root.makePanelGrid(panelsBeforeRowGroups, panelWidth, panelHeight, 0), - } - ).panels, -} diff --git a/vendor/github.com/grafana/grafonnet/grafonnet-base/util/main.libsonnet b/vendor/github.com/grafana/grafonnet/grafonnet-base/util/main.libsonnet deleted file mode 100644 index 78fe95f..0000000 --- a/vendor/github.com/grafana/grafonnet/grafonnet-base/util/main.libsonnet +++ /dev/null @@ -1,9 +0,0 @@ -local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; - -{ - '#': d.package.newSub('util', 'Helper functions that work well with Grafonnet.'), - dashboard: (import './dashboard.libsonnet'), - grid: (import './grid.libsonnet'), - panel: (import './panel.libsonnet'), - string: (import './string.libsonnet'), -} diff --git a/vendor/github.com/grafana/grafonnet/grafonnet-base/util/panel.libsonnet b/vendor/github.com/grafana/grafonnet/grafonnet-base/util/panel.libsonnet deleted file mode 100644 index 55e0772..0000000 --- a/vendor/github.com/grafana/grafonnet/grafonnet-base/util/panel.libsonnet +++ /dev/null @@ -1,51 +0,0 @@ -local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; - -{ - local this = self, - - '#setPanelIDs':: d.func.new( - ||| - `setPanelIDs` ensures that all `panels` have a unique ID, this functions is used in - `dashboard.withPanels` and `dashboard.withPanelsMixin` to provide a consistent - experience. - - used in ../veneer/dashboard.libsonnet - |||, - args=[ - d.arg('panels', d.T.array), - ] - ), - setPanelIDs(panels): - local infunc(panels, start=1) = - std.foldl( - function(acc, panel) - acc { - index: // Track the index to ensure no duplicates exist. - acc.index - + 1 - + (if panel.type == 'row' - && 'panels' in panel - then std.length(panel.panels) - else 0), - - panels+: [ - panel { id: acc.index } - + ( - if panel.type == 'row' - && 'panels' in panel - then { - panels: - infunc( - panel.panels, - acc.index + 1 - ), - } - else {} - ), - ], - }, - panels, - { index: start, panels: [] } - ).panels; - infunc(panels), -} diff --git a/vendor/github.com/grafana/grafonnet/grafonnet-base/util/string.libsonnet b/vendor/github.com/grafana/grafonnet/grafonnet-base/util/string.libsonnet deleted file mode 100644 index ec5a66e..0000000 --- a/vendor/github.com/grafana/grafonnet/grafonnet-base/util/string.libsonnet +++ /dev/null @@ -1,27 +0,0 @@ -local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; -local xtd = import 'github.com/jsonnet-libs/xtd/main.libsonnet'; - -{ - '#slugify':: d.func.new( - ||| - `slugify` will create a simple slug from `string`, keeping only alphanumeric - characters and replacing spaces with dashes. - |||, - args=[d.arg('string', d.T.string)] - ), - slugify(string): - std.strReplace( - std.asciiLower( - std.join('', [ - string[i] - for i in std.range(0, std.length(string) - 1) - if xtd.ascii.isUpper(string[i]) - || xtd.ascii.isLower(string[i]) - || xtd.ascii.isNumber(string[i]) - || string[i] == ' ' - ]) - ), - ' ', - '-', - ), -} diff --git a/vendor/github.com/grafana/grafonnet/grafonnet-base/veneer/annotation.libsonnet b/vendor/github.com/grafana/grafonnet/grafonnet-base/veneer/annotation.libsonnet deleted file mode 100644 index 697d2a9..0000000 --- a/vendor/github.com/grafana/grafonnet/grafonnet-base/veneer/annotation.libsonnet +++ /dev/null @@ -1,12 +0,0 @@ -local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; - -// The `anno` argument should match `dashboard.annotations.list` -function(anno) - anno { - '#':: d.package.newSub( - 'annotation', - '', - ), - - // TODO: provide API that matches the UI - } diff --git a/vendor/github.com/grafana/grafonnet/grafonnet-base/veneer/core.libsonnet b/vendor/github.com/grafana/grafonnet/grafonnet-base/veneer/core.libsonnet deleted file mode 100644 index f6dc89e..0000000 --- a/vendor/github.com/grafana/grafonnet/grafonnet-base/veneer/core.libsonnet +++ /dev/null @@ -1,313 +0,0 @@ -local util = import '../util/main.libsonnet'; -local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; - -local veneer = { - dashboard+: { - // Remove legacy panels (heatmap, graph), new users should not create those. - // Schemas are also underdeveloped. - panels:: {}, - - '#new':: d.func.new( - 'Creates a new dashboard with a title.', - args=[d.arg('title', d.T.string)] - ), - new(title): - self.withTitle(title) - + self.withSchemaVersion() - + self.withTimezone('utc') - + self.time.withFrom('now-6h') - + self.time.withTo('now'), - - // Hide functions covered by objects - '#withTime':: {}, - '#withTimeMixin':: {}, - '#withTimepicker':: {}, - '#withTimepickerMixin':: {}, - '#withGraphTooltip':: {}, - '#withGraphTooltipMixin':: {}, - - // Hide internal values - '#withGnetId':: {}, - '#withId':: {}, - '#withRevision':: {}, - '#withVersion':: {}, - '#snapshot':: {}, // Snapshots can't be created through code afaik - '#withSnapshot':: {}, - '#withSnapshotMixin':: {}, - - - local withGraphTooltip = super.withGraphTooltip, - graphTooltip+: { - // 0 - Default - // 1 - Shared crosshair - // 2 - Shared tooltip - '#withSharedCrosshair':: d.func.new( - 'Share crosshair on all panels.', - ), - withSharedCrosshair(): - withGraphTooltip(1), - - '#withSharedTooltip':: d.func.new( - 'Share crosshair and tooltip on all panels.', - ), - withSharedTooltip(): - withGraphTooltip(2), - }, - - // Manual veneer for annotations - '#annotations':: {}, - annotation: (import './annotation.libsonnet')(self.annotations.list), - '#withAnnotations': - d.func.new( - ||| - `withAnnotations` adds an array of annotations to a dashboard. - - This function appends passed data to existing values - |||, - args=[d.arg('value', d.T.array)] - ), - withAnnotations(value): self.annotations.withList(value), - '#withAnnotationsMixin': - d.func.new( - ||| - `withAnnotationsMixin` adds an array of annotations to a dashboard. - - This function appends passed data to existing values - |||, - args=[d.arg('value', d.T.array)] - ), - withAnnotationsMixin(value): self.annotations.withListMixin(value), - - // Manual veneer for links (matches UI) - '#links':: {}, - link: (import './link.libsonnet')(self.links), - - // Manual veneer for variables (matches UI) - variable: (import './variable.libsonnet')(self.templating.list), - - '#withVariables': - d.func.new( - ||| - `withVariables` adds an array of variables to a dashboard - |||, - args=[d.arg('value', d.T.array)] - ), - withVariables(value): self.templating.withList(value), - - '#withVariablesMixin': - d.func.new( - ||| - `withVariablesMixin` adds an array of variables to a dashboard. - - This function appends passed data to existing values - |||, - args=[d.arg('value', d.T.array)] - ), - withVariablesMixin(value): self.templating.withListMixin(value), - - - // Hide from docs but keep available for backwards compatibility, use `variable` subpackage instead. - '#templateVariable':: {}, - templateVariable:: self.templating.list, - '#templating':: {}, - templating+: { - list+: { - local this = self, - - '#new':: d.func.new( - 'Create a template variable.', - args=[ - d.arg('name', d.T.string), - d.arg('type', d.T.string, default='query'), - ] - ), - new(name, type='query'): - { - name: name, - type: type, - [if type == 'custom' then 'query']: '', - [if type == 'custom' then 'current']: - util.dashboard.getOptionsForCustomQuery(self.query).current, - [if type == 'custom' then 'options']: - util.dashboard.getOptionsForCustomQuery(self.query).options, - }, - - withType(value): - super.withType(value) - + { - [if value == 'custom' then 'query']: '', - [if value == 'custom' then 'current']: - util.dashboard.getOptionsForCustomQuery(self.query).current, - [if value == 'custom' then 'options']: - util.dashboard.getOptionsForCustomQuery(self.query).options, - }, - - query+: { - '#withLabelValues':: d.func.new( - 'Construct a Prometheus template variable using `label_values()`.', - args=[ - d.arg('label', d.T.string), - d.arg('metric', d.T.string), - ] - ), - withLabelValues(label, metric): { - query: 'label_values(%s, %s)' % [metric, label], - }, - }, - - '#withRegex':: d.func.new( - 'Filter the values with a regex.', - args=[ - d.arg('value', d.T.string), - ] - ), - withRegex(value): { - regex: value, - }, - - // Deliberately undocumented, use `refresh` below - withRefresh(value): { - // 1 - On dashboard load - // 2 - On time range chagne - refresh: value, - }, - - local withRefresh = self.withRefresh, - refresh+: { - '#onLoad':: d.func.new( - 'Refresh label values on dashboard load.' - ), - onLoad(): - withRefresh(1), - - '#onTime':: d.func.new( - 'Refresh label values on time range change.' - ), - onTime(): - withRefresh(2), - }, - - '#withMulti':: d.func.new( - 'Enable selecting multiple values.', - args=[ - d.arg('value', d.T.boolean, default=true), - ] - ), - withMulti(value=true): { - multi: value, - }, - - '#withIncludeAll':: d.func.new( - 'Provide option to select "All" values.', - args=[ - d.arg('value', d.T.boolean, default=true), - ] - ), - withIncludeAll(value=true): { - includeAll: value, - }, - - '#withAllValue':: d.func.new( - ||| - Provide value to use with the `withIncludeAll`, this will also enable - includeAll by default. - |||, - args=[ - d.arg('value', d.T.string), - ] - ), - withAllValue(value): - self.withIncludeAll(true) - + { - allValue: value, - }, - - - '#withSort':: d.func.new( - ||| - Choose how to sort the values in the dropdown. - - This can be called as `withSort() to use the integer values for each - option. If `i==0` then it will be ignored and the other arguments will take - precedence. - - The numerical values are: - - - 1 - Alphabetical (asc) - - 2 - Alphabetical (desc) - - 3 - Numerical (asc) - - 4 - Numerical (desc) - - 5 - Alphabetical (case-insensitive, asc) - - 6 - Alphabetical (case-insensitive, desc) - |||, - args=[ - d.arg('i', d.T.number, default=0), - d.arg('type', d.T.string, default='alphabetical'), - d.arg('asc', d.T.boolean, default=true), - d.arg('caseInsensitive', d.T.boolean, default=false), - ], - ), - withSort(i=0, type='alphabetical', asc=true, caseInsensitive=false): - if i != 0 // provide fallback to numerical value - then { sort: i } - else - { - local mapping = { - alphabethical: - if !caseInsensitive - then - if asc - then 1 - else 2 - else - if asc - then 5 - else 6, - numerical: - if asc - then 3 - else 4, - }, - sort: mapping[type], - }, - - datasource+: { - '#new':: d.func.new( - 'Select a datasource for the variable template query.', - args=[ - d.arg('type', d.T.string), - d.arg('uid', d.T.string), - ] - ), - new(type, uid): - self.withType(type) - + self.withUid(uid), - - '#fromVariable':: d.func.new( - 'Select the datasource from another template variable.', - args=[ - d.arg('variable', d.T.object), - ] - ), - fromVariable(variable): - if variable.type == 'datasource' - then - self.new(variable.query, '${%s}' % variable.name) - else - error "`variable` not of type 'datasource'", - }, - }, - }, - - withPanels(value): { - _panels:: if std.isArray(value) then value else [value], - panels: util.panel.setPanelIDs(self._panels), - }, - withPanelsMixin(value): { - _panels+:: if std.isArray(value) then value else [value], - panels: util.panel.setPanelIDs(self._panels), - }, - }, -}; - -function(name) std.get(veneer, name, default={}) diff --git a/vendor/github.com/grafana/grafonnet/grafonnet-base/veneer/link.libsonnet b/vendor/github.com/grafana/grafonnet/grafonnet-base/veneer/link.libsonnet deleted file mode 100644 index 20909bf..0000000 --- a/vendor/github.com/grafana/grafonnet/grafonnet-base/veneer/link.libsonnet +++ /dev/null @@ -1,65 +0,0 @@ -local helpers = import '../helpers.libsonnet'; -local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; - -// The `link` argument should match `dashboard.links` -function(link) { - - '#':: d.package.newSub( - 'link', - '', - ), - - local groupings = { - options: [ - 'withAsDropdown', - 'withKeepTime', - 'withIncludeVars', - 'withTargetBlank', - ], - linkOptions: [ - 'withTooltip', - 'withIcon', - ], - }, - - local grouped = helpers.group(link, groupings), - - dashboards: - { - '#new':: d.func.new( - ||| - Create links to dashboards based on `tags`. - |||, - args=[ - d.arg('title', d.T.string), - d.arg('tags', d.T.array), - ] - ), - new(title, tags): - link.withTitle(title) - + link.withType('dashboards') - + link.withTags(tags), - - options: grouped.options, - }, - - link: - grouped.linkOptions { - '#new':: d.func.new( - ||| - Create link to an arbitrary URL. - |||, - args=[ - d.arg('title', d.T.string), - d.arg('url', d.T.string), - ] - ), - new(title, url): - link.withTitle(title) - + link.withType('link') - + link.withUrl(url), - - options: grouped.options, - }, - -} diff --git a/vendor/github.com/grafana/grafonnet/grafonnet-base/veneer/main.libsonnet b/vendor/github.com/grafana/grafonnet/grafonnet-base/veneer/main.libsonnet deleted file mode 100644 index 86e0008..0000000 --- a/vendor/github.com/grafana/grafonnet/grafonnet-base/veneer/main.libsonnet +++ /dev/null @@ -1,6 +0,0 @@ -{ - core: (import './core.libsonnet'), - panel: (import './panel.libsonnet'), - row: (import './row.libsonnet'), - query: (import './query.libsonnet'), -} diff --git a/vendor/github.com/grafana/grafonnet/grafonnet-base/veneer/panel.libsonnet b/vendor/github.com/grafana/grafonnet/grafonnet-base/veneer/panel.libsonnet deleted file mode 100644 index 7cf1800..0000000 --- a/vendor/github.com/grafana/grafonnet/grafonnet-base/veneer/panel.libsonnet +++ /dev/null @@ -1,226 +0,0 @@ -local helpers = import '../helpers.libsonnet'; -local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; - -local groupings = { - panelOptions: [ - 'withTitle', - 'withDescription', // both found in root and fieldConfig.defaults ??? - 'withTransparent', - 'withLinks', // depend on sub package - 'withLinksMixin', - 'withRepeat', // to veneer // missing maxPerRow - 'withRepeatDirection', - ], - - queryOptions: [ - 'withDatasource', // In as-code, default to per-query datasources - 'withDatasourceMixin', - 'withMaxDataPoints', - 'withInterval', //minInterval - //'queryCachingTTL', // not in schema - 'withTimeFrom', //relativeTime - 'withTimeShift', - //'hideTimeOverride', // not in schema - 'withTargets', // query, expression or recorded query, not clear from schema - 'withTargetsMixin', - 'withTransformations', // depend on very bare sub package for a very useful feature - 'withTransformationsMixin', - ], - - standardOptions: [ // 'fieldConfig.defaults. - 'fieldConfig.defaults.withUnit', - 'fieldConfig.defaults.withMin', - 'fieldConfig.defaults.withMax', - 'fieldConfig.defaults.withDecimals', - 'fieldConfig.defaults.withDisplayName', - 'fieldConfig.defaults.color', - 'fieldConfig.defaults.withNoValue', - 'fieldConfig.defaults.withLinks', // known as 'Data links' in UI, uses links subpackage - 'fieldConfig.defaults.withLinksMixin', - 'fieldConfig.defaults.withMappings', // known as 'Value mappings' in UI, uses valueMapping subpackage - 'fieldConfig.defaults.withMappingsMixin', - - // fieldOverrides needs to recieve more attention in Grafonnet, the JSON is unintuitive - // matcher = obj, properties = array, unclear in current grafonnet - 'fieldConfig.withOverrides', // known as 'Overrides' in UI, uses fieldOverrides subpackage - 'fieldConfig.withOverridesMixin', - ], - - 'standardOptions.thresholds': [ - 'fieldConfig.defaults.thresholds.withMode', - 'fieldConfig.defaults.thresholds.withSteps', - 'fieldConfig.defaults.thresholds.withStepsMixin', - ], -}; - -local subPackages = [ - { - from: 'links', - to: 'link', - docstring: '', - }, - { - from: 'transformations', - to: 'transformation', - docstring: '', - }, - { - from: 'fieldConfig.defaults.mappings', - to: 'valueMapping', - docstring: '', - }, - { - from: 'fieldConfig.defaults.thresholds.steps', - to: 'thresholdStep', - docstring: '', - }, -]; - -local toRemove = [ - // Access through more specific attributes - '#withFieldConfig', - '#withFieldConfigMixin', - '#withGridPos', - '#withGridPosMixin', - '#withOptions', - '#withOptionsMixin', - 'fieldConfig.#withDefaults', - 'fieldConfig.#withDefaultsMixin', - 'fieldConfig.defaults.#withColor', - 'fieldConfig.defaults.#withColorMixin', - 'fieldConfig.defaults.#withCustom', - 'fieldConfig.defaults.#withCustomMixin', - 'fieldConfig.defaults.#withThresholds', - 'fieldConfig.defaults.#withThresholdsMixin', - - // Internal - '#withId', - '#withPluginVersion', // The current PluginVersion value should come from the schema, this should be set on `new()`, 9.4/9.5 schema's don't have a value. - '#withRepeatPanelId', - '#withType', - - // Not in UI - '#withLibraryPanel', - '#withLibraryPanelMixin', - '#withTags', // seems to be related to search - '#withTagsMixin', - 'fieldConfig.defaults.#withDescription', - 'fieldConfig.defaults.#withDisplayNameFromDS', - 'fieldConfig.defaults.#withFilterable', // only found in overrides - 'fieldConfig.defaults.#withPath', // also related to overrides - 'fieldConfig.defaults.#withWriteable', - - // Old fields, not used anymore - '#withThresholds', - '#withThresholdsMixin', - '#withTimeRegions', - '#withTimeRegionsMixin', -]; - - -function(name, panel) - helpers.regroup(panel, groupings) - + helpers.repackage(panel, subPackages) - + helpers.removePaths(panel, toRemove) - + { - '#new':: d.func.new( - 'Creates a new %s panel with a title.' % name, - args=[d.arg('title', d.T.string)] - ), - new(title): - self.withTitle(title) - + self.withType() - // Default to Mixed datasource so panels can be datasource agnostic, this - // requires query targets to explicitly set datasource, which is a lot more - // interesting from a reusability standpoint. - + self.datasource.withType('datasource') - + self.datasource.withUid('-- Mixed --'), - - fieldConfig+: { - '#overrides':: {}, - overrides+:: {}, - }, - local overrides = super.fieldConfig.overrides, - fieldOverride: - local matchers = [ - 'byName', - 'byRegexp', - 'byType', - 'byQuery', - 'byValue', // TODO: byValue takes more complex `options` than string - ]; - { - '#':: d.package.newSub( - 'fieldOverride', - ||| - Overrides allow you to customize visualization settings for specific fields or - series. This is accomplished by adding an override rule that targets - a particular set of fields and that can each define multiple options. - - ```jsonnet - fieldOverride.byType.new('number') - + fieldOverride.byType.withPropertiesFromOptions( - panel.standardOptions.withDecimals(2) - + panel.standardOptions.withUnit('s') - ) - ``` - ||| - ), - } + { - [matcher]: { - '#new':: d.fn( - '`new` creates a new override of type `%s`.' % matcher, - args=[ - d.arg('value', d.T.string), - ] - ), - new(value): - overrides.matcher.withId(matcher) - + overrides.matcher.withOptions(value), - - '#withProperty':: d.fn( - ||| - `withProperty` adds a property that needs to be overridden. This function can - be called multiple time, adding more properties. - |||, - args=[ - d.arg('id', d.T.string), - d.arg('value', d.T.any), - ] - ), - withProperty(id, value): - overrides.withPropertiesMixin([ - overrides.properties.withId(id) - + overrides.properties.withValue(value), - ]), - - '#withPropertiesFromOptions':: d.fn( - ||| - `withPropertiesFromOptions` takes an object with properties that need to be - overridden. See example code above. - |||, - args=[ - d.arg('options', d.T.object), - ] - ), - withPropertiesFromOptions(options): - local infunc(input, path=[]) = - std.foldl( - function(acc, p) - acc + ( - if std.isObject(input[p]) - then infunc(input[p], path=path + [p]) - else - overrides.withPropertiesMixin([ - overrides.properties.withId(std.join('.', path + [p])) - + overrides.properties.withValue(input[p]), - ]) - ), - std.objectFields(input), - {} - ); - infunc(options.fieldConfig.defaults), - } - for matcher in matchers - }, - } diff --git a/vendor/github.com/grafana/grafonnet/grafonnet-base/veneer/query.libsonnet b/vendor/github.com/grafana/grafonnet/grafonnet-base/veneer/query.libsonnet deleted file mode 100644 index b05163f..0000000 --- a/vendor/github.com/grafana/grafonnet/grafonnet-base/veneer/query.libsonnet +++ /dev/null @@ -1,90 +0,0 @@ -local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; - - -// Upstream schema `DataQuery.datasource` is not properly defined, this bit of veneer -// provides a generic way for setting the datasource on a query type. -local datasourceFunction(type) = { - '#withDatasource':: d.func.new( - 'Set the datasource for this query.', - args=[ - d.arg('value', d.T.string), - ] - ), - withDatasource(value): { - datasource+: { - type: type, - uid: value, - }, - }, -}; -local veneer = { - loki+: - { - '#new':: d.func.new( - 'Creates a new loki query target for panels.', - args=[ - d.arg('datasource', d.T.string), - d.arg('expr', d.T.string), - ] - ), - new(datasource, expr): - self.withDatasource(datasource) - + self.withExpr(expr), - - } - + datasourceFunction('loki'), - - prometheus+: - { - '#new':: d.func.new( - 'Creates a new prometheus query target for panels.', - args=[ - d.arg('datasource', d.T.string), - d.arg('expr', d.T.string), - ] - ), - new(datasource, expr): - self.withDatasource(datasource) - + self.withExpr(expr), - - '#withIntervalFactor':: d.func.new( - 'Set the interval factor for this query.', - args=[ - d.arg('value', d.T.string), - ] - ), - withIntervalFactor(value): { - intervalFactor: value, - }, - - '#withLegendFormat':: d.func.new( - 'Set the legend format for this query.', - args=[ - d.arg('value', d.T.string), - ] - ), - withLegendFormat(value): { - legendFormat: value, - }, - } - + datasourceFunction('prometheus'), - - tempo+: - { - '#new':: d.func.new( - 'Creates a new tempo query target for panels.', - args=[ - d.arg('datasource', d.T.string), - d.arg('query', d.T.string), - d.arg('filters', d.T.array), - ] - ), - new(datasource, query, filters): - self.withDatasource(datasource) - + self.withQuery(query) - + self.withFilters(filters), - } - + datasourceFunction('tempo'), -}; - -function(name) std.get(veneer, name, default={}) diff --git a/vendor/github.com/grafana/grafonnet/grafonnet-base/veneer/row.libsonnet b/vendor/github.com/grafana/grafonnet/grafonnet-base/veneer/row.libsonnet deleted file mode 100644 index 83236d2..0000000 --- a/vendor/github.com/grafana/grafonnet/grafonnet-base/veneer/row.libsonnet +++ /dev/null @@ -1,12 +0,0 @@ -local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; - -function(name, panel) - { - '#new':: d.func.new( - 'Creates a new %s panel with a title.' % name, - args=[d.arg('title', d.T.string)] - ), - new(title): - self.withTitle(title) - + self.withType(), - } diff --git a/vendor/github.com/grafana/grafonnet/grafonnet-base/veneer/variable.libsonnet b/vendor/github.com/grafana/grafonnet/grafonnet-base/veneer/variable.libsonnet deleted file mode 100644 index 789485a..0000000 --- a/vendor/github.com/grafana/grafonnet/grafonnet-base/veneer/variable.libsonnet +++ /dev/null @@ -1,459 +0,0 @@ -local helpers = import '../helpers.libsonnet'; -local util = import '../util/main.libsonnet'; -local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; - -// The `var` argument should match `dashboard.templating.list` -function(var) { - - '#':: d.package.newSub( - 'variable', - ||| - Example usage: - - ```jsonnet - local g = import 'g.libsonnet'; - local var = g.dashboard.variable; - - local customVar = - var.custom.new( - 'myOptions', - values=['a', 'b', 'c', 'd'], - ) - + var.custom.generalOptions.withDescription( - 'This is a variable for my custom options.' - ) - + var.custom.selectionOptions.withMulti(); - - local queryVar = - var.query.new('queryOptions') - + var.query.queryTypes.withLabelValues( - 'up', - 'instance', - ) - + var.query.withDatasource( - type='prometheus', - uid='mimir-prod', - ) - + var.query.selectionOptions.withIncludeAll(); - - - g.dashboard.new('my dashboard') - + g.dashboard.withVariables([ - customVar, - queryVar, - ]) - ``` - |||, - ), - - local groupings = { - generalOptions: [ - 'withName', - 'withLabel', - 'withDescription', - ], - }, - - local general = - helpers.group(var, groupings) - + { - generalOptions+: - { - showOnDashboard: { - '#withLabelAndValue':: d.func.new(''), - withLabelAndValue(): var.withHide(0), - '#withValueOnly':: d.func.new(''), - withValueOnly(): var.withHide(1), - '#withNothing':: d.func.new(''), - withNothing(): var.withHide(2), - }, - }, - }, - - local selectionOptions = - { - selectionOptions: - { - '#withMulti':: d.func.new( - 'Enable selecting multiple values.', - args=[ - d.arg('value', d.T.boolean, default=true), - ] - ), - withMulti(value=true): { - multi: value, - }, - - '#withIncludeAll':: d.func.new( - ||| - `withIncludeAll` enables an option to include all variables. - - Optionally you can set a `customAllValue`. - |||, - args=[ - d.arg('value', d.T.boolean, default=true), - d.arg('customAllValue', d.T.boolean, default=null), - ] - ), - withIncludeAll(value=true, customAllValue=null): { - includeAll: value, - [if customAllValue != null then 'allValue']: customAllValue, - }, - }, - }, - - query: - general - + selectionOptions - + { - '#new':: d.func.new( - ||| - Create a query template variable. - - `query` argument is optional, this can also be set with `query.queryTypes`. - |||, - args=[ - d.arg('name', d.T.string), - d.arg('query', d.T.string, default=''), - ] - ), - new(name, query=''): - var.withName(name) - + var.withType('query') - + var.withQuery(query), - - '#withDatasource':: d.func.new( - 'Select a datasource for the variable template query.', - args=[ - d.arg('type', d.T.string), - d.arg('uid', d.T.string), - ] - ), - withDatasource(type, uid): - var.datasource.withType(type) - + var.datasource.withUid(uid), - - '#withDatasourceFromVariable':: d.func.new( - 'Select the datasource from another template variable.', - args=[ - d.arg('variable', d.T.object), - ] - ), - withDatasourceFromVariable(variable): - if variable.type == 'datasource' - then self.withDatasource(variable.query, '${%s}' % variable.name) - else error "`variable` not of type 'datasource'", - - '#withRegex':: d.func.new( - ||| - `withRegex` can extract part of a series name or metric node segment. Named - capture groups can be used to separate the display text and value - ([see examples](https://grafana.com/docs/grafana/latest/variables/filter-variables-with-regex#filter-and-modify-using-named-text-and-value-capture-groups)). - |||, - args=[ - d.arg('value', d.T.string), - ] - ), - withRegex(value): { - regex: value, - }, - - '#withSort':: d.func.new( - ||| - Choose how to sort the values in the dropdown. - - This can be called as `withSort() to use the integer values for each - option. If `i==0` then it will be ignored and the other arguments will take - precedence. - - The numerical values are: - - - 1 - Alphabetical (asc) - - 2 - Alphabetical (desc) - - 3 - Numerical (asc) - - 4 - Numerical (desc) - - 5 - Alphabetical (case-insensitive, asc) - - 6 - Alphabetical (case-insensitive, desc) - |||, - args=[ - d.arg('i', d.T.number, default=0), - d.arg('type', d.T.string, default='alphabetical'), - d.arg('asc', d.T.boolean, default=true), - d.arg('caseInsensitive', d.T.boolean, default=false), - ], - ), - withSort(i=0, type='alphabetical', asc=true, caseInsensitive=false): - if i != 0 // provide fallback to numerical value - then { sort: i } - else - { - local mapping = { - alphabetical: - if !caseInsensitive - then - if asc - then 1 - else 2 - else - if asc - then 5 - else 6, - numerical: - if asc - then 3 - else 4, - }, - sort: mapping[type], - }, - - // TODO: Expand with Query types to match GUI - queryTypes: { - '#withLabelValues':: d.func.new( - 'Construct a Prometheus template variable using `label_values()`.', - args=[ - d.arg('label', d.T.string), - d.arg('metric', d.T.string), - ] - ), - withLabelValues(label, metric): - var.withQuery('label_values(%s, %s)' % [metric, label]), - }, - - // Deliberately undocumented, use `refresh` below - withRefresh(value): { - // 1 - On dashboard load - // 2 - On time range chagne - refresh: value, - }, - - local withRefresh = self.withRefresh, - refresh+: { - '#onLoad':: d.func.new( - 'Refresh label values on dashboard load.' - ), - onLoad(): withRefresh(1), - - '#onTime':: d.func.new( - 'Refresh label values on time range change.' - ), - onTime(): withRefresh(2), - }, - }, - - custom: - general - + selectionOptions - + { - '#new':: d.func.new( - ||| - `new` creates a custom template variable. - - The `values` array accepts an object with key/value keys, if it's not an object - then it will be added as a string. - - Example: - ``` - [ - { key: 'mykey', value: 'myvalue' }, - 'myvalue', - 12, - ] - |||, - args=[ - d.arg('name', d.T.string), - d.arg('values', d.T.array), - ] - ), - new(name, values): - var.withName(name) - + var.withType('custom') - + { - // Make values array available in jsonnet - values:: [ - if !std.isObject(item) - then { - key: std.toString(item), - value: std.toString(item), - } - else item - for item in values - ], - - // Render query from values array - query: - std.join(',', [ - std.join(' : ', [item.key, item.value]) - for item in self.values - ]), - - // Set current/options - current: util.dashboard.getCurrentFromValues(self.values), - options: util.dashboard.getOptionsFromValues(self.values), - }, - - withQuery(query): { - values:: util.dashboard.parseCustomQuery(query), - query: query, - }, - }, - - textbox: - general - { - '#new':: d.func.new( - '`new` creates a textbox template variable.', - args=[ - d.arg('name', d.T.string), - d.arg('default', d.T.string, default=''), - ] - ), - new(name, default=''): - var.withName(name) - + var.withType('textbox') - + { - local this = self, - default:: default, - query: self.default, - - // Set current/options - keyvaluedict:: [{ key: this.query, value: this.query }], - current: util.dashboard.getCurrentFromValues(self.keyvaluedict), - options: util.dashboard.getOptionsFromValues(self.keyvaluedict), - }, - }, - - constant: - general - { - '#new':: d.func.new( - '`new` creates a hidden constant template variable.', - args=[ - d.arg('name', d.T.string), - d.arg('value', d.T.string), - ] - ), - new(name, value=''): - var.withName(name) - + var.withType('constant') - + var.withHide(2) - + var.withQuery(value), - }, - - datasource: - general - + selectionOptions - + { - '#new':: d.func.new( - '`new` creates a datasource template variable.', - args=[ - d.arg('name', d.T.string), - d.arg('type', d.T.string), - ] - ), - new(name, type): - var.withName(name) - + var.withType('datasource') - + var.withQuery(type), - - '#withRegex':: d.func.new( - ||| - `withRegex` filter for which data source instances to choose from in the - variable value list. Example: `/^prod/` - |||, - args=[ - d.arg('value', d.T.string), - ] - ), - withRegex(value): { - regex: value, - }, - }, - - interval: - general - { - '#new':: d.func.new( - '`new` creates an interval template variable.', - args=[ - d.arg('name', d.T.string), - d.arg('values', d.T.array), - ] - ), - new(name, values): - var.withName(name) - + var.withType('interval') - + { - // Make values array available in jsonnet - values:: values, - // Render query from values array - query: std.join(',', self.values), - - // Set current/options - keyvaluedict:: [ - { - key: item, - value: item, - } - for item in values - ], - current: util.dashboard.getCurrentFromValues(self.keyvaluedict), - options: util.dashboard.getOptionsFromValues(self.keyvaluedict), - }, - - - '#withAutoOption':: d.func.new( - ||| - `withAutoOption` adds an options to dynamically calculate interval by dividing - time range by the count specified. - - `minInterval' has to be either unit-less or end with one of the following units: - "y, M, w, d, h, m, s, ms". - |||, - args=[ - d.arg('count', d.T.number), - d.arg('minInterval', d.T.string), - ] - ), - withAutoOption(count=30, minInterval='10s'): { - auto: true, - auto_count: count, - auto_min: minInterval, - - // Add auto item to current/options - keyvaluedict:: - [{ key: 'auto', value: '$__auto_interval_' + self.name }] - + super.keyvaluedict, - }, - }, - - adhoc: - general - { - '#new':: d.func.new( - '`new` creates an adhoc template variable for datasource with `type` and `uid`.', - args=[ - d.arg('name', d.T.string), - d.arg('type', d.T.string), - d.arg('uid', d.T.string), - ] - ), - new(name, type, uid): - var.withName(name) - + var.withType('adhoc') - + var.datasource.withType(type) - + var.datasource.withUid(uid), - - '#newFromVariable':: d.func.new( - 'Same as `new` but selecting the datasource from another template variable.', - args=[ - d.arg('name', d.T.string), - d.arg('variable', d.T.object), - ] - ), - newFromDatasourceVariable(name, variable): - if variable.type == 'datasource' - then self.new(name, variable.query, '${%s}' % variable.name) - else error "`variable` not of type 'datasource'", - - }, -} diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/imports.libsonnet b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/imports.libsonnet deleted file mode 100644 index 0f496ab..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/imports.libsonnet +++ /dev/null @@ -1,50 +0,0 @@ -// Code generated - EDITING IS FUTILE. DO NOT EDIT. -// -// Generated by pipeline: -// jsonnet -// Using jennies: -// JsonnetImportsCoreJenny -// -// Run 'go generate ./' from repository root to regenerate. - -[ - import "./kinds/core/dashboard/x/dashboard_types_gen.json", - import "./kinds/core/librarypanel/x/librarypanel_types_gen.json", - import "./kinds/core/playlist/x/playlist_types_gen.json", - import "./kinds/core/preferences/x/preferences_types_gen.json", - import "./kinds/core/publicdashboard/x/publicdashboard_types_gen.json", - import "./kinds/core/serviceaccount/x/serviceaccount_types_gen.json", - import "./kinds/core/team/x/team_types_gen.json", - import "./kinds/composable/azuremonitor/dataquery/x/azuremonitor_types_gen.json", - import "./kinds/composable/cloudwatch/dataquery/x/cloudwatch_types_gen.json", - import "./kinds/composable/elasticsearch/dataquery/x/elasticsearch_types_gen.json", - import "./kinds/composable/loki/dataquery/x/loki_types_gen.json", - import "./kinds/composable/parca/dataquery/x/parca_types_gen.json", - import "./kinds/composable/grafanapyroscope/dataquery/x/grafanapyroscope_types_gen.json", - import "./kinds/composable/prometheus/dataquery/x/prometheus_types_gen.json", - import "./kinds/composable/tempo/dataquery/x/tempo_types_gen.json", - import "./kinds/composable/testdata/dataquery/x/testdata_types_gen.json", - import "./kinds/composable/alertgroups/panelcfg/x/alertgroups_types_gen.json", - import "./kinds/composable/annotationslist/panelcfg/x/annotationslist_types_gen.json", - import "./kinds/composable/barchart/panelcfg/x/barchart_types_gen.json", - import "./kinds/composable/bargauge/panelcfg/x/bargauge_types_gen.json", - import "./kinds/composable/dashboardlist/panelcfg/x/dashboardlist_types_gen.json", - import "./kinds/composable/datagrid/panelcfg/x/datagrid_types_gen.json", - import "./kinds/composable/debug/panelcfg/x/debug_types_gen.json", - import "./kinds/composable/gauge/panelcfg/x/gauge_types_gen.json", - import "./kinds/composable/geomap/panelcfg/x/geomap_types_gen.json", - import "./kinds/composable/heatmap/panelcfg/x/heatmap_types_gen.json", - import "./kinds/composable/histogram/panelcfg/x/histogram_types_gen.json", - import "./kinds/composable/logs/panelcfg/x/logs_types_gen.json", - import "./kinds/composable/news/panelcfg/x/news_types_gen.json", - import "./kinds/composable/nodegraph/panelcfg/x/nodegraph_types_gen.json", - import "./kinds/composable/piechart/panelcfg/x/piechart_types_gen.json", - import "./kinds/composable/stat/panelcfg/x/stat_types_gen.json", - import "./kinds/composable/statetimeline/panelcfg/x/statetimeline_types_gen.json", - import "./kinds/composable/statushistory/panelcfg/x/statushistory_types_gen.json", - import "./kinds/composable/table/panelcfg/x/table_types_gen.json", - import "./kinds/composable/text/panelcfg/x/text_types_gen.json", - import "./kinds/composable/timeseries/panelcfg/x/timeseries_types_gen.json", - import "./kinds/composable/trend/panelcfg/x/trend_types_gen.json", - import "./kinds/composable/xychart/panelcfg/x/xychart_types_gen.json", -] diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/alertgroups/panelcfg/x/alertgroups_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/alertgroups/panelcfg/x/alertgroups_types_gen.json deleted file mode 100644 index 68322af..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/alertgroups/panelcfg/x/alertgroups_types_gen.json +++ /dev/null @@ -1,43 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "AlertGroupsPanelCfg", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "AlertGroupsPanelCfg": { - "type": "object", - "required": [ - "PanelOptions" - ], - "properties": { - "PanelOptions": { - "type": "object", - "required": [ - "labels", - "alertmanager", - "expandAll" - ], - "properties": { - "labels": { - "description": "Comma-separated list of values used to filter alert results", - "type": "string" - }, - "alertmanager": { - "description": "Name of the alertmanager used as a source for alerts", - "type": "string" - }, - "expandAll": { - "description": "Expand all alert groups by default", - "type": "boolean" - } - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/annotationslist/panelcfg/x/annotationslist_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/annotationslist/panelcfg/x/annotationslist_types_gen.json deleted file mode 100644 index de266cf..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/annotationslist/panelcfg/x/annotationslist_types_gen.json +++ /dev/null @@ -1,82 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "AnnotationsListPanelCfg", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "AnnotationsListPanelCfg": { - "type": "object", - "required": [ - "PanelOptions" - ], - "properties": { - "PanelOptions": { - "type": "object", - "required": [ - "onlyFromThisDashboard", - "onlyInTimeRange", - "tags", - "limit", - "showUser", - "showTime", - "showTags", - "navigateToPanel", - "navigateBefore", - "navigateAfter" - ], - "properties": { - "onlyFromThisDashboard": { - "type": "boolean", - "default": false - }, - "onlyInTimeRange": { - "type": "boolean", - "default": false - }, - "tags": { - "type": "array", - "items": { - "type": "string" - } - }, - "limit": { - "type": "integer", - "minimum": 0, - "maximum": 4294967295, - "default": 10 - }, - "showUser": { - "type": "boolean", - "default": true - }, - "showTime": { - "type": "boolean", - "default": true - }, - "showTags": { - "type": "boolean", - "default": true - }, - "navigateToPanel": { - "type": "boolean", - "default": true - }, - "navigateBefore": { - "type": "string", - "default": "10m" - }, - "navigateAfter": { - "type": "string", - "default": "10m" - } - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/azuremonitor/dataquery/x/azuremonitor_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/azuremonitor/dataquery/x/azuremonitor_types_gen.json deleted file mode 100644 index 7ff584c..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/azuremonitor/dataquery/x/azuremonitor_types_gen.json +++ /dev/null @@ -1,711 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "AzureMonitorDataQuery", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "AppInsightsGroupByQuery": { - "type": "object", - "properties": { - "kind": { - "type": "string", - "enum": [ - "AppInsightsGroupByQuery" - ] - }, - "metricName": { - "type": "string" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BaseGrafanaTemplateVariableQuery" - }, - { - "required": [ - "kind", - "metricName" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "AppInsightsMetricNameQuery": { - "type": "object", - "properties": { - "kind": { - "type": "string", - "enum": [ - "AppInsightsMetricNameQuery" - ] - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BaseGrafanaTemplateVariableQuery" - }, - { - "required": [ - "kind" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "AzureLogsQuery": { - "description": "Azure Monitor Logs sub-query properties", - "type": "object", - "properties": { - "query": { - "description": "KQL query to be executed.", - "type": "string" - }, - "resultFormat": { - "$ref": "#/components/schemas/ResultFormat" - }, - "resources": { - "description": "Array of resource URIs to be queried.", - "type": "array", - "items": { - "type": "string" - } - }, - "workspace": { - "description": "Workspace ID. This was removed in Grafana 8, but remains for backwards compat", - "type": "string" - }, - "resource": { - "description": "@deprecated Use resources instead", - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "AzureMetricDimension": { - "type": "object", - "properties": { - "dimension": { - "description": "Name of Dimension to be filtered on.", - "type": "string" - }, - "operator": { - "description": "String denoting the filter operation. Supports 'eq' - equals,'ne' - not equals, 'sw' - starts with. Note that some dimensions may not support all operators.", - "type": "string" - }, - "filters": { - "description": "Values to match with the filter.", - "type": "array", - "items": { - "type": "string" - } - }, - "filter": { - "description": "@deprecated filter is deprecated in favour of filters to support multiselect.", - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "AzureMetricQuery": { - "type": "object", - "properties": { - "resources": { - "description": "Array of resource URIs to be queried.", - "type": "array", - "items": { - "$ref": "#/components/schemas/AzureMonitorResource" - } - }, - "metricNamespace": { - "description": "metricNamespace is used as the resource type (or resource namespace).\nIt's usually equal to the target metric namespace. e.g. microsoft.storage/storageaccounts\nKept the name of the variable as metricNamespace to avoid backward incompatibility issues.", - "type": "string" - }, - "customNamespace": { - "description": "Used as the value for the metricNamespace property when it's different from the resource namespace.", - "type": "string" - }, - "metricName": { - "description": "The metric to query data for within the specified metricNamespace. e.g. UsedCapacity", - "type": "string" - }, - "region": { - "description": "The Azure region containing the resource(s).", - "type": "string" - }, - "timeGrain": { - "description": "The granularity of data points to be queried. Defaults to auto.", - "type": "string" - }, - "aggregation": { - "description": "The aggregation to be used within the query. Defaults to the primaryAggregationType defined by the metric.", - "type": "string" - }, - "dimensionFilters": { - "description": "Filters to reduce the set of data returned. Dimensions that can be filtered on are defined by the metric.", - "type": "array", - "items": { - "$ref": "#/components/schemas/AzureMetricDimension" - } - }, - "top": { - "description": "Maximum number of records to return. Defaults to 10.", - "type": "string" - }, - "allowedTimeGrainsMs": { - "description": "Time grains that are supported by the metric.", - "type": "array", - "items": { - "type": "integer", - "format": "int64" - } - }, - "alias": { - "description": "Aliases can be set to modify the legend labels. e.g. {{ resourceGroup }}. See docs for more detail.", - "type": "string" - }, - "timeGrainUnit": { - "description": "@deprecated", - "type": "string" - }, - "dimension": { - "description": "@deprecated This property was migrated to dimensionFilters and should only be accessed in the migration", - "type": "string" - }, - "dimensionFilter": { - "description": "@deprecated This property was migrated to dimensionFilters and should only be accessed in the migration", - "type": "string" - }, - "metricDefinition": { - "description": "@deprecated Use metricNamespace instead", - "type": "string" - }, - "resourceUri": { - "description": "@deprecated Use resourceGroup, resourceName and metricNamespace instead", - "type": "string" - }, - "resourceGroup": { - "description": "@deprecated Use resources instead", - "type": "string" - }, - "resourceName": { - "description": "@deprecated Use resources instead", - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "AzureMonitorDataQuery": { - "type": "object", - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "AzureMonitorQuery": { - "type": "object", - "properties": { - "subscription": { - "description": "Azure subscription containing the resource(s) to be queried.", - "type": "string" - }, - "subscriptions": { - "description": "Subscriptions to be queried via Azure Resource Graph.", - "type": "array", - "items": { - "type": "string" - } - }, - "azureMonitor": { - "$ref": "#/components/schemas/AzureMetricQuery" - }, - "azureLogAnalytics": { - "$ref": "#/components/schemas/AzureLogsQuery" - }, - "azureResourceGraph": { - "$ref": "#/components/schemas/AzureResourceGraphQuery" - }, - "azureTraces": { - "$ref": "#/components/schemas/AzureTracesQuery" - }, - "grafanaTemplateVariableFn": { - "$ref": "#/components/schemas/GrafanaTemplateVariableQuery" - }, - "resourceGroup": { - "description": "Template variables params. These exist for backwards compatiblity with legacy template variables.", - "type": "string" - }, - "namespace": { - "type": "string" - }, - "resource": { - "type": "string" - }, - "region": { - "description": "Azure Monitor query type.\nqueryType: #AzureQueryType", - "type": "string" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/DataQuery" - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "AzureMonitorResource": { - "type": "object", - "properties": { - "subscription": { - "type": "string" - }, - "resourceGroup": { - "type": "string" - }, - "resourceName": { - "type": "string" - }, - "metricNamespace": { - "type": "string" - }, - "region": { - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "AzureQueryType": { - "description": "Defines the supported queryTypes. GrafanaTemplateVariableFn is deprecated", - "type": "string", - "enum": [ - "Azure Monitor", - "Azure Log Analytics", - "Azure Resource Graph", - "Azure Traces", - "Azure Subscriptions", - "Azure Resource Groups", - "Azure Namespaces", - "Azure Resource Names", - "Azure Metric Names", - "Azure Workspaces", - "Azure Regions", - "Grafana Template Variable Function" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "AzureResourceGraphQuery": { - "type": "object", - "properties": { - "query": { - "description": "Azure Resource Graph KQL query to be executed.", - "type": "string" - }, - "resultFormat": { - "description": "Specifies the format results should be returned as. Defaults to table.", - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "AzureTracesFilter": { - "type": "object", - "required": [ - "property", - "operation", - "filters" - ], - "properties": { - "property": { - "description": "Property name, auto-populated based on available traces.", - "type": "string" - }, - "operation": { - "description": "Comparison operator to use. Either equals or not equals.", - "type": "string" - }, - "filters": { - "description": "Values to filter by.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "AzureTracesQuery": { - "description": "Application Insights Traces sub-query properties", - "type": "object", - "properties": { - "resultFormat": { - "$ref": "#/components/schemas/ResultFormat" - }, - "resources": { - "description": "Array of resource URIs to be queried.", - "type": "array", - "items": { - "type": "string" - } - }, - "operationId": { - "description": "Operation ID. Used only for Traces queries.", - "type": "string" - }, - "traceTypes": { - "description": "Types of events to filter by.", - "type": "array", - "items": { - "type": "string" - } - }, - "filters": { - "description": "Filters for property values.", - "type": "array", - "items": { - "$ref": "#/components/schemas/AzureTracesFilter" - } - }, - "query": { - "description": "KQL query to be executed.", - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "BaseGrafanaTemplateVariableQuery": { - "type": "object", - "properties": { - "rawQuery": { - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "DataQuery": { - "description": "These are the common properties available to all queries in all datasources.\nSpecific implementations will *extend* this interface, adding the required\nproperties for the given context.", - "type": "object", - "required": [ - "refId" - ], - "properties": { - "refId": { - "description": "A unique identifier for the query within the list of targets.\nIn server side expressions, the refId is used as a variable name to identify results.\nBy default, the UI will assign A-\u003eZ; however setting meaningful names may be useful.", - "type": "string" - }, - "hide": { - "description": "true if query is disabled (ie should not be returned to the dashboard)\nNote this does not always imply that the query should not be executed since\nthe results from a hidden query may be used as the input to other queries (SSE etc)", - "type": "boolean" - }, - "queryType": { - "description": "Specify the query flavor\nTODO make this required and give it a default", - "type": "string" - }, - "datasource": { - "description": "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "GrafanaTemplateVariableQuery": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/AppInsightsMetricNameQuery" - }, - { - "$ref": "#/components/schemas/AppInsightsGroupByQuery" - }, - { - "$ref": "#/components/schemas/SubscriptionsQuery" - }, - { - "$ref": "#/components/schemas/ResourceGroupsQuery" - }, - { - "$ref": "#/components/schemas/ResourceNamesQuery" - }, - { - "$ref": "#/components/schemas/MetricNamespaceQuery" - }, - { - "$ref": "#/components/schemas/MetricDefinitionsQuery" - }, - { - "$ref": "#/components/schemas/MetricNamesQuery" - }, - { - "$ref": "#/components/schemas/WorkspacesQuery" - }, - { - "$ref": "#/components/schemas/UnknownQuery" - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "GrafanaTemplateVariableQueryType": { - "type": "string", - "enum": [ - "AppInsightsMetricNameQuery", - "AppInsightsGroupByQuery", - "SubscriptionsQuery", - "ResourceGroupsQuery", - "ResourceNamesQuery", - "MetricNamespaceQuery", - "MetricNamesQuery", - "WorkspacesQuery", - "UnknownQuery" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "MetricDefinitionsQuery": { - "description": "@deprecated Use MetricNamespaceQuery instead", - "type": "object", - "properties": { - "kind": { - "type": "string", - "enum": [ - "MetricDefinitionsQuery" - ] - }, - "subscription": { - "type": "string" - }, - "resourceGroup": { - "type": "string" - }, - "metricNamespace": { - "type": "string" - }, - "resourceName": { - "type": "string" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BaseGrafanaTemplateVariableQuery" - }, - { - "required": [ - "kind", - "subscription", - "resourceGroup" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "MetricNamesQuery": { - "type": "object", - "properties": { - "kind": { - "type": "string", - "enum": [ - "MetricNamesQuery" - ] - }, - "subscription": { - "type": "string" - }, - "resourceGroup": { - "type": "string" - }, - "resourceName": { - "type": "string" - }, - "metricNamespace": { - "type": "string" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BaseGrafanaTemplateVariableQuery" - }, - { - "required": [ - "kind", - "subscription", - "resourceGroup", - "resourceName", - "metricNamespace" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "MetricNamespaceQuery": { - "type": "object", - "properties": { - "kind": { - "type": "string", - "enum": [ - "MetricNamespaceQuery" - ] - }, - "subscription": { - "type": "string" - }, - "resourceGroup": { - "type": "string" - }, - "metricNamespace": { - "type": "string" - }, - "resourceName": { - "type": "string" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BaseGrafanaTemplateVariableQuery" - }, - { - "required": [ - "kind", - "subscription", - "resourceGroup" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ResourceGroupsQuery": { - "type": "object", - "properties": { - "kind": { - "type": "string", - "enum": [ - "ResourceGroupsQuery" - ] - }, - "subscription": { - "type": "string" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BaseGrafanaTemplateVariableQuery" - }, - { - "required": [ - "kind", - "subscription" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ResourceNamesQuery": { - "type": "object", - "properties": { - "kind": { - "type": "string", - "enum": [ - "ResourceNamesQuery" - ] - }, - "subscription": { - "type": "string" - }, - "resourceGroup": { - "type": "string" - }, - "metricNamespace": { - "type": "string" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BaseGrafanaTemplateVariableQuery" - }, - { - "required": [ - "kind", - "subscription", - "resourceGroup", - "metricNamespace" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ResultFormat": { - "type": "string", - "enum": [ - "table", - "time_series", - "trace" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "SubscriptionsQuery": { - "type": "object", - "properties": { - "kind": { - "type": "string", - "enum": [ - "SubscriptionsQuery" - ] - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BaseGrafanaTemplateVariableQuery" - }, - { - "required": [ - "kind" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "UnknownQuery": { - "type": "object", - "properties": { - "kind": { - "type": "string", - "enum": [ - "UnknownQuery" - ] - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BaseGrafanaTemplateVariableQuery" - }, - { - "required": [ - "kind" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "WorkspacesQuery": { - "type": "object", - "properties": { - "kind": { - "type": "string", - "enum": [ - "WorkspacesQuery" - ] - }, - "subscription": { - "type": "string" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BaseGrafanaTemplateVariableQuery" - }, - { - "required": [ - "kind", - "subscription" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/barchart/panelcfg/x/barchart_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/barchart/panelcfg/x/barchart_types_gen.json deleted file mode 100644 index 5882a45..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/barchart/panelcfg/x/barchart_types_gen.json +++ /dev/null @@ -1,505 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "BarChartPanelCfg", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "AxisColorMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "text", - "series" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "AxisConfig": { - "description": "TODO docs", - "type": "object", - "properties": { - "axisPlacement": { - "$ref": "#/components/schemas/AxisPlacement" - }, - "axisColorMode": { - "$ref": "#/components/schemas/AxisColorMode" - }, - "axisLabel": { - "type": "string" - }, - "axisWidth": { - "type": "number" - }, - "axisSoftMin": { - "type": "number" - }, - "axisSoftMax": { - "type": "number" - }, - "axisGridShow": { - "type": "boolean" - }, - "scaleDistribution": { - "$ref": "#/components/schemas/ScaleDistributionConfig" - }, - "axisCenteredZero": { - "type": "boolean" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "AxisPlacement": { - "description": "TODO docs", - "type": "string", - "enum": [ - "auto", - "top", - "right", - "bottom", - "left", - "hidden" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "BarChartPanelCfg": { - "type": "object", - "required": [ - "PanelOptions", - "PanelFieldConfig" - ], - "properties": { - "PanelOptions": { - "type": "object", - "properties": { - "xField": { - "description": "Manually select which field from the dataset to represent the x field.", - "type": "string" - }, - "colorByField": { - "description": "Use the color value for a sibling field to color each bar value.", - "type": "string" - }, - "orientation": { - "description": "Controls the orientation of the bar chart, either vertical or horizontal.", - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/VizOrientation" - } - ] - }, - "barRadius": { - "description": "Controls the radius of each bar.", - "type": "number", - "minimum": 0, - "maximum": 0.5, - "default": 0 - }, - "xTickLabelRotation": { - "description": "Controls the rotation of the x axis labels.", - "type": "integer", - "minimum": -90, - "maximum": 90, - "default": 0 - }, - "xTickLabelMaxLength": { - "description": "Sets the max length that a label can have before it is truncated.", - "type": "integer", - "minimum": 0, - "maximum": 2147483647 - }, - "xTickLabelSpacing": { - "description": "Controls the spacing between x axis labels.\nnegative values indicate backwards skipping behavior", - "type": "integer", - "minimum": -2147483648, - "maximum": 2147483647, - "default": 0 - }, - "stacking": { - "description": "Controls whether bars are stacked or not, either normally or in percent mode.", - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/StackingMode" - } - ] - }, - "showValue": { - "description": "This controls whether values are shown on top or to the left of bars.", - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/VisibilityMode" - } - ] - }, - "barWidth": { - "description": "Controls the width of bars. 1 = Max width, 0 = Min width.", - "type": "number", - "minimum": 0, - "maximum": 1, - "default": 0.97 - }, - "groupWidth": { - "description": "Controls the width of groups. 1 = max with, 0 = min width.", - "type": "number", - "minimum": 0, - "maximum": 1, - "default": 0.7 - }, - "fullHighlight": { - "description": "Enables mode which highlights the entire bar area and shows tooltip when cursor\nhovers over highlighted area", - "type": "boolean", - "default": false - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OptionsWithLegend" - }, - { - "$ref": "#/components/schemas/OptionsWithTooltip" - }, - { - "$ref": "#/components/schemas/OptionsWithTextFormatting" - }, - { - "required": [ - "orientation", - "xTickLabelRotation", - "xTickLabelMaxLength", - "stacking", - "showValue", - "barWidth", - "groupWidth", - "fullHighlight" - ] - } - ] - }, - "PanelFieldConfig": { - "type": "object", - "properties": { - "lineWidth": { - "description": "Controls line width of the bars.", - "type": "integer", - "minimum": 0, - "maximum": 10, - "default": 1 - }, - "fillOpacity": { - "description": "Controls the fill opacity of the bars.", - "type": "integer", - "minimum": 0, - "maximum": 100, - "default": 80 - }, - "gradientMode": { - "description": "Set the mode of the gradient fill. Fill gradient is based on the line color. To change the color, use the standard color scheme field option.\nGradient appearance is influenced by the Fill opacity setting.", - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/GraphGradientMode" - } - ] - }, - "thresholdsStyle": { - "$ref": "#/components/schemas/GraphThresholdsStyleConfig" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/AxisConfig" - }, - { - "$ref": "#/components/schemas/HideableFieldConfig" - } - ] - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "GraphGradientMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "none", - "opacity", - "hue", - "scheme" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "GraphThresholdsStyleConfig": { - "description": "TODO docs", - "type": "object", - "required": [ - "mode" - ], - "properties": { - "mode": { - "$ref": "#/components/schemas/GraphTresholdsStyleMode" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "GraphTresholdsStyleMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "off", - "line", - "dashed", - "area", - "line+area", - "dashed+area", - "series" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "HideSeriesConfig": { - "description": "TODO docs", - "type": "object", - "required": [ - "tooltip", - "legend", - "viz" - ], - "properties": { - "tooltip": { - "type": "boolean" - }, - "legend": { - "type": "boolean" - }, - "viz": { - "type": "boolean" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "HideableFieldConfig": { - "description": "TODO docs", - "type": "object", - "properties": { - "hideFrom": { - "$ref": "#/components/schemas/HideSeriesConfig" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "LegendDisplayMode": { - "description": "TODO docs\nNote: \"hidden\" needs to remain as an option for plugins compatibility", - "type": "string", - "enum": [ - "list", - "table", - "hidden" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "LegendPlacement": { - "description": "TODO docs", - "type": "string", - "enum": [ - "bottom", - "right" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "OptionsWithLegend": { - "description": "TODO docs", - "type": "object", - "required": [ - "legend" - ], - "properties": { - "legend": { - "$ref": "#/components/schemas/VizLegendOptions" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "OptionsWithTextFormatting": { - "description": "TODO docs", - "type": "object", - "properties": { - "text": { - "$ref": "#/components/schemas/VizTextDisplayOptions" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "OptionsWithTooltip": { - "description": "TODO docs", - "type": "object", - "required": [ - "tooltip" - ], - "properties": { - "tooltip": { - "$ref": "#/components/schemas/VizTooltipOptions" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ScaleDistribution": { - "description": "TODO docs", - "type": "string", - "enum": [ - "linear", - "log", - "ordinal", - "symlog" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ScaleDistributionConfig": { - "description": "TODO docs", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "$ref": "#/components/schemas/ScaleDistribution" - }, - "log": { - "type": "number" - }, - "linearThreshold": { - "type": "number" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "SortOrder": { - "description": "TODO docs", - "type": "string", - "enum": [ - "asc", - "desc", - "none" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "StackingMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "none", - "normal", - "percent" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TooltipDisplayMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "single", - "multi", - "none" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VisibilityMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "auto", - "never", - "always" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VizLegendOptions": { - "description": "TODO docs", - "type": "object", - "required": [ - "displayMode", - "placement", - "showLegend", - "calcs" - ], - "properties": { - "displayMode": { - "$ref": "#/components/schemas/LegendDisplayMode" - }, - "placement": { - "$ref": "#/components/schemas/LegendPlacement" - }, - "showLegend": { - "type": "boolean" - }, - "asTable": { - "type": "boolean" - }, - "isVisible": { - "type": "boolean" - }, - "sortBy": { - "type": "string" - }, - "sortDesc": { - "type": "boolean" - }, - "width": { - "type": "number" - }, - "calcs": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VizOrientation": { - "description": "TODO docs", - "type": "string", - "enum": [ - "auto", - "vertical", - "horizontal" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VizTextDisplayOptions": { - "description": "TODO docs", - "type": "object", - "properties": { - "titleSize": { - "description": "Explicit title text size", - "type": "number" - }, - "valueSize": { - "description": "Explicit value text size", - "type": "number" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VizTooltipOptions": { - "description": "TODO docs", - "type": "object", - "required": [ - "mode", - "sort" - ], - "properties": { - "mode": { - "$ref": "#/components/schemas/TooltipDisplayMode" - }, - "sort": { - "$ref": "#/components/schemas/SortOrder" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/bargauge/panelcfg/x/bargauge_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/bargauge/panelcfg/x/bargauge_types_gen.json deleted file mode 100644 index 143b0cd..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/bargauge/panelcfg/x/bargauge_types_gen.json +++ /dev/null @@ -1,172 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "BarGaugePanelCfg", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "BarGaugeDisplayMode": { - "description": "Enum expressing the possible display modes\nfor the bar gauge component of Grafana UI", - "type": "string", - "enum": [ - "basic", - "lcd", - "gradient" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "BarGaugePanelCfg": { - "type": "object", - "required": [ - "PanelOptions" - ], - "properties": { - "PanelOptions": { - "type": "object", - "properties": { - "displayMode": { - "type": "string", - "$ref": "#/components/schemas/BarGaugeDisplayMode" - }, - "valueMode": { - "type": "string", - "$ref": "#/components/schemas/BarGaugeValueMode" - }, - "showUnfilled": { - "type": "boolean", - "default": true - }, - "minVizWidth": { - "type": "integer", - "minimum": 0, - "maximum": 4294967295, - "default": 0 - }, - "minVizHeight": { - "type": "integer", - "minimum": 0, - "maximum": 4294967295, - "default": 10 - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/SingleStatBaseOptions" - }, - { - "required": [ - "displayMode", - "valueMode", - "showUnfilled", - "minVizWidth", - "minVizHeight" - ] - } - ] - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "BarGaugeValueMode": { - "description": "Allows for the table cell gauge display type to set the gauge mode.", - "type": "string", - "enum": [ - "color", - "text", - "hidden" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "OptionsWithTextFormatting": { - "description": "TODO docs", - "type": "object", - "properties": { - "text": { - "$ref": "#/components/schemas/VizTextDisplayOptions" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ReduceDataOptions": { - "description": "TODO docs", - "type": "object", - "required": [ - "calcs" - ], - "properties": { - "values": { - "description": "If true show each row value", - "type": "boolean" - }, - "limit": { - "description": "if showing all values limit", - "type": "number" - }, - "calcs": { - "description": "When !values, pick one value for the whole field", - "type": "array", - "items": { - "type": "string" - } - }, - "fields": { - "description": "Which fields to show. By default this is only numeric fields", - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "SingleStatBaseOptions": { - "description": "TODO docs", - "type": "object", - "properties": { - "reduceOptions": { - "$ref": "#/components/schemas/ReduceDataOptions" - }, - "orientation": { - "$ref": "#/components/schemas/VizOrientation" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OptionsWithTextFormatting" - }, - { - "required": [ - "reduceOptions", - "orientation" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VizOrientation": { - "description": "TODO docs", - "type": "string", - "enum": [ - "auto", - "vertical", - "horizontal" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VizTextDisplayOptions": { - "description": "TODO docs", - "type": "object", - "properties": { - "titleSize": { - "description": "Explicit title text size", - "type": "number" - }, - "valueSize": { - "description": "Explicit value text size", - "type": "number" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/cloudwatch/dataquery/x/cloudwatch_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/cloudwatch/dataquery/x/cloudwatch_types_gen.json deleted file mode 100644 index 04431a5..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/cloudwatch/dataquery/x/cloudwatch_types_gen.json +++ /dev/null @@ -1,632 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "CloudWatchDataQuery", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "CloudWatchAnnotationQuery": { - "description": "Shape of a CloudWatch Annotation query", - "type": "object", - "properties": { - "queryMode": { - "$ref": "#/components/schemas/CloudWatchQueryMode" - }, - "prefixMatching": { - "description": "Enable matching on the prefix of the action name or alarm name, specify the prefixes with actionPrefix and/or alarmNamePrefix", - "type": "boolean" - }, - "actionPrefix": { - "description": "Use this parameter to filter the results of the operation to only those alarms\nthat use a certain alarm action. For example, you could specify the ARN of\nan SNS topic to find all alarms that send notifications to that topic.\ne.g. `arn:aws:sns:us-east-1:123456789012:my-app-` would match `arn:aws:sns:us-east-1:123456789012:my-app-action`\nbut not match `arn:aws:sns:us-east-1:123456789012:your-app-action`", - "type": "string" - }, - "alarmNamePrefix": { - "description": "An alarm name prefix. If you specify this parameter, you receive information\nabout all alarms that have names that start with this prefix.\ne.g. `my-team-service-` would match `my-team-service-high-cpu` but not match `your-team-service-high-cpu`", - "type": "string" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/DataQuery" - }, - { - "$ref": "#/components/schemas/MetricStat" - }, - { - "required": [ - "queryMode" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "CloudWatchDataQuery": { - "type": "object", - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "CloudWatchLogsQuery": { - "description": "Shape of a CloudWatch Logs query", - "type": "object", - "properties": { - "queryMode": { - "$ref": "#/components/schemas/CloudWatchQueryMode" - }, - "id": { - "type": "string" - }, - "region": { - "description": "AWS region to query for the logs", - "type": "string" - }, - "expression": { - "description": "The CloudWatch Logs Insights query to execute", - "type": "string" - }, - "statsGroups": { - "description": "Fields to group the results by, this field is automatically populated whenever the query is updated", - "type": "array", - "items": { - "type": "string" - } - }, - "logGroups": { - "description": "Log groups to query", - "type": "array", - "items": { - "$ref": "#/components/schemas/LogGroup" - } - }, - "logGroupNames": { - "description": "@deprecated use logGroups", - "type": "array", - "items": { - "type": "string" - } - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/DataQuery" - }, - { - "required": [ - "queryMode", - "id", - "region" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "CloudWatchMetricsQuery": { - "description": "Shape of a CloudWatch Metrics query", - "type": "object", - "properties": { - "queryMode": { - "$ref": "#/components/schemas/CloudWatchQueryMode" - }, - "metricQueryType": { - "$ref": "#/components/schemas/MetricQueryType" - }, - "metricEditorMode": { - "$ref": "#/components/schemas/MetricEditorMode" - }, - "id": { - "description": "ID can be used to reference other queries in math expressions. The ID can include numbers, letters, and underscore, and must start with a lowercase letter.", - "type": "string" - }, - "alias": { - "description": "Deprecated: use label\n@deprecated use label", - "type": "string" - }, - "label": { - "description": "Change the time series legend names using dynamic labels. See https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html for more details.", - "type": "string" - }, - "expression": { - "description": "Math expression query", - "type": "string" - }, - "sqlExpression": { - "description": "When the metric query type is `metricQueryType` is set to `Query`, this field is used to specify the query string.", - "type": "string" - }, - "sql": { - "$ref": "#/components/schemas/SQLExpression" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/DataQuery" - }, - { - "$ref": "#/components/schemas/MetricStat" - }, - { - "required": [ - "id" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "CloudWatchQueryMode": { - "type": "string", - "enum": [ - "Metrics", - "Logs", - "Annotations" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "DataQuery": { - "description": "These are the common properties available to all queries in all datasources.\nSpecific implementations will *extend* this interface, adding the required\nproperties for the given context.", - "type": "object", - "required": [ - "refId" - ], - "properties": { - "refId": { - "description": "A unique identifier for the query within the list of targets.\nIn server side expressions, the refId is used as a variable name to identify results.\nBy default, the UI will assign A-\u003eZ; however setting meaningful names may be useful.", - "type": "string" - }, - "hide": { - "description": "true if query is disabled (ie should not be returned to the dashboard)\nNote this does not always imply that the query should not be executed since\nthe results from a hidden query may be used as the input to other queries (SSE etc)", - "type": "boolean" - }, - "queryType": { - "description": "Specify the query flavor\nTODO make this required and give it a default", - "type": "string" - }, - "datasource": { - "description": "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "Dimensions": { - "description": "A name/value pair that is part of the identity of a metric. For example, you can get statistics for a specific EC2 instance by specifying the InstanceId dimension when you search for metrics.", - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ] - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "LogGroup": { - "type": "object", - "required": [ - "arn", - "name" - ], - "properties": { - "arn": { - "description": "ARN of the log group", - "type": "string" - }, - "name": { - "description": "Name of the log group", - "type": "string" - }, - "accountId": { - "description": "AccountId of the log group", - "type": "string" - }, - "accountLabel": { - "description": "Label of the log group", - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "MetricEditorMode": { - "type": "integer", - "enum": [ - 0, - 1 - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "MetricQueryType": { - "type": "integer", - "enum": [ - 0, - 1 - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "MetricStat": { - "type": "object", - "required": [ - "region", - "namespace" - ], - "properties": { - "region": { - "description": "AWS region to query for the metric", - "type": "string" - }, - "namespace": { - "description": "A namespace is a container for CloudWatch metrics. Metrics in different namespaces are isolated from each other, so that metrics from different applications are not mistakenly aggregated into the same statistics. For example, Amazon EC2 uses the AWS/EC2 namespace.", - "type": "string" - }, - "metricName": { - "description": "Name of the metric", - "type": "string" - }, - "dimensions": { - "$ref": "#/components/schemas/Dimensions" - }, - "matchExact": { - "description": "Only show metrics that exactly match all defined dimension names.", - "type": "boolean" - }, - "period": { - "description": "The length of time associated with a specific Amazon CloudWatch statistic. Can be specified by a number of seconds, 'auto', or as a duration string e.g. '15m' being 15 minutes", - "type": "string" - }, - "accountId": { - "description": "The ID of the AWS account to query for the metric, specifying `all` will query all accounts that the monitoring account is permitted to query.", - "type": "string" - }, - "statistic": { - "description": "Metric data aggregations over specified periods of time. For detailed definitions of the statistics supported by CloudWatch, see https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.", - "type": "string" - }, - "statistics": { - "description": "@deprecated use statistic", - "type": "array", - "items": { - "type": "string" - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "QueryEditorArrayExpression": { - "type": "object", - "required": [ - "type", - "expressions" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "and", - "or" - ] - }, - "expressions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/QueryEditorExpression" - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "QueryEditorExpression": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/QueryEditorArrayExpression" - }, - { - "$ref": "#/components/schemas/QueryEditorPropertyExpression" - }, - { - "$ref": "#/components/schemas/QueryEditorGroupByExpression" - }, - { - "$ref": "#/components/schemas/QueryEditorFunctionExpression" - }, - { - "$ref": "#/components/schemas/QueryEditorFunctionParameterExpression" - }, - { - "$ref": "#/components/schemas/QueryEditorOperatorExpression" - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "QueryEditorExpressionType": { - "type": "string", - "enum": [ - "property", - "operator", - "or", - "and", - "groupBy", - "function", - "functionParameter" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "QueryEditorFunctionExpression": { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/QueryEditorExpressionType" - }, - { - "enum": [ - "function" - ] - } - ] - }, - "name": { - "type": "string" - }, - "parameters": { - "type": "array", - "items": { - "$ref": "#/components/schemas/QueryEditorFunctionParameterExpression" - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "QueryEditorFunctionParameterExpression": { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/QueryEditorExpressionType" - }, - { - "enum": [ - "functionParameter" - ] - } - ] - }, - "name": { - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "QueryEditorGroupByExpression": { - "type": "object", - "required": [ - "type", - "property" - ], - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/QueryEditorExpressionType" - }, - { - "enum": [ - "groupBy" - ] - } - ] - }, - "property": { - "$ref": "#/components/schemas/QueryEditorProperty" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "QueryEditorOperator": { - "description": "TS type is QueryEditorOperator\u003cT extends QueryEditorOperatorValueType\u003e, extended in veneer", - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "value": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "boolean" - }, - { - "type": "number", - "minimum": -9223372036854775808, - "maximum": 9223372036854775807 - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/QueryEditorOperatorType" - } - } - ] - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "QueryEditorOperatorExpression": { - "type": "object", - "required": [ - "type", - "property", - "operator" - ], - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/QueryEditorExpressionType" - }, - { - "enum": [ - "operator" - ] - } - ] - }, - "property": { - "$ref": "#/components/schemas/QueryEditorProperty" - }, - "operator": { - "$ref": "#/components/schemas/QueryEditorOperator" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "QueryEditorOperatorType": { - "oneOf": [ - { - "type": "string", - "$schema": "http://json-schema.org/draft-04/schema#" - }, - { - "type": "boolean", - "$schema": "http://json-schema.org/draft-04/schema#" - }, - { - "type": "number", - "minimum": -9223372036854775808, - "maximum": 9223372036854775807, - "$schema": "http://json-schema.org/draft-04/schema#" - } - ] - }, - "QueryEditorOperatorValueType": { - "oneOf": [ - { - "type": "string", - "$schema": "http://json-schema.org/draft-04/schema#" - }, - { - "type": "boolean", - "$schema": "http://json-schema.org/draft-04/schema#" - }, - { - "type": "number", - "minimum": -9223372036854775808, - "maximum": 9223372036854775807, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/QueryEditorOperatorType" - }, - "$schema": "http://json-schema.org/draft-04/schema#" - } - ] - }, - "QueryEditorProperty": { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "$ref": "#/components/schemas/QueryEditorPropertyType" - }, - "name": { - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "QueryEditorPropertyExpression": { - "type": "object", - "required": [ - "type", - "property" - ], - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/QueryEditorExpressionType" - }, - { - "enum": [ - "property" - ] - } - ] - }, - "property": { - "$ref": "#/components/schemas/QueryEditorProperty" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "QueryEditorPropertyType": { - "type": "string", - "enum": [ - "string" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "SQLExpression": { - "type": "object", - "properties": { - "select": { - "$ref": "#/components/schemas/QueryEditorFunctionExpression" - }, - "from": { - "description": "FROM part of the SQL expression", - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/QueryEditorPropertyExpression" - }, - { - "$ref": "#/components/schemas/QueryEditorFunctionExpression" - } - ] - }, - "where": { - "$ref": "#/components/schemas/QueryEditorArrayExpression" - }, - "groupBy": { - "$ref": "#/components/schemas/QueryEditorArrayExpression" - }, - "orderBy": { - "$ref": "#/components/schemas/QueryEditorFunctionExpression" - }, - "orderByDirection": { - "description": "The sort order of the SQL expression, `ASC` or `DESC`", - "type": "string" - }, - "limit": { - "description": "LIMIT part of the SQL expression", - "type": "integer", - "format": "int64" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/dashboardlist/panelcfg/x/dashboardlist_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/dashboardlist/panelcfg/x/dashboardlist_types_gen.json deleted file mode 100644 index 307b5fc..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/dashboardlist/panelcfg/x/dashboardlist_types_gen.json +++ /dev/null @@ -1,78 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "DashboardListPanelCfg", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "DashboardListPanelCfg": { - "type": "object", - "required": [ - "PanelOptions" - ], - "properties": { - "PanelOptions": { - "type": "object", - "required": [ - "keepTime", - "includeVars", - "showStarred", - "showRecentlyViewed", - "showSearch", - "showHeadings", - "maxItems", - "query", - "tags" - ], - "properties": { - "keepTime": { - "type": "boolean", - "default": false - }, - "includeVars": { - "type": "boolean", - "default": false - }, - "showStarred": { - "type": "boolean", - "default": true - }, - "showRecentlyViewed": { - "type": "boolean", - "default": false - }, - "showSearch": { - "type": "boolean", - "default": false - }, - "showHeadings": { - "type": "boolean", - "default": true - }, - "maxItems": { - "type": "integer", - "default": 10 - }, - "query": { - "type": "string", - "default": "" - }, - "folderId": { - "type": "integer" - }, - "tags": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/datagrid/panelcfg/x/datagrid_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/datagrid/panelcfg/x/datagrid_types_gen.json deleted file mode 100644 index 0bef3c8..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/datagrid/panelcfg/x/datagrid_types_gen.json +++ /dev/null @@ -1,35 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "DatagridPanelCfg", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "DatagridPanelCfg": { - "type": "object", - "required": [ - "PanelOptions" - ], - "properties": { - "PanelOptions": { - "type": "object", - "required": [ - "selectedSeries" - ], - "properties": { - "selectedSeries": { - "type": "integer", - "minimum": 0, - "maximum": 2147483647, - "default": 0 - } - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/debug/panelcfg/x/debug_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/debug/panelcfg/x/debug_types_gen.json deleted file mode 100644 index 5b8813c..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/debug/panelcfg/x/debug_types_gen.json +++ /dev/null @@ -1,97 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "DebugPanelCfg", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "DebugMode": { - "type": "string", - "enum": [ - "render", - "events", - "cursor", - "State", - "ThrowError" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "DebugPanelCfg": { - "type": "object", - "required": [ - "UpdateConfig", - "DebugMode", - "PanelOptions" - ], - "properties": { - "UpdateConfig": { - "type": "object", - "required": [ - "render", - "dataChanged", - "schemaChanged" - ], - "properties": { - "render": { - "type": "boolean" - }, - "dataChanged": { - "type": "boolean" - }, - "schemaChanged": { - "type": "boolean" - } - } - }, - "DebugMode": { - "type": "string", - "enum": [ - "render", - "events", - "cursor", - "State", - "ThrowError" - ] - }, - "PanelOptions": { - "type": "object", - "required": [ - "mode" - ], - "properties": { - "mode": { - "$ref": "#/components/schemas/DebugMode" - }, - "counters": { - "$ref": "#/components/schemas/UpdateConfig" - } - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "UpdateConfig": { - "type": "object", - "required": [ - "render", - "dataChanged", - "schemaChanged" - ], - "properties": { - "render": { - "type": "boolean" - }, - "dataChanged": { - "type": "boolean" - }, - "schemaChanged": { - "type": "boolean" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/elasticsearch/dataquery/x/elasticsearch_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/elasticsearch/dataquery/x/elasticsearch_types_gen.json deleted file mode 100644 index fb898e7..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/elasticsearch/dataquery/x/elasticsearch_types_gen.json +++ /dev/null @@ -1,1756 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "ElasticsearchDataQuery", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "Average": { - "type": "object", - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/MetricAggregationType" - }, - { - "enum": [ - "avg" - ] - } - ] - }, - "settings": { - "type": "object", - "properties": { - "script": { - "$ref": "#/components/schemas/InlineScript" - }, - "missing": { - "type": "string" - } - } - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/MetricAggregationWithField" - }, - { - "$ref": "#/components/schemas/MetricAggregationWithMissingSupport" - }, - { - "$ref": "#/components/schemas/MetricAggregationWithInlineScript" - }, - { - "required": [ - "type" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "BaseBucketAggregation": { - "type": "object", - "required": [ - "id", - "type" - ], - "properties": { - "id": { - "type": "string" - }, - "type": { - "$ref": "#/components/schemas/BucketAggregationType" - }, - "settings": {} - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "BaseMetricAggregation": { - "type": "object", - "required": [ - "type", - "id" - ], - "properties": { - "type": { - "$ref": "#/components/schemas/MetricAggregationType" - }, - "id": { - "type": "string" - }, - "hide": { - "type": "boolean" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "BaseMovingAverageModelSettings": { - "type": "object", - "required": [ - "model", - "window", - "predict" - ], - "properties": { - "model": { - "$ref": "#/components/schemas/MovingAverageModel" - }, - "window": { - "type": "string" - }, - "predict": { - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "BasePipelineMetricAggregation": { - "type": "object", - "properties": { - "pipelineAgg": { - "type": "string" - }, - "type": { - "$ref": "#/components/schemas/PipelineMetricAggregationType" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/MetricAggregationWithField" - }, - { - "required": [ - "type" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "BucketAggregation": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/DateHistogram" - }, - { - "$ref": "#/components/schemas/Histogram" - }, - { - "$ref": "#/components/schemas/Terms" - }, - { - "$ref": "#/components/schemas/Filters" - }, - { - "$ref": "#/components/schemas/GeoHashGrid" - }, - { - "$ref": "#/components/schemas/Nested" - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "BucketAggregationType": { - "type": "string", - "enum": [ - "terms", - "filters", - "geohash_grid", - "date_histogram", - "histogram", - "nested" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "BucketAggregationWithField": { - "type": "object", - "properties": { - "field": { - "type": "string" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BaseBucketAggregation" - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "BucketScript": { - "type": "object", - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/PipelineMetricAggregationType" - }, - { - "enum": [ - "bucket_script" - ] - } - ] - }, - "settings": { - "type": "object", - "properties": { - "script": { - "$ref": "#/components/schemas/InlineScript" - } - } - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/PipelineMetricAggregationWithMultipleBucketPaths" - }, - { - "required": [ - "type" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "Count": { - "type": "object", - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/MetricAggregationType" - }, - { - "enum": [ - "count" - ] - } - ] - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BaseMetricAggregation" - }, - { - "required": [ - "type" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "CumulativeSum": { - "type": "object", - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/PipelineMetricAggregationType" - }, - { - "enum": [ - "cumulative_sum" - ] - } - ] - }, - "settings": { - "type": "object", - "properties": { - "format": { - "type": "string" - } - } - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BasePipelineMetricAggregation" - }, - { - "required": [ - "type" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "DataQuery": { - "description": "These are the common properties available to all queries in all datasources.\nSpecific implementations will *extend* this interface, adding the required\nproperties for the given context.", - "type": "object", - "required": [ - "refId" - ], - "properties": { - "refId": { - "description": "A unique identifier for the query within the list of targets.\nIn server side expressions, the refId is used as a variable name to identify results.\nBy default, the UI will assign A-\u003eZ; however setting meaningful names may be useful.", - "type": "string" - }, - "hide": { - "description": "true if query is disabled (ie should not be returned to the dashboard)\nNote this does not always imply that the query should not be executed since\nthe results from a hidden query may be used as the input to other queries (SSE etc)", - "type": "boolean" - }, - "queryType": { - "description": "Specify the query flavor\nTODO make this required and give it a default", - "type": "string" - }, - "datasource": { - "description": "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "DateHistogram": { - "type": "object", - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/BucketAggregationType" - }, - { - "enum": [ - "date_histogram" - ] - } - ] - }, - "settings": { - "$ref": "#/components/schemas/DateHistogramSettings" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BucketAggregationWithField" - }, - { - "required": [ - "type" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "DateHistogramSettings": { - "type": "object", - "properties": { - "interval": { - "type": "string" - }, - "min_doc_count": { - "type": "string" - }, - "trimEdges": { - "type": "string" - }, - "offset": { - "type": "string" - }, - "timeZone": { - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "Derivative": { - "type": "object", - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/PipelineMetricAggregationType" - }, - { - "enum": [ - "derivative" - ] - } - ] - }, - "settings": { - "type": "object", - "properties": { - "unit": { - "type": "string" - } - } - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BasePipelineMetricAggregation" - }, - { - "required": [ - "type" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ElasticsearchDataQuery": { - "type": "object", - "properties": { - "alias": { - "description": "Alias pattern", - "type": "string" - }, - "query": { - "description": "Lucene query", - "type": "string" - }, - "timeField": { - "description": "Name of time field", - "type": "string" - }, - "bucketAggs": { - "description": "List of bucket aggregations", - "type": "array", - "items": { - "$ref": "#/components/schemas/BucketAggregation" - } - }, - "metrics": { - "description": "List of metric aggregations", - "type": "array", - "items": { - "$ref": "#/components/schemas/MetricAggregation" - } - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/DataQuery" - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ExtendedStat": { - "type": "object", - "required": [ - "label", - "value" - ], - "properties": { - "label": { - "type": "string" - }, - "value": { - "$ref": "#/components/schemas/ExtendedStatMetaType" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ExtendedStatMetaType": { - "type": "string", - "enum": [ - "avg", - "min", - "max", - "sum", - "count", - "std_deviation", - "std_deviation_bounds_upper", - "std_deviation_bounds_lower" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ExtendedStats": { - "type": "object", - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/MetricAggregationType" - }, - { - "enum": [ - "extended_stats" - ] - } - ] - }, - "settings": { - "type": "object", - "properties": { - "script": { - "$ref": "#/components/schemas/InlineScript" - }, - "missing": { - "type": "string" - }, - "sigma": { - "type": "string" - } - } - }, - "meta": { - "type": "object" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/MetricAggregationWithField" - }, - { - "$ref": "#/components/schemas/MetricAggregationWithInlineScript" - }, - { - "required": [ - "type" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "Filter": { - "type": "object", - "required": [ - "query", - "label" - ], - "properties": { - "query": { - "type": "string" - }, - "label": { - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "Filters": { - "type": "object", - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/BucketAggregationType" - }, - { - "enum": [ - "filters" - ] - } - ] - }, - "settings": { - "$ref": "#/components/schemas/FiltersSettings" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BaseBucketAggregation" - }, - { - "required": [ - "type" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "FiltersSettings": { - "type": "object", - "properties": { - "filters": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Filter" - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "GeoHashGrid": { - "type": "object", - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/BucketAggregationType" - }, - { - "enum": [ - "geohash_grid" - ] - } - ] - }, - "settings": { - "$ref": "#/components/schemas/GeoHashGridSettings" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BucketAggregationWithField" - }, - { - "required": [ - "type" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "GeoHashGridSettings": { - "type": "object", - "properties": { - "precision": { - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "Histogram": { - "type": "object", - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/BucketAggregationType" - }, - { - "enum": [ - "histogram" - ] - } - ] - }, - "settings": { - "$ref": "#/components/schemas/HistogramSettings" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BucketAggregationWithField" - }, - { - "required": [ - "type" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "HistogramSettings": { - "type": "object", - "properties": { - "interval": { - "type": "string" - }, - "min_doc_count": { - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "InlineScript": { - "oneOf": [ - { - "type": "string", - "$schema": "http://json-schema.org/draft-04/schema#" - }, - { - "type": "object", - "properties": { - "inline": { - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - } - ] - }, - "Logs": { - "type": "object", - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/MetricAggregationType" - }, - { - "enum": [ - "logs" - ] - } - ] - }, - "settings": { - "type": "object", - "properties": { - "limit": { - "type": "string" - } - } - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BaseMetricAggregation" - }, - { - "required": [ - "type" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "Max": { - "type": "object", - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/MetricAggregationType" - }, - { - "enum": [ - "max" - ] - } - ] - }, - "settings": { - "type": "object", - "properties": { - "script": { - "$ref": "#/components/schemas/InlineScript" - }, - "missing": { - "type": "string" - } - } - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/MetricAggregationWithField" - }, - { - "$ref": "#/components/schemas/MetricAggregationWithInlineScript" - }, - { - "required": [ - "type" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "MetricAggregation": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/Count" - }, - { - "$ref": "#/components/schemas/PipelineMetricAggregation" - }, - { - "allOf": [ - { - "$ref": "#/components/schemas/MetricAggregationWithSettings" - }, - { - "not": { - "anyOf": [ - { - "$ref": "#/components/schemas/PipelineMetricAggregation" - } - ] - } - } - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "MetricAggregationType": { - "type": "string", - "enum": [ - "count", - "avg", - "sum", - "min", - "max", - "extended_stats", - "percentiles", - "cardinality", - "raw_document", - "raw_data", - "logs", - "rate", - "top_metrics", - "moving_avg", - "moving_fn", - "derivative", - "serial_diff", - "cumulative_sum", - "bucket_script" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "MetricAggregationWithField": { - "type": "object", - "properties": { - "field": { - "type": "string" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BaseMetricAggregation" - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "MetricAggregationWithInlineScript": { - "type": "object", - "properties": { - "settings": { - "type": "object", - "properties": { - "script": { - "$ref": "#/components/schemas/InlineScript" - } - } - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BaseMetricAggregation" - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "MetricAggregationWithMissingSupport": { - "type": "object", - "properties": { - "settings": { - "type": "object", - "properties": { - "missing": { - "type": "string" - } - } - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BaseMetricAggregation" - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "MetricAggregationWithSettings": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/BucketScript" - }, - { - "$ref": "#/components/schemas/CumulativeSum" - }, - { - "$ref": "#/components/schemas/Derivative" - }, - { - "$ref": "#/components/schemas/SerialDiff" - }, - { - "$ref": "#/components/schemas/RawData" - }, - { - "$ref": "#/components/schemas/RawDocument" - }, - { - "$ref": "#/components/schemas/UniqueCount" - }, - { - "$ref": "#/components/schemas/Percentiles" - }, - { - "$ref": "#/components/schemas/ExtendedStats" - }, - { - "$ref": "#/components/schemas/Min" - }, - { - "$ref": "#/components/schemas/Max" - }, - { - "$ref": "#/components/schemas/Sum" - }, - { - "$ref": "#/components/schemas/Average" - }, - { - "$ref": "#/components/schemas/MovingAverage" - }, - { - "$ref": "#/components/schemas/MovingFunction" - }, - { - "$ref": "#/components/schemas/Logs" - }, - { - "$ref": "#/components/schemas/Rate" - }, - { - "$ref": "#/components/schemas/TopMetrics" - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "Min": { - "type": "object", - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/MetricAggregationType" - }, - { - "enum": [ - "min" - ] - } - ] - }, - "settings": { - "type": "object", - "properties": { - "script": { - "$ref": "#/components/schemas/InlineScript" - }, - "missing": { - "type": "string" - } - } - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/MetricAggregationWithField" - }, - { - "$ref": "#/components/schemas/MetricAggregationWithInlineScript" - }, - { - "required": [ - "type" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "MovingAverage": { - "description": "#MovingAverage's settings are overridden in types.ts", - "type": "object", - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/PipelineMetricAggregationType" - }, - { - "enum": [ - "moving_avg" - ] - } - ] - }, - "settings": { - "type": "object" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BasePipelineMetricAggregation" - }, - { - "required": [ - "type" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "MovingAverageEWMAModelSettings": { - "type": "object", - "properties": { - "model": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/MovingAverageModel" - }, - { - "enum": [ - "ewma" - ] - } - ] - }, - "settings": { - "type": "object", - "properties": { - "alpha": { - "type": "string" - } - } - }, - "minimize": { - "type": "boolean" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BaseMovingAverageModelSettings" - }, - { - "required": [ - "model", - "minimize" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "MovingAverageHoltModelSettings": { - "type": "object", - "properties": { - "model": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/MovingAverageModel" - }, - { - "enum": [ - "holt" - ] - } - ] - }, - "settings": { - "type": "object", - "properties": { - "alpha": { - "type": "string" - }, - "beta": { - "type": "string" - } - } - }, - "minimize": { - "type": "boolean" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BaseMovingAverageModelSettings" - }, - { - "required": [ - "model", - "settings", - "minimize" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "MovingAverageHoltWintersModelSettings": { - "type": "object", - "properties": { - "model": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/MovingAverageModel" - }, - { - "enum": [ - "holt_winters" - ] - } - ] - }, - "settings": { - "type": "object", - "properties": { - "alpha": { - "type": "string" - }, - "beta": { - "type": "string" - }, - "gamma": { - "type": "string" - }, - "period": { - "type": "string" - }, - "pad": { - "type": "boolean" - } - } - }, - "minimize": { - "type": "boolean" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BaseMovingAverageModelSettings" - }, - { - "required": [ - "model", - "settings", - "minimize" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "MovingAverageLinearModelSettings": { - "type": "object", - "properties": { - "model": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/MovingAverageModel" - }, - { - "enum": [ - "linear" - ] - } - ] - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BaseMovingAverageModelSettings" - }, - { - "required": [ - "model" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "MovingAverageModel": { - "type": "string", - "enum": [ - "simple", - "linear", - "ewma", - "holt", - "holt_winters" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "MovingAverageModelOption": { - "type": "object", - "required": [ - "label", - "value" - ], - "properties": { - "label": { - "type": "string" - }, - "value": { - "$ref": "#/components/schemas/MovingAverageModel" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "MovingAverageSimpleModelSettings": { - "type": "object", - "properties": { - "model": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/MovingAverageModel" - }, - { - "enum": [ - "simple" - ] - } - ] - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BaseMovingAverageModelSettings" - }, - { - "required": [ - "model" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "MovingFunction": { - "type": "object", - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/PipelineMetricAggregationType" - }, - { - "enum": [ - "moving_fn" - ] - } - ] - }, - "settings": { - "type": "object", - "properties": { - "window": { - "type": "string" - }, - "script": { - "$ref": "#/components/schemas/InlineScript" - }, - "shift": { - "type": "string" - } - } - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BasePipelineMetricAggregation" - }, - { - "required": [ - "type" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "Nested": { - "type": "object", - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/BucketAggregationType" - }, - { - "enum": [ - "nested" - ] - } - ] - }, - "settings": { - "type": "object" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BucketAggregationWithField" - }, - { - "required": [ - "type" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "Percentiles": { - "type": "object", - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/MetricAggregationType" - }, - { - "enum": [ - "percentiles" - ] - } - ] - }, - "settings": { - "type": "object", - "properties": { - "script": { - "$ref": "#/components/schemas/InlineScript" - }, - "missing": { - "type": "string" - }, - "percents": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/MetricAggregationWithField" - }, - { - "$ref": "#/components/schemas/MetricAggregationWithInlineScript" - }, - { - "required": [ - "type" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "PipelineMetricAggregation": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/MovingAverage" - }, - { - "$ref": "#/components/schemas/Derivative" - }, - { - "$ref": "#/components/schemas/CumulativeSum" - }, - { - "$ref": "#/components/schemas/BucketScript" - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "PipelineMetricAggregationType": { - "type": "string", - "enum": [ - "moving_avg", - "moving_fn", - "derivative", - "serial_diff", - "cumulative_sum", - "bucket_script" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "PipelineMetricAggregationWithMultipleBucketPaths": { - "type": "object", - "properties": { - "pipelineVariables": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PipelineVariable" - } - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BaseMetricAggregation" - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "PipelineVariable": { - "type": "object", - "required": [ - "name", - "pipelineAgg" - ], - "properties": { - "name": { - "type": "string" - }, - "pipelineAgg": { - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "Rate": { - "type": "object", - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/MetricAggregationType" - }, - { - "enum": [ - "rate" - ] - } - ] - }, - "settings": { - "type": "object", - "properties": { - "unit": { - "type": "string" - }, - "mode": { - "type": "string" - } - } - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/MetricAggregationWithField" - }, - { - "required": [ - "type" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "RawData": { - "type": "object", - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/MetricAggregationType" - }, - { - "enum": [ - "raw_data" - ] - } - ] - }, - "settings": { - "type": "object", - "properties": { - "size": { - "type": "string" - } - } - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BaseMetricAggregation" - }, - { - "required": [ - "type" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "RawDocument": { - "type": "object", - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/MetricAggregationType" - }, - { - "enum": [ - "raw_document" - ] - } - ] - }, - "settings": { - "type": "object", - "properties": { - "size": { - "type": "string" - } - } - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BaseMetricAggregation" - }, - { - "required": [ - "type" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "SerialDiff": { - "type": "object", - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/PipelineMetricAggregationType" - }, - { - "enum": [ - "serial_diff" - ] - } - ] - }, - "settings": { - "type": "object", - "properties": { - "lag": { - "type": "string" - } - } - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BasePipelineMetricAggregation" - }, - { - "required": [ - "type" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "Sum": { - "type": "object", - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/MetricAggregationType" - }, - { - "enum": [ - "sum" - ] - } - ] - }, - "settings": { - "type": "object", - "properties": { - "script": { - "$ref": "#/components/schemas/InlineScript" - }, - "missing": { - "type": "string" - } - } - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/MetricAggregationWithField" - }, - { - "$ref": "#/components/schemas/MetricAggregationWithInlineScript" - }, - { - "required": [ - "type" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "Terms": { - "type": "object", - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/BucketAggregationType" - }, - { - "enum": [ - "terms" - ] - } - ] - }, - "settings": { - "$ref": "#/components/schemas/TermsSettings" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BucketAggregationWithField" - }, - { - "required": [ - "type" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TermsOrder": { - "type": "string", - "enum": [ - "desc", - "asc" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TermsSettings": { - "type": "object", - "properties": { - "order": { - "$ref": "#/components/schemas/TermsOrder" - }, - "size": { - "type": "string" - }, - "min_doc_count": { - "type": "string" - }, - "orderBy": { - "type": "string" - }, - "missing": { - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TopMetrics": { - "type": "object", - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/MetricAggregationType" - }, - { - "enum": [ - "top_metrics" - ] - } - ] - }, - "settings": { - "type": "object", - "properties": { - "order": { - "type": "string" - }, - "orderBy": { - "type": "string" - }, - "metrics": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BaseMetricAggregation" - }, - { - "required": [ - "type" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "UniqueCount": { - "type": "object", - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/MetricAggregationType" - }, - { - "enum": [ - "cardinality" - ] - } - ] - }, - "settings": { - "type": "object", - "properties": { - "precision_threshold": { - "type": "string" - }, - "missing": { - "type": "string" - } - } - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/MetricAggregationWithField" - }, - { - "required": [ - "type" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/gauge/panelcfg/x/gauge_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/gauge/panelcfg/x/gauge_types_gen.json deleted file mode 100644 index b1fd877..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/gauge/panelcfg/x/gauge_types_gen.json +++ /dev/null @@ -1,133 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "GaugePanelCfg", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "GaugePanelCfg": { - "type": "object", - "required": [ - "PanelOptions" - ], - "properties": { - "PanelOptions": { - "type": "object", - "properties": { - "showThresholdLabels": { - "type": "boolean", - "default": false - }, - "showThresholdMarkers": { - "type": "boolean", - "default": true - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/SingleStatBaseOptions" - }, - { - "required": [ - "showThresholdLabels", - "showThresholdMarkers" - ] - } - ] - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "OptionsWithTextFormatting": { - "description": "TODO docs", - "type": "object", - "properties": { - "text": { - "$ref": "#/components/schemas/VizTextDisplayOptions" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ReduceDataOptions": { - "description": "TODO docs", - "type": "object", - "required": [ - "calcs" - ], - "properties": { - "values": { - "description": "If true show each row value", - "type": "boolean" - }, - "limit": { - "description": "if showing all values limit", - "type": "number" - }, - "calcs": { - "description": "When !values, pick one value for the whole field", - "type": "array", - "items": { - "type": "string" - } - }, - "fields": { - "description": "Which fields to show. By default this is only numeric fields", - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "SingleStatBaseOptions": { - "description": "TODO docs", - "type": "object", - "properties": { - "reduceOptions": { - "$ref": "#/components/schemas/ReduceDataOptions" - }, - "orientation": { - "$ref": "#/components/schemas/VizOrientation" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OptionsWithTextFormatting" - }, - { - "required": [ - "reduceOptions", - "orientation" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VizOrientation": { - "description": "TODO docs", - "type": "string", - "enum": [ - "auto", - "vertical", - "horizontal" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VizTextDisplayOptions": { - "description": "TODO docs", - "type": "object", - "properties": { - "titleSize": { - "description": "Explicit title text size", - "type": "number" - }, - "valueSize": { - "description": "Explicit value text size", - "type": "number" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/geomap/panelcfg/x/geomap_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/geomap/panelcfg/x/geomap_types_gen.json deleted file mode 100644 index 39d6351..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/geomap/panelcfg/x/geomap_types_gen.json +++ /dev/null @@ -1,349 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "GeomapPanelCfg", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "ControlsOptions": { - "type": "object", - "properties": { - "showZoom": { - "description": "Zoom (upper left)", - "type": "boolean" - }, - "mouseWheelZoom": { - "description": "let the mouse wheel zoom", - "type": "boolean" - }, - "showAttribution": { - "description": "Lower right", - "type": "boolean" - }, - "showScale": { - "description": "Scale options", - "type": "boolean" - }, - "showDebug": { - "description": "Show debug", - "type": "boolean" - }, - "showMeasure": { - "description": "Show measure", - "type": "boolean" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "FrameGeometrySource": { - "type": "object", - "required": [ - "mode" - ], - "properties": { - "mode": { - "$ref": "#/components/schemas/FrameGeometrySourceMode" - }, - "geohash": { - "description": "Field mappings", - "type": "string" - }, - "latitude": { - "type": "string" - }, - "longitude": { - "type": "string" - }, - "wkt": { - "type": "string" - }, - "lookup": { - "type": "string" - }, - "gazetteer": { - "description": "Path to Gazetteer", - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "FrameGeometrySourceMode": { - "type": "string", - "enum": [ - "auto", - "geohash", - "coords", - "lookup" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "GeomapPanelCfg": { - "type": "object", - "required": [ - "PanelOptions", - "MapViewConfig", - "ControlsOptions", - "TooltipOptions", - "TooltipMode", - "MapCenterID" - ], - "properties": { - "PanelOptions": { - "type": "object", - "required": [ - "view", - "controls", - "basemap", - "layers", - "tooltip" - ], - "properties": { - "view": { - "$ref": "#/components/schemas/MapViewConfig" - }, - "controls": { - "$ref": "#/components/schemas/ControlsOptions" - }, - "basemap": { - "$ref": "#/components/schemas/MapLayerOptions" - }, - "layers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MapLayerOptions" - } - }, - "tooltip": { - "$ref": "#/components/schemas/TooltipOptions" - } - } - }, - "MapViewConfig": { - "type": "object", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "string", - "default": "zero" - }, - "lat": { - "type": "integer", - "minimum": -9223372036854775808, - "maximum": 9223372036854775807, - "default": 0 - }, - "lon": { - "type": "integer", - "minimum": -9223372036854775808, - "maximum": 9223372036854775807, - "default": 0 - }, - "zoom": { - "type": "integer", - "minimum": -9223372036854775808, - "maximum": 9223372036854775807, - "default": 1 - }, - "minZoom": { - "type": "integer", - "format": "int64" - }, - "maxZoom": { - "type": "integer", - "format": "int64" - }, - "padding": { - "type": "integer", - "format": "int64" - }, - "allLayers": { - "type": "boolean", - "default": true - }, - "lastOnly": { - "type": "boolean" - }, - "layer": { - "type": "string" - }, - "shared": { - "type": "boolean" - } - } - }, - "ControlsOptions": { - "type": "object", - "properties": { - "showZoom": { - "description": "Zoom (upper left)", - "type": "boolean" - }, - "mouseWheelZoom": { - "description": "let the mouse wheel zoom", - "type": "boolean" - }, - "showAttribution": { - "description": "Lower right", - "type": "boolean" - }, - "showScale": { - "description": "Scale options", - "type": "boolean" - }, - "showDebug": { - "description": "Show debug", - "type": "boolean" - }, - "showMeasure": { - "description": "Show measure", - "type": "boolean" - } - } - }, - "TooltipOptions": { - "type": "object", - "required": [ - "mode" - ], - "properties": { - "mode": { - "$ref": "#/components/schemas/TooltipMode" - } - } - }, - "TooltipMode": { - "type": "string", - "enum": [ - "none", - "details" - ] - }, - "MapCenterID": { - "type": "string", - "enum": [ - "zero", - "coords", - "fit" - ] - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "MapLayerOptions": { - "type": "object", - "required": [ - "type", - "name" - ], - "properties": { - "type": { - "type": "string" - }, - "name": { - "description": "configured unique display name", - "type": "string" - }, - "config": { - "description": "Custom options depending on the type" - }, - "location": { - "$ref": "#/components/schemas/FrameGeometrySource" - }, - "filterData": { - "description": "Defines a frame MatcherConfig that may filter data for the given layer" - }, - "opacity": { - "description": "Common properties:\nhttps://openlayers.org/en/latest/apidoc/module-ol_layer_Base-BaseLayer.html\nLayer opacity (0-1)", - "type": "integer", - "format": "int64" - }, - "tooltip": { - "description": "Check tooltip (defaults to true)", - "type": "boolean" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "MapViewConfig": { - "type": "object", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "string", - "default": "zero" - }, - "lat": { - "type": "integer", - "minimum": -9223372036854775808, - "maximum": 9223372036854775807, - "default": 0 - }, - "lon": { - "type": "integer", - "minimum": -9223372036854775808, - "maximum": 9223372036854775807, - "default": 0 - }, - "zoom": { - "type": "integer", - "minimum": -9223372036854775808, - "maximum": 9223372036854775807, - "default": 1 - }, - "minZoom": { - "type": "integer", - "format": "int64" - }, - "maxZoom": { - "type": "integer", - "format": "int64" - }, - "padding": { - "type": "integer", - "format": "int64" - }, - "allLayers": { - "type": "boolean", - "default": true - }, - "lastOnly": { - "type": "boolean" - }, - "layer": { - "type": "string" - }, - "shared": { - "type": "boolean" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TooltipMode": { - "type": "string", - "enum": [ - "none", - "details" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TooltipOptions": { - "type": "object", - "required": [ - "mode" - ], - "properties": { - "mode": { - "$ref": "#/components/schemas/TooltipMode" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/grafanapyroscope/dataquery/x/grafanapyroscope_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/grafanapyroscope/dataquery/x/grafanapyroscope_types_gen.json deleted file mode 100644 index a2f2ad7..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/grafanapyroscope/dataquery/x/grafanapyroscope_types_gen.json +++ /dev/null @@ -1,86 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "GrafanaPyroscopeDataQuery", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "DataQuery": { - "description": "These are the common properties available to all queries in all datasources.\nSpecific implementations will *extend* this interface, adding the required\nproperties for the given context.", - "type": "object", - "required": [ - "refId" - ], - "properties": { - "refId": { - "description": "A unique identifier for the query within the list of targets.\nIn server side expressions, the refId is used as a variable name to identify results.\nBy default, the UI will assign A-\u003eZ; however setting meaningful names may be useful.", - "type": "string" - }, - "hide": { - "description": "true if query is disabled (ie should not be returned to the dashboard)\nNote this does not always imply that the query should not be executed since\nthe results from a hidden query may be used as the input to other queries (SSE etc)", - "type": "boolean" - }, - "queryType": { - "description": "Specify the query flavor\nTODO make this required and give it a default", - "type": "string" - }, - "datasource": { - "description": "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "GrafanaPyroscopeDataQuery": { - "type": "object", - "properties": { - "labelSelector": { - "description": "Specifies the query label selectors.", - "type": "string", - "default": "{}" - }, - "profileTypeId": { - "description": "Specifies the type of profile to query.", - "type": "string" - }, - "groupBy": { - "description": "Allows to group the results.", - "type": "array", - "items": { - "type": "string" - } - }, - "maxNodes": { - "description": "Sets the maximum number of nodes in the flamegraph.", - "type": "integer", - "format": "int64" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/DataQuery" - }, - { - "required": [ - "labelSelector", - "profileTypeId", - "groupBy" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "PhlareQueryType": { - "type": "string", - "enum": [ - "both", - "profile", - "metrics" - ], - "default": "both", - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/heatmap/panelcfg/x/heatmap_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/heatmap/panelcfg/x/heatmap_types_gen.json deleted file mode 100644 index e7da0df..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/heatmap/panelcfg/x/heatmap_types_gen.json +++ /dev/null @@ -1,853 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "HeatmapPanelCfg", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "AxisColorMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "text", - "series" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "AxisConfig": { - "description": "TODO docs", - "type": "object", - "properties": { - "axisPlacement": { - "$ref": "#/components/schemas/AxisPlacement" - }, - "axisColorMode": { - "$ref": "#/components/schemas/AxisColorMode" - }, - "axisLabel": { - "type": "string" - }, - "axisWidth": { - "type": "number" - }, - "axisSoftMin": { - "type": "number" - }, - "axisSoftMax": { - "type": "number" - }, - "axisGridShow": { - "type": "boolean" - }, - "scaleDistribution": { - "$ref": "#/components/schemas/ScaleDistributionConfig" - }, - "axisCenteredZero": { - "type": "boolean" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "AxisPlacement": { - "description": "TODO docs", - "type": "string", - "enum": [ - "auto", - "top", - "right", - "bottom", - "left", - "hidden" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "CellValues": { - "description": "Controls cell value options", - "type": "object", - "properties": { - "unit": { - "description": "Controls the cell value unit", - "type": "string" - }, - "decimals": { - "description": "Controls the number of decimals for cell values", - "type": "number", - "format": "float" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ExemplarConfig": { - "description": "Controls exemplar options", - "type": "object", - "required": [ - "color" - ], - "properties": { - "color": { - "description": "Sets the color of the exemplar markers", - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "FilterValueRange": { - "description": "Controls the value filter range", - "type": "object", - "properties": { - "le": { - "description": "Sets the filter range to values less than or equal to the given value", - "type": "number", - "format": "float" - }, - "ge": { - "description": "Sets the filter range to values greater than or equal to the given value", - "type": "number", - "format": "float" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "HeatmapCalculationBucketConfig": { - "type": "object", - "properties": { - "mode": { - "$ref": "#/components/schemas/HeatmapCalculationMode" - }, - "value": { - "description": "The number of buckets to use for the axis in the heatmap", - "type": "string" - }, - "scale": { - "$ref": "#/components/schemas/ScaleDistributionConfig" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "HeatmapCalculationMode": { - "type": "string", - "enum": [ - "size", - "count" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "HeatmapCalculationOptions": { - "type": "object", - "properties": { - "xBuckets": { - "$ref": "#/components/schemas/HeatmapCalculationBucketConfig" - }, - "yBuckets": { - "$ref": "#/components/schemas/HeatmapCalculationBucketConfig" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "HeatmapCellLayout": { - "type": "string", - "enum": [ - "le", - "ge", - "unknown", - "auto" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "HeatmapColorMode": { - "description": "Controls the color mode of the heatmap", - "type": "string", - "enum": [ - "opacity", - "scheme" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "HeatmapColorOptions": { - "description": "Controls various color options", - "type": "object", - "required": [ - "scheme", - "fill", - "exponent", - "steps", - "reverse" - ], - "properties": { - "mode": { - "$ref": "#/components/schemas/HeatmapColorMode" - }, - "scheme": { - "description": "Controls the color scheme used", - "type": "string" - }, - "fill": { - "description": "Controls the color fill when in opacity mode", - "type": "string" - }, - "scale": { - "$ref": "#/components/schemas/HeatmapColorScale" - }, - "exponent": { - "description": "Controls the exponent when scale is set to exponential", - "type": "number", - "format": "float" - }, - "steps": { - "description": "Controls the number of color steps", - "type": "integer", - "minimum": 2, - "maximum": 128 - }, - "reverse": { - "description": "Reverses the color scheme", - "type": "boolean" - }, - "min": { - "description": "Sets the minimum value for the color scale", - "type": "number", - "format": "float" - }, - "max": { - "description": "Sets the maximum value for the color scale", - "type": "number", - "format": "float" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "HeatmapColorScale": { - "description": "Controls the color scale of the heatmap", - "type": "string", - "enum": [ - "linear", - "exponential" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "HeatmapLegend": { - "description": "Controls legend options", - "type": "object", - "required": [ - "show" - ], - "properties": { - "show": { - "description": "Controls if the legend is shown", - "type": "boolean" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "HeatmapPanelCfg": { - "type": "object", - "required": [ - "HeatmapColorMode", - "HeatmapColorScale", - "HeatmapColorOptions", - "YAxisConfig", - "CellValues", - "FilterValueRange", - "HeatmapTooltip", - "HeatmapLegend", - "ExemplarConfig", - "RowsHeatmapOptions", - "PanelOptions", - "PanelFieldConfig" - ], - "properties": { - "HeatmapColorMode": { - "description": "Controls the color mode of the heatmap", - "type": "string", - "enum": [ - "opacity", - "scheme" - ] - }, - "HeatmapColorScale": { - "description": "Controls the color scale of the heatmap", - "type": "string", - "enum": [ - "linear", - "exponential" - ] - }, - "HeatmapColorOptions": { - "description": "Controls various color options", - "type": "object", - "required": [ - "scheme", - "fill", - "exponent", - "steps", - "reverse" - ], - "properties": { - "mode": { - "$ref": "#/components/schemas/HeatmapColorMode" - }, - "scheme": { - "description": "Controls the color scheme used", - "type": "string" - }, - "fill": { - "description": "Controls the color fill when in opacity mode", - "type": "string" - }, - "scale": { - "$ref": "#/components/schemas/HeatmapColorScale" - }, - "exponent": { - "description": "Controls the exponent when scale is set to exponential", - "type": "number", - "format": "float" - }, - "steps": { - "description": "Controls the number of color steps", - "type": "integer", - "minimum": 2, - "maximum": 128 - }, - "reverse": { - "description": "Reverses the color scheme", - "type": "boolean" - }, - "min": { - "description": "Sets the minimum value for the color scale", - "type": "number", - "format": "float" - }, - "max": { - "description": "Sets the maximum value for the color scale", - "type": "number", - "format": "float" - } - } - }, - "YAxisConfig": { - "description": "Configuration options for the yAxis", - "type": "object", - "properties": { - "unit": { - "description": "Sets the yAxis unit", - "type": "string" - }, - "reverse": { - "description": "Reverses the yAxis", - "type": "boolean" - }, - "decimals": { - "description": "Controls the number of decimals for yAxis values", - "type": "number", - "format": "float" - }, - "min": { - "description": "Sets the minimum value for the yAxis", - "type": "number", - "format": "float" - }, - "max": { - "description": "Sets the maximum value for the yAxis", - "type": "number", - "format": "float" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/AxisConfig" - } - ] - }, - "CellValues": { - "description": "Controls cell value options", - "type": "object", - "properties": { - "unit": { - "description": "Controls the cell value unit", - "type": "string" - }, - "decimals": { - "description": "Controls the number of decimals for cell values", - "type": "number", - "format": "float" - } - } - }, - "FilterValueRange": { - "description": "Controls the value filter range", - "type": "object", - "properties": { - "le": { - "description": "Sets the filter range to values less than or equal to the given value", - "type": "number", - "format": "float" - }, - "ge": { - "description": "Sets the filter range to values greater than or equal to the given value", - "type": "number", - "format": "float" - } - } - }, - "HeatmapTooltip": { - "description": "Controls tooltip options", - "type": "object", - "required": [ - "show" - ], - "properties": { - "show": { - "description": "Controls if the tooltip is shown", - "type": "boolean" - }, - "yHistogram": { - "description": "Controls if the tooltip shows a histogram of the y-axis values", - "type": "boolean" - } - } - }, - "HeatmapLegend": { - "description": "Controls legend options", - "type": "object", - "required": [ - "show" - ], - "properties": { - "show": { - "description": "Controls if the legend is shown", - "type": "boolean" - } - } - }, - "ExemplarConfig": { - "description": "Controls exemplar options", - "type": "object", - "required": [ - "color" - ], - "properties": { - "color": { - "description": "Sets the color of the exemplar markers", - "type": "string" - } - } - }, - "RowsHeatmapOptions": { - "description": "Controls frame rows options", - "type": "object", - "properties": { - "value": { - "description": "Sets the name of the cell when not calculating from data", - "type": "string" - }, - "layout": { - "$ref": "#/components/schemas/HeatmapCellLayout" - } - } - }, - "PanelOptions": { - "type": "object", - "required": [ - "color", - "showValue", - "yAxis", - "legend", - "tooltip", - "exemplars" - ], - "properties": { - "calculate": { - "description": "Controls if the heatmap should be calculated from data", - "type": "boolean", - "default": false - }, - "calculation": { - "$ref": "#/components/schemas/HeatmapCalculationOptions" - }, - "color": { - "description": "Controls the color options", - "type": "object", - "default": { - "scheme": "Oranges", - "fill": "dark-orange", - "reverse": false, - "exponent": 0.5, - "steps": 64 - }, - "oneOf": [ - { - "allOf": [ - { - "$ref": "#/components/schemas/HeatmapColorOptions" - }, - { - "not": { - "anyOf": [ - { - "required": [ - "scheme", - "fill", - "reverse", - "exponent", - "steps" - ], - "properties": { - "scheme": { - "description": "mode: HeatmapColorMode // TODO: fix after remove when https://github.com/grafana/cuetsy/issues/74 is fixed", - "type": "string", - "enum": [ - "Oranges" - ] - }, - "fill": { - "type": "string", - "enum": [ - "dark-orange" - ] - }, - "reverse": { - "description": "scale: HeatmapColorScale // TODO: fix after remove when https://github.com/grafana/cuetsy/issues/74 is fixed", - "type": "boolean", - "enum": [ - false - ] - }, - "exponent": { - "type": "number", - "enum": [ - 0.5 - ] - }, - "steps": { - "type": "integer", - "enum": [ - 64 - ] - } - } - } - ] - } - } - ] - }, - { - "required": [ - "scheme", - "fill", - "reverse", - "exponent", - "steps" - ], - "properties": { - "scheme": { - "description": "mode: HeatmapColorMode // TODO: fix after remove when https://github.com/grafana/cuetsy/issues/74 is fixed", - "type": "string", - "enum": [ - "Oranges" - ] - }, - "fill": { - "type": "string", - "enum": [ - "dark-orange" - ] - }, - "reverse": { - "description": "scale: HeatmapColorScale // TODO: fix after remove when https://github.com/grafana/cuetsy/issues/74 is fixed", - "type": "boolean", - "enum": [ - false - ] - }, - "exponent": { - "type": "number", - "enum": [ - 0.5 - ] - }, - "steps": { - "type": "integer", - "enum": [ - 64 - ] - } - } - } - ] - }, - "filterValues": { - "description": "Filters values between a given range", - "type": "object", - "default": { - "le": 1E-9 - }, - "oneOf": [ - { - "allOf": [ - { - "$ref": "#/components/schemas/FilterValueRange" - }, - { - "not": { - "anyOf": [ - { - "required": [ - "le" - ], - "properties": { - "le": { - "type": "number", - "enum": [ - 1E-9 - ] - } - } - } - ] - } - } - ] - }, - { - "required": [ - "le" - ], - "properties": { - "le": { - "type": "number", - "enum": [ - 1E-9 - ] - } - } - } - ] - }, - "rowsFrame": { - "$ref": "#/components/schemas/RowsHeatmapOptions" - }, - "showValue": { - "description": "| *{\n\tlayout: ui.HeatmapCellLayout \u0026 \"auto\" // TODO: fix after remove when https://github.com/grafana/cuetsy/issues/74 is fixed\n}\nControls the display of the value in the cell", - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/VisibilityMode" - } - ] - }, - "cellGap": { - "description": "Controls gap between cells", - "type": "integer", - "minimum": 0, - "maximum": 25, - "default": 1 - }, - "cellRadius": { - "description": "Controls cell radius", - "type": "number", - "format": "float" - }, - "cellValues": { - "description": "Controls cell value unit", - "type": "object", - "default": {}, - "oneOf": [ - { - "allOf": [ - { - "$ref": "#/components/schemas/CellValues" - }, - { - "not": { - "anyOf": [ - {} - ] - } - } - ] - }, - { - "not": { - "anyOf": [ - { - "$ref": "#/components/schemas/CellValues" - } - ] - } - } - ] - }, - "yAxis": { - "$ref": "#/components/schemas/YAxisConfig" - }, - "legend": { - "$ref": "#/components/schemas/HeatmapLegend" - }, - "tooltip": { - "$ref": "#/components/schemas/HeatmapTooltip" - }, - "exemplars": { - "$ref": "#/components/schemas/ExemplarConfig" - } - } - }, - "PanelFieldConfig": { - "type": "object", - "properties": { - "scaleDistribution": { - "$ref": "#/components/schemas/ScaleDistributionConfig" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/HideableFieldConfig" - } - ] - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "HeatmapTooltip": { - "description": "Controls tooltip options", - "type": "object", - "required": [ - "show" - ], - "properties": { - "show": { - "description": "Controls if the tooltip is shown", - "type": "boolean" - }, - "yHistogram": { - "description": "Controls if the tooltip shows a histogram of the y-axis values", - "type": "boolean" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "HideSeriesConfig": { - "description": "TODO docs", - "type": "object", - "required": [ - "tooltip", - "legend", - "viz" - ], - "properties": { - "tooltip": { - "type": "boolean" - }, - "legend": { - "type": "boolean" - }, - "viz": { - "type": "boolean" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "HideableFieldConfig": { - "description": "TODO docs", - "type": "object", - "properties": { - "hideFrom": { - "$ref": "#/components/schemas/HideSeriesConfig" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "RowsHeatmapOptions": { - "description": "Controls frame rows options", - "type": "object", - "properties": { - "value": { - "description": "Sets the name of the cell when not calculating from data", - "type": "string" - }, - "layout": { - "$ref": "#/components/schemas/HeatmapCellLayout" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ScaleDistribution": { - "description": "TODO docs", - "type": "string", - "enum": [ - "linear", - "log", - "ordinal", - "symlog" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ScaleDistributionConfig": { - "description": "TODO docs", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "$ref": "#/components/schemas/ScaleDistribution" - }, - "log": { - "type": "number" - }, - "linearThreshold": { - "type": "number" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VisibilityMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "auto", - "never", - "always" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "YAxisConfig": { - "description": "Configuration options for the yAxis", - "type": "object", - "properties": { - "unit": { - "description": "Sets the yAxis unit", - "type": "string" - }, - "reverse": { - "description": "Reverses the yAxis", - "type": "boolean" - }, - "decimals": { - "description": "Controls the number of decimals for yAxis values", - "type": "number", - "format": "float" - }, - "min": { - "description": "Sets the minimum value for the yAxis", - "type": "number", - "format": "float" - }, - "max": { - "description": "Sets the maximum value for the yAxis", - "type": "number", - "format": "float" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/AxisConfig" - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/histogram/panelcfg/x/histogram_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/histogram/panelcfg/x/histogram_types_gen.json deleted file mode 100644 index bd4e955..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/histogram/panelcfg/x/histogram_types_gen.json +++ /dev/null @@ -1,340 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "HistogramPanelCfg", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "AxisColorMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "text", - "series" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "AxisConfig": { - "description": "TODO docs", - "type": "object", - "properties": { - "axisPlacement": { - "$ref": "#/components/schemas/AxisPlacement" - }, - "axisColorMode": { - "$ref": "#/components/schemas/AxisColorMode" - }, - "axisLabel": { - "type": "string" - }, - "axisWidth": { - "type": "number" - }, - "axisSoftMin": { - "type": "number" - }, - "axisSoftMax": { - "type": "number" - }, - "axisGridShow": { - "type": "boolean" - }, - "scaleDistribution": { - "$ref": "#/components/schemas/ScaleDistributionConfig" - }, - "axisCenteredZero": { - "type": "boolean" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "AxisPlacement": { - "description": "TODO docs", - "type": "string", - "enum": [ - "auto", - "top", - "right", - "bottom", - "left", - "hidden" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "GraphGradientMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "none", - "opacity", - "hue", - "scheme" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "HideSeriesConfig": { - "description": "TODO docs", - "type": "object", - "required": [ - "tooltip", - "legend", - "viz" - ], - "properties": { - "tooltip": { - "type": "boolean" - }, - "legend": { - "type": "boolean" - }, - "viz": { - "type": "boolean" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "HideableFieldConfig": { - "description": "TODO docs", - "type": "object", - "properties": { - "hideFrom": { - "$ref": "#/components/schemas/HideSeriesConfig" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "HistogramPanelCfg": { - "type": "object", - "required": [ - "PanelOptions", - "PanelFieldConfig" - ], - "properties": { - "PanelOptions": { - "type": "object", - "properties": { - "bucketSize": { - "description": "Size of each bucket", - "type": "integer", - "format": "int32" - }, - "bucketOffset": { - "description": "Offset buckets by this amount", - "type": "integer", - "minimum": -2147483648, - "maximum": 2147483647, - "default": 0 - }, - "combine": { - "description": "Combines multiple series into a single histogram", - "type": "boolean" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OptionsWithLegend" - }, - { - "$ref": "#/components/schemas/OptionsWithTooltip" - } - ] - }, - "PanelFieldConfig": { - "type": "object", - "properties": { - "lineWidth": { - "description": "Controls line width of the bars.", - "type": "integer", - "minimum": 0, - "maximum": 10, - "default": 1 - }, - "fillOpacity": { - "description": "Controls the fill opacity of the bars.", - "type": "integer", - "minimum": 0, - "maximum": 100, - "default": 80 - }, - "gradientMode": { - "description": "Set the mode of the gradient fill. Fill gradient is based on the line color. To change the color, use the standard color scheme field option.\nGradient appearance is influenced by the Fill opacity setting.", - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/GraphGradientMode" - } - ] - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/AxisConfig" - }, - { - "$ref": "#/components/schemas/HideableFieldConfig" - } - ] - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "LegendDisplayMode": { - "description": "TODO docs\nNote: \"hidden\" needs to remain as an option for plugins compatibility", - "type": "string", - "enum": [ - "list", - "table", - "hidden" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "LegendPlacement": { - "description": "TODO docs", - "type": "string", - "enum": [ - "bottom", - "right" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "OptionsWithLegend": { - "description": "TODO docs", - "type": "object", - "required": [ - "legend" - ], - "properties": { - "legend": { - "$ref": "#/components/schemas/VizLegendOptions" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "OptionsWithTooltip": { - "description": "TODO docs", - "type": "object", - "required": [ - "tooltip" - ], - "properties": { - "tooltip": { - "$ref": "#/components/schemas/VizTooltipOptions" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ScaleDistribution": { - "description": "TODO docs", - "type": "string", - "enum": [ - "linear", - "log", - "ordinal", - "symlog" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ScaleDistributionConfig": { - "description": "TODO docs", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "$ref": "#/components/schemas/ScaleDistribution" - }, - "log": { - "type": "number" - }, - "linearThreshold": { - "type": "number" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "SortOrder": { - "description": "TODO docs", - "type": "string", - "enum": [ - "asc", - "desc", - "none" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TooltipDisplayMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "single", - "multi", - "none" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VizLegendOptions": { - "description": "TODO docs", - "type": "object", - "required": [ - "displayMode", - "placement", - "showLegend", - "calcs" - ], - "properties": { - "displayMode": { - "$ref": "#/components/schemas/LegendDisplayMode" - }, - "placement": { - "$ref": "#/components/schemas/LegendPlacement" - }, - "showLegend": { - "type": "boolean" - }, - "asTable": { - "type": "boolean" - }, - "isVisible": { - "type": "boolean" - }, - "sortBy": { - "type": "string" - }, - "sortDesc": { - "type": "boolean" - }, - "width": { - "type": "number" - }, - "calcs": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VizTooltipOptions": { - "description": "TODO docs", - "type": "object", - "required": [ - "mode", - "sort" - ], - "properties": { - "mode": { - "$ref": "#/components/schemas/TooltipDisplayMode" - }, - "sort": { - "$ref": "#/components/schemas/SortOrder" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/logs/panelcfg/x/logs_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/logs/panelcfg/x/logs_types_gen.json deleted file mode 100644 index 9ea10b8..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/logs/panelcfg/x/logs_types_gen.json +++ /dev/null @@ -1,78 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "LogsPanelCfg", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "LogsDedupStrategy": { - "type": "string", - "enum": [ - "none", - "exact", - "numbers", - "signature" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "LogsPanelCfg": { - "type": "object", - "required": [ - "PanelOptions" - ], - "properties": { - "PanelOptions": { - "type": "object", - "required": [ - "showLabels", - "showCommonLabels", - "showTime", - "wrapLogMessage", - "prettifyLogMessage", - "enableLogDetails", - "sortOrder", - "dedupStrategy" - ], - "properties": { - "showLabels": { - "type": "boolean" - }, - "showCommonLabels": { - "type": "boolean" - }, - "showTime": { - "type": "boolean" - }, - "wrapLogMessage": { - "type": "boolean" - }, - "prettifyLogMessage": { - "type": "boolean" - }, - "enableLogDetails": { - "type": "boolean" - }, - "sortOrder": { - "$ref": "#/components/schemas/LogsSortOrder" - }, - "dedupStrategy": { - "$ref": "#/components/schemas/LogsDedupStrategy" - } - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "LogsSortOrder": { - "type": "string", - "enum": [ - "Descending", - "Ascending" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/loki/dataquery/x/loki_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/loki/dataquery/x/loki_types_gen.json deleted file mode 100644 index 911c745..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/loki/dataquery/x/loki_types_gen.json +++ /dev/null @@ -1,116 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "LokiDataQuery", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "DataQuery": { - "description": "These are the common properties available to all queries in all datasources.\nSpecific implementations will *extend* this interface, adding the required\nproperties for the given context.", - "type": "object", - "required": [ - "refId" - ], - "properties": { - "refId": { - "description": "A unique identifier for the query within the list of targets.\nIn server side expressions, the refId is used as a variable name to identify results.\nBy default, the UI will assign A-\u003eZ; however setting meaningful names may be useful.", - "type": "string" - }, - "hide": { - "description": "true if query is disabled (ie should not be returned to the dashboard)\nNote this does not always imply that the query should not be executed since\nthe results from a hidden query may be used as the input to other queries (SSE etc)", - "type": "boolean" - }, - "queryType": { - "description": "Specify the query flavor\nTODO make this required and give it a default", - "type": "string" - }, - "datasource": { - "description": "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "LokiDataQuery": { - "type": "object", - "properties": { - "expr": { - "description": "The LogQL query.", - "type": "string" - }, - "legendFormat": { - "description": "Used to override the name of the series.", - "type": "string" - }, - "maxLines": { - "description": "Used to limit the number of log rows returned.", - "type": "integer", - "format": "int64" - }, - "resolution": { - "description": "Used to scale the interval value.", - "type": "integer", - "format": "int64" - }, - "editorMode": { - "$ref": "#/components/schemas/QueryEditorMode" - }, - "range": { - "description": "@deprecated, now use queryType.", - "type": "boolean" - }, - "instant": { - "description": "@deprecated, now use queryType.", - "type": "boolean" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/DataQuery" - }, - { - "required": [ - "expr" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "LokiQueryDirection": { - "type": "string", - "enum": [ - "forward", - "backward" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "LokiQueryType": { - "type": "string", - "enum": [ - "range", - "instant", - "stream" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "QueryEditorMode": { - "type": "string", - "enum": [ - "code", - "builder" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "SupportingQueryType": { - "type": "string", - "enum": [ - "logsVolume", - "logsSample", - "dataSample" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/news/panelcfg/x/news_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/news/panelcfg/x/news_types_gen.json deleted file mode 100644 index be76a81..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/news/panelcfg/x/news_types_gen.json +++ /dev/null @@ -1,34 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "NewsPanelCfg", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "NewsPanelCfg": { - "type": "object", - "required": [ - "PanelOptions" - ], - "properties": { - "PanelOptions": { - "type": "object", - "properties": { - "feedUrl": { - "description": "empty/missing will default to grafana blog", - "type": "string" - }, - "showImage": { - "type": "boolean", - "default": true - } - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/nodegraph/panelcfg/x/nodegraph_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/nodegraph/panelcfg/x/nodegraph_types_gen.json deleted file mode 100644 index 9ced95b..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/nodegraph/panelcfg/x/nodegraph_types_gen.json +++ /dev/null @@ -1,130 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "NodeGraphPanelCfg", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "ArcOption": { - "type": "object", - "properties": { - "field": { - "description": "Field from which to get the value. Values should be less than 1, representing fraction of a circle.", - "type": "string" - }, - "color": { - "description": "The color of the arc.", - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "EdgeOptions": { - "type": "object", - "properties": { - "mainStatUnit": { - "description": "Unit for the main stat to override what ever is set in the data frame.", - "type": "string" - }, - "secondaryStatUnit": { - "description": "Unit for the secondary stat to override what ever is set in the data frame.", - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "NodeGraphPanelCfg": { - "type": "object", - "required": [ - "ArcOption", - "NodeOptions", - "EdgeOptions", - "PanelOptions" - ], - "properties": { - "ArcOption": { - "type": "object", - "properties": { - "field": { - "description": "Field from which to get the value. Values should be less than 1, representing fraction of a circle.", - "type": "string" - }, - "color": { - "description": "The color of the arc.", - "type": "string" - } - } - }, - "NodeOptions": { - "type": "object", - "properties": { - "mainStatUnit": { - "description": "Unit for the main stat to override what ever is set in the data frame.", - "type": "string" - }, - "secondaryStatUnit": { - "description": "Unit for the secondary stat to override what ever is set in the data frame.", - "type": "string" - }, - "arcs": { - "description": "Define which fields are shown as part of the node arc (colored circle around the node).", - "type": "array", - "items": { - "$ref": "#/components/schemas/ArcOption" - } - } - } - }, - "EdgeOptions": { - "type": "object", - "properties": { - "mainStatUnit": { - "description": "Unit for the main stat to override what ever is set in the data frame.", - "type": "string" - }, - "secondaryStatUnit": { - "description": "Unit for the secondary stat to override what ever is set in the data frame.", - "type": "string" - } - } - }, - "PanelOptions": { - "type": "object", - "properties": { - "nodes": { - "$ref": "#/components/schemas/NodeOptions" - }, - "edges": { - "$ref": "#/components/schemas/EdgeOptions" - } - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "NodeOptions": { - "type": "object", - "properties": { - "mainStatUnit": { - "description": "Unit for the main stat to override what ever is set in the data frame.", - "type": "string" - }, - "secondaryStatUnit": { - "description": "Unit for the secondary stat to override what ever is set in the data frame.", - "type": "string" - }, - "arcs": { - "description": "Define which fields are shown as part of the node arc (colored circle around the node).", - "type": "array", - "items": { - "$ref": "#/components/schemas/ArcOption" - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/parca/dataquery/x/parca_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/parca/dataquery/x/parca_types_gen.json deleted file mode 100644 index 4190fab..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/parca/dataquery/x/parca_types_gen.json +++ /dev/null @@ -1,73 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "ParcaDataQuery", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "DataQuery": { - "description": "These are the common properties available to all queries in all datasources.\nSpecific implementations will *extend* this interface, adding the required\nproperties for the given context.", - "type": "object", - "required": [ - "refId" - ], - "properties": { - "refId": { - "description": "A unique identifier for the query within the list of targets.\nIn server side expressions, the refId is used as a variable name to identify results.\nBy default, the UI will assign A-\u003eZ; however setting meaningful names may be useful.", - "type": "string" - }, - "hide": { - "description": "true if query is disabled (ie should not be returned to the dashboard)\nNote this does not always imply that the query should not be executed since\nthe results from a hidden query may be used as the input to other queries (SSE etc)", - "type": "boolean" - }, - "queryType": { - "description": "Specify the query flavor\nTODO make this required and give it a default", - "type": "string" - }, - "datasource": { - "description": "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ParcaDataQuery": { - "type": "object", - "properties": { - "labelSelector": { - "description": "Specifies the query label selectors.", - "type": "string", - "default": "{}" - }, - "profileTypeId": { - "description": "Specifies the type of profile to query.", - "type": "string" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/DataQuery" - }, - { - "required": [ - "labelSelector", - "profileTypeId" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ParcaQueryType": { - "type": "string", - "enum": [ - "both", - "profile", - "metrics" - ], - "default": "both", - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/piechart/panelcfg/x/piechart_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/piechart/panelcfg/x/piechart_types_gen.json deleted file mode 100644 index 9f867e9..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/piechart/panelcfg/x/piechart_types_gen.json +++ /dev/null @@ -1,388 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "PieChartPanelCfg", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "HideSeriesConfig": { - "description": "TODO docs", - "type": "object", - "required": [ - "tooltip", - "legend", - "viz" - ], - "properties": { - "tooltip": { - "type": "boolean" - }, - "legend": { - "type": "boolean" - }, - "viz": { - "type": "boolean" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "HideableFieldConfig": { - "description": "TODO docs", - "type": "object", - "properties": { - "hideFrom": { - "$ref": "#/components/schemas/HideSeriesConfig" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "LegendDisplayMode": { - "description": "TODO docs\nNote: \"hidden\" needs to remain as an option for plugins compatibility", - "type": "string", - "enum": [ - "list", - "table", - "hidden" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "LegendPlacement": { - "description": "TODO docs", - "type": "string", - "enum": [ - "bottom", - "right" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "OptionsWithTextFormatting": { - "description": "TODO docs", - "type": "object", - "properties": { - "text": { - "$ref": "#/components/schemas/VizTextDisplayOptions" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "OptionsWithTooltip": { - "description": "TODO docs", - "type": "object", - "required": [ - "tooltip" - ], - "properties": { - "tooltip": { - "$ref": "#/components/schemas/VizTooltipOptions" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "PieChartLabels": { - "description": "Select labels to display on the pie chart.\n - Name - The series or field name.\n - Percent - The percentage of the whole.\n - Value - The raw numerical value.", - "type": "string", - "enum": [ - "name", - "value", - "percent" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "PieChartLegendOptions": { - "type": "object", - "properties": { - "values": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PieChartLegendValues" - } - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/VizLegendOptions" - }, - { - "required": [ - "values" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "PieChartLegendValues": { - "description": "Select values to display in the legend.\n - Percent: The percentage of the whole.\n - Value: The raw numerical value.", - "type": "string", - "enum": [ - "value", - "percent" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "PieChartPanelCfg": { - "type": "object", - "required": [ - "PieChartType", - "PieChartLabels", - "PieChartLegendValues", - "PieChartLegendOptions", - "PanelOptions", - "PanelFieldConfig" - ], - "properties": { - "PieChartType": { - "description": "Select the pie chart display style.", - "type": "string", - "enum": [ - "pie", - "donut" - ] - }, - "PieChartLabels": { - "description": "Select labels to display on the pie chart.\n - Name - The series or field name.\n - Percent - The percentage of the whole.\n - Value - The raw numerical value.", - "type": "string", - "enum": [ - "name", - "value", - "percent" - ] - }, - "PieChartLegendValues": { - "description": "Select values to display in the legend.\n - Percent: The percentage of the whole.\n - Value: The raw numerical value.", - "type": "string", - "enum": [ - "value", - "percent" - ] - }, - "PieChartLegendOptions": { - "type": "object", - "properties": { - "values": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PieChartLegendValues" - } - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/VizLegendOptions" - }, - { - "required": [ - "values" - ] - } - ] - }, - "PanelOptions": { - "type": "object", - "properties": { - "pieType": { - "$ref": "#/components/schemas/PieChartType" - }, - "displayLabels": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PieChartLabels" - } - }, - "legend": { - "$ref": "#/components/schemas/PieChartLegendOptions" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OptionsWithTooltip" - }, - { - "$ref": "#/components/schemas/SingleStatBaseOptions" - }, - { - "required": [ - "pieType", - "displayLabels", - "legend" - ] - } - ] - }, - "PanelFieldConfig": { - "$ref": "#/components/schemas/HideableFieldConfig" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "PieChartType": { - "description": "Select the pie chart display style.", - "type": "string", - "enum": [ - "pie", - "donut" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ReduceDataOptions": { - "description": "TODO docs", - "type": "object", - "required": [ - "calcs" - ], - "properties": { - "values": { - "description": "If true show each row value", - "type": "boolean" - }, - "limit": { - "description": "if showing all values limit", - "type": "number" - }, - "calcs": { - "description": "When !values, pick one value for the whole field", - "type": "array", - "items": { - "type": "string" - } - }, - "fields": { - "description": "Which fields to show. By default this is only numeric fields", - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "SingleStatBaseOptions": { - "description": "TODO docs", - "type": "object", - "properties": { - "reduceOptions": { - "$ref": "#/components/schemas/ReduceDataOptions" - }, - "orientation": { - "$ref": "#/components/schemas/VizOrientation" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OptionsWithTextFormatting" - }, - { - "required": [ - "reduceOptions", - "orientation" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "SortOrder": { - "description": "TODO docs", - "type": "string", - "enum": [ - "asc", - "desc", - "none" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TooltipDisplayMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "single", - "multi", - "none" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VizLegendOptions": { - "description": "TODO docs", - "type": "object", - "required": [ - "displayMode", - "placement", - "showLegend", - "calcs" - ], - "properties": { - "displayMode": { - "$ref": "#/components/schemas/LegendDisplayMode" - }, - "placement": { - "$ref": "#/components/schemas/LegendPlacement" - }, - "showLegend": { - "type": "boolean" - }, - "asTable": { - "type": "boolean" - }, - "isVisible": { - "type": "boolean" - }, - "sortBy": { - "type": "string" - }, - "sortDesc": { - "type": "boolean" - }, - "width": { - "type": "number" - }, - "calcs": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VizOrientation": { - "description": "TODO docs", - "type": "string", - "enum": [ - "auto", - "vertical", - "horizontal" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VizTextDisplayOptions": { - "description": "TODO docs", - "type": "object", - "properties": { - "titleSize": { - "description": "Explicit title text size", - "type": "number" - }, - "valueSize": { - "description": "Explicit value text size", - "type": "number" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VizTooltipOptions": { - "description": "TODO docs", - "type": "object", - "required": [ - "mode", - "sort" - ], - "properties": { - "mode": { - "$ref": "#/components/schemas/TooltipDisplayMode" - }, - "sort": { - "$ref": "#/components/schemas/SortOrder" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/prometheus/dataquery/x/prometheus_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/prometheus/dataquery/x/prometheus_types_gen.json deleted file mode 100644 index 2659c59..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/prometheus/dataquery/x/prometheus_types_gen.json +++ /dev/null @@ -1,100 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "PrometheusDataQuery", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "DataQuery": { - "description": "These are the common properties available to all queries in all datasources.\nSpecific implementations will *extend* this interface, adding the required\nproperties for the given context.", - "type": "object", - "required": [ - "refId" - ], - "properties": { - "refId": { - "description": "A unique identifier for the query within the list of targets.\nIn server side expressions, the refId is used as a variable name to identify results.\nBy default, the UI will assign A-\u003eZ; however setting meaningful names may be useful.", - "type": "string" - }, - "hide": { - "description": "true if query is disabled (ie should not be returned to the dashboard)\nNote this does not always imply that the query should not be executed since\nthe results from a hidden query may be used as the input to other queries (SSE etc)", - "type": "boolean" - }, - "queryType": { - "description": "Specify the query flavor\nTODO make this required and give it a default", - "type": "string" - }, - "datasource": { - "description": "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "PromQueryFormat": { - "type": "string", - "enum": [ - "time_series", - "table", - "heatmap" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "PrometheusDataQuery": { - "type": "object", - "properties": { - "expr": { - "description": "The actual expression/query that will be evaluated by Prometheus", - "type": "string" - }, - "instant": { - "description": "Returns only the latest value that Prometheus has scraped for the requested time series", - "type": "boolean" - }, - "range": { - "description": "Returns a Range vector, comprised of a set of time series containing a range of data points over time for each time series", - "type": "boolean" - }, - "exemplar": { - "description": "Execute an additional query to identify interesting raw samples relevant for the given expr", - "type": "boolean" - }, - "editorMode": { - "$ref": "#/components/schemas/QueryEditorMode" - }, - "format": { - "$ref": "#/components/schemas/PromQueryFormat" - }, - "legendFormat": { - "description": "Series name override or template. Ex. {{hostname}} will be replaced with label value for hostname", - "type": "string" - }, - "intervalFactor": { - "description": "@deprecated Used to specify how many times to divide max data points by. We use max data points under query options\nSee https://github.com/grafana/grafana/issues/48081", - "type": "number" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/DataQuery" - }, - { - "required": [ - "expr" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "QueryEditorMode": { - "type": "string", - "enum": [ - "code", - "builder" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/stat/panelcfg/x/stat_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/stat/panelcfg/x/stat_types_gen.json deleted file mode 100644 index 309e9d7..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/stat/panelcfg/x/stat_types_gen.json +++ /dev/null @@ -1,185 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "StatPanelCfg", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "BigValueColorMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "value", - "background", - "background_solid", - "none" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "BigValueGraphMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "none", - "line", - "area" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "BigValueJustifyMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "auto", - "center" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "BigValueTextMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "auto", - "value", - "value_and_name", - "name", - "none" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "OptionsWithTextFormatting": { - "description": "TODO docs", - "type": "object", - "properties": { - "text": { - "$ref": "#/components/schemas/VizTextDisplayOptions" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ReduceDataOptions": { - "description": "TODO docs", - "type": "object", - "required": [ - "calcs" - ], - "properties": { - "values": { - "description": "If true show each row value", - "type": "boolean" - }, - "limit": { - "description": "if showing all values limit", - "type": "number" - }, - "calcs": { - "description": "When !values, pick one value for the whole field", - "type": "array", - "items": { - "type": "string" - } - }, - "fields": { - "description": "Which fields to show. By default this is only numeric fields", - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "SingleStatBaseOptions": { - "description": "TODO docs", - "type": "object", - "properties": { - "reduceOptions": { - "$ref": "#/components/schemas/ReduceDataOptions" - }, - "orientation": { - "$ref": "#/components/schemas/VizOrientation" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OptionsWithTextFormatting" - }, - { - "required": [ - "reduceOptions", - "orientation" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "StatPanelCfg": { - "type": "object", - "required": [ - "PanelOptions" - ], - "properties": { - "PanelOptions": { - "type": "object", - "properties": { - "graphMode": { - "type": "string", - "$ref": "#/components/schemas/BigValueGraphMode" - }, - "colorMode": { - "type": "string", - "$ref": "#/components/schemas/BigValueColorMode" - }, - "justifyMode": { - "type": "string", - "$ref": "#/components/schemas/BigValueJustifyMode" - }, - "textMode": { - "type": "string", - "$ref": "#/components/schemas/BigValueTextMode" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/SingleStatBaseOptions" - }, - { - "required": [ - "graphMode", - "colorMode", - "justifyMode", - "textMode" - ] - } - ] - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VizOrientation": { - "description": "TODO docs", - "type": "string", - "enum": [ - "auto", - "vertical", - "horizontal" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VizTextDisplayOptions": { - "description": "TODO docs", - "type": "object", - "properties": { - "titleSize": { - "description": "Explicit title text size", - "type": "number" - }, - "valueSize": { - "description": "Explicit value text size", - "type": "number" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/statetimeline/panelcfg/x/statetimeline_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/statetimeline/panelcfg/x/statetimeline_types_gen.json deleted file mode 100644 index 33636f0..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/statetimeline/panelcfg/x/statetimeline_types_gen.json +++ /dev/null @@ -1,298 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "StateTimelinePanelCfg", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "HideSeriesConfig": { - "description": "TODO docs", - "type": "object", - "required": [ - "tooltip", - "legend", - "viz" - ], - "properties": { - "tooltip": { - "type": "boolean" - }, - "legend": { - "type": "boolean" - }, - "viz": { - "type": "boolean" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "HideableFieldConfig": { - "description": "TODO docs", - "type": "object", - "properties": { - "hideFrom": { - "$ref": "#/components/schemas/HideSeriesConfig" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "LegendDisplayMode": { - "description": "TODO docs\nNote: \"hidden\" needs to remain as an option for plugins compatibility", - "type": "string", - "enum": [ - "list", - "table", - "hidden" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "LegendPlacement": { - "description": "TODO docs", - "type": "string", - "enum": [ - "bottom", - "right" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "OptionsWithLegend": { - "description": "TODO docs", - "type": "object", - "required": [ - "legend" - ], - "properties": { - "legend": { - "$ref": "#/components/schemas/VizLegendOptions" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "OptionsWithTimezones": { - "description": "TODO docs", - "type": "object", - "properties": { - "timezone": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TimeZone" - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "OptionsWithTooltip": { - "description": "TODO docs", - "type": "object", - "required": [ - "tooltip" - ], - "properties": { - "tooltip": { - "$ref": "#/components/schemas/VizTooltipOptions" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "SortOrder": { - "description": "TODO docs", - "type": "string", - "enum": [ - "asc", - "desc", - "none" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "StateTimelinePanelCfg": { - "type": "object", - "required": [ - "PanelOptions", - "PanelFieldConfig" - ], - "properties": { - "PanelOptions": { - "type": "object", - "properties": { - "showValue": { - "description": "Show timeline values on chart", - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/VisibilityMode" - } - ] - }, - "rowHeight": { - "description": "Controls the row height", - "type": "number", - "maximum": 1, - "default": 0.9 - }, - "mergeValues": { - "description": "Merge equal consecutive values", - "type": "boolean", - "default": true - }, - "alignValue": { - "description": "Controls value alignment on the timelines", - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/TimelineValueAlignment" - } - ] - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OptionsWithLegend" - }, - { - "$ref": "#/components/schemas/OptionsWithTooltip" - }, - { - "$ref": "#/components/schemas/OptionsWithTimezones" - }, - { - "required": [ - "showValue", - "rowHeight" - ] - } - ] - }, - "PanelFieldConfig": { - "type": "object", - "properties": { - "lineWidth": { - "type": "integer", - "minimum": 0, - "maximum": 10, - "default": 0 - }, - "fillOpacity": { - "type": "integer", - "minimum": 0, - "maximum": 100, - "default": 70 - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/HideableFieldConfig" - } - ] - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TimeZone": { - "description": "A specific timezone from https://en.wikipedia.org/wiki/Tz_database", - "type": "string", - "default": "browser", - "oneOf": [ - { - "enum": [ - "utc" - ] - }, - {} - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TimelineValueAlignment": { - "description": "Controls the value alignment in the TimelineChart component", - "type": "string", - "enum": [ - "center", - "left", - "right" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TooltipDisplayMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "single", - "multi", - "none" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VisibilityMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "auto", - "never", - "always" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VizLegendOptions": { - "description": "TODO docs", - "type": "object", - "required": [ - "displayMode", - "placement", - "showLegend", - "calcs" - ], - "properties": { - "displayMode": { - "$ref": "#/components/schemas/LegendDisplayMode" - }, - "placement": { - "$ref": "#/components/schemas/LegendPlacement" - }, - "showLegend": { - "type": "boolean" - }, - "asTable": { - "type": "boolean" - }, - "isVisible": { - "type": "boolean" - }, - "sortBy": { - "type": "string" - }, - "sortDesc": { - "type": "boolean" - }, - "width": { - "type": "number" - }, - "calcs": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VizTooltipOptions": { - "description": "TODO docs", - "type": "object", - "required": [ - "mode", - "sort" - ], - "properties": { - "mode": { - "$ref": "#/components/schemas/TooltipDisplayMode" - }, - "sort": { - "$ref": "#/components/schemas/SortOrder" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/statushistory/panelcfg/x/statushistory_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/statushistory/panelcfg/x/statushistory_types_gen.json deleted file mode 100644 index 7f7bcb7..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/statushistory/panelcfg/x/statushistory_types_gen.json +++ /dev/null @@ -1,281 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "StatusHistoryPanelCfg", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "HideSeriesConfig": { - "description": "TODO docs", - "type": "object", - "required": [ - "tooltip", - "legend", - "viz" - ], - "properties": { - "tooltip": { - "type": "boolean" - }, - "legend": { - "type": "boolean" - }, - "viz": { - "type": "boolean" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "HideableFieldConfig": { - "description": "TODO docs", - "type": "object", - "properties": { - "hideFrom": { - "$ref": "#/components/schemas/HideSeriesConfig" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "LegendDisplayMode": { - "description": "TODO docs\nNote: \"hidden\" needs to remain as an option for plugins compatibility", - "type": "string", - "enum": [ - "list", - "table", - "hidden" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "LegendPlacement": { - "description": "TODO docs", - "type": "string", - "enum": [ - "bottom", - "right" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "OptionsWithLegend": { - "description": "TODO docs", - "type": "object", - "required": [ - "legend" - ], - "properties": { - "legend": { - "$ref": "#/components/schemas/VizLegendOptions" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "OptionsWithTimezones": { - "description": "TODO docs", - "type": "object", - "properties": { - "timezone": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TimeZone" - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "OptionsWithTooltip": { - "description": "TODO docs", - "type": "object", - "required": [ - "tooltip" - ], - "properties": { - "tooltip": { - "$ref": "#/components/schemas/VizTooltipOptions" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "SortOrder": { - "description": "TODO docs", - "type": "string", - "enum": [ - "asc", - "desc", - "none" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "StatusHistoryPanelCfg": { - "type": "object", - "required": [ - "PanelOptions", - "PanelFieldConfig" - ], - "properties": { - "PanelOptions": { - "type": "object", - "properties": { - "rowHeight": { - "description": "Set the height of the rows", - "type": "number", - "minimum": 0, - "maximum": 1, - "default": 0.9 - }, - "showValue": { - "description": "Show values on the columns", - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/VisibilityMode" - } - ] - }, - "colWidth": { - "description": "Controls the column width", - "type": "number", - "maximum": 1, - "default": 0.9 - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OptionsWithLegend" - }, - { - "$ref": "#/components/schemas/OptionsWithTooltip" - }, - { - "$ref": "#/components/schemas/OptionsWithTimezones" - }, - { - "required": [ - "rowHeight", - "showValue" - ] - } - ] - }, - "PanelFieldConfig": { - "type": "object", - "properties": { - "lineWidth": { - "type": "integer", - "minimum": 0, - "maximum": 10, - "default": 1 - }, - "fillOpacity": { - "type": "integer", - "minimum": 0, - "maximum": 100, - "default": 70 - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/HideableFieldConfig" - } - ] - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TimeZone": { - "description": "A specific timezone from https://en.wikipedia.org/wiki/Tz_database", - "type": "string", - "default": "browser", - "oneOf": [ - { - "enum": [ - "utc" - ] - }, - {} - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TooltipDisplayMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "single", - "multi", - "none" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VisibilityMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "auto", - "never", - "always" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VizLegendOptions": { - "description": "TODO docs", - "type": "object", - "required": [ - "displayMode", - "placement", - "showLegend", - "calcs" - ], - "properties": { - "displayMode": { - "$ref": "#/components/schemas/LegendDisplayMode" - }, - "placement": { - "$ref": "#/components/schemas/LegendPlacement" - }, - "showLegend": { - "type": "boolean" - }, - "asTable": { - "type": "boolean" - }, - "isVisible": { - "type": "boolean" - }, - "sortBy": { - "type": "string" - }, - "sortDesc": { - "type": "boolean" - }, - "width": { - "type": "number" - }, - "calcs": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VizTooltipOptions": { - "description": "TODO docs", - "type": "object", - "required": [ - "mode", - "sort" - ], - "properties": { - "mode": { - "$ref": "#/components/schemas/TooltipDisplayMode" - }, - "sort": { - "$ref": "#/components/schemas/SortOrder" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/table/panelcfg/x/table_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/table/panelcfg/x/table_types_gen.json deleted file mode 100644 index 8804297..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/table/panelcfg/x/table_types_gen.json +++ /dev/null @@ -1,205 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "TablePanelCfg", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "TableCellHeight": { - "description": "Height of a table cell", - "type": "string", - "enum": [ - "sm", - "md", - "lg" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TableFooterOptions": { - "description": "Footer options", - "type": "object", - "required": [ - "show", - "reducer" - ], - "properties": { - "show": { - "type": "boolean" - }, - "reducer": { - "type": "array", - "items": { - "type": "string" - } - }, - "fields": { - "type": "array", - "items": { - "type": "string" - } - }, - "enablePagination": { - "type": "boolean" - }, - "countRows": { - "type": "boolean" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TablePanelCfg": { - "type": "object", - "required": [ - "PanelOptions" - ], - "properties": { - "PanelOptions": { - "type": "object", - "required": [ - "frameIndex", - "showHeader" - ], - "properties": { - "frameIndex": { - "description": "Represents the index of the selected frame", - "type": "number", - "default": 0 - }, - "showHeader": { - "description": "Controls whether the panel should show the header", - "type": "boolean", - "default": true - }, - "showTypeIcons": { - "description": "Controls whether the header should show icons for the column types", - "type": "boolean", - "default": false - }, - "sortBy": { - "description": "Used to control row sorting", - "type": "array", - "items": { - "$ref": "#/components/schemas/TableSortByFieldState" - } - }, - "footer": { - "description": "Controls footer options", - "type": "object", - "default": { - "show": false, - "countRows": false, - "reducer": [] - }, - "oneOf": [ - { - "allOf": [ - { - "$ref": "#/components/schemas/TableFooterOptions" - }, - { - "not": { - "anyOf": [ - { - "required": [ - "show", - "countRows", - "reducer" - ], - "properties": { - "show": { - "description": "Controls whether the footer should be shown", - "type": "boolean", - "enum": [ - false - ] - }, - "countRows": { - "description": "Controls whether the footer should show the total number of rows on Count calculation", - "type": "boolean", - "enum": [ - false - ] - }, - "reducer": { - "description": "Represents the selected calculations", - "type": "array", - "enum": [ - [] - ] - } - } - } - ] - } - } - ] - }, - { - "required": [ - "show", - "countRows", - "reducer" - ], - "properties": { - "show": { - "description": "Controls whether the footer should be shown", - "type": "boolean", - "enum": [ - false - ] - }, - "countRows": { - "description": "Controls whether the footer should show the total number of rows on Count calculation", - "type": "boolean", - "enum": [ - false - ] - }, - "reducer": { - "description": "Represents the selected calculations", - "type": "array", - "enum": [ - [] - ] - } - } - } - ] - }, - "cellHeight": { - "description": "Controls the height of the rows", - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/TableCellHeight" - } - ] - } - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TableSortByFieldState": { - "description": "Sort by field state", - "type": "object", - "required": [ - "displayName" - ], - "properties": { - "displayName": { - "description": "Sets the display name of the field to sort by", - "type": "string" - }, - "desc": { - "description": "Flag used to indicate descending sort order", - "type": "boolean" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/tempo/dataquery/x/tempo_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/tempo/dataquery/x/tempo_types_gen.json deleted file mode 100644 index 963656a..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/tempo/dataquery/x/tempo_types_gen.json +++ /dev/null @@ -1,163 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "TempoDataQuery", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "DataQuery": { - "description": "These are the common properties available to all queries in all datasources.\nSpecific implementations will *extend* this interface, adding the required\nproperties for the given context.", - "type": "object", - "required": [ - "refId" - ], - "properties": { - "refId": { - "description": "A unique identifier for the query within the list of targets.\nIn server side expressions, the refId is used as a variable name to identify results.\nBy default, the UI will assign A-\u003eZ; however setting meaningful names may be useful.", - "type": "string" - }, - "hide": { - "description": "true if query is disabled (ie should not be returned to the dashboard)\nNote this does not always imply that the query should not be executed since\nthe results from a hidden query may be used as the input to other queries (SSE etc)", - "type": "boolean" - }, - "queryType": { - "description": "Specify the query flavor\nTODO make this required and give it a default", - "type": "string" - }, - "datasource": { - "description": "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TempoDataQuery": { - "type": "object", - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TempoQuery": { - "type": "object", - "properties": { - "query": { - "description": "TraceQL query or trace ID", - "type": "string" - }, - "search": { - "description": "Logfmt query to filter traces by their tags. Example: http.status_code=200 error=true", - "type": "string" - }, - "serviceName": { - "description": "Query traces by service name", - "type": "string" - }, - "spanName": { - "description": "Query traces by span name", - "type": "string" - }, - "minDuration": { - "description": "Define the minimum duration to select traces. Use duration format, for example: 1.2s, 100ms", - "type": "string" - }, - "maxDuration": { - "description": "Define the maximum duration to select traces. Use duration format, for example: 1.2s, 100ms", - "type": "string" - }, - "serviceMapQuery": { - "description": "Filters to be included in a PromQL query to select data for the service graph. Example: {client=\"app\",service=\"app\"}", - "type": "string" - }, - "limit": { - "description": "Defines the maximum number of traces that are returned from Tempo", - "type": "integer", - "format": "int64" - }, - "filters": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TraceqlFilter" - } - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/DataQuery" - }, - { - "required": [ - "query", - "filters" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TempoQueryType": { - "description": "search = Loki search, nativeSearch = Tempo search for backwards compatibility", - "type": "string", - "enum": [ - "traceql", - "traceqlSearch", - "search", - "serviceMap", - "upload", - "nativeSearch", - "clear" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TraceqlFilter": { - "type": "object", - "required": [ - "id" - ], - "properties": { - "id": { - "description": "Uniquely identify the filter, will not be used in the query generation", - "type": "string" - }, - "tag": { - "description": "The tag for the search filter, for example: .http.status_code, .service.name, status", - "type": "string" - }, - "operator": { - "description": "The operator that connects the tag to the value, for example: =, \u003e, !=, =~", - "type": "string" - }, - "value": { - "description": "The value for the search filter", - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ] - }, - "valueType": { - "description": "The type of the value, used for example to check whether we need to wrap the value in quotes when generating the query", - "type": "string" - }, - "scope": { - "$ref": "#/components/schemas/TraceqlSearchScope" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TraceqlSearchScope": { - "description": "static fields are pre-set in the UI, dynamic fields are added by the user", - "type": "string", - "enum": [ - "unscoped", - "resource", - "span" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/testdata/dataquery/x/testdata_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/testdata/dataquery/x/testdata_types_gen.json deleted file mode 100644 index 5776843..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/testdata/dataquery/x/testdata_types_gen.json +++ /dev/null @@ -1,360 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "TestDataDataQuery", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "CSVWave": { - "type": "object", - "properties": { - "timeStep": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "valuesCSV": { - "type": "string" - }, - "labels": { - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "DataQuery": { - "description": "These are the common properties available to all queries in all datasources.\nSpecific implementations will *extend* this interface, adding the required\nproperties for the given context.", - "type": "object", - "required": [ - "refId" - ], - "properties": { - "refId": { - "description": "A unique identifier for the query within the list of targets.\nIn server side expressions, the refId is used as a variable name to identify results.\nBy default, the UI will assign A-\u003eZ; however setting meaningful names may be useful.", - "type": "string" - }, - "hide": { - "description": "true if query is disabled (ie should not be returned to the dashboard)\nNote this does not always imply that the query should not be executed since\nthe results from a hidden query may be used as the input to other queries (SSE etc)", - "type": "boolean" - }, - "queryType": { - "description": "Specify the query flavor\nTODO make this required and give it a default", - "type": "string" - }, - "datasource": { - "description": "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "NodesQuery": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "random", - "response", - "random edges" - ] - }, - "count": { - "type": "integer", - "format": "int64" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "PulseWaveQuery": { - "type": "object", - "properties": { - "timeStep": { - "type": "integer", - "format": "int64" - }, - "onCount": { - "type": "integer", - "format": "int64" - }, - "offCount": { - "type": "integer", - "format": "int64" - }, - "onValue": { - "type": "number", - "format": "double" - }, - "offValue": { - "type": "number", - "format": "double" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "Scenario": { - "description": "TODO: Should this live here given it's not used in the dataquery?", - "type": "object", - "required": [ - "id", - "name", - "stringInput" - ], - "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "stringInput": { - "type": "string" - }, - "description": { - "type": "string" - }, - "hideAliasField": { - "type": "boolean" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "SimulationQuery": { - "type": "object", - "required": [ - "key" - ], - "properties": { - "key": { - "type": "object", - "required": [ - "type", - "tick" - ], - "properties": { - "type": { - "type": "string" - }, - "tick": { - "type": "number", - "format": "double" - }, - "uid": { - "type": "string" - } - } - }, - "config": { - "type": "object" - }, - "stream": { - "type": "boolean" - }, - "last": { - "type": "boolean" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "StreamingQuery": { - "type": "object", - "required": [ - "type", - "speed", - "spread", - "noise" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "signal", - "logs", - "fetch" - ] - }, - "speed": { - "type": "integer", - "format": "int32" - }, - "spread": { - "type": "integer", - "format": "int32" - }, - "noise": { - "type": "integer", - "format": "int32" - }, - "bands": { - "type": "integer", - "format": "int32" - }, - "url": { - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TestDataDataQuery": { - "type": "object", - "properties": { - "alias": { - "type": "string" - }, - "scenarioId": { - "type": "string", - "$ref": "#/components/schemas/TestDataQueryType" - }, - "stringInput": { - "type": "string" - }, - "stream": { - "$ref": "#/components/schemas/StreamingQuery" - }, - "pulseWave": { - "$ref": "#/components/schemas/PulseWaveQuery" - }, - "sim": { - "$ref": "#/components/schemas/SimulationQuery" - }, - "csvWave": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CSVWave" - } - }, - "labels": { - "type": "string" - }, - "lines": { - "type": "integer", - "format": "int64" - }, - "levelColumn": { - "type": "boolean" - }, - "channel": { - "type": "string" - }, - "nodes": { - "$ref": "#/components/schemas/NodesQuery" - }, - "csvFileName": { - "type": "string" - }, - "csvContent": { - "type": "string" - }, - "rawFrameContent": { - "type": "string" - }, - "seriesCount": { - "type": "integer", - "format": "int32" - }, - "usa": { - "$ref": "#/components/schemas/USAQuery" - }, - "errorType": { - "type": "string", - "enum": [ - "server_panic", - "frontend_exception", - "frontend_observable" - ] - }, - "spanCount": { - "type": "integer", - "format": "int32" - }, - "points": { - "type": "array", - "items": { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "number", - "minimum": -9223372036854775808, - "maximum": 9223372036854775807 - } - ] - } - } - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/DataQuery" - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TestDataQueryType": { - "type": "string", - "enum": [ - "random_walk", - "slow_query", - "random_walk_with_error", - "random_walk_table", - "exponential_heatmap_bucket_data", - "linear_heatmap_bucket_data", - "no_data_points", - "datapoints_outside_range", - "csv_metric_values", - "predictable_pulse", - "predictable_csv_wave", - "streaming_client", - "simulation", - "usa", - "live", - "grafana_api", - "arrow", - "annotations", - "table_static", - "server_error_500", - "logs", - "node_graph", - "flame_graph", - "raw_frame", - "csv_file", - "csv_content", - "trace", - "manual_entry", - "variables-query" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "USAQuery": { - "type": "object", - "properties": { - "mode": { - "type": "string" - }, - "period": { - "type": "string" - }, - "fields": { - "type": "array", - "items": { - "type": "string" - } - }, - "states": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/text/panelcfg/x/text_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/text/panelcfg/x/text_types_gen.json deleted file mode 100644 index b0701ec..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/text/panelcfg/x/text_types_gen.json +++ /dev/null @@ -1,135 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "TextPanelCfg", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "CodeLanguage": { - "type": "string", - "enum": [ - "plaintext", - "yaml", - "xml", - "typescript", - "sql", - "go", - "markdown", - "html", - "json" - ], - "default": "plaintext", - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "CodeOptions": { - "type": "object", - "required": [ - "language", - "showLineNumbers", - "showMiniMap" - ], - "properties": { - "language": { - "$ref": "#/components/schemas/CodeLanguage" - }, - "showLineNumbers": { - "type": "boolean", - "default": false - }, - "showMiniMap": { - "type": "boolean", - "default": false - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TextMode": { - "type": "string", - "enum": [ - "html", - "markdown", - "code" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TextPanelCfg": { - "type": "object", - "required": [ - "TextMode", - "CodeLanguage", - "CodeOptions", - "PanelOptions" - ], - "properties": { - "TextMode": { - "type": "string", - "enum": [ - "html", - "markdown", - "code" - ] - }, - "CodeLanguage": { - "type": "string", - "enum": [ - "plaintext", - "yaml", - "xml", - "typescript", - "sql", - "go", - "markdown", - "html", - "json" - ], - "default": "plaintext" - }, - "CodeOptions": { - "type": "object", - "required": [ - "language", - "showLineNumbers", - "showMiniMap" - ], - "properties": { - "language": { - "$ref": "#/components/schemas/CodeLanguage" - }, - "showLineNumbers": { - "type": "boolean", - "default": false - }, - "showMiniMap": { - "type": "boolean", - "default": false - } - } - }, - "PanelOptions": { - "type": "object", - "required": [ - "mode", - "content" - ], - "properties": { - "mode": { - "type": "string", - "$ref": "#/components/schemas/TextMode" - }, - "code": { - "$ref": "#/components/schemas/CodeOptions" - }, - "content": { - "type": "string", - "default": "# Title\n\nFor markdown syntax help: [commonmark.org/help](https://commonmark.org/help/)" - } - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/timeseries/panelcfg/x/timeseries_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/timeseries/panelcfg/x/timeseries_types_gen.json deleted file mode 100644 index 1f71e94..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/timeseries/panelcfg/x/timeseries_types_gen.json +++ /dev/null @@ -1,557 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "TimeSeriesPanelCfg", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "AxisColorMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "text", - "series" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "AxisConfig": { - "description": "TODO docs", - "type": "object", - "properties": { - "axisPlacement": { - "$ref": "#/components/schemas/AxisPlacement" - }, - "axisColorMode": { - "$ref": "#/components/schemas/AxisColorMode" - }, - "axisLabel": { - "type": "string" - }, - "axisWidth": { - "type": "number" - }, - "axisSoftMin": { - "type": "number" - }, - "axisSoftMax": { - "type": "number" - }, - "axisGridShow": { - "type": "boolean" - }, - "scaleDistribution": { - "$ref": "#/components/schemas/ScaleDistributionConfig" - }, - "axisCenteredZero": { - "type": "boolean" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "AxisPlacement": { - "description": "TODO docs", - "type": "string", - "enum": [ - "auto", - "top", - "right", - "bottom", - "left", - "hidden" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "BarAlignment": { - "description": "TODO docs", - "type": "integer", - "enum": [ - -1, - 0, - 1 - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "BarConfig": { - "description": "TODO docs", - "type": "object", - "properties": { - "barAlignment": { - "$ref": "#/components/schemas/BarAlignment" - }, - "barWidthFactor": { - "type": "number" - }, - "barMaxWidth": { - "type": "number" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "FillConfig": { - "description": "TODO docs", - "type": "object", - "properties": { - "fillColor": { - "type": "string" - }, - "fillOpacity": { - "type": "number" - }, - "fillBelowTo": { - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "GraphDrawStyle": { - "description": "TODO docs", - "type": "string", - "enum": [ - "line", - "bars", - "points" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "GraphFieldConfig": { - "description": "TODO docs", - "type": "object", - "properties": { - "drawStyle": { - "$ref": "#/components/schemas/GraphDrawStyle" - }, - "gradientMode": { - "$ref": "#/components/schemas/GraphGradientMode" - }, - "thresholdsStyle": { - "$ref": "#/components/schemas/GraphThresholdsStyleConfig" - }, - "transform": { - "$ref": "#/components/schemas/GraphTransform" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/LineConfig" - }, - { - "$ref": "#/components/schemas/FillConfig" - }, - { - "$ref": "#/components/schemas/PointsConfig" - }, - { - "$ref": "#/components/schemas/AxisConfig" - }, - { - "$ref": "#/components/schemas/BarConfig" - }, - { - "$ref": "#/components/schemas/StackableFieldConfig" - }, - { - "$ref": "#/components/schemas/HideableFieldConfig" - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "GraphGradientMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "none", - "opacity", - "hue", - "scheme" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "GraphThresholdsStyleConfig": { - "description": "TODO docs", - "type": "object", - "required": [ - "mode" - ], - "properties": { - "mode": { - "$ref": "#/components/schemas/GraphTresholdsStyleMode" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "GraphTransform": { - "description": "TODO docs", - "type": "string", - "enum": [ - "constant", - "negative-Y" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "GraphTresholdsStyleMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "off", - "line", - "dashed", - "area", - "line+area", - "dashed+area", - "series" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "HideSeriesConfig": { - "description": "TODO docs", - "type": "object", - "required": [ - "tooltip", - "legend", - "viz" - ], - "properties": { - "tooltip": { - "type": "boolean" - }, - "legend": { - "type": "boolean" - }, - "viz": { - "type": "boolean" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "HideableFieldConfig": { - "description": "TODO docs", - "type": "object", - "properties": { - "hideFrom": { - "$ref": "#/components/schemas/HideSeriesConfig" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "LegendDisplayMode": { - "description": "TODO docs\nNote: \"hidden\" needs to remain as an option for plugins compatibility", - "type": "string", - "enum": [ - "list", - "table", - "hidden" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "LegendPlacement": { - "description": "TODO docs", - "type": "string", - "enum": [ - "bottom", - "right" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "LineConfig": { - "description": "TODO docs", - "type": "object", - "properties": { - "lineColor": { - "type": "string" - }, - "lineWidth": { - "type": "number" - }, - "lineInterpolation": { - "$ref": "#/components/schemas/LineInterpolation" - }, - "lineStyle": { - "$ref": "#/components/schemas/LineStyle" - }, - "spanNulls": { - "description": "Indicate if null values should be treated as gaps or connected.\nWhen the value is a number, it represents the maximum delta in the\nX axis that should be considered connected. For timeseries, this is milliseconds", - "oneOf": [ - { - "type": "boolean" - }, - { - "type": "number" - } - ] - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "LineInterpolation": { - "description": "TODO docs", - "type": "string", - "enum": [ - "linear", - "smooth", - "stepBefore", - "stepAfter" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "LineStyle": { - "description": "TODO docs", - "type": "object", - "properties": { - "fill": { - "type": "string", - "enum": [ - "solid", - "dash", - "dot", - "square" - ] - }, - "dash": { - "type": "array", - "items": { - "type": "number" - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "OptionsWithTimezones": { - "description": "TODO docs", - "type": "object", - "properties": { - "timezone": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TimeZone" - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "PointsConfig": { - "description": "TODO docs", - "type": "object", - "properties": { - "showPoints": { - "$ref": "#/components/schemas/VisibilityMode" - }, - "pointSize": { - "type": "number" - }, - "pointColor": { - "type": "string" - }, - "pointSymbol": { - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ScaleDistribution": { - "description": "TODO docs", - "type": "string", - "enum": [ - "linear", - "log", - "ordinal", - "symlog" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ScaleDistributionConfig": { - "description": "TODO docs", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "$ref": "#/components/schemas/ScaleDistribution" - }, - "log": { - "type": "number" - }, - "linearThreshold": { - "type": "number" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "SortOrder": { - "description": "TODO docs", - "type": "string", - "enum": [ - "asc", - "desc", - "none" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "StackableFieldConfig": { - "description": "TODO docs", - "type": "object", - "properties": { - "stacking": { - "$ref": "#/components/schemas/StackingConfig" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "StackingConfig": { - "description": "TODO docs", - "type": "object", - "properties": { - "mode": { - "$ref": "#/components/schemas/StackingMode" - }, - "group": { - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "StackingMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "none", - "normal", - "percent" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TimeSeriesPanelCfg": { - "type": "object", - "required": [ - "PanelOptions", - "PanelFieldConfig" - ], - "properties": { - "PanelOptions": { - "type": "object", - "properties": { - "legend": { - "$ref": "#/components/schemas/VizLegendOptions" - }, - "tooltip": { - "$ref": "#/components/schemas/VizTooltipOptions" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OptionsWithTimezones" - }, - { - "required": [ - "legend", - "tooltip" - ] - } - ] - }, - "PanelFieldConfig": { - "type": "object", - "$ref": "#/components/schemas/GraphFieldConfig" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TimeZone": { - "description": "A specific timezone from https://en.wikipedia.org/wiki/Tz_database", - "type": "string", - "default": "browser", - "oneOf": [ - { - "enum": [ - "utc" - ] - }, - {} - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TooltipDisplayMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "single", - "multi", - "none" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VisibilityMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "auto", - "never", - "always" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VizLegendOptions": { - "description": "TODO docs", - "type": "object", - "required": [ - "displayMode", - "placement", - "showLegend", - "calcs" - ], - "properties": { - "displayMode": { - "$ref": "#/components/schemas/LegendDisplayMode" - }, - "placement": { - "$ref": "#/components/schemas/LegendPlacement" - }, - "showLegend": { - "type": "boolean" - }, - "asTable": { - "type": "boolean" - }, - "isVisible": { - "type": "boolean" - }, - "sortBy": { - "type": "string" - }, - "sortDesc": { - "type": "boolean" - }, - "width": { - "type": "number" - }, - "calcs": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VizTooltipOptions": { - "description": "TODO docs", - "type": "object", - "required": [ - "mode", - "sort" - ], - "properties": { - "mode": { - "$ref": "#/components/schemas/TooltipDisplayMode" - }, - "sort": { - "$ref": "#/components/schemas/SortOrder" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/trend/panelcfg/x/trend_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/trend/panelcfg/x/trend_types_gen.json deleted file mode 100644 index 3172e8a..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/trend/panelcfg/x/trend_types_gen.json +++ /dev/null @@ -1,528 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "TrendPanelCfg", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "AxisColorMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "text", - "series" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "AxisConfig": { - "description": "TODO docs", - "type": "object", - "properties": { - "axisPlacement": { - "$ref": "#/components/schemas/AxisPlacement" - }, - "axisColorMode": { - "$ref": "#/components/schemas/AxisColorMode" - }, - "axisLabel": { - "type": "string" - }, - "axisWidth": { - "type": "number" - }, - "axisSoftMin": { - "type": "number" - }, - "axisSoftMax": { - "type": "number" - }, - "axisGridShow": { - "type": "boolean" - }, - "scaleDistribution": { - "$ref": "#/components/schemas/ScaleDistributionConfig" - }, - "axisCenteredZero": { - "type": "boolean" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "AxisPlacement": { - "description": "TODO docs", - "type": "string", - "enum": [ - "auto", - "top", - "right", - "bottom", - "left", - "hidden" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "BarAlignment": { - "description": "TODO docs", - "type": "integer", - "enum": [ - -1, - 0, - 1 - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "BarConfig": { - "description": "TODO docs", - "type": "object", - "properties": { - "barAlignment": { - "$ref": "#/components/schemas/BarAlignment" - }, - "barWidthFactor": { - "type": "number" - }, - "barMaxWidth": { - "type": "number" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "FillConfig": { - "description": "TODO docs", - "type": "object", - "properties": { - "fillColor": { - "type": "string" - }, - "fillOpacity": { - "type": "number" - }, - "fillBelowTo": { - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "GraphDrawStyle": { - "description": "TODO docs", - "type": "string", - "enum": [ - "line", - "bars", - "points" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "GraphFieldConfig": { - "description": "TODO docs", - "type": "object", - "properties": { - "drawStyle": { - "$ref": "#/components/schemas/GraphDrawStyle" - }, - "gradientMode": { - "$ref": "#/components/schemas/GraphGradientMode" - }, - "thresholdsStyle": { - "$ref": "#/components/schemas/GraphThresholdsStyleConfig" - }, - "transform": { - "$ref": "#/components/schemas/GraphTransform" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/LineConfig" - }, - { - "$ref": "#/components/schemas/FillConfig" - }, - { - "$ref": "#/components/schemas/PointsConfig" - }, - { - "$ref": "#/components/schemas/AxisConfig" - }, - { - "$ref": "#/components/schemas/BarConfig" - }, - { - "$ref": "#/components/schemas/StackableFieldConfig" - }, - { - "$ref": "#/components/schemas/HideableFieldConfig" - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "GraphGradientMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "none", - "opacity", - "hue", - "scheme" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "GraphThresholdsStyleConfig": { - "description": "TODO docs", - "type": "object", - "required": [ - "mode" - ], - "properties": { - "mode": { - "$ref": "#/components/schemas/GraphTresholdsStyleMode" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "GraphTransform": { - "description": "TODO docs", - "type": "string", - "enum": [ - "constant", - "negative-Y" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "GraphTresholdsStyleMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "off", - "line", - "dashed", - "area", - "line+area", - "dashed+area", - "series" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "HideSeriesConfig": { - "description": "TODO docs", - "type": "object", - "required": [ - "tooltip", - "legend", - "viz" - ], - "properties": { - "tooltip": { - "type": "boolean" - }, - "legend": { - "type": "boolean" - }, - "viz": { - "type": "boolean" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "HideableFieldConfig": { - "description": "TODO docs", - "type": "object", - "properties": { - "hideFrom": { - "$ref": "#/components/schemas/HideSeriesConfig" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "LegendDisplayMode": { - "description": "TODO docs\nNote: \"hidden\" needs to remain as an option for plugins compatibility", - "type": "string", - "enum": [ - "list", - "table", - "hidden" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "LegendPlacement": { - "description": "TODO docs", - "type": "string", - "enum": [ - "bottom", - "right" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "LineConfig": { - "description": "TODO docs", - "type": "object", - "properties": { - "lineColor": { - "type": "string" - }, - "lineWidth": { - "type": "number" - }, - "lineInterpolation": { - "$ref": "#/components/schemas/LineInterpolation" - }, - "lineStyle": { - "$ref": "#/components/schemas/LineStyle" - }, - "spanNulls": { - "description": "Indicate if null values should be treated as gaps or connected.\nWhen the value is a number, it represents the maximum delta in the\nX axis that should be considered connected. For timeseries, this is milliseconds", - "oneOf": [ - { - "type": "boolean" - }, - { - "type": "number" - } - ] - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "LineInterpolation": { - "description": "TODO docs", - "type": "string", - "enum": [ - "linear", - "smooth", - "stepBefore", - "stepAfter" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "LineStyle": { - "description": "TODO docs", - "type": "object", - "properties": { - "fill": { - "type": "string", - "enum": [ - "solid", - "dash", - "dot", - "square" - ] - }, - "dash": { - "type": "array", - "items": { - "type": "number" - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "PointsConfig": { - "description": "TODO docs", - "type": "object", - "properties": { - "showPoints": { - "$ref": "#/components/schemas/VisibilityMode" - }, - "pointSize": { - "type": "number" - }, - "pointColor": { - "type": "string" - }, - "pointSymbol": { - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ScaleDistribution": { - "description": "TODO docs", - "type": "string", - "enum": [ - "linear", - "log", - "ordinal", - "symlog" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ScaleDistributionConfig": { - "description": "TODO docs", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "$ref": "#/components/schemas/ScaleDistribution" - }, - "log": { - "type": "number" - }, - "linearThreshold": { - "type": "number" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "SortOrder": { - "description": "TODO docs", - "type": "string", - "enum": [ - "asc", - "desc", - "none" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "StackableFieldConfig": { - "description": "TODO docs", - "type": "object", - "properties": { - "stacking": { - "$ref": "#/components/schemas/StackingConfig" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "StackingConfig": { - "description": "TODO docs", - "type": "object", - "properties": { - "mode": { - "$ref": "#/components/schemas/StackingMode" - }, - "group": { - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "StackingMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "none", - "normal", - "percent" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TooltipDisplayMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "single", - "multi", - "none" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TrendPanelCfg": { - "type": "object", - "required": [ - "PanelOptions", - "PanelFieldConfig" - ], - "properties": { - "PanelOptions": { - "description": "Identical to timeseries... except it does not have timezone settings", - "type": "object", - "required": [ - "legend", - "tooltip" - ], - "properties": { - "legend": { - "$ref": "#/components/schemas/VizLegendOptions" - }, - "tooltip": { - "$ref": "#/components/schemas/VizTooltipOptions" - }, - "xField": { - "description": "Name of the x field to use (defaults to first number)", - "type": "string" - } - } - }, - "PanelFieldConfig": { - "type": "object", - "$ref": "#/components/schemas/GraphFieldConfig" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VisibilityMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "auto", - "never", - "always" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VizLegendOptions": { - "description": "TODO docs", - "type": "object", - "required": [ - "displayMode", - "placement", - "showLegend", - "calcs" - ], - "properties": { - "displayMode": { - "$ref": "#/components/schemas/LegendDisplayMode" - }, - "placement": { - "$ref": "#/components/schemas/LegendPlacement" - }, - "showLegend": { - "type": "boolean" - }, - "asTable": { - "type": "boolean" - }, - "isVisible": { - "type": "boolean" - }, - "sortBy": { - "type": "string" - }, - "sortDesc": { - "type": "boolean" - }, - "width": { - "type": "number" - }, - "calcs": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VizTooltipOptions": { - "description": "TODO docs", - "type": "object", - "required": [ - "mode", - "sort" - ], - "properties": { - "mode": { - "$ref": "#/components/schemas/TooltipDisplayMode" - }, - "sort": { - "$ref": "#/components/schemas/SortOrder" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/xychart/panelcfg/x/xychart_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/xychart/panelcfg/x/xychart_types_gen.json deleted file mode 100644 index 42c820c..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/composable/xychart/panelcfg/x/xychart_types_gen.json +++ /dev/null @@ -1,622 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "XYChartPanelCfg", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "AxisColorMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "text", - "series" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "AxisConfig": { - "description": "TODO docs", - "type": "object", - "properties": { - "axisPlacement": { - "$ref": "#/components/schemas/AxisPlacement" - }, - "axisColorMode": { - "$ref": "#/components/schemas/AxisColorMode" - }, - "axisLabel": { - "type": "string" - }, - "axisWidth": { - "type": "number" - }, - "axisSoftMin": { - "type": "number" - }, - "axisSoftMax": { - "type": "number" - }, - "axisGridShow": { - "type": "boolean" - }, - "scaleDistribution": { - "$ref": "#/components/schemas/ScaleDistributionConfig" - }, - "axisCenteredZero": { - "type": "boolean" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "AxisPlacement": { - "description": "TODO docs", - "type": "string", - "enum": [ - "auto", - "top", - "right", - "bottom", - "left", - "hidden" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "BaseDimensionConfig": { - "type": "object", - "properties": { - "field": { - "description": "fixed: T -- will be added by each element", - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ColorDimensionConfig": { - "type": "object", - "properties": { - "fixed": { - "type": "string" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BaseDimensionConfig" - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "HideSeriesConfig": { - "description": "TODO docs", - "type": "object", - "required": [ - "tooltip", - "legend", - "viz" - ], - "properties": { - "tooltip": { - "type": "boolean" - }, - "legend": { - "type": "boolean" - }, - "viz": { - "type": "boolean" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "HideableFieldConfig": { - "description": "TODO docs", - "type": "object", - "properties": { - "hideFrom": { - "$ref": "#/components/schemas/HideSeriesConfig" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "LegendDisplayMode": { - "description": "TODO docs\nNote: \"hidden\" needs to remain as an option for plugins compatibility", - "type": "string", - "enum": [ - "list", - "table", - "hidden" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "LegendPlacement": { - "description": "TODO docs", - "type": "string", - "enum": [ - "bottom", - "right" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "LineStyle": { - "description": "TODO docs", - "type": "object", - "properties": { - "fill": { - "type": "string", - "enum": [ - "solid", - "dash", - "dot", - "square" - ] - }, - "dash": { - "type": "array", - "items": { - "type": "number" - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "OptionsWithLegend": { - "description": "TODO docs", - "type": "object", - "required": [ - "legend" - ], - "properties": { - "legend": { - "$ref": "#/components/schemas/VizLegendOptions" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "OptionsWithTooltip": { - "description": "TODO docs", - "type": "object", - "required": [ - "tooltip" - ], - "properties": { - "tooltip": { - "$ref": "#/components/schemas/VizTooltipOptions" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ScaleDimensionConfig": { - "type": "object", - "properties": { - "min": { - "type": "number" - }, - "max": { - "type": "number" - }, - "fixed": { - "type": "number" - }, - "mode": { - "$ref": "#/components/schemas/ScaleDimensionMode" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BaseDimensionConfig" - }, - { - "required": [ - "min", - "max" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ScaleDimensionMode": { - "type": "string", - "enum": [ - "linear", - "quad" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ScaleDistribution": { - "description": "TODO docs", - "type": "string", - "enum": [ - "linear", - "log", - "ordinal", - "symlog" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ScaleDistributionConfig": { - "description": "TODO docs", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "$ref": "#/components/schemas/ScaleDistribution" - }, - "log": { - "type": "number" - }, - "linearThreshold": { - "type": "number" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ScatterFieldConfig": { - "type": "object", - "properties": { - "show": { - "type": "string", - "$ref": "#/components/schemas/ScatterShow" - }, - "pointSize": { - "$ref": "#/components/schemas/ScaleDimensionConfig" - }, - "lineColor": { - "$ref": "#/components/schemas/ColorDimensionConfig" - }, - "pointColor": { - "$ref": "#/components/schemas/ColorDimensionConfig" - }, - "labelValue": { - "$ref": "#/components/schemas/TextDimensionConfig" - }, - "lineWidth": { - "type": "integer", - "minimum": 0, - "maximum": 2147483647 - }, - "lineStyle": { - "$ref": "#/components/schemas/LineStyle" - }, - "label": { - "type": "string", - "$ref": "#/components/schemas/VisibilityMode" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/HideableFieldConfig" - }, - { - "$ref": "#/components/schemas/AxisConfig" - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ScatterSeriesConfig": { - "type": "object", - "properties": { - "x": { - "type": "string" - }, - "y": { - "type": "string" - }, - "name": { - "type": "string" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/ScatterFieldConfig" - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ScatterShow": { - "type": "string", - "enum": [ - "points", - "lines", - "points+lines" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "SeriesMapping": { - "type": "string", - "enum": [ - "auto", - "manual" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "SortOrder": { - "description": "TODO docs", - "type": "string", - "enum": [ - "asc", - "desc", - "none" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TextDimensionConfig": { - "type": "object", - "properties": { - "mode": { - "$ref": "#/components/schemas/TextDimensionMode" - }, - "fixed": { - "type": "string" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/BaseDimensionConfig" - }, - { - "required": [ - "mode" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TextDimensionMode": { - "type": "string", - "enum": [ - "fixed", - "field", - "template" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "TooltipDisplayMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "single", - "multi", - "none" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VisibilityMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "auto", - "never", - "always" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VizLegendOptions": { - "description": "TODO docs", - "type": "object", - "required": [ - "displayMode", - "placement", - "showLegend", - "calcs" - ], - "properties": { - "displayMode": { - "$ref": "#/components/schemas/LegendDisplayMode" - }, - "placement": { - "$ref": "#/components/schemas/LegendPlacement" - }, - "showLegend": { - "type": "boolean" - }, - "asTable": { - "type": "boolean" - }, - "isVisible": { - "type": "boolean" - }, - "sortBy": { - "type": "string" - }, - "sortDesc": { - "type": "boolean" - }, - "width": { - "type": "number" - }, - "calcs": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VizTooltipOptions": { - "description": "TODO docs", - "type": "object", - "required": [ - "mode", - "sort" - ], - "properties": { - "mode": { - "$ref": "#/components/schemas/TooltipDisplayMode" - }, - "sort": { - "$ref": "#/components/schemas/SortOrder" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "XYChartPanelCfg": { - "type": "object", - "required": [ - "SeriesMapping", - "ScatterShow", - "XYDimensionConfig", - "ScatterFieldConfig", - "ScatterSeriesConfig", - "PanelOptions" - ], - "properties": { - "SeriesMapping": { - "type": "string", - "enum": [ - "auto", - "manual" - ] - }, - "ScatterShow": { - "type": "string", - "enum": [ - "points", - "lines", - "points+lines" - ] - }, - "XYDimensionConfig": { - "type": "object", - "required": [ - "frame" - ], - "properties": { - "frame": { - "type": "integer", - "minimum": 0, - "maximum": 2147483647 - }, - "x": { - "type": "string" - }, - "exclude": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "ScatterFieldConfig": { - "type": "object", - "properties": { - "show": { - "type": "string", - "$ref": "#/components/schemas/ScatterShow" - }, - "pointSize": { - "$ref": "#/components/schemas/ScaleDimensionConfig" - }, - "lineColor": { - "$ref": "#/components/schemas/ColorDimensionConfig" - }, - "pointColor": { - "$ref": "#/components/schemas/ColorDimensionConfig" - }, - "labelValue": { - "$ref": "#/components/schemas/TextDimensionConfig" - }, - "lineWidth": { - "type": "integer", - "minimum": 0, - "maximum": 2147483647 - }, - "lineStyle": { - "$ref": "#/components/schemas/LineStyle" - }, - "label": { - "type": "string", - "$ref": "#/components/schemas/VisibilityMode" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/HideableFieldConfig" - }, - { - "$ref": "#/components/schemas/AxisConfig" - } - ] - }, - "ScatterSeriesConfig": { - "type": "object", - "properties": { - "x": { - "type": "string" - }, - "y": { - "type": "string" - }, - "name": { - "type": "string" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/ScatterFieldConfig" - } - ] - }, - "PanelOptions": { - "type": "object", - "properties": { - "seriesMapping": { - "$ref": "#/components/schemas/SeriesMapping" - }, - "dims": { - "$ref": "#/components/schemas/XYDimensionConfig" - }, - "series": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ScatterSeriesConfig" - } - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OptionsWithLegend" - }, - { - "$ref": "#/components/schemas/OptionsWithTooltip" - }, - { - "required": [ - "dims", - "series" - ] - } - ] - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "XYDimensionConfig": { - "type": "object", - "required": [ - "frame" - ], - "properties": { - "frame": { - "type": "integer", - "minimum": 0, - "maximum": 2147483647 - }, - "x": { - "type": "string" - }, - "exclude": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/core/dashboard/x/dashboard_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/core/dashboard/x/dashboard_types_gen.json deleted file mode 100644 index 6fb102e..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/core/dashboard/x/dashboard_types_gen.json +++ /dev/null @@ -1,1630 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "dashboard", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "AnnotationContainer": { - "description": "TODO -- should not be a public interface on its own, but required for Veneer", - "type": "object", - "properties": { - "list": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AnnotationQuery" - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "AnnotationPanelFilter": { - "type": "object", - "required": [ - "ids" - ], - "properties": { - "exclude": { - "description": "Should the specified panels be included or excluded", - "type": "boolean", - "default": false - }, - "ids": { - "description": "Panel IDs that should be included or excluded", - "type": "array", - "items": { - "type": "integer", - "minimum": 0, - "maximum": 255 - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "AnnotationQuery": { - "description": "TODO docs\nFROM: AnnotationQuery in grafana-data/src/types/annotations.ts", - "type": "object", - "required": [ - "name", - "datasource", - "enable", - "iconColor" - ], - "properties": { - "name": { - "description": "Name of annotation.", - "type": "string" - }, - "datasource": { - "description": "TODO: Should be DataSourceRef", - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "uid": { - "type": "string" - } - } - }, - "enable": { - "description": "When enabled the annotation query is issued with every dashboard refresh", - "type": "boolean", - "default": true - }, - "hide": { - "description": "Annotation queries can be toggled on or off at the top of the dashboard.\nWhen hide is true, the toggle is not shown in the dashboard.", - "type": "boolean", - "default": false - }, - "iconColor": { - "description": "Color to use for the annotation event markers", - "type": "string" - }, - "filter": { - "$ref": "#/components/schemas/AnnotationPanelFilter" - }, - "target": { - "$ref": "#/components/schemas/AnnotationTarget" - }, - "type": { - "description": "TODO -- this should not exist here, it is based on the --grafana-- datasource", - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "AnnotationTarget": { - "description": "TODO: this should be a regular DataQuery that depends on the selected dashboard\nthese match the properties of the \"grafana\" datasouce that is default in most dashboards", - "type": "object", - "required": [ - "limit", - "matchAny", - "tags", - "type" - ], - "properties": { - "limit": { - "description": "Only required/valid for the grafana datasource...\nbut code+tests is already depending on it so hard to change", - "type": "integer", - "format": "int64" - }, - "matchAny": { - "description": "Only required/valid for the grafana datasource...\nbut code+tests is already depending on it so hard to change", - "type": "boolean" - }, - "tags": { - "description": "Only required/valid for the grafana datasource...\nbut code+tests is already depending on it so hard to change", - "type": "array", - "items": { - "type": "string" - } - }, - "type": { - "description": "Only required/valid for the grafana datasource...\nbut code+tests is already depending on it so hard to change", - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "DashboardCursorSync": { - "description": "0 for no shared crosshair or tooltip (default).\n1 for shared crosshair.\n2 for shared crosshair AND shared tooltip.", - "type": "integer", - "enum": [ - 0, - 1, - 2 - ], - "default": 0, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "DashboardLink": { - "description": "FROM public/app/features/dashboard/state/DashboardModels.ts - ish\nTODO docs", - "type": "object", - "required": [ - "title", - "type", - "icon", - "tooltip", - "url", - "tags", - "asDropdown", - "targetBlank", - "includeVars", - "keepTime" - ], - "properties": { - "title": { - "type": "string" - }, - "type": { - "$ref": "#/components/schemas/DashboardLinkType" - }, - "icon": { - "type": "string" - }, - "tooltip": { - "type": "string" - }, - "url": { - "type": "string" - }, - "tags": { - "type": "array", - "items": { - "type": "string" - } - }, - "asDropdown": { - "type": "boolean", - "default": false - }, - "targetBlank": { - "type": "boolean", - "default": false - }, - "includeVars": { - "type": "boolean", - "default": false - }, - "keepTime": { - "type": "boolean", - "default": false - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "DashboardLinkType": { - "description": "TODO docs", - "type": "string", - "enum": [ - "link", - "dashboards" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "DataSourceRef": { - "description": "Ref to a DataSource instance", - "type": "object", - "properties": { - "type": { - "description": "The plugin type-id", - "type": "string" - }, - "uid": { - "description": "Specific datasource instance", - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "DataTransformerConfig": { - "description": "TODO docs", - "type": "object", - "required": [ - "id", - "options" - ], - "properties": { - "id": { - "description": "Unique identifier of transformer", - "type": "string" - }, - "disabled": { - "description": "Disabled transformations are skipped", - "type": "boolean" - }, - "filter": { - "$ref": "#/components/schemas/MatcherConfig" - }, - "options": { - "description": "Options to be passed to the transformer\nValid options depend on the transformer id" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "DynamicConfigValue": { - "type": "object", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "string", - "default": "" - }, - "value": {} - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "FieldColor": { - "description": "TODO docs", - "type": "object", - "required": [ - "mode" - ], - "properties": { - "mode": { - "description": "The main color scheme mode", - "type": "string", - "oneOf": [ - { - "enum": [ - "thresholds", - "palette-classic", - "palette-saturated", - "continuous-GrYlRd", - "fixed" - ] - }, - {} - ] - }, - "fixedColor": { - "description": "Stores the fixed color value if mode is fixed", - "type": "string" - }, - "seriesBy": { - "$ref": "#/components/schemas/FieldColorSeriesByMode" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "FieldColorModeId": { - "description": "TODO docs", - "type": "string", - "enum": [ - "thresholds", - "palette-classic", - "palette-saturated", - "continuous-GrYlRd", - "fixed" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "FieldColorSeriesByMode": { - "description": "TODO docs", - "type": "string", - "enum": [ - "min", - "max", - "last" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "FieldConfig": { - "type": "object", - "properties": { - "displayName": { - "description": "The display value for this field. This supports template variables blank is auto", - "type": "string" - }, - "displayNameFromDS": { - "description": "This can be used by data sources that return and explicit naming structure for values and labels\nWhen this property is configured, this value is used rather than the default naming strategy.", - "type": "string" - }, - "description": { - "description": "Human readable field metadata", - "type": "string" - }, - "path": { - "description": "An explicit path to the field in the datasource. When the frame meta includes a path,\nThis will default to `${frame.meta.path}/${field.name}\n\nWhen defined, this value can be used as an identifier within the datasource scope, and\nmay be used to update the results", - "type": "string" - }, - "writeable": { - "description": "True if data source can write a value to the path. Auth/authz are supported separately", - "type": "boolean" - }, - "filterable": { - "description": "True if data source field supports ad-hoc filters", - "type": "boolean" - }, - "unit": { - "description": "Numeric Options", - "type": "string" - }, - "decimals": { - "description": "Significant digits (for display)", - "type": "number" - }, - "min": { - "type": "number" - }, - "max": { - "type": "number" - }, - "mappings": { - "description": "Convert input values into a display string", - "type": "array", - "items": { - "$ref": "#/components/schemas/ValueMapping" - } - }, - "thresholds": { - "$ref": "#/components/schemas/ThresholdsConfig" - }, - "color": { - "$ref": "#/components/schemas/FieldColor" - }, - "links": { - "description": "The behavior when clicking on a result", - "type": "array", - "items": {} - }, - "noValue": { - "description": "Alternative to empty string", - "type": "string" - }, - "custom": { - "description": "custom is specified by the PanelFieldConfig field\nin panel plugin schemas.", - "type": "object" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "FieldConfigSource": { - "type": "object", - "required": [ - "defaults", - "overrides" - ], - "properties": { - "defaults": { - "$ref": "#/components/schemas/FieldConfig" - }, - "overrides": { - "type": "array", - "items": { - "type": "object", - "required": [ - "matcher", - "properties" - ], - "properties": { - "matcher": { - "$ref": "#/components/schemas/MatcherConfig" - }, - "properties": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DynamicConfigValue" - } - } - } - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "GraphPanel": { - "description": "Support for legacy graph and heatmap panels.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "graph" - ] - }, - "legend": { - "description": "@deprecated this is part of deprecated graph panel", - "type": "object", - "required": [ - "show" - ], - "properties": { - "show": { - "type": "boolean", - "default": true - }, - "sort": { - "type": "string" - }, - "sortDesc": { - "type": "boolean" - } - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "GridPos": { - "type": "object", - "required": [ - "h", - "w", - "x", - "y" - ], - "properties": { - "h": { - "description": "Panel", - "type": "integer", - "minimum": 0, - "exclusiveMinimum": true, - "maximum": 4294967295, - "default": 9 - }, - "w": { - "description": "Panel", - "type": "integer", - "minimum": 0, - "exclusiveMinimum": true, - "maximum": 24, - "default": 12 - }, - "x": { - "description": "Panel x", - "type": "integer", - "minimum": 0, - "maximum": 24, - "exclusiveMaximum": true, - "default": 0 - }, - "y": { - "description": "Panel y", - "type": "integer", - "minimum": 0, - "maximum": 4294967295, - "default": 0 - }, - "static": { - "description": "true if fixed", - "type": "boolean" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "HeatmapPanel": { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "heatmap" - ] - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "LibraryPanelRef": { - "type": "object", - "required": [ - "name", - "uid" - ], - "properties": { - "name": { - "type": "string" - }, - "uid": { - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "LoadingState": { - "type": "string", - "enum": [ - "NotStarted", - "Loading", - "Streaming", - "Done", - "Error" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "MappingType": { - "description": "TODO docs", - "type": "string", - "enum": [ - "value", - "range", - "regex", - "special" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "MatcherConfig": { - "type": "object", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "string", - "default": "" - }, - "options": {} - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "Panel": { - "description": "Dashboard panels. Panels are canonically defined inline\nbecause they share a version timeline with the dashboard\nschema; they do not evolve independently.", - "type": "object", - "required": [ - "type", - "transparent", - "repeatDirection", - "transformations", - "options", - "fieldConfig" - ], - "properties": { - "type": { - "description": "The panel plugin type id. May not be empty.", - "type": "string", - "minLength": 1 - }, - "id": { - "description": "TODO docs", - "type": "integer", - "minimum": 0, - "maximum": 4294967295 - }, - "pluginVersion": { - "description": "FIXME this almost certainly has to be changed in favor of scuemata versions", - "type": "string" - }, - "tags": { - "description": "TODO docs", - "type": "array", - "items": { - "type": "string" - } - }, - "targets": { - "description": "TODO docs", - "type": "array", - "items": { - "$ref": "#/components/schemas/Target" - } - }, - "title": { - "description": "Panel title.", - "type": "string" - }, - "description": { - "description": "Description.", - "type": "string" - }, - "transparent": { - "description": "Whether to display the panel without a background.", - "type": "boolean", - "default": false - }, - "datasource": { - "description": "The datasource used in all targets.", - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "uid": { - "type": "string" - } - } - }, - "gridPos": { - "$ref": "#/components/schemas/GridPos" - }, - "links": { - "description": "Panel links.\nTODO fill this out - seems there are a couple variants?", - "type": "array", - "items": { - "$ref": "#/components/schemas/DashboardLink" - } - }, - "repeat": { - "description": "Name of template variable to repeat for.", - "type": "string" - }, - "repeatDirection": { - "description": "Direction to repeat in if 'repeat' is set.\n\"h\" for horizontal, \"v\" for vertical.\nTODO this is probably optional", - "type": "string", - "enum": [ - "h", - "v" - ], - "default": "h" - }, - "repeatPanelId": { - "description": "Id of the repeating panel.", - "type": "integer", - "format": "int64" - }, - "maxDataPoints": { - "description": "TODO docs", - "type": "number" - }, - "thresholds": { - "description": "TODO docs - seems to be an old field from old dashboard alerts?", - "type": "array", - "items": {} - }, - "timeRegions": { - "description": "TODO docs", - "type": "array", - "items": {} - }, - "transformations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DataTransformerConfig" - } - }, - "interval": { - "description": "TODO docs\nTODO tighter constraint", - "type": "string" - }, - "timeFrom": { - "description": "TODO docs\nTODO tighter constraint", - "type": "string" - }, - "timeShift": { - "description": "TODO docs\nTODO tighter constraint", - "type": "string" - }, - "libraryPanel": { - "$ref": "#/components/schemas/LibraryPanelRef" - }, - "options": { - "description": "options is specified by the PanelOptions field in panel\nplugin schemas.", - "type": "object" - }, - "fieldConfig": { - "$ref": "#/components/schemas/FieldConfigSource" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "RangeMap": { - "description": "TODO docs", - "type": "object", - "required": [ - "type", - "options" - ], - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/MappingType" - }, - { - "enum": [ - "range" - ] - } - ] - }, - "options": { - "type": "object", - "required": [ - "from", - "to", - "result" - ], - "properties": { - "from": { - "description": "to and from are `number | null` in current ts, really not sure what to do", - "type": "number", - "format": "double" - }, - "to": { - "type": "number", - "format": "double" - }, - "result": { - "$ref": "#/components/schemas/ValueMappingResult" - } - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "RegexMap": { - "description": "TODO docs", - "type": "object", - "required": [ - "type", - "options" - ], - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/MappingType" - }, - { - "enum": [ - "regex" - ] - } - ] - }, - "options": { - "type": "object", - "required": [ - "pattern", - "result" - ], - "properties": { - "pattern": { - "type": "string" - }, - "result": { - "$ref": "#/components/schemas/ValueMappingResult" - } - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "RowPanel": { - "description": "Row panel", - "type": "object", - "required": [ - "type", - "collapsed", - "id", - "panels" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "row" - ] - }, - "collapsed": { - "type": "boolean", - "default": false - }, - "title": { - "type": "string" - }, - "datasource": { - "description": "Name of default datasource.", - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "uid": { - "type": "string" - } - } - }, - "gridPos": { - "$ref": "#/components/schemas/GridPos" - }, - "id": { - "type": "integer", - "minimum": 0, - "maximum": 4294967295 - }, - "panels": { - "type": "array", - "items": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/Panel" - }, - { - "$ref": "#/components/schemas/GraphPanel" - }, - { - "$ref": "#/components/schemas/HeatmapPanel" - } - ] - } - }, - "repeat": { - "description": "Name of template variable to repeat for.", - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "Snapshot": { - "description": "TODO docs", - "type": "object", - "required": [ - "created", - "expires", - "external", - "externalUrl", - "id", - "key", - "name", - "orgId", - "updated", - "userId" - ], - "properties": { - "created": { - "description": "TODO docs", - "type": "string", - "format": "date-time" - }, - "expires": { - "description": "TODO docs", - "type": "string" - }, - "external": { - "description": "TODO docs", - "type": "boolean" - }, - "externalUrl": { - "description": "TODO docs", - "type": "string" - }, - "id": { - "description": "TODO docs", - "type": "integer", - "minimum": 0, - "maximum": 4294967295 - }, - "key": { - "description": "TODO docs", - "type": "string" - }, - "name": { - "description": "TODO docs", - "type": "string" - }, - "orgId": { - "description": "TODO docs", - "type": "integer", - "minimum": 0, - "maximum": 4294967295 - }, - "updated": { - "description": "TODO docs", - "type": "string", - "format": "date-time" - }, - "url": { - "description": "TODO docs", - "type": "string" - }, - "userId": { - "description": "TODO docs", - "type": "integer", - "minimum": 0, - "maximum": 4294967295 - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "SpecialValueMap": { - "description": "TODO docs", - "type": "object", - "required": [ - "type", - "options" - ], - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/MappingType" - }, - { - "enum": [ - "special" - ] - } - ] - }, - "options": { - "type": "object", - "required": [ - "match", - "pattern", - "result" - ], - "properties": { - "match": { - "type": "string", - "enum": [ - "true", - "false" - ] - }, - "pattern": { - "type": "string" - }, - "result": { - "$ref": "#/components/schemas/ValueMappingResult" - } - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "SpecialValueMatch": { - "description": "TODO docs", - "type": "string", - "enum": [ - "true", - "false", - "null", - "nan", - "null+nan", - "empty" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "Target": { - "description": "Schema for panel targets is specified by datasource\nplugins. We use a placeholder definition, which the Go\nschema loader either left open/as-is with the Base\nvariant of the Dashboard and Panel families, or filled\nwith types derived from plugins in the Instance variant.\nWhen working directly from CUE, importers can extend this\ntype directly to achieve the same effect.", - "type": "object", - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "Threshold": { - "description": "TODO docs", - "type": "object", - "required": [ - "color" - ], - "properties": { - "value": { - "description": "TODO docs\nFIXME the corresponding typescript field is required/non-optional, but nulls currently appear here when serializing -Infinity to JSON", - "type": "number" - }, - "color": { - "description": "TODO docs", - "type": "string" - }, - "index": { - "description": "Threshold index, an old property that is not needed an should only appear in older dashboards", - "type": "integer", - "format": "int32" - }, - "state": { - "description": "TODO docs\nTODO are the values here enumerable into a disjunction?\nSome seem to be listed in typescript comment", - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ThresholdsConfig": { - "type": "object", - "required": [ - "mode", - "steps" - ], - "properties": { - "mode": { - "$ref": "#/components/schemas/ThresholdsMode" - }, - "steps": { - "description": "Must be sorted by 'value', first value is always -Infinity", - "type": "array", - "items": { - "$ref": "#/components/schemas/Threshold" - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ThresholdsMode": { - "type": "string", - "enum": [ - "absolute", - "percentage" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ValueMap": { - "description": "TODO docs", - "type": "object", - "required": [ - "type", - "options" - ], - "properties": { - "type": { - "type": "string", - "allOf": [ - { - "$ref": "#/components/schemas/MappingType" - }, - { - "enum": [ - "value" - ] - } - ] - }, - "options": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/ValueMappingResult" - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ValueMapping": { - "description": "TODO docs", - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/ValueMap" - }, - { - "$ref": "#/components/schemas/RangeMap" - }, - { - "$ref": "#/components/schemas/RegexMap" - }, - { - "$ref": "#/components/schemas/SpecialValueMap" - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "ValueMappingResult": { - "description": "TODO docs", - "type": "object", - "properties": { - "text": { - "type": "string" - }, - "color": { - "type": "string" - }, - "icon": { - "type": "string" - }, - "index": { - "type": "integer", - "format": "int32" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VariableHide": { - "type": "integer", - "enum": [ - 0, - 1, - 2 - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VariableModel": { - "description": "FROM: packages/grafana-data/src/types/templateVars.ts\nTODO docs\nTODO what about what's in public/app/features/types.ts?\nTODO there appear to be a lot of different kinds of [template] vars here? if so need a disjunction", - "type": "object", - "required": [ - "id", - "type", - "name", - "global", - "hide", - "skipUrlSync", - "index", - "state" - ], - "properties": { - "id": { - "type": "string", - "default": "00000000-0000-0000-0000-000000000000" - }, - "type": { - "$ref": "#/components/schemas/VariableType" - }, - "name": { - "type": "string" - }, - "label": { - "type": "string" - }, - "rootStateKey": { - "type": "string" - }, - "global": { - "type": "boolean", - "default": false - }, - "hide": { - "$ref": "#/components/schemas/VariableHide" - }, - "skipUrlSync": { - "type": "boolean", - "default": false - }, - "index": { - "type": "integer", - "minimum": -2147483648, - "maximum": 2147483647, - "default": -1 - }, - "state": { - "$ref": "#/components/schemas/LoadingState" - }, - "error": { - "type": "object" - }, - "description": { - "type": "string" - }, - "query": { - "description": "TODO: Move this into a separated QueryVariableModel type", - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - } - ] - }, - "datasource": { - "$ref": "#/components/schemas/DataSourceRef" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "VariableType": { - "description": "FROM: packages/grafana-data/src/types/templateVars.ts\nTODO docs\nTODO this implies some wider pattern/discriminated union, probably?", - "type": "string", - "enum": [ - "query", - "adhoc", - "constant", - "datasource", - "interval", - "textbox", - "custom", - "system" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "_kubeObjectMetadata": { - "description": "_kubeObjectMetadata is metadata found in a kubernetes object's metadata field.\nIt is not exhaustive and only includes fields which may be relevant to a kind's implementation,\nAs it is also intended to be generic enough to function with any API Server.", - "type": "object", - "required": [ - "uid", - "creationTimestamp", - "finalizers", - "resourceVersion", - "labels" - ], - "properties": { - "uid": { - "type": "string" - }, - "creationTimestamp": { - "type": "string", - "format": "date-time" - }, - "deletionTimestamp": { - "type": "string", - "format": "date-time" - }, - "finalizers": { - "type": "array", - "items": { - "type": "string" - } - }, - "resourceVersion": { - "type": "string" - }, - "labels": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "dashboard": { - "type": "object", - "properties": { - "metadata": { - "description": "metadata contains embedded CommonMetadata and can be extended with custom string fields\nTODO: use CommonMetadata instead of redefining here; currently needs to be defined here\nwithout external reference as using the CommonMetadata reference breaks thema codegen.", - "type": "object", - "properties": { - "updateTimestamp": { - "type": "string", - "format": "date-time" - }, - "createdBy": { - "type": "string" - }, - "updatedBy": { - "type": "string" - }, - "extraFields": { - "description": "extraFields is reserved for any fields that are pulled from the API server metadata but do not have concrete fields in the CUE metadata", - "type": "object" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/_kubeObjectMetadata" - }, - { - "required": [ - "updateTimestamp", - "createdBy", - "updatedBy", - "extraFields" - ] - } - ] - }, - "spec": { - "type": "object", - "required": [ - "style", - "editable", - "graphTooltip", - "schemaVersion" - ], - "properties": { - "id": { - "description": "Unique numeric identifier for the dashboard.\nTODO must isolate or remove identifiers local to a Grafana instance...?", - "type": "integer", - "format": "int64" - }, - "uid": { - "description": "Unique dashboard identifier that can be generated by anyone. string (8-40)", - "type": "string" - }, - "title": { - "description": "Title of dashboard.", - "type": "string" - }, - "description": { - "description": "Description of dashboard.", - "type": "string" - }, - "revision": { - "description": "This property should only be used in dashboards defined by plugins. It is a quick check\nto see if the version has changed since the last time. Unclear why using the version property\nis insufficient.", - "type": "integer", - "format": "int64" - }, - "gnetId": { - "description": "For dashboards imported from the https://grafana.com/grafana/dashboards/ portal", - "type": "string" - }, - "tags": { - "description": "Tags associated with dashboard.", - "type": "array", - "items": { - "type": "string" - } - }, - "style": { - "description": "Theme of dashboard.", - "type": "string", - "enum": [ - "dark", - "light" - ], - "default": "dark" - }, - "timezone": { - "description": "Timezone of dashboard. Accepts IANA TZDB zone ID or \"browser\" or \"utc\".", - "type": "string", - "default": "browser" - }, - "editable": { - "description": "Whether a dashboard is editable or not.", - "type": "boolean", - "default": true - }, - "graphTooltip": { - "$ref": "#/components/schemas/DashboardCursorSync" - }, - "time": { - "description": "Time range for dashboard, e.g. last 6 hours, last 7 days, etc", - "type": "object", - "required": [ - "from", - "to" - ], - "properties": { - "from": { - "type": "string", - "default": "now-6h" - }, - "to": { - "type": "string", - "default": "now" - } - } - }, - "timepicker": { - "description": "TODO docs\nTODO this appears to be spread all over in the frontend. Concepts will likely need tidying in tandem with schema changes", - "type": "object", - "required": [ - "collapse", - "enable", - "hidden", - "refresh_intervals", - "time_options" - ], - "properties": { - "collapse": { - "description": "Whether timepicker is collapsed or not.", - "type": "boolean", - "default": false - }, - "enable": { - "description": "Whether timepicker is enabled or not.", - "type": "boolean", - "default": true - }, - "hidden": { - "description": "Whether timepicker is visible or not.", - "type": "boolean", - "default": false - }, - "refresh_intervals": { - "description": "Selectable intervals for auto-refresh.", - "type": "array", - "items": { - "type": "string" - }, - "default": [ - "5s", - "10s", - "30s", - "1m", - "5m", - "15m", - "30m", - "1h", - "2h", - "1d" - ] - }, - "time_options": { - "description": "TODO docs", - "type": "array", - "items": { - "type": "string" - }, - "default": [ - "5m", - "15m", - "1h", - "6h", - "12h", - "24h", - "2d", - "7d", - "30d" - ] - } - } - }, - "fiscalYearStartMonth": { - "description": "The month that the fiscal year starts on. 0 = January, 11 = December", - "type": "integer", - "minimum": 0, - "maximum": 12, - "exclusiveMaximum": true, - "default": 0 - }, - "liveNow": { - "description": "When set to true, the dashboard will redraw panels at an interval matching the pixel width.\nThis will keep data \"moving left\" regardless of the query refresh rate. This setting helps\navoid dashboards presenting stale live data", - "type": "boolean" - }, - "weekStart": { - "description": "TODO docs", - "type": "string" - }, - "refresh": { - "description": "Refresh rate of dashboard. Represented via interval string, e.g. \"5s\", \"1m\", \"1h\", \"1d\".", - "oneOf": [ - { - "enum": [ - false - ] - }, - { - "type": "string" - } - ] - }, - "schemaVersion": { - "description": "Version of the JSON schema, incremented each time a Grafana update brings\nchanges to said schema.\nTODO this is the existing schema numbering system. It will be replaced by Thema's themaVersion", - "type": "integer", - "minimum": 0, - "maximum": 65535, - "default": 36 - }, - "version": { - "description": "Version of the dashboard, incremented each time the dashboard is updated.", - "type": "integer", - "minimum": 0, - "maximum": 4294967295 - }, - "panels": { - "type": "array", - "items": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/Panel" - }, - { - "$ref": "#/components/schemas/RowPanel" - }, - { - "$ref": "#/components/schemas/GraphPanel" - }, - { - "$ref": "#/components/schemas/HeatmapPanel" - } - ] - } - }, - "templating": { - "description": "TODO docs", - "type": "object", - "properties": { - "list": { - "type": "array", - "items": { - "$ref": "#/components/schemas/VariableModel" - } - } - } - }, - "annotations": { - "$ref": "#/components/schemas/AnnotationContainer" - }, - "links": { - "description": "TODO docs", - "type": "array", - "items": { - "$ref": "#/components/schemas/DashboardLink" - } - }, - "snapshot": { - "$ref": "#/components/schemas/Snapshot" - } - } - }, - "status": { - "type": "object", - "required": [ - "additionalFields" - ], - "properties": { - "operatorStates": { - "description": "operatorStates is a map of operator ID to operator state evaluations.\nAny operator which consumes this kind SHOULD add its state evaluation information to this field.", - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/joinSchema.status.#OperatorState" - } - }, - "additionalFields": { - "description": "additionalFields is reserved for future use", - "type": "object" - } - } - } - }, - "allOf": [ - { - "required": [ - "metadata", - "spec", - "status" - ] - }, - { - "required": [ - "spec" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "joinSchema.status.#OperatorState": { - "type": "object", - "required": [ - "lastEvaluation", - "state" - ], - "properties": { - "lastEvaluation": { - "description": "lastEvaluation is the ResourceVersion last evaluated", - "type": "string" - }, - "state": { - "description": "state describes the state of the lastEvaluation.\nIt is limited to three possible states for machine evaluation.", - "type": "string", - "enum": [ - "success", - "in_progress", - "failed" - ] - }, - "descriptiveState": { - "description": "descriptiveState is an optional more descriptive state field which has no requirements on format", - "type": "string" - }, - "details": { - "description": "details contains any extra information that is operator-specific", - "type": "object" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "status.#OperatorState": { - "type": "object", - "required": [ - "lastEvaluation", - "state" - ], - "properties": { - "lastEvaluation": { - "description": "lastEvaluation is the ResourceVersion last evaluated", - "type": "string" - }, - "state": { - "description": "state describes the state of the lastEvaluation.\nIt is limited to three possible states for machine evaluation.", - "type": "string", - "enum": [ - "success", - "in_progress", - "failed" - ] - }, - "descriptiveState": { - "description": "descriptiveState is an optional more descriptive state field which has no requirements on format", - "type": "string" - }, - "details": { - "description": "details contains any extra information that is operator-specific", - "type": "object" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/core/librarypanel/x/librarypanel_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/core/librarypanel/x/librarypanel_types_gen.json deleted file mode 100644 index 9b63581..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/core/librarypanel/x/librarypanel_types_gen.json +++ /dev/null @@ -1,298 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "librarypanel", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "LibraryElementDTOMeta": { - "type": "object", - "required": [ - "folderName", - "folderUid", - "connectedDashboards", - "created", - "updated", - "createdBy", - "updatedBy" - ], - "properties": { - "folderName": { - "type": "string" - }, - "folderUid": { - "type": "string" - }, - "connectedDashboards": { - "type": "integer", - "format": "int64" - }, - "created": { - "type": "string", - "format": "date-time" - }, - "updated": { - "type": "string", - "format": "date-time" - }, - "createdBy": { - "$ref": "#/components/schemas/LibraryElementDTOMetaUser" - }, - "updatedBy": { - "$ref": "#/components/schemas/LibraryElementDTOMetaUser" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "LibraryElementDTOMetaUser": { - "type": "object", - "required": [ - "id", - "name", - "avatarUrl" - ], - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "avatarUrl": { - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "_kubeObjectMetadata": { - "description": "_kubeObjectMetadata is metadata found in a kubernetes object's metadata field.\nIt is not exhaustive and only includes fields which may be relevant to a kind's implementation,\nAs it is also intended to be generic enough to function with any API Server.", - "type": "object", - "required": [ - "uid", - "creationTimestamp", - "finalizers", - "resourceVersion", - "labels" - ], - "properties": { - "uid": { - "type": "string" - }, - "creationTimestamp": { - "type": "string", - "format": "date-time" - }, - "deletionTimestamp": { - "type": "string", - "format": "date-time" - }, - "finalizers": { - "type": "array", - "items": { - "type": "string" - } - }, - "resourceVersion": { - "type": "string" - }, - "labels": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "joinSchema.status.#OperatorState": { - "type": "object", - "required": [ - "lastEvaluation", - "state" - ], - "properties": { - "lastEvaluation": { - "description": "lastEvaluation is the ResourceVersion last evaluated", - "type": "string" - }, - "state": { - "description": "state describes the state of the lastEvaluation.\nIt is limited to three possible states for machine evaluation.", - "type": "string", - "enum": [ - "success", - "in_progress", - "failed" - ] - }, - "descriptiveState": { - "description": "descriptiveState is an optional more descriptive state field which has no requirements on format", - "type": "string" - }, - "details": { - "description": "details contains any extra information that is operator-specific", - "type": "object" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "librarypanel": { - "type": "object", - "properties": { - "metadata": { - "description": "metadata contains embedded CommonMetadata and can be extended with custom string fields\nTODO: use CommonMetadata instead of redefining here; currently needs to be defined here\nwithout external reference as using the CommonMetadata reference breaks thema codegen.", - "type": "object", - "properties": { - "updateTimestamp": { - "type": "string", - "format": "date-time" - }, - "createdBy": { - "type": "string" - }, - "updatedBy": { - "type": "string" - }, - "extraFields": { - "description": "extraFields is reserved for any fields that are pulled from the API server metadata but do not have concrete fields in the CUE metadata", - "type": "object" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/_kubeObjectMetadata" - }, - { - "required": [ - "updateTimestamp", - "createdBy", - "updatedBy", - "extraFields" - ] - } - ] - }, - "spec": { - "type": "object", - "required": [ - "uid", - "name", - "type", - "version", - "model" - ], - "properties": { - "folderUid": { - "description": "Folder UID", - "type": "string" - }, - "uid": { - "description": "Library element UID", - "type": "string" - }, - "name": { - "description": "Panel name (also saved in the model)", - "type": "string", - "minLength": 1 - }, - "description": { - "description": "Panel description", - "type": "string" - }, - "type": { - "description": "The panel type (from inside the model)", - "type": "string", - "minLength": 1 - }, - "schemaVersion": { - "description": "Dashboard version when this was saved (zero if unknown)", - "type": "integer", - "minimum": 0, - "maximum": 65535 - }, - "version": { - "description": "panel version, incremented each time the dashboard is updated.", - "type": "integer", - "format": "int64" - }, - "model": { - "description": "TODO: should be the same panel schema defined in dashboard\nTypescript: Omit\u003cPanel, 'gridPos' | 'id' | 'libraryPanel'\u003e;", - "type": "object" - }, - "meta": { - "$ref": "#/components/schemas/LibraryElementDTOMeta" - } - } - }, - "status": { - "type": "object", - "required": [ - "additionalFields" - ], - "properties": { - "operatorStates": { - "description": "operatorStates is a map of operator ID to operator state evaluations.\nAny operator which consumes this kind SHOULD add its state evaluation information to this field.", - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/joinSchema.status.#OperatorState" - } - }, - "additionalFields": { - "description": "additionalFields is reserved for future use", - "type": "object" - } - } - } - }, - "allOf": [ - { - "required": [ - "metadata", - "spec", - "status" - ] - }, - { - "required": [ - "spec" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "status.#OperatorState": { - "type": "object", - "required": [ - "lastEvaluation", - "state" - ], - "properties": { - "lastEvaluation": { - "description": "lastEvaluation is the ResourceVersion last evaluated", - "type": "string" - }, - "state": { - "description": "state describes the state of the lastEvaluation.\nIt is limited to three possible states for machine evaluation.", - "type": "string", - "enum": [ - "success", - "in_progress", - "failed" - ] - }, - "descriptiveState": { - "description": "descriptiveState is an optional more descriptive state field which has no requirements on format", - "type": "string" - }, - "details": { - "description": "details contains any extra information that is operator-specific", - "type": "object" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/core/playlist/x/playlist_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/core/playlist/x/playlist_types_gen.json deleted file mode 100644 index 5b8f327..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/core/playlist/x/playlist_types_gen.json +++ /dev/null @@ -1,243 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "playlist", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "PlaylistItem": { - "type": "object", - "required": [ - "type", - "value" - ], - "properties": { - "type": { - "description": "Type of the item.", - "type": "string", - "enum": [ - "dashboard_by_uid", - "dashboard_by_id", - "dashboard_by_tag" - ] - }, - "value": { - "description": "Value depends on type and describes the playlist item.\n\n - dashboard_by_id: The value is an internal numerical identifier set by Grafana. This\n is not portable as the numerical identifier is non-deterministic between different instances.\n Will be replaced by dashboard_by_uid in the future. (deprecated)\n - dashboard_by_tag: The value is a tag which is set on any number of dashboards. All\n dashboards behind the tag will be added to the playlist.\n - dashboard_by_uid: The value is the dashboard UID", - "type": "string" - }, - "title": { - "description": "Title is an unused property -- it will be removed in the future", - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "_kubeObjectMetadata": { - "description": "_kubeObjectMetadata is metadata found in a kubernetes object's metadata field.\nIt is not exhaustive and only includes fields which may be relevant to a kind's implementation,\nAs it is also intended to be generic enough to function with any API Server.", - "type": "object", - "required": [ - "uid", - "creationTimestamp", - "finalizers", - "resourceVersion", - "labels" - ], - "properties": { - "uid": { - "type": "string" - }, - "creationTimestamp": { - "type": "string", - "format": "date-time" - }, - "deletionTimestamp": { - "type": "string", - "format": "date-time" - }, - "finalizers": { - "type": "array", - "items": { - "type": "string" - } - }, - "resourceVersion": { - "type": "string" - }, - "labels": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "joinSchema.status.#OperatorState": { - "type": "object", - "required": [ - "lastEvaluation", - "state" - ], - "properties": { - "lastEvaluation": { - "description": "lastEvaluation is the ResourceVersion last evaluated", - "type": "string" - }, - "state": { - "description": "state describes the state of the lastEvaluation.\nIt is limited to three possible states for machine evaluation.", - "type": "string", - "enum": [ - "success", - "in_progress", - "failed" - ] - }, - "descriptiveState": { - "description": "descriptiveState is an optional more descriptive state field which has no requirements on format", - "type": "string" - }, - "details": { - "description": "details contains any extra information that is operator-specific", - "type": "object" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "playlist": { - "type": "object", - "properties": { - "metadata": { - "description": "metadata contains embedded CommonMetadata and can be extended with custom string fields\nTODO: use CommonMetadata instead of redefining here; currently needs to be defined here\nwithout external reference as using the CommonMetadata reference breaks thema codegen.", - "type": "object", - "properties": { - "updateTimestamp": { - "type": "string", - "format": "date-time" - }, - "createdBy": { - "type": "string" - }, - "updatedBy": { - "type": "string" - }, - "extraFields": { - "description": "extraFields is reserved for any fields that are pulled from the API server metadata but do not have concrete fields in the CUE metadata", - "type": "object" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/_kubeObjectMetadata" - }, - { - "required": [ - "updateTimestamp", - "createdBy", - "updatedBy", - "extraFields" - ] - } - ] - }, - "spec": { - "type": "object", - "required": [ - "uid", - "name", - "interval" - ], - "properties": { - "uid": { - "description": "Unique playlist identifier. Generated on creation, either by the\ncreator of the playlist of by the application.", - "type": "string" - }, - "name": { - "description": "Name of the playlist.", - "type": "string" - }, - "interval": { - "description": "Interval sets the time between switching views in a playlist.\nFIXME: Is this based on a standardized format or what options are available? Can datemath be used?", - "type": "string", - "default": "5m" - }, - "items": { - "description": "The ordered list of items that the playlist will iterate over.\nFIXME! This should not be optional, but changing it makes the godegen awkward", - "type": "array", - "items": { - "$ref": "#/components/schemas/PlaylistItem" - } - } - } - }, - "status": { - "type": "object", - "required": [ - "additionalFields" - ], - "properties": { - "operatorStates": { - "description": "operatorStates is a map of operator ID to operator state evaluations.\nAny operator which consumes this kind SHOULD add its state evaluation information to this field.", - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/joinSchema.status.#OperatorState" - } - }, - "additionalFields": { - "description": "additionalFields is reserved for future use", - "type": "object" - } - } - } - }, - "allOf": [ - { - "required": [ - "metadata", - "spec", - "status" - ] - }, - { - "required": [ - "spec" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "status.#OperatorState": { - "type": "object", - "required": [ - "lastEvaluation", - "state" - ], - "properties": { - "lastEvaluation": { - "description": "lastEvaluation is the ResourceVersion last evaluated", - "type": "string" - }, - "state": { - "description": "state describes the state of the lastEvaluation.\nIt is limited to three possible states for machine evaluation.", - "type": "string", - "enum": [ - "success", - "in_progress", - "failed" - ] - }, - "descriptiveState": { - "description": "descriptiveState is an optional more descriptive state field which has no requirements on format", - "type": "string" - }, - "details": { - "description": "details contains any extra information that is operator-specific", - "type": "object" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/core/preferences/x/preferences_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/core/preferences/x/preferences_types_gen.json deleted file mode 100644 index 692bfeb..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/core/preferences/x/preferences_types_gen.json +++ /dev/null @@ -1,224 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "preferences", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "QueryHistoryPreference": { - "type": "object", - "properties": { - "homeTab": { - "description": "one of: '' | 'query' | 'starred';", - "type": "string" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "_kubeObjectMetadata": { - "description": "_kubeObjectMetadata is metadata found in a kubernetes object's metadata field.\nIt is not exhaustive and only includes fields which may be relevant to a kind's implementation,\nAs it is also intended to be generic enough to function with any API Server.", - "type": "object", - "required": [ - "uid", - "creationTimestamp", - "finalizers", - "resourceVersion", - "labels" - ], - "properties": { - "uid": { - "type": "string" - }, - "creationTimestamp": { - "type": "string", - "format": "date-time" - }, - "deletionTimestamp": { - "type": "string", - "format": "date-time" - }, - "finalizers": { - "type": "array", - "items": { - "type": "string" - } - }, - "resourceVersion": { - "type": "string" - }, - "labels": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "joinSchema.status.#OperatorState": { - "type": "object", - "required": [ - "lastEvaluation", - "state" - ], - "properties": { - "lastEvaluation": { - "description": "lastEvaluation is the ResourceVersion last evaluated", - "type": "string" - }, - "state": { - "description": "state describes the state of the lastEvaluation.\nIt is limited to three possible states for machine evaluation.", - "type": "string", - "enum": [ - "success", - "in_progress", - "failed" - ] - }, - "descriptiveState": { - "description": "descriptiveState is an optional more descriptive state field which has no requirements on format", - "type": "string" - }, - "details": { - "description": "details contains any extra information that is operator-specific", - "type": "object" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "preferences": { - "type": "object", - "properties": { - "metadata": { - "description": "metadata contains embedded CommonMetadata and can be extended with custom string fields\nTODO: use CommonMetadata instead of redefining here; currently needs to be defined here\nwithout external reference as using the CommonMetadata reference breaks thema codegen.", - "type": "object", - "properties": { - "updateTimestamp": { - "type": "string", - "format": "date-time" - }, - "createdBy": { - "type": "string" - }, - "updatedBy": { - "type": "string" - }, - "extraFields": { - "description": "extraFields is reserved for any fields that are pulled from the API server metadata but do not have concrete fields in the CUE metadata", - "type": "object" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/_kubeObjectMetadata" - }, - { - "required": [ - "updateTimestamp", - "createdBy", - "updatedBy", - "extraFields" - ] - } - ] - }, - "spec": { - "type": "object", - "properties": { - "homeDashboardUID": { - "description": "UID for the home dashboard", - "type": "string" - }, - "timezone": { - "description": "The timezone selection\nTODO: this should use the timezone defined in common", - "type": "string" - }, - "weekStart": { - "description": "day of the week (sunday, monday, etc)", - "type": "string" - }, - "theme": { - "description": "light, dark, empty is default", - "type": "string" - }, - "language": { - "description": "Selected language (beta)", - "type": "string" - }, - "queryHistory": { - "$ref": "#/components/schemas/QueryHistoryPreference" - } - } - }, - "status": { - "type": "object", - "required": [ - "additionalFields" - ], - "properties": { - "operatorStates": { - "description": "operatorStates is a map of operator ID to operator state evaluations.\nAny operator which consumes this kind SHOULD add its state evaluation information to this field.", - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/joinSchema.status.#OperatorState" - } - }, - "additionalFields": { - "description": "additionalFields is reserved for future use", - "type": "object" - } - } - } - }, - "allOf": [ - { - "required": [ - "metadata", - "spec", - "status" - ] - }, - { - "required": [ - "spec" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "status.#OperatorState": { - "type": "object", - "required": [ - "lastEvaluation", - "state" - ], - "properties": { - "lastEvaluation": { - "description": "lastEvaluation is the ResourceVersion last evaluated", - "type": "string" - }, - "state": { - "description": "state describes the state of the lastEvaluation.\nIt is limited to three possible states for machine evaluation.", - "type": "string", - "enum": [ - "success", - "in_progress", - "failed" - ] - }, - "descriptiveState": { - "description": "descriptiveState is an optional more descriptive state field which has no requirements on format", - "type": "string" - }, - "details": { - "description": "details contains any extra information that is operator-specific", - "type": "object" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/core/publicdashboard/x/publicdashboard_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/core/publicdashboard/x/publicdashboard_types_gen.json deleted file mode 100644 index 1422bfa..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/core/publicdashboard/x/publicdashboard_types_gen.json +++ /dev/null @@ -1,222 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "publicdashboard", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "_kubeObjectMetadata": { - "description": "_kubeObjectMetadata is metadata found in a kubernetes object's metadata field.\nIt is not exhaustive and only includes fields which may be relevant to a kind's implementation,\nAs it is also intended to be generic enough to function with any API Server.", - "type": "object", - "required": [ - "uid", - "creationTimestamp", - "finalizers", - "resourceVersion", - "labels" - ], - "properties": { - "uid": { - "type": "string" - }, - "creationTimestamp": { - "type": "string", - "format": "date-time" - }, - "deletionTimestamp": { - "type": "string", - "format": "date-time" - }, - "finalizers": { - "type": "array", - "items": { - "type": "string" - } - }, - "resourceVersion": { - "type": "string" - }, - "labels": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "joinSchema.status.#OperatorState": { - "type": "object", - "required": [ - "lastEvaluation", - "state" - ], - "properties": { - "lastEvaluation": { - "description": "lastEvaluation is the ResourceVersion last evaluated", - "type": "string" - }, - "state": { - "description": "state describes the state of the lastEvaluation.\nIt is limited to three possible states for machine evaluation.", - "type": "string", - "enum": [ - "success", - "in_progress", - "failed" - ] - }, - "descriptiveState": { - "description": "descriptiveState is an optional more descriptive state field which has no requirements on format", - "type": "string" - }, - "details": { - "description": "details contains any extra information that is operator-specific", - "type": "object" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "publicdashboard": { - "type": "object", - "properties": { - "metadata": { - "description": "metadata contains embedded CommonMetadata and can be extended with custom string fields\nTODO: use CommonMetadata instead of redefining here; currently needs to be defined here\nwithout external reference as using the CommonMetadata reference breaks thema codegen.", - "type": "object", - "properties": { - "updateTimestamp": { - "type": "string", - "format": "date-time" - }, - "createdBy": { - "type": "string" - }, - "updatedBy": { - "type": "string" - }, - "extraFields": { - "description": "extraFields is reserved for any fields that are pulled from the API server metadata but do not have concrete fields in the CUE metadata", - "type": "object" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/_kubeObjectMetadata" - }, - { - "required": [ - "updateTimestamp", - "createdBy", - "updatedBy", - "extraFields" - ] - } - ] - }, - "spec": { - "type": "object", - "required": [ - "uid", - "dashboardUid", - "isEnabled", - "annotationsEnabled", - "timeSelectionEnabled" - ], - "properties": { - "uid": { - "description": "Unique public dashboard identifier", - "type": "string" - }, - "dashboardUid": { - "description": "Dashboard unique identifier referenced by this public dashboard", - "type": "string" - }, - "accessToken": { - "description": "Unique public access token", - "type": "string" - }, - "isEnabled": { - "description": "Flag that indicates if the public dashboard is enabled", - "type": "boolean" - }, - "annotationsEnabled": { - "description": "Flag that indicates if annotations are enabled", - "type": "boolean" - }, - "timeSelectionEnabled": { - "description": "Flag that indicates if the time range picker is enabled", - "type": "boolean" - } - } - }, - "status": { - "type": "object", - "required": [ - "additionalFields" - ], - "properties": { - "operatorStates": { - "description": "operatorStates is a map of operator ID to operator state evaluations.\nAny operator which consumes this kind SHOULD add its state evaluation information to this field.", - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/joinSchema.status.#OperatorState" - } - }, - "additionalFields": { - "description": "additionalFields is reserved for future use", - "type": "object" - } - } - } - }, - "allOf": [ - { - "required": [ - "metadata", - "spec", - "status" - ] - }, - { - "required": [ - "spec" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "status.#OperatorState": { - "type": "object", - "required": [ - "lastEvaluation", - "state" - ], - "properties": { - "lastEvaluation": { - "description": "lastEvaluation is the ResourceVersion last evaluated", - "type": "string" - }, - "state": { - "description": "state describes the state of the lastEvaluation.\nIt is limited to three possible states for machine evaluation.", - "type": "string", - "enum": [ - "success", - "in_progress", - "failed" - ] - }, - "descriptiveState": { - "description": "descriptiveState is an optional more descriptive state field which has no requirements on format", - "type": "string" - }, - "details": { - "description": "details contains any extra information that is operator-specific", - "type": "object" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/core/serviceaccount/x/serviceaccount_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/core/serviceaccount/x/serviceaccount_types_gen.json deleted file mode 100644 index f8d0fca..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/core/serviceaccount/x/serviceaccount_types_gen.json +++ /dev/null @@ -1,259 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "serviceaccount", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "OrgRole": { - "description": "OrgRole is a Grafana Organization Role which can be 'Viewer', 'Editor', 'Admin'.", - "type": "string", - "enum": [ - "Admin", - "Editor", - "Viewer" - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "_kubeObjectMetadata": { - "description": "_kubeObjectMetadata is metadata found in a kubernetes object's metadata field.\nIt is not exhaustive and only includes fields which may be relevant to a kind's implementation,\nAs it is also intended to be generic enough to function with any API Server.", - "type": "object", - "required": [ - "uid", - "creationTimestamp", - "finalizers", - "resourceVersion", - "labels" - ], - "properties": { - "uid": { - "type": "string" - }, - "creationTimestamp": { - "type": "string", - "format": "date-time" - }, - "deletionTimestamp": { - "type": "string", - "format": "date-time" - }, - "finalizers": { - "type": "array", - "items": { - "type": "string" - } - }, - "resourceVersion": { - "type": "string" - }, - "labels": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "joinSchema.status.#OperatorState": { - "type": "object", - "required": [ - "lastEvaluation", - "state" - ], - "properties": { - "lastEvaluation": { - "description": "lastEvaluation is the ResourceVersion last evaluated", - "type": "string" - }, - "state": { - "description": "state describes the state of the lastEvaluation.\nIt is limited to three possible states for machine evaluation.", - "type": "string", - "enum": [ - "success", - "in_progress", - "failed" - ] - }, - "descriptiveState": { - "description": "descriptiveState is an optional more descriptive state field which has no requirements on format", - "type": "string" - }, - "details": { - "description": "details contains any extra information that is operator-specific", - "type": "object" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "serviceaccount": { - "type": "object", - "properties": { - "metadata": { - "description": "metadata contains embedded CommonMetadata and can be extended with custom string fields\nTODO: use CommonMetadata instead of redefining here; currently needs to be defined here\nwithout external reference as using the CommonMetadata reference breaks thema codegen.", - "type": "object", - "properties": { - "updateTimestamp": { - "type": "string", - "format": "date-time" - }, - "createdBy": { - "type": "string" - }, - "updatedBy": { - "type": "string" - }, - "extraFields": { - "description": "extraFields is reserved for any fields that are pulled from the API server metadata but do not have concrete fields in the CUE metadata", - "type": "object" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/_kubeObjectMetadata" - }, - { - "required": [ - "updateTimestamp", - "createdBy", - "updatedBy", - "extraFields" - ] - } - ] - }, - "spec": { - "type": "object", - "required": [ - "id", - "orgId", - "name", - "login", - "isDisabled", - "role", - "tokens", - "avatarUrl" - ], - "properties": { - "id": { - "description": "ID is the unique identifier of the service account in the database.", - "type": "integer", - "format": "int64" - }, - "orgId": { - "description": "OrgId is the ID of an organisation the service account belongs to.", - "type": "integer", - "format": "int64" - }, - "name": { - "description": "Name of the service account.", - "type": "string" - }, - "login": { - "description": "Login of the service account.", - "type": "string" - }, - "isDisabled": { - "description": "IsDisabled indicates if the service account is disabled.", - "type": "boolean" - }, - "role": { - "$ref": "#/components/schemas/OrgRole" - }, - "tokens": { - "description": "Tokens is the number of active tokens for the service account.\nTokens are used to authenticate the service account against Grafana.", - "type": "integer", - "format": "int64" - }, - "avatarUrl": { - "description": "AvatarUrl is the service account's avatar URL. It allows the frontend to display a picture in front\nof the service account.", - "type": "string" - }, - "accessControl": { - "description": "AccessControl metadata associated with a given resource.", - "type": "object", - "additionalProperties": { - "type": "boolean" - } - }, - "teams": { - "description": "Teams is a list of teams the service account belongs to.", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "status": { - "type": "object", - "required": [ - "additionalFields" - ], - "properties": { - "operatorStates": { - "description": "operatorStates is a map of operator ID to operator state evaluations.\nAny operator which consumes this kind SHOULD add its state evaluation information to this field.", - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/joinSchema.status.#OperatorState" - } - }, - "additionalFields": { - "description": "additionalFields is reserved for future use", - "type": "object" - } - } - } - }, - "allOf": [ - { - "required": [ - "metadata", - "spec", - "status" - ] - }, - { - "required": [ - "spec" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "status.#OperatorState": { - "type": "object", - "required": [ - "lastEvaluation", - "state" - ], - "properties": { - "lastEvaluation": { - "description": "lastEvaluation is the ResourceVersion last evaluated", - "type": "string" - }, - "state": { - "description": "state describes the state of the lastEvaluation.\nIt is limited to three possible states for machine evaluation.", - "type": "string", - "enum": [ - "success", - "in_progress", - "failed" - ] - }, - "descriptiveState": { - "description": "descriptiveState is an optional more descriptive state field which has no requirements on format", - "type": "string" - }, - "details": { - "description": "details contains any extra information that is operator-specific", - "type": "object" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/core/team/x/team_types_gen.json b/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/core/team/x/team_types_gen.json deleted file mode 100644 index c782be8..0000000 --- a/vendor/github.com/grafana/grok/jsonnet/v10.0.0/kinds/core/team/x/team_types_gen.json +++ /dev/null @@ -1,239 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "team", - "version": "0.0" - }, - "paths": {}, - "components": { - "schemas": { - "Permission": { - "type": "integer", - "enum": [ - 0, - 1, - 2, - 4 - ], - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "_kubeObjectMetadata": { - "description": "_kubeObjectMetadata is metadata found in a kubernetes object's metadata field.\nIt is not exhaustive and only includes fields which may be relevant to a kind's implementation,\nAs it is also intended to be generic enough to function with any API Server.", - "type": "object", - "required": [ - "uid", - "creationTimestamp", - "finalizers", - "resourceVersion", - "labels" - ], - "properties": { - "uid": { - "type": "string" - }, - "creationTimestamp": { - "type": "string", - "format": "date-time" - }, - "deletionTimestamp": { - "type": "string", - "format": "date-time" - }, - "finalizers": { - "type": "array", - "items": { - "type": "string" - } - }, - "resourceVersion": { - "type": "string" - }, - "labels": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "joinSchema.status.#OperatorState": { - "type": "object", - "required": [ - "lastEvaluation", - "state" - ], - "properties": { - "lastEvaluation": { - "description": "lastEvaluation is the ResourceVersion last evaluated", - "type": "string" - }, - "state": { - "description": "state describes the state of the lastEvaluation.\nIt is limited to three possible states for machine evaluation.", - "type": "string", - "enum": [ - "success", - "in_progress", - "failed" - ] - }, - "descriptiveState": { - "description": "descriptiveState is an optional more descriptive state field which has no requirements on format", - "type": "string" - }, - "details": { - "description": "details contains any extra information that is operator-specific", - "type": "object" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "status.#OperatorState": { - "type": "object", - "required": [ - "lastEvaluation", - "state" - ], - "properties": { - "lastEvaluation": { - "description": "lastEvaluation is the ResourceVersion last evaluated", - "type": "string" - }, - "state": { - "description": "state describes the state of the lastEvaluation.\nIt is limited to three possible states for machine evaluation.", - "type": "string", - "enum": [ - "success", - "in_progress", - "failed" - ] - }, - "descriptiveState": { - "description": "descriptiveState is an optional more descriptive state field which has no requirements on format", - "type": "string" - }, - "details": { - "description": "details contains any extra information that is operator-specific", - "type": "object" - } - }, - "$schema": "http://json-schema.org/draft-04/schema#" - }, - "team": { - "type": "object", - "properties": { - "metadata": { - "description": "metadata contains embedded CommonMetadata and can be extended with custom string fields\nTODO: use CommonMetadata instead of redefining here; currently needs to be defined here\nwithout external reference as using the CommonMetadata reference breaks thema codegen.", - "type": "object", - "properties": { - "updateTimestamp": { - "type": "string", - "format": "date-time" - }, - "createdBy": { - "type": "string" - }, - "updatedBy": { - "type": "string" - }, - "extraFields": { - "description": "extraFields is reserved for any fields that are pulled from the API server metadata but do not have concrete fields in the CUE metadata", - "type": "object" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/_kubeObjectMetadata" - }, - { - "required": [ - "updateTimestamp", - "createdBy", - "updatedBy", - "extraFields" - ] - } - ] - }, - "spec": { - "type": "object", - "required": [ - "orgId", - "name", - "memberCount", - "permission" - ], - "properties": { - "orgId": { - "description": "OrgId is the ID of an organisation the team belongs to.", - "type": "integer", - "format": "int64" - }, - "name": { - "description": "Name of the team.", - "type": "string" - }, - "email": { - "description": "Email of the team.", - "type": "string" - }, - "avatarUrl": { - "description": "AvatarUrl is the team's avatar URL.", - "type": "string" - }, - "memberCount": { - "description": "MemberCount is the number of the team members.", - "type": "integer", - "format": "int64" - }, - "permission": { - "$ref": "#/components/schemas/Permission" - }, - "accessControl": { - "description": "AccessControl metadata associated with a given resource.", - "type": "object", - "additionalProperties": { - "type": "boolean" - } - } - } - }, - "status": { - "type": "object", - "required": [ - "additionalFields" - ], - "properties": { - "operatorStates": { - "description": "operatorStates is a map of operator ID to operator state evaluations.\nAny operator which consumes this kind SHOULD add its state evaluation information to this field.", - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/joinSchema.status.#OperatorState" - } - }, - "additionalFields": { - "description": "additionalFields is reserved for future use", - "type": "object" - } - } - } - }, - "allOf": [ - { - "required": [ - "metadata", - "spec", - "status" - ] - }, - { - "required": [ - "spec" - ] - } - ], - "$schema": "http://json-schema.org/draft-04/schema#" - } - } - } -} \ No newline at end of file diff --git a/vendor/github.com/jsonnet-libs/docsonnet/doc-util/README.md b/vendor/github.com/jsonnet-libs/docsonnet/doc-util/README.md deleted file mode 100644 index aa19a25..0000000 --- a/vendor/github.com/jsonnet-libs/docsonnet/doc-util/README.md +++ /dev/null @@ -1,231 +0,0 @@ -# doc-util - -`doc-util` provides a Jsonnet interface for `docsonnet`, - a Jsonnet API doc generator that uses structured data instead of comments. - - -## Install - -``` -jb install github.com/jsonnet-libs/docsonnet/doc-util@master -``` - -## Usage - -```jsonnet -local d = import "github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet" -``` - -## Index - -* [`fn arg(name, type, default, enums)`](#fn-arg) -* [`fn fn(help, args)`](#fn-fn) -* [`fn obj(help, fields)`](#fn-obj) -* [`fn pkg(name, url, help, filename="", version="master")`](#fn-pkg) -* [`fn render(obj)`](#fn-render) -* [`fn val(type, help, default)`](#fn-val) -* [`obj argument`](#obj-argument) - * [`fn new(name, type, default, enums)`](#fn-argumentnew) -* [`obj func`](#obj-func) - * [`fn new(help, args)`](#fn-funcnew) - * [`fn withArgs(args)`](#fn-funcwithargs) - * [`fn withHelp(help)`](#fn-funcwithhelp) -* [`obj object`](#obj-object) - * [`fn new(help, fields)`](#fn-objectnew) - * [`fn withFields(fields)`](#fn-objectwithfields) -* [`obj value`](#obj-value) - * [`fn new(type, help, default)`](#fn-valuenew) -* [`obj T`](#obj-t) -* [`obj package`](#obj-package) - * [`fn new(name, url, help, filename="", version="master")`](#fn-packagenew) - * [`fn newSub(name, help)`](#fn-packagenewsub) - -## Fields - -### fn arg - -```ts -arg(name, type, default, enums) -``` - -`arg` is a shorthand for `argument.new` - -### fn fn - -```ts -fn(help, args) -``` - -`fn` is a shorthand for `func.new` - -### fn obj - -```ts -obj(help, fields) -``` - -`obj` is a shorthand for `object.new` - -### fn pkg - -```ts -pkg(name, url, help, filename="", version="master") -``` - -`new` is a shorthand for `package.new` - -### fn render - -```ts -render(obj) -``` - -`render` converts the docstrings to human readable Markdown files. - -Usage: - -```jsonnet -// docs.jsonnet -d.render(import 'main.libsonnet') -``` - -Call with: `jsonnet -S -c -m docs/ docs.jsonnet` - - -### fn val - -```ts -val(type, help, default) -``` - -`val` is a shorthand for `value.new` - -### obj argument - -Utilities for creating function arguments - -#### fn argument.new - -```ts -new(name, type, default, enums) -``` - -`new` creates a new function argument, taking the `name`, the `type`. Optionally it -can take a `default` value and `enum`-erate potential values. - -Examples: - -```jsonnet -[ - d.argument.new('foo', d.T.string), - d.argument.new('bar', d.T.string, default='loo'), - d.argument.new('baz', d.T.number, enums=[1,2,3]), -] -``` - - -### obj func - -Utilities for documenting Jsonnet methods (functions of objects) - -#### fn func.new - -```ts -new(help, args) -``` - -new creates a new function, optionally with description and arguments - -#### fn func.withArgs - -```ts -withArgs(args) -``` - -The `withArgs` modifier overrides the arguments of that function - -#### fn func.withHelp - -```ts -withHelp(help) -``` - -The `withHelp` modifier overrides the help text of that function - -### obj object - -Utilities for documenting Jsonnet objects (`{ }`). - -#### fn object.new - -```ts -new(help, fields) -``` - -new creates a new object, optionally with description and fields - -#### fn object.withFields - -```ts -withFields(fields) -``` - -The `withFields` modifier overrides the fields property of an already created object - -### obj value - -Utilities for documenting plain Jsonnet values (primitives) - -#### fn value.new - -```ts -new(type, help, default) -``` - -new creates a new object of given type, optionally with description and default value - -### obj T - - -* `T.any` (`string`): `"any"` - argument of type "any" -* `T.array` (`string`): `"array"` - argument of type "array" -* `T.boolean` (`string`): `"bool"` - argument of type "boolean" -* `T.func` (`string`): `"function"` - argument of type "func" -* `T.null` (`string`): `"null"` - argument of type "null" -* `T.number` (`string`): `"number"` - argument of type "number" -* `T.object` (`string`): `"object"` - argument of type "object" -* `T.string` (`string`): `"string"` - argument of type "string" - -### obj package - - -#### fn package.new - -```ts -new(name, url, help, filename="", version="master") -``` - -`new` creates a new package - -Arguments: - -* given `name` -* source `url` for jsonnet-bundler and the import -* `help` text -* `filename` for the import, defaults to blank for backward compatibility -* `version` for jsonnet-bundler install, defaults to `master` just like jsonnet-bundler - - -#### fn package.newSub - -```ts -newSub(name, help) -``` - -`newSub` creates a package without the preconfigured install/usage templates. - -Arguments: - -* given `name` -* `help` text - diff --git a/vendor/github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet b/vendor/github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet deleted file mode 100644 index f47c83d..0000000 --- a/vendor/github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet +++ /dev/null @@ -1,218 +0,0 @@ -{ - local d = self, - - '#': - d.pkg( - name='doc-util', - url='github.com/jsonnet-libs/docsonnet/doc-util', - help=||| - `doc-util` provides a Jsonnet interface for `docsonnet`, - a Jsonnet API doc generator that uses structured data instead of comments. - |||, - filename=std.thisFile, - ) - + d.package.withUsageTemplate( - 'local d = import "%(import)s"' - ), - - package:: { - '#new':: d.fn(||| - `new` creates a new package - - Arguments: - - * given `name` - * source `url` for jsonnet-bundler and the import - * `help` text - * `filename` for the import, defaults to blank for backward compatibility - * `version` for jsonnet-bundler install, defaults to `master` just like jsonnet-bundler - |||, [ - d.arg('name', d.T.string), - d.arg('url', d.T.string), - d.arg('help', d.T.string), - d.arg('filename', d.T.string, ''), - d.arg('version', d.T.string, 'master'), - ]), - new(name, url, help, filename='', version='master'):: - { - name: name, - help: help, - 'import': - if filename != '' - then url + '/' + filename - else url, - url: url, - filename: filename, - version: version, - - } - + self.withInstallTemplate( - 'jb install %(url)s@%(version)s' - ) - + self.withUsageTemplate( - 'local %(name)s = import "%(import)s"' - ), - - '#newSub':: d.fn(||| - `newSub` creates a package without the preconfigured install/usage templates. - - Arguments: - - * given `name` - * `help` text - |||, [ - d.arg('name', d.T.string), - d.arg('help', d.T.string), - ]), - newSub(name, help):: - { - name: name, - help: help, - }, - - withUsageTemplate(template):: { - usageTemplate: template, - }, - - withInstallTemplate(template):: { - installTemplate: template, - }, - }, - - '#pkg':: self.package['#new'] + d.func.withHelp('`new` is a shorthand for `package.new`'), - pkg:: self.package.new, - - '#object': d.obj('Utilities for documenting Jsonnet objects (`{ }`).'), - object:: { - '#new': d.fn('new creates a new object, optionally with description and fields', [d.arg('help', d.T.string), d.arg('fields', d.T.object)]), - new(help='', fields={}):: { object: { - help: help, - fields: fields, - } }, - - '#withFields': d.fn('The `withFields` modifier overrides the fields property of an already created object', [d.arg('fields', d.T.object)]), - withFields(fields):: { object+: { - fields: fields, - } }, - }, - - '#obj': self.object['#new'] + d.func.withHelp('`obj` is a shorthand for `object.new`'), - obj:: self.object.new, - - '#func': d.obj('Utilities for documenting Jsonnet methods (functions of objects)'), - func:: { - '#new': d.fn('new creates a new function, optionally with description and arguments', [d.arg('help', d.T.string), d.arg('args', d.T.array)]), - new(help='', args=[]):: { 'function': { - help: help, - args: args, - } }, - - '#withHelp': d.fn('The `withHelp` modifier overrides the help text of that function', [d.arg('help', d.T.string)]), - withHelp(help):: { 'function'+: { - help: help, - } }, - - '#withArgs': d.fn('The `withArgs` modifier overrides the arguments of that function', [d.arg('args', d.T.array)]), - withArgs(args):: { 'function'+: { - args: args, - } }, - }, - - '#fn': self.func['#new'] + d.func.withHelp('`fn` is a shorthand for `func.new`'), - fn:: self.func.new, - - '#argument': d.obj('Utilities for creating function arguments'), - argument:: { - '#new': d.fn(||| - `new` creates a new function argument, taking the `name`, the `type`. Optionally it - can take a `default` value and `enum`-erate potential values. - - Examples: - - ```jsonnet - [ - d.argument.new('foo', d.T.string), - d.argument.new('bar', d.T.string, default='loo'), - d.argument.new('baz', d.T.number, enums=[1,2,3]), - ] - ``` - |||, [ - d.arg('name', d.T.string), - d.arg('type', d.T.string), - d.arg('default', d.T.any), - d.arg('enums', d.T.array), - ]), - new(name, type, default=null, enums=null): { - name: name, - type: type, - default: default, - enums: enums, - }, - }, - '#arg': self.argument['#new'] + self.func.withHelp('`arg` is a shorthand for `argument.new`'), - arg:: self.argument.new, - - '#value': d.obj('Utilities for documenting plain Jsonnet values (primitives)'), - value:: { - '#new': d.fn('new creates a new object of given type, optionally with description and default value', [d.arg('type', d.T.string), d.arg('help', d.T.string), d.arg('default', d.T.any)]), - new(type, help='', default=null): { value: { - help: help, - type: type, - default: default, - } }, - }, - '#val': self.value['#new'] + self.func.withHelp('`val` is a shorthand for `value.new`'), - val:: self.value.new, - - // T contains constants for the Jsonnet types - T:: { - '#string': d.val(d.T.string, 'argument of type "string"'), - string: 'string', - - '#number': d.val(d.T.string, 'argument of type "number"'), - number: 'number', - int: self.number, - integer: self.number, - - '#boolean': d.val(d.T.string, 'argument of type "boolean"'), - boolean: 'bool', - bool: self.boolean, - - '#object': d.val(d.T.string, 'argument of type "object"'), - object: 'object', - - '#array': d.val(d.T.string, 'argument of type "array"'), - array: 'array', - - '#any': d.val(d.T.string, 'argument of type "any"'), - any: 'any', - - '#null': d.val(d.T.string, 'argument of type "null"'), - 'null': 'null', - nil: self['null'], - - '#func': d.val(d.T.string, 'argument of type "func"'), - func: 'function', - 'function': self.func, - }, - - '#render': d.fn( - ||| - `render` converts the docstrings to human readable Markdown files. - - Usage: - - ```jsonnet - // docs.jsonnet - d.render(import 'main.libsonnet') - ``` - - Call with: `jsonnet -S -c -m docs/ docs.jsonnet` - |||, - args=[ - d.arg('obj', d.T.object), - ] - ), - render:: (import './render.libsonnet').render, - -} diff --git a/vendor/github.com/jsonnet-libs/docsonnet/doc-util/render.libsonnet b/vendor/github.com/jsonnet-libs/docsonnet/doc-util/render.libsonnet deleted file mode 100644 index 0c620c3..0000000 --- a/vendor/github.com/jsonnet-libs/docsonnet/doc-util/render.libsonnet +++ /dev/null @@ -1,401 +0,0 @@ -{ - local root = self, - - templates: { - package: ||| - # %(name)s - - %(content)s - |||, - - indexPage: ||| - # %(prefix)s%(name)s - - %(index)s - |||, - - index: ||| - ## Index - - %s - |||, - - sectionTitle: '%(abbr)s %(prefix)s%(name)s', - - sectionLink: '* [`%(abbr)s %(linkName)s`](#%(link)s)', - - value: '* `%(prefix)s%(name)s` (`%(type)s`): `"%(value)s"` - %(help)s', - - section: ||| - %(headerDepth)s %(title)s - - %(content)s - |||, - }, - - joinPathPrefixes(prefixes, sep='/'):: - std.join(sep, prefixes) - + (if std.length(prefixes) > 0 - then sep - else ''), - - joinPrefixes(prefixes, sep='.'):: - std.join(sep, prefixes) - + (if std.length(prefixes) > 0 - then sep - else ''), - - renderSectionTitle(section, prefixes):: - root.templates.sectionTitle % { - name: section.name, - abbr: section.type.abbr, - prefix: root.joinPrefixes(prefixes), - }, - - renderValues(values, prefixes=[]):: - if std.length(values) > 0 - then - std.join('\n', [ - root.templates.value - % value { - prefix: root.joinPrefixes(prefixes), - } - for value in values - ]) + '\n' - else '', - - renderSections(sections, depth=0, prefixes=[]):: - if std.length(sections) > 0 - then - std.join('\n', [ - root.templates.section - % { - headerDepth: std.join('', [ - '#' - for d in std.range(0, depth + 2) - ]), - title: root.renderSectionTitle( - section, - prefixes, - ), - content: section.content, - } - + root.renderValues( - section.values, - prefixes + [section.name] - ) - + root.renderSections( - section.subSections, - depth + 1, - prefixes + [section.name] - ) - for section in sections - ]) - else '', - - renderPackage(package, path=''):: - (root.templates.package % package) - + ( - if std.length(package.subPackages) > 0 - then - '## Subpackages\n\n' - + std.join('\n', [ - '* [%(name)s](%(path)s)' % { - name: sub.name, - path: path + sub.name - + (if std.length(sub.subPackages) > 0 - then '/index.md' - else '.md'), - } - for sub in package.subPackages - ]) + '\n\n' - else '' - ) - + (if std.length(package.sections) > 0 - then (root.templates.index % root.index(package.sections)) - else '') - + (if std.length(package.values) > 0 - || std.length(package.sections) > 0 - then - '\n## Fields\n\n' - + root.renderValues(package.values) - + root.renderSections(package.sections) - else ''), - - index(sections, depth=0, prefixes=[]):: - std.join('\n', [ - std.join('', [ - ' ' - for d in std.range(0, (depth * 2) - 1) - ]) - + (root.templates.sectionLink % { - abbr: section.type.abbr, - linkName: section.linkName, - link: - std.asciiLower( - std.strReplace( - std.strReplace(root.renderSectionTitle(section, prefixes), '.', '') - , ' ', '-' - ) - ), - }) - + ( - if std.length(section.subSections) > 0 - then '\n' + root.index( - section.subSections, - depth + 1, - prefixes + [section.name] - ) - else '' - ) - for section in sections - ]), - - sections: { - base: { - subSections: [], - values: [], - }, - object(key, doc, obj, depth):: self.base { - name: std.strReplace(key, '#', ''), - - local processed = root.prepare(obj, depth=depth + 1), - - subSections: processed.sections, - - values: processed.values, - - type: { full: 'object', abbr: 'obj' }, - - abbr: self.type.abbr, - - doc: - if self.type.full in doc - then doc[self.type.full] - else { help: '' }, - - help: self.doc.help, - - linkName: self.name, - - content: - if self.help != '' - then self.help + '\n' - else '', - }, - - 'function'(key, doc):: self.base { - name: std.strReplace(key, '#', ''), - - type: { full: 'function', abbr: 'fn' }, - - abbr: self.type.abbr, - - doc: doc[self.type.full], - - help: self.doc.help, - - args: std.join(', ', [ - if arg.default != null - then std.join('=', [ - arg.name, - std.manifestJsonEx(arg.default, '', ''), - ]) - else arg.name - for arg in self.doc.args - ]), - - enums: std.join('', [ - if arg.enums != null - then '\n\nAccepted values for `%s` are ' % arg.name - + std.join(', ', [ - std.manifestJsonEx(item, '', '') - for item in arg.enums - ]) - else '' - for arg in self.doc.args - ]), - - linkName: '%(name)s(%(args)s)' % self, - - content: - (||| - ```ts - %(name)s(%(args)s) - ``` - - ||| % self) - + '%(help)s' % self - + '%(enums)s' % self, - // odd concatenation to prevent unintential newline changes - - }, - - value(key, doc, obj):: self.base { - name: std.strReplace(key, '#', ''), - type: doc.value.type, - help: doc.value.help, - value: obj, - }, - - package(doc, root):: { - name: doc.name, - content: - ||| - %(help)s - ||| % doc - + (if 'installTemplate' in doc - then ||| - - ## Install - - ``` - %(install)s - ``` - ||| % doc.installTemplate % doc - else '') - + (if 'usageTemplate' in doc - then ||| - - ## Usage - - ```jsonnet - %(usage)s - ``` - ||| % doc.usageTemplate % doc - else ''), - }, - }, - - prepare(obj, depth=0):: - std.foldl( - function(acc, key) - acc + - // Package definition - if key == '#' - then root.sections.package( - obj[key], - (depth == 0) - ) - - - // Field definition - else if std.startsWith(key, '#') - then ( - local realKey = key[1:]; - - if !std.isObject(obj[key]) - then - std.trace( - 'INFO: docstring "%s" cannot be parsed, ignored while rendering.' % key, - {} - ) - - else if 'value' in obj[key] - then { - values+: [root.sections.value( - key, - obj[key], - obj[realKey] - )], - } - else if 'function' in obj[key] - then { - functionSections+: [root.sections['function']( - key, - obj[key], - )], - } - else if 'object' in obj[key] - then { - objectSections+: [root.sections.object( - key, - obj[key], - obj[realKey], - depth - )], - } - else - std.trace( - 'INFO: docstring "%s" cannot be parsed, ignored while rendering.' % key, - {} - ) - ) - - // subPackage definition - else if std.isObject(obj[key]) && '#' in obj[key] - then { - subPackages+: [root.prepare(obj[key])], - } - - // undocumented object - else if std.isObject(obj[key]) && !('#' + key in obj) - then ( - local section = root.sections.object( - key, - {}, - obj[key], - depth - ); - // only add if has documented subSections or values - if std.length(section.subSections) > 0 - || std.length(section.values) > 0 - then { objectSections+: [section] } - else {} - ) - - else {}, - std.objectFieldsAll(obj), - { - functionSections: [], - objectSections: [], - - sections: - self.functionSections - + self.objectSections, - subPackages: [], - values: [], - } - ), - - renderIndexPage(package, prefixes):: - root.templates.indexPage % { - name: package.name, - prefix: root.joinPrefixes(prefixes), - index: std.join('\n', [ - '* [%(name)s](%(name)s.md)' % sub - for sub in package.subPackages - ]), - }, - - renderFiles(package, prefixes=[]): - local path = root.joinPathPrefixes(prefixes); - ( - if std.length(prefixes) == 0 - then { - [path + 'README.md']: root.renderPackage(package, package.name + '/'), - } - else if std.length(package.subPackages) > 0 - then { - [path + package.name + '/index.md']: root.renderPackage(package), - } - else { - [path + package.name + '.md']: root.renderPackage(package, package.name + '/'), - } - ) - + std.foldl( - function(acc, sub) - acc + sub, - [ - root.renderFiles( - sub, - prefixes=prefixes + [package.name] - ) - for sub in package.subPackages - ], - {} - ), - - render(obj): - self.renderFiles(self.prepare(obj)), -} diff --git a/vendor/github.com/jsonnet-libs/xtd/.gitignore b/vendor/github.com/jsonnet-libs/xtd/.gitignore deleted file mode 100644 index bb476a1..0000000 --- a/vendor/github.com/jsonnet-libs/xtd/.gitignore +++ /dev/null @@ -1,3 +0,0 @@ -.jekyll-cache -jsonnetfile.lock.json -vendor diff --git a/vendor/github.com/jsonnet-libs/xtd/LICENSE b/vendor/github.com/jsonnet-libs/xtd/LICENSE deleted file mode 100644 index 0a39b25..0000000 --- a/vendor/github.com/jsonnet-libs/xtd/LICENSE +++ /dev/null @@ -1,201 +0,0 @@ - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "{}" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright 2018 grafana, sh0rez - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. diff --git a/vendor/github.com/jsonnet-libs/xtd/Makefile b/vendor/github.com/jsonnet-libs/xtd/Makefile deleted file mode 100644 index 7ffe3aa..0000000 --- a/vendor/github.com/jsonnet-libs/xtd/Makefile +++ /dev/null @@ -1,16 +0,0 @@ -.PHONY: test -test: - @cd test/; \ - jb install; \ - RESULT=0; \ - for f in $$(find . -path './.git' -prune -o -name 'vendor' -prune -o -name '*_test.jsonnet' -print); do \ - echo "$$f"; \ - jsonnet -J vendor -J lib "$$f"; \ - RESULT=$$(($$RESULT + $$?)); \ - done; \ - exit $$RESULT - - -.PHONY: docs -docs: - docsonnet main.libsonnet diff --git a/vendor/github.com/jsonnet-libs/xtd/README.md b/vendor/github.com/jsonnet-libs/xtd/README.md deleted file mode 100644 index a060428..0000000 --- a/vendor/github.com/jsonnet-libs/xtd/README.md +++ /dev/null @@ -1,19 +0,0 @@ -# `xtd` - -`xtd` aims to collect useful functions not included in the Jsonnet standard library (`std`). - -## Install - -```console -jb install github.com/jsonnet-libs/xtd -``` - -## Usage - -```jsonnet -local xtd = import "github.com/jsonnet-libs/xtd/main.libsonnet" -``` - -## Docs - -[docs](docs/README.md) diff --git a/vendor/github.com/jsonnet-libs/xtd/aggregate.libsonnet b/vendor/github.com/jsonnet-libs/xtd/aggregate.libsonnet deleted file mode 100644 index 78d3c1c..0000000 --- a/vendor/github.com/jsonnet-libs/xtd/aggregate.libsonnet +++ /dev/null @@ -1,104 +0,0 @@ -local d = import 'doc-util/main.libsonnet'; - -{ - local this = self, - - '#': d.pkg( - name='aggregate', - url='github.com/jsonnet-libs/xtd/aggregate.libsonnet', - help=||| - `aggregate` implements helper functions to aggregate arrays of objects into objects with arrays. - - Example: - - ```jsonnet - local apps = [ - { - appid: 'id1', - name: 'yo', - id: i, - } - for i in std.range(0, 10) - ]; - - aggregate.byKeys(apps, ['appid', 'name']); - ``` - - Output: - - ```json - { - "id1": { - "yo": [ - { - "appid": "id1", - "id": 0, - "name": "yo" - }, - { - "appid": "id1", - "id": 1, - "name": "yo" - }, - ... - ] - } - } - ``` - |||, - ), - - '#byKey':: d.fn( - ||| - `byKey` aggregates an array by the value of `key` - |||, - [ - d.arg('arr', d.T.array), - d.arg('key', d.T.string), - ] - ), - byKey(arr, key): - // find all values of key - local values = std.set([ - item[key] - for item in arr - ]); - - // create the aggregate for the value of each key - { - [value]: [ - item - for item in std.filter( - function(x) - x[key] == value, - arr - ) - ] - for value in values - }, - - '#byKeys':: d.fn( - ||| - `byKey` aggregates an array by iterating over `keys`, each item in `keys` nests the - aggregate one layer deeper. - |||, - [ - d.arg('arr', d.T.array), - d.arg('keys', d.T.array), - ] - ), - byKeys(arr, keys): - local aggregate = self.byKey(arr, keys[0]); - // if last key in keys - if std.length(keys) == 1 - - // then return aggregate - then aggregate - - // else aggregate with remaining keys - else { - [k]: this.byKeys(aggregate[k], keys[1:]) - for k in std.objectFields(aggregate) - }, - -} diff --git a/vendor/github.com/jsonnet-libs/xtd/array.libsonnet b/vendor/github.com/jsonnet-libs/xtd/array.libsonnet deleted file mode 100644 index f000c87..0000000 --- a/vendor/github.com/jsonnet-libs/xtd/array.libsonnet +++ /dev/null @@ -1,37 +0,0 @@ -local d = import 'doc-util/main.libsonnet'; - -{ - '#': d.pkg( - name='array', - url='github.com/jsonnet-libs/xtd/array.libsonnet', - help='`array` implements helper functions for processing arrays.', - ), - - '#slice':: d.fn( - '`slice` works the same as `std.slice` but with support for negative index/end.', - [ - d.arg('indexable', d.T.array), - d.arg('index', d.T.number), - d.arg('end', d.T.number, default='null'), - d.arg('step', d.T.number, default=1), - ] - ), - slice(indexable, index, end=null, step=1): - local invar = { - index: - if index != null - then - if index < 0 - then std.length(indexable) + index - else index - else 0, - end: - if end != null - then - if end < 0 - then std.length(indexable) + end - else end - else std.length(indexable), - }; - indexable[invar.index:invar.end:step], -} diff --git a/vendor/github.com/jsonnet-libs/xtd/ascii.libsonnet b/vendor/github.com/jsonnet-libs/xtd/ascii.libsonnet deleted file mode 100644 index 28571ac..0000000 --- a/vendor/github.com/jsonnet-libs/xtd/ascii.libsonnet +++ /dev/null @@ -1,39 +0,0 @@ -local d = import 'doc-util/main.libsonnet'; - -{ - '#': d.pkg( - name='ascii', - url='github.com/jsonnet-libs/xtd/ascii.libsonnet', - help='`ascii` implements helper functions for ascii characters', - ), - - local cp(c) = std.codepoint(c), - - '#isLower':: d.fn( - '`isLower` reports whether ASCII character `c` is a lower case letter', - [d.arg('c', d.T.string)] - ), - isLower(c): - if cp(c) >= 97 && cp(c) < 123 - then true - else false, - - '#isUpper':: d.fn( - '`isUpper` reports whether ASCII character `c` is a upper case letter', - [d.arg('c', d.T.string)] - ), - isUpper(c): - if cp(c) >= 65 && cp(c) < 91 - then true - else false, - - '#isNumber':: d.fn( - '`isNumber` reports whether character `c` is a number.', - [d.arg('c', d.T.string)] - ), - isNumber(c): - if std.isNumber(c) || (cp(c) >= 48 && cp(c) < 58) - then true - else false, - -} diff --git a/vendor/github.com/jsonnet-libs/xtd/camelcase.libsonnet b/vendor/github.com/jsonnet-libs/xtd/camelcase.libsonnet deleted file mode 100644 index 06b519b..0000000 --- a/vendor/github.com/jsonnet-libs/xtd/camelcase.libsonnet +++ /dev/null @@ -1,80 +0,0 @@ -local xtd = import './main.libsonnet'; -local d = import 'doc-util/main.libsonnet'; - -{ - '#': d.pkg( - name='camelcase', - url='github.com/jsonnet-libs/xtd/camelcase.libsonnet', - help='`camelcase` can split camelCase words into an array of words.', - ), - - '#split':: d.fn( - ||| - `split` splits a camelcase word and returns an array of words. It also supports - digits. Both lower camel case and upper camel case are supported. It only supports - ASCII characters. - For more info please check: http://en.wikipedia.org/wiki/CamelCase - Based on https://github.com/fatih/camelcase/ - |||, - [d.arg('src', d.T.string)] - ), - split(src): - if src == '' - then [''] - else - local runes = std.foldl( - function(acc, r) - acc { - local class = - if xtd.ascii.isNumber(r) - then 1 - else if xtd.ascii.isLower(r) - then 2 - else if xtd.ascii.isUpper(r) - then 3 - else 4, - - lastClass:: class, - - runes: - if class == super.lastClass - then super.runes[:std.length(super.runes) - 1] - + [super.runes[std.length(super.runes) - 1] + r] - else super.runes + [r], - }, - [src[i] for i in std.range(0, std.length(src) - 1)], - { lastClass:: 0, runes: [] } - ).runes; - - local fixRunes = - std.foldl( - function(runes, i) - if xtd.ascii.isUpper(runes[i][0]) - && xtd.ascii.isLower(runes[i + 1][0]) - && !xtd.ascii.isNumber(runes[i + 1][0]) - && runes[i][0] != ' ' - && runes[i + 1][0] != ' ' - then - std.mapWithIndex( - function(index, r) - if index == i + 1 - then runes[i][std.length(runes[i]) - 1:] + r - else - if index == i - then r[:std.length(r) - 1] - else r - , runes - ) - else runes - , - [i for i in std.range(0, std.length(runes) - 2)], - runes - ); - - [ - r - for r in fixRunes - if r != '' - ], - -} diff --git a/vendor/github.com/jsonnet-libs/xtd/date.libsonnet b/vendor/github.com/jsonnet-libs/xtd/date.libsonnet deleted file mode 100644 index e611ed4..0000000 --- a/vendor/github.com/jsonnet-libs/xtd/date.libsonnet +++ /dev/null @@ -1,58 +0,0 @@ -local d = import 'doc-util/main.libsonnet'; - -{ - '#': d.pkg( - name='date', - url='github.com/jsonnet-libs/xtd/date.libsonnet', - help='`time` provides various date related functions.', - ), - - // Lookup tables for calendar calculations - local commonYearMonthLength = [31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31], - local commonYearMonthOffset = [0, 3, 3, 6, 1, 4, 6, 2, 5, 0, 3, 5], - local leapYearMonthOffset = [0, 3, 4, 0, 2, 5, 0, 3, 6, 1, 4, 6], - - // monthOffset looks up the offset to apply in day of week calculations based on the year and month - local monthOffset(year, month) = - if self.isLeapYear(year) - then leapYearMonthOffset[month - 1] - else commonYearMonthOffset[month - 1], - - '#isLeapYear': d.fn( - '`isLeapYear` returns true if the given year is a leap year.', - [d.arg('year', d.T.number)], - ), - isLeapYear(year):: year % 4 == 0 && (year % 100 != 0 || year % 400 == 0), - - '#dayOfWeek': d.fn( - '`dayOfWeek` returns the day of the week for the given date. 0=Sunday, 1=Monday, etc.', - [ - d.arg('year', d.T.number), - d.arg('month', d.T.number), - d.arg('day', d.T.number), - ], - ), - dayOfWeek(year, month, day):: - (day + monthOffset(year, month) + 5 * ((year - 1) % 4) + 4 * ((year - 1) % 100) + 6 * ((year - 1) % 400)) % 7, - - '#dayOfYear': d.fn( - ||| - `dayOfYear` calculates the ordinal day of the year based on the given date. The range of outputs is 1-365 - for common years, and 1-366 for leap years. - |||, - [ - d.arg('year', d.T.number), - d.arg('month', d.T.number), - d.arg('day', d.T.number), - ], - ), - dayOfYear(year, month, day):: - std.foldl( - function(a, b) a + b, - std.slice(commonYearMonthLength, 0, month - 1, 1), - 0 - ) + day + - if month > 2 && self.isLeapYear(year) - then 1 - else 0, -} diff --git a/vendor/github.com/jsonnet-libs/xtd/docs/.gitignore b/vendor/github.com/jsonnet-libs/xtd/docs/.gitignore deleted file mode 100644 index d7951d9..0000000 --- a/vendor/github.com/jsonnet-libs/xtd/docs/.gitignore +++ /dev/null @@ -1,2 +0,0 @@ -Gemfile.lock -_site diff --git a/vendor/github.com/jsonnet-libs/xtd/docs/Gemfile b/vendor/github.com/jsonnet-libs/xtd/docs/Gemfile deleted file mode 100644 index 75d9835..0000000 --- a/vendor/github.com/jsonnet-libs/xtd/docs/Gemfile +++ /dev/null @@ -1,2 +0,0 @@ -source "https://rubygems.org" -gem "github-pages", group: :jekyll_plugins diff --git a/vendor/github.com/jsonnet-libs/xtd/docs/README.md b/vendor/github.com/jsonnet-libs/xtd/docs/README.md deleted file mode 100644 index 0fbf376..0000000 --- a/vendor/github.com/jsonnet-libs/xtd/docs/README.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -permalink: / ---- - -# package xtd - -```jsonnet -local xtd = import "github.com/jsonnet-libs/xtd/main.libsonnet" -``` - -`xtd` aims to collect useful functions not included in the Jsonnet standard library (`std`). - -This package serves as a test field for functions intended to be contributed to `std` -in the future, but also provides a place for less general, yet useful utilities. - - -## Subpackages - -* [aggregate](aggregate.md) -* [array](array.md) -* [ascii](ascii.md) -* [camelcase](camelcase.md) -* [date](date.md) -* [inspect](inspect.md) -* [jsonpath](jsonpath.md) -* [string](string.md) -* [url](url.md) \ No newline at end of file diff --git a/vendor/github.com/jsonnet-libs/xtd/docs/_config.yml b/vendor/github.com/jsonnet-libs/xtd/docs/_config.yml deleted file mode 100644 index d18a288..0000000 --- a/vendor/github.com/jsonnet-libs/xtd/docs/_config.yml +++ /dev/null @@ -1,2 +0,0 @@ -theme: jekyll-theme-cayman -baseurl: /xtd diff --git a/vendor/github.com/jsonnet-libs/xtd/docs/aggregate.md b/vendor/github.com/jsonnet-libs/xtd/docs/aggregate.md deleted file mode 100644 index aba530d..0000000 --- a/vendor/github.com/jsonnet-libs/xtd/docs/aggregate.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -permalink: /aggregate/ ---- - -# package aggregate - -```jsonnet -local aggregate = import "github.com/jsonnet-libs/xtd/aggregate.libsonnet" -``` - -`aggregate` implements helper functions to aggregate arrays of objects into objects with arrays. - -Example: - -```jsonnet -local apps = [ - { - appid: 'id1', - name: 'yo', - id: i, - } - for i in std.range(0, 10) -]; - -aggregate.byKeys(apps, ['appid', 'name']); -``` - -Output: - -```json -{ - "id1": { - "yo": [ - { - "appid": "id1", - "id": 0, - "name": "yo" - }, - { - "appid": "id1", - "id": 1, - "name": "yo" - }, - ... - ] - } -} -``` - - -## Index - -* [`fn byKey(arr, key)`](#fn-bykey) -* [`fn byKeys(arr, keys)`](#fn-bykeys) - -## Fields - -### fn byKey - -```ts -byKey(arr, key) -``` - -`byKey` aggregates an array by the value of `key` - - -### fn byKeys - -```ts -byKeys(arr, keys) -``` - -`byKey` aggregates an array by iterating over `keys`, each item in `keys` nests the -aggregate one layer deeper. diff --git a/vendor/github.com/jsonnet-libs/xtd/docs/array.md b/vendor/github.com/jsonnet-libs/xtd/docs/array.md deleted file mode 100644 index 1d9e4a8..0000000 --- a/vendor/github.com/jsonnet-libs/xtd/docs/array.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -permalink: /array/ ---- - -# package array - -```jsonnet -local array = import "github.com/jsonnet-libs/xtd/array.libsonnet" -``` - -`array` implements helper functions for processing arrays. - -## Index - -* [`fn slice(indexable, index, end='null', step=1)`](#fn-slice) - -## Fields - -### fn slice - -```ts -slice(indexable, index, end='null', step=1) -``` - -`slice` works the same as `std.slice` but with support for negative index/end. \ No newline at end of file diff --git a/vendor/github.com/jsonnet-libs/xtd/docs/ascii.md b/vendor/github.com/jsonnet-libs/xtd/docs/ascii.md deleted file mode 100644 index 37d7ed7..0000000 --- a/vendor/github.com/jsonnet-libs/xtd/docs/ascii.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -permalink: /ascii/ ---- - -# package ascii - -```jsonnet -local ascii = import "github.com/jsonnet-libs/xtd/ascii.libsonnet" -``` - -`ascii` implements helper functions for ascii characters - -## Index - -* [`fn isLower(c)`](#fn-islower) -* [`fn isNumber(c)`](#fn-isnumber) -* [`fn isUpper(c)`](#fn-isupper) - -## Fields - -### fn isLower - -```ts -isLower(c) -``` - -`isLower` reports whether ASCII character `c` is a lower case letter - -### fn isNumber - -```ts -isNumber(c) -``` - -`isNumber` reports whether character `c` is a number. - -### fn isUpper - -```ts -isUpper(c) -``` - -`isUpper` reports whether ASCII character `c` is a upper case letter \ No newline at end of file diff --git a/vendor/github.com/jsonnet-libs/xtd/docs/camelcase.md b/vendor/github.com/jsonnet-libs/xtd/docs/camelcase.md deleted file mode 100644 index 0634fa9..0000000 --- a/vendor/github.com/jsonnet-libs/xtd/docs/camelcase.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -permalink: /camelcase/ ---- - -# package camelcase - -```jsonnet -local camelcase = import "github.com/jsonnet-libs/xtd/camelcase.libsonnet" -``` - -`camelcase` can split camelCase words into an array of words. - -## Index - -* [`fn split(src)`](#fn-split) - -## Fields - -### fn split - -```ts -split(src) -``` - -`split` splits a camelcase word and returns an array of words. It also supports -digits. Both lower camel case and upper camel case are supported. It only supports -ASCII characters. -For more info please check: http://en.wikipedia.org/wiki/CamelCase -Based on https://github.com/fatih/camelcase/ diff --git a/vendor/github.com/jsonnet-libs/xtd/docs/date.md b/vendor/github.com/jsonnet-libs/xtd/docs/date.md deleted file mode 100644 index e2c9295..0000000 --- a/vendor/github.com/jsonnet-libs/xtd/docs/date.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -permalink: /date/ ---- - -# package date - -```jsonnet -local date = import "github.com/jsonnet-libs/xtd/date.libsonnet" -``` - -`time` provides various date related functions. - -## Index - -* [`fn dayOfWeek(year, month, day)`](#fn-dayofweek) -* [`fn dayOfYear(year, month, day)`](#fn-dayofyear) -* [`fn isLeapYear(year)`](#fn-isleapyear) - -## Fields - -### fn dayOfWeek - -```ts -dayOfWeek(year, month, day) -``` - -`dayOfWeek` returns the day of the week for the given date. 0=Sunday, 1=Monday, etc. - -### fn dayOfYear - -```ts -dayOfYear(year, month, day) -``` - -`dayOfYear` calculates the ordinal day of the year based on the given date. The range of outputs is 1-365 -for common years, and 1-366 for leap years. - - -### fn isLeapYear - -```ts -isLeapYear(year) -``` - -`isLeapYear` returns true if the given year is a leap year. \ No newline at end of file diff --git a/vendor/github.com/jsonnet-libs/xtd/docs/inspect.md b/vendor/github.com/jsonnet-libs/xtd/docs/inspect.md deleted file mode 100644 index 1ec3605..0000000 --- a/vendor/github.com/jsonnet-libs/xtd/docs/inspect.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -permalink: /inspect/ ---- - -# package inspect - -```jsonnet -local inspect = import "github.com/jsonnet-libs/xtd/inspect.libsonnet" -``` - -`inspect` implements helper functions for inspecting Jsonnet - -## Index - -* [`fn diff(input1, input2)`](#fn-diff) -* [`fn inspect(object, maxDepth)`](#fn-inspect) - -## Fields - -### fn diff - -```ts -diff(input1, input2) -``` - -`diff` returns a JSON object describing the differences between two inputs. It -attemps to show diffs in nested objects and arrays too. - -Simple example: - -```jsonnet -local input1 = { - same: 'same', - change: 'this', - remove: 'removed', -}; - -local input2 = { - same: 'same', - change: 'changed', - add: 'added', -}; - -diff(input1, input2), -``` - -Output: -```json -{ - "add +": "added", - "change ~": "~[ this , changed ]", - "remove -": "removed" -} -``` - - -### fn inspect - -```ts -inspect(object, maxDepth) -``` - -`inspect` reports the structure of a Jsonnet object with a recursion depth of -`maxDepth` (default maxDepth=10). diff --git a/vendor/github.com/jsonnet-libs/xtd/docs/jsonpath.md b/vendor/github.com/jsonnet-libs/xtd/docs/jsonpath.md deleted file mode 100644 index f498803..0000000 --- a/vendor/github.com/jsonnet-libs/xtd/docs/jsonpath.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -permalink: /jsonpath/ ---- - -# package jsonpath - -```jsonnet -local jsonpath = import "github.com/jsonnet-libs/xtd/jsonpath.libsonnet" -``` - -`jsonpath` implements helper functions to use JSONPath expressions. - -## Index - -* [`fn convertBracketToDot(path)`](#fn-convertbrackettodot) -* [`fn getJSONPath(source, path)`](#fn-getjsonpath) -* [`fn parseFilterExpr(path)`](#fn-parsefilterexpr) - -## Fields - -### fn convertBracketToDot - -```ts -convertBracketToDot(path) -``` - -`convertBracketToDot` converts the bracket notation to dot notation. - -This function does not support escaping brackets/quotes in path keys. - - -### fn getJSONPath - -```ts -getJSONPath(source, path) -``` - -`getJSONPath` gets the value at `path` from `source` where path is a JSONPath. - -This is a rudimentary implementation supporting the slice operator `[0:3:2]` and -partially supporting filter expressions `?(@.attr==value)`. - - -### fn parseFilterExpr - -```ts -parseFilterExpr(path) -``` - -`parseFilterExpr` returns a filter function `f(x)` for a filter expression `expr`. - - It supports comparisons (<, <=, >, >=) and equality checks (==, !=). If it doesn't - have an operator, it will check if the `expr` value exists. diff --git a/vendor/github.com/jsonnet-libs/xtd/docs/string.md b/vendor/github.com/jsonnet-libs/xtd/docs/string.md deleted file mode 100644 index 17b75b5..0000000 --- a/vendor/github.com/jsonnet-libs/xtd/docs/string.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -permalink: /string/ ---- - -# package string - -```jsonnet -local string = import "github.com/jsonnet-libs/xtd/string.libsonnet" -``` - -`string` implements helper functions for processing strings. - -## Index - -* [`fn splitEscape(str, c, escape='\\')`](#fn-splitescape) - -## Fields - -### fn splitEscape - -```ts -splitEscape(str, c, escape='\\') -``` - -`split` works the same as `std.split` but with support for escaping the dividing -string `c`. diff --git a/vendor/github.com/jsonnet-libs/xtd/docs/url.md b/vendor/github.com/jsonnet-libs/xtd/docs/url.md deleted file mode 100644 index 5529d5b..0000000 --- a/vendor/github.com/jsonnet-libs/xtd/docs/url.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -permalink: /url/ ---- - -# package url - -```jsonnet -local url = import "github.com/jsonnet-libs/xtd/url.libsonnet" -``` - -`url` implements URL escaping and query building - -## Index - -* [`fn encodeQuery(params)`](#fn-encodequery) -* [`fn escapeString(str, excludedChars)`](#fn-escapestring) - -## Fields - -### fn encodeQuery - -```ts -encodeQuery(params) -``` - -`encodeQuery` takes an object of query parameters and returns them as an escaped `key=value` string - -### fn escapeString - -```ts -escapeString(str, excludedChars) -``` - -`escapeString` escapes the given string so it can be safely placed inside an URL, replacing special characters with `%XX` sequences \ No newline at end of file diff --git a/vendor/github.com/jsonnet-libs/xtd/inspect.libsonnet b/vendor/github.com/jsonnet-libs/xtd/inspect.libsonnet deleted file mode 100644 index 051ed0d..0000000 --- a/vendor/github.com/jsonnet-libs/xtd/inspect.libsonnet +++ /dev/null @@ -1,146 +0,0 @@ -local d = import 'doc-util/main.libsonnet'; - -{ - '#': d.pkg( - name='inspect', - url='github.com/jsonnet-libs/xtd/inspect.libsonnet', - help='`inspect` implements helper functions for inspecting Jsonnet', - ), - - - '#inspect':: d.fn( - ||| - `inspect` reports the structure of a Jsonnet object with a recursion depth of - `maxDepth` (default maxDepth=10). - |||, - [ - d.arg('object', d.T.object), - d.arg('maxDepth', d.T.number), - //d.arg('depth', d.T.number), // used for recursion, not exposing in docs - ] - ), - - local this = self, - inspect(object, maxDepth=10, depth=0): - std.foldl( - function(acc, p) - acc + ( - if std.isObject(object[p]) - && depth != maxDepth - then { [p]+: - this.inspect( - object[p], - maxDepth, - depth + 1 - ) } - else { - [ - (if !std.objectHas(object, p) - then 'hidden_' - else '') - + (if std.isFunction(object[p]) - then 'functions' - else 'fields') - ]+: [p], - } - ), - std.objectFieldsAll(object), - {} - ), - - '#diff':: d.fn( - ||| - `diff` returns a JSON object describing the differences between two inputs. It - attemps to show diffs in nested objects and arrays too. - - Simple example: - - ```jsonnet - local input1 = { - same: 'same', - change: 'this', - remove: 'removed', - }; - - local input2 = { - same: 'same', - change: 'changed', - add: 'added', - }; - - diff(input1, input2), - ``` - - Output: - ```json - { - "add +": "added", - "change ~": "~[ this , changed ]", - "remove -": "removed" - } - ``` - |||, - [ - d.arg('input1', d.T.any), - d.arg('input2', d.T.any), - ] - ), - - diff(input1, input2):: - if input1 == input2 - then '' - else if std.isArray(input1) && std.isArray(input2) - then - [ - if input1[i] != input2[i] - then - this.diff( - input1[i], - input2[i] - ) - else input2[i] - for i in std.range(0, std.length(input2) - 1) - if std.length(input1) > i - ] - + (if std.length(input1) < std.length(input2) - then [ - '+ ' + input2[i] - for i in std.range(std.length(input1), std.length(input2) - 1) - ] - else []) - + (if std.length(input1) > std.length(input2) - then [ - '- ' + input1[i] - for i in std.range(std.length(input2), std.length(input1) - 1) - ] - else []) - - else if std.isObject(input1) && std.isObject(input2) - then std.foldl( - function(acc, k) - acc + ( - if k in input1 && input1[k] != input2[k] - then { - [k + ' ~']: - this.diff( - input1[k], - input2[k] - ), - } - else if !(k in input1) - then { - [k + ' +']: input2[k], - } - else {} - ), - std.objectFields(input2), - {}, - ) - + { - [l + ' -']: input1[l] - for l in std.objectFields(input1) - if !(l in input2) - } - - else '~[ %s ]' % std.join(' , ', [std.toString(input1), std.toString(input2)]), -} diff --git a/vendor/github.com/jsonnet-libs/xtd/jsonpath.libsonnet b/vendor/github.com/jsonnet-libs/xtd/jsonpath.libsonnet deleted file mode 100644 index 7722d64..0000000 --- a/vendor/github.com/jsonnet-libs/xtd/jsonpath.libsonnet +++ /dev/null @@ -1,142 +0,0 @@ -local xtd = import './main.libsonnet'; -local d = import 'doc-util/main.libsonnet'; - -{ - '#': d.pkg( - name='jsonpath', - url='github.com/jsonnet-libs/xtd/jsonpath.libsonnet', - help='`jsonpath` implements helper functions to use JSONPath expressions.', - ), - - - '#getJSONPath':: d.fn( - ||| - `getJSONPath` gets the value at `path` from `source` where path is a JSONPath. - - This is a rudimentary implementation supporting the slice operator `[0:3:2]` and - partially supporting filter expressions `?(@.attr==value)`. - |||, - [ - d.arg('source', d.T.any), - d.arg('path', d.T.string,), - d.arg('default', d.T.any, default='null'), - ] - ), - getJSONPath(source, path, default=null): - local _path = self.convertBracketToDot(path); - std.foldl( - function(acc, key) - if acc == null - then acc - else get(acc, key, default), - xtd.string.splitEscape(_path, '.'), - source, - ), - - '#convertBracketToDot':: d.fn( - ||| - `convertBracketToDot` converts the bracket notation to dot notation. - - This function does not support escaping brackets/quotes in path keys. - |||, - [ - d.arg('path', d.T.string,), - ] - ), - convertBracketToDot(path): - if std.length(std.findSubstr('[', path)) > 0 - then - local split = std.split(path, '['); - std.join('.', [ - local a = std.stripChars(i, "[]'"); - std.strReplace(a, '@.', '@\\.') - for i in split - ]) - else path, - - local get(source, key, default) = - if key == '' - || key == '$' - || key == '*' - then source - else if std.isArray(source) - then getFromArray(source, key) - else std.get(source, key, default), - - local getFromArray(arr, key) = - if std.startsWith(key, '?(@\\.') - then - std.filter( - self.parseFilterExpr(std.stripChars(key, '?(@\\.)')), - arr - ) - else if std.length(std.findSubstr(':', key)) >= 1 - then - local split = std.splitLimit(key, ':', 2); - local step = - if std.length(split) < 3 - then 1 - else parseIntOrNull(split[2]); - xtd.array.slice( - arr, - parseIntOrNull(split[0]), - parseIntOrNull(split[1]), - step, - ) - else - arr[std.parseInt(key)], - - local parseIntOrNull(str) = - if str == '' - then null - else std.parseInt(str), - - '#parseFilterExpr':: d.fn( - ||| - `parseFilterExpr` returns a filter function `f(x)` for a filter expression `expr`. - - It supports comparisons (<, <=, >, >=) and equality checks (==, !=). If it doesn't - have an operator, it will check if the `expr` value exists. - |||, - [ - d.arg('path', d.T.string,), - ] - ), - parseFilterExpr(expr): - local operandFunctions = { - '=='(a, b): a == b, - '!='(a, b): a != b, - '<='(a, b): a <= b, - '>='(a, b): a >= b, - '<'(a, b): a < b, - '>'(a, b): a > b, - }; - - local findOperands = std.filter( - function(op) std.length(std.findSubstr(op, expr)) > 0, - std.reverse( // reverse to match '<=' before '<' - std.objectFields(operandFunctions) - ) - ); - - if std.length(findOperands) > 0 - then - local op = findOperands[0]; - local s = [ - std.stripChars(i, ' ') - for i in std.splitLimit(expr, op, 1) - ]; - function(x) - if s[0] in x - then - local left = x[s[0]]; - local right = - if std.isNumber(left) - then std.parseInt(s[1]) // Only parse if comparing numbers - else s[1]; - operandFunctions[op](left, right) - else false - else - // Default to key matching - function(x) (expr in x), -} diff --git a/vendor/github.com/jsonnet-libs/xtd/main.libsonnet b/vendor/github.com/jsonnet-libs/xtd/main.libsonnet deleted file mode 100644 index 59c4034..0000000 --- a/vendor/github.com/jsonnet-libs/xtd/main.libsonnet +++ /dev/null @@ -1,24 +0,0 @@ -local d = import 'doc-util/main.libsonnet'; - -{ - '#': d.pkg( - name='xtd', - url='github.com/jsonnet-libs/xtd/main.libsonnet', - help=||| - `xtd` aims to collect useful functions not included in the Jsonnet standard library (`std`). - - This package serves as a test field for functions intended to be contributed to `std` - in the future, but also provides a place for less general, yet useful utilities. - |||, - ), - - aggregate: (import './aggregate.libsonnet'), - array: (import './array.libsonnet'), - ascii: (import './ascii.libsonnet'), - camelcase: (import './camelcase.libsonnet'), - date: (import './date.libsonnet'), - inspect: (import './inspect.libsonnet'), - jsonpath: (import './jsonpath.libsonnet'), - string: (import './string.libsonnet'), - url: (import './url.libsonnet'), -} diff --git a/vendor/github.com/jsonnet-libs/xtd/string.libsonnet b/vendor/github.com/jsonnet-libs/xtd/string.libsonnet deleted file mode 100644 index 5514cde..0000000 --- a/vendor/github.com/jsonnet-libs/xtd/string.libsonnet +++ /dev/null @@ -1,35 +0,0 @@ -local d = import 'doc-util/main.libsonnet'; - -{ - '#': d.pkg( - name='string', - url='github.com/jsonnet-libs/xtd/string.libsonnet', - help='`string` implements helper functions for processing strings.', - ), - - // BelRune is a string of the Ascii character BEL which made computers ring in ancient times. - // We use it as "magic" char to temporarily replace an escaped string as it is a non printable - // character and thereby will unlikely be in a valid key by accident. Only when we include it. - local BelRune = std.char(7), - - '#splitEscape':: d.fn( - ||| - `split` works the same as `std.split` but with support for escaping the dividing - string `c`. - |||, - [ - d.arg('str', d.T.string), - d.arg('c', d.T.string), - d.arg('escape', d.T.string, default='\\'), - ] - ), - splitEscape(str, c, escape='\\'): - std.map( - function(i) - std.strReplace(i, BelRune, escape + c), - std.split( - std.strReplace(str, escape + c, BelRune), - c, - ) - ), -} diff --git a/vendor/github.com/jsonnet-libs/xtd/test/array_test.jsonnet b/vendor/github.com/jsonnet-libs/xtd/test/array_test.jsonnet deleted file mode 100644 index 65aef8a..0000000 --- a/vendor/github.com/jsonnet-libs/xtd/test/array_test.jsonnet +++ /dev/null @@ -1,83 +0,0 @@ -local array = import '../array.libsonnet'; -local test = import 'github.com/jsonnet-libs/testonnet/main.libsonnet'; - -local arr = std.range(0, 10); - -test.new(std.thisFile) - -+ test.case.new( - name='first two', - test=test.expect.eq( - actual=array.slice( - arr, - index=0, - end=2, - ), - expected=[0, 1], - ) -) -+ test.case.new( - name='last two', - test=test.expect.eq( - actual=array.slice( - arr, - index=1, - end=3, - ), - expected=[1, 2], - ) -) -+ test.case.new( - name='until end', - test=test.expect.eq( - actual=array.slice( - arr, - index=1 - ), - expected=[1, 2, 3, 4, 5, 6, 7, 8, 9, 10], - ) -) -+ test.case.new( - name='from beginning', - test=test.expect.eq( - actual=array.slice( - arr, - index=0, - end=2 - ), - expected=[0, 1], - ) -) -+ test.case.new( - name='negative start', - test=test.expect.eq( - actual=array.slice( - arr, - index=-2 - ), - expected=[9, 10], - ) -) -+ test.case.new( - name='negative end', - test=test.expect.eq( - actual=array.slice( - arr, - index=0, - end=-1 - ), - expected=[0, 1, 2, 3, 4, 5, 6, 7, 8, 9], - ) -) -+ test.case.new( - name='step', - test=test.expect.eq( - actual=array.slice( - arr, - index=0, - end=5, - step=2 - ), - expected=[0, 2, 4], - ) -) diff --git a/vendor/github.com/jsonnet-libs/xtd/test/camelcase_test.jsonnet b/vendor/github.com/jsonnet-libs/xtd/test/camelcase_test.jsonnet deleted file mode 100644 index b171c64..0000000 --- a/vendor/github.com/jsonnet-libs/xtd/test/camelcase_test.jsonnet +++ /dev/null @@ -1,137 +0,0 @@ -local xtd = import '../main.libsonnet'; -local test = import 'github.com/jsonnet-libs/testonnet/main.libsonnet'; - -test.new(std.thisFile) - -+ test.case.new( - name='nostring', - test=test.expect.eq( - actual=xtd.camelcase.split(''), - expected=[''], - ) -) -+ test.case.new( - name='lowercase', - test=test.expect.eq( - actual=xtd.camelcase.split('lowercase'), - expected=['lowercase'], - ) -) -+ test.case.new( - name='Class', - test=test.expect.eq( - actual=xtd.camelcase.split('Class'), - expected=['Class'], - ) -) -+ test.case.new( - name='MyClass', - test=test.expect.eq( - actual=xtd.camelcase.split('MyClass'), - expected=['My', 'Class'], - ) -) -+ test.case.new( - name='MyC', - test=test.expect.eq( - actual=xtd.camelcase.split('MyC'), - expected=['My', 'C'], - ) -) -+ test.case.new( - name='HTML', - test=test.expect.eq( - actual=xtd.camelcase.split('HTML'), - expected=['HTML'], - ) -) -+ test.case.new( - name='PDFLoader', - test=test.expect.eq( - actual=xtd.camelcase.split('PDFLoader'), - expected=['PDF', 'Loader'], - ) -) -+ test.case.new( - name='AString', - test=test.expect.eq( - actual=xtd.camelcase.split('AString'), - expected=['A', 'String'], - ) -) -+ test.case.new( - name='SimpleXMLParser', - test=test.expect.eq( - actual=xtd.camelcase.split('SimpleXMLParser'), - expected=['Simple', 'XML', 'Parser'], - ) -) -+ test.case.new( - name='vimRPCPlugin', - test=test.expect.eq( - actual=xtd.camelcase.split('vimRPCPlugin'), - expected=['vim', 'RPC', 'Plugin'], - ) -) -+ test.case.new( - name='GL11Version', - test=test.expect.eq( - actual=xtd.camelcase.split('GL11Version'), - expected=['GL', '11', 'Version'], - ) -) -+ test.case.new( - name='99Bottles', - test=test.expect.eq( - actual=xtd.camelcase.split('99Bottles'), - expected=['99', 'Bottles'], - ) -) -+ test.case.new( - name='May5', - test=test.expect.eq( - actual=xtd.camelcase.split('May5'), - expected=['May', '5'], - ) -) -+ test.case.new( - name='BFG9000', - test=test.expect.eq( - actual=xtd.camelcase.split('BFG9000'), - expected=['BFG', '9000'], - ) -) -+ test.case.new( - name='Two spaces', - test=test.expect.eq( - actual=xtd.camelcase.split('Two spaces'), - expected=['Two', ' ', 'spaces'], - ) -) -+ test.case.new( - name='Multiple Random spaces', - test=test.expect.eq( - actual=xtd.camelcase.split('Multiple Random spaces'), - expected=['Multiple', ' ', 'Random', ' ', 'spaces'], - ) -) - -// TODO: find or create is(Upper|Lower) for non-ascii characters -// Something like this for Jsonnet: -// https://cs.opensource.google/go/go/+/refs/tags/go1.17.3:src/unicode/tables.go -//+ test.case.new( -// name='BöseÜberraschung', -// test=test.expect.eq( -// actual=xtd.camelcase.split('BöseÜberraschung'), -// expected=['Böse', 'Überraschung'], -// ) -//) - -// This doesn't even render in Jsonnet -//+ test.case.new( -// name="BadUTF8\xe2\xe2\xa1", -// test=test.expect.eq( -// actual=xtd.camelcase.split("BadUTF8\xe2\xe2\xa1"), -// expected=["BadUTF8\xe2\xe2\xa1"], -// ) -//) diff --git a/vendor/github.com/jsonnet-libs/xtd/test/date_test.jsonnet b/vendor/github.com/jsonnet-libs/xtd/test/date_test.jsonnet deleted file mode 100644 index c0ebe77..0000000 --- a/vendor/github.com/jsonnet-libs/xtd/test/date_test.jsonnet +++ /dev/null @@ -1,131 +0,0 @@ -local xtd = import '../main.libsonnet'; -local test = import 'github.com/jsonnet-libs/testonnet/main.libsonnet'; - -test.new(std.thisFile) - -+ test.case.new( - name='Leap Year commonYear', - test=test.expect.eq( - actual=xtd.date.isLeapYear(1995), - expected=false, - ) -) - -+ test.case.new( - name='Leap Year fourYearCycle', - test=test.expect.eq( - actual=xtd.date.isLeapYear(1996), - expected=true, - ) -) - -+ test.case.new( - name='Leap Year fourHundredYearCycle', - test=test.expect.eq( - actual=xtd.date.isLeapYear(2000), - expected=true, - ) -) - -+ test.case.new( - name='Leap Year hundredYearCycle', - test=test.expect.eq( - actual=xtd.date.isLeapYear(2100), - expected=false, - ) -) - -+ test.case.new( - name='Day Of Week leapYearStart', - test=test.expect.eq( - actual=xtd.date.dayOfWeek(2000, 1, 1), - expected=6, - ) -) - -+ test.case.new( - name='Day Of Week leapYearEnd', - test=test.expect.eq( - actual=xtd.date.dayOfWeek(2000, 12, 31), - expected=0, - ) -) - -+ test.case.new( - name='Day Of Week commonYearStart', - test=test.expect.eq( - actual=xtd.date.dayOfWeek(1995, 1, 1), - expected=0, - ) -) - -+ test.case.new( - name='Day Of Week commonYearEnd', - test=test.expect.eq( - actual=xtd.date.dayOfWeek(2003, 12, 31), - expected=3, - ) -) - -+ test.case.new( - name='Day Of Week leapYearMid', - test=test.expect.eq( - actual=xtd.date.dayOfWeek(2024, 7, 19), - expected=5, - ) -) - -+ test.case.new( - name='Day Of Week commonYearMid', - test=test.expect.eq( - actual=xtd.date.dayOfWeek(2023, 6, 15), - expected=4, - ) -) -+ test.case.new( - name='Day Of Year leapYearStart', - test=test.expect.eq( - actual=xtd.date.dayOfYear(2000, 1, 1), - expected=1, - ) -) - -+ test.case.new( - name='Day Of Year leapYearEnd', - test=test.expect.eq( - actual=xtd.date.dayOfYear(2000, 12, 31), - expected=366, - ) -) - -+ test.case.new( - name='Day Of Year commonYearStart', - test=test.expect.eq( - actual=xtd.date.dayOfYear(1995, 1, 1), - expected=1, - ) -) - -+ test.case.new( - name='Day Of Year commonYearEnd', - test=test.expect.eq( - actual=xtd.date.dayOfYear(2003, 12, 31), - expected=365, - ) -) - -+ test.case.new( - name='Day Of Year leapYearMid', - test=test.expect.eq( - actual=xtd.date.dayOfYear(2024, 7, 19), - expected=201, - ) -) - -+ test.case.new( - name='Day Of Year commonYearMid', - test=test.expect.eq( - actual=xtd.date.dayOfYear(2023, 6, 15), - expected=166, - ) -) diff --git a/vendor/github.com/jsonnet-libs/xtd/test/inspect_test.jsonnet b/vendor/github.com/jsonnet-libs/xtd/test/inspect_test.jsonnet deleted file mode 100644 index 54510ea..0000000 --- a/vendor/github.com/jsonnet-libs/xtd/test/inspect_test.jsonnet +++ /dev/null @@ -1,152 +0,0 @@ -local xtd = import '../main.libsonnet'; -local test = import 'github.com/jsonnet-libs/testonnet/main.libsonnet'; - -test.new(std.thisFile) - -+ test.case.new( - name='emptyobject', - test=test.expect.eq( - actual=xtd.inspect.inspect({}), - expected={} - ) -) - -+ test.case.new( - name='flatObject', - test=test.expect.eq( - actual=xtd.inspect.inspect({ - key: 'value', - hidden_key:: 'value', - func(value): value, - hidden_func(value):: value, - }), - expected={ - fields: ['key'], - hidden_fields: ['hidden_key'], - functions: ['func'], - hidden_functions: ['hidden_func'], - } - ) -) - -+ test.case.new( - name='nestedObject', - test=test.expect.eq( - actual=xtd.inspect.inspect({ - nested: { - key: 'value', - hidden_key:: 'value', - func(value): value, - hidden_func(value):: value, - }, - key: 'value', - hidden_func(value):: value, - }), - expected={ - nested: { - fields: ['key'], - hidden_fields: ['hidden_key'], - functions: ['func'], - hidden_functions: ['hidden_func'], - }, - fields: ['key'], - hidden_functions: ['hidden_func'], - } - ) -) - -+ test.case.new( - name='maxRecursionDepth', - test=test.expect.eq( - actual=xtd.inspect.inspect({ - key: 'value', - nested: { - key: 'value', - nested: { - key: 'value', - }, - }, - }, maxDepth=1), - expected={ - fields: ['key'], - nested: { - fields: ['key', 'nested'], - }, - } - ) -) - -+ test.case.new( - name='noDiff', - test=test.expect.eq( - actual=xtd.inspect.diff('', ''), - expected='' - ) -) -+ test.case.new( - name='typeDiff', - test=test.expect.eq( - actual=xtd.inspect.diff('string', true), - expected='~[ string , true ]' - ) -) -+ ( - local input1 = { - same: 'same', - change: 'this', - remove: 'removed', - }; - local input2 = { - same: 'same', - change: 'changed', - add: 'added', - }; - test.case.new( - name='objectDiff', - test=test.expect.eq( - actual=xtd.inspect.diff(input1, input2), - expected={ - 'add +': 'added', - 'change ~': '~[ this , changed ]', - 'remove -': 'removed', - } - ) - ) -) - -+ ( - local input1 = [ - 'same', - 'this', - [ - 'same', - 'this', - ], - 'remove', - ]; - local input2 = [ - 'same', - 'changed', - [ - 'same', - 'changed', - 'added', - ], - ]; - test.case.new( - name='arrayDiff', - test=test.expect.eq( - actual=xtd.inspect.diff(input1, input2), - expected=[ - 'same', - '~[ this , changed ]', - [ - 'same', - '~[ this , changed ]', - '+ added', - ], - '- remove', - ] - ) - ) -) diff --git a/vendor/github.com/jsonnet-libs/xtd/test/jsonnetfile.json b/vendor/github.com/jsonnet-libs/xtd/test/jsonnetfile.json deleted file mode 100644 index ce9ad4d..0000000 --- a/vendor/github.com/jsonnet-libs/xtd/test/jsonnetfile.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "version": 1, - "dependencies": [ - { - "source": { - "git": { - "remote": "https://github.com/jsonnet-libs/testonnet.git", - "subdir": "" - } - }, - "version": "master" - } - ], - "legacyImports": true -} diff --git a/vendor/github.com/jsonnet-libs/xtd/test/jsonpath_test.jsonnet b/vendor/github.com/jsonnet-libs/xtd/test/jsonpath_test.jsonnet deleted file mode 100644 index 8c1106b..0000000 --- a/vendor/github.com/jsonnet-libs/xtd/test/jsonpath_test.jsonnet +++ /dev/null @@ -1,305 +0,0 @@ -local jsonpath = import '../jsonpath.libsonnet'; -local test = import 'github.com/jsonnet-libs/testonnet/main.libsonnet'; - -test.new(std.thisFile) - -// Root -+ test.case.new( - name='root $', - test=test.expect.eq( - actual=jsonpath.getJSONPath({ key: 'content' }, '$'), - expected={ key: 'content' }, - ) -) -+ test.case.new( - name='root (empty path)', - test=test.expect.eq( - actual=jsonpath.getJSONPath({ key: 'content' }, ''), - expected={ key: 'content' }, - ) -) -+ test.case.new( - name='root .', - test=test.expect.eq( - actual=jsonpath.getJSONPath({ key: 'content' }, '.'), - expected={ key: 'content' }, - ) -) - -// Single key -+ test.case.new( - name='path without dot prefix', - test=test.expect.eq( - actual=jsonpath.getJSONPath({ key: 'content' }, 'key'), - expected='content', - ) -) -+ test.case.new( - name='single key', - test=test.expect.eq( - actual=jsonpath.getJSONPath({ key: 'content' }, '.key'), - expected='content', - ) -) -+ test.case.new( - name='single bracket key', - test=test.expect.eq( - actual=jsonpath.getJSONPath({ key: 'content' }, '[key]'), - expected='content', - ) -) -+ test.case.new( - name='single bracket key with $', - test=test.expect.eq( - actual=jsonpath.getJSONPath({ key: 'content' }, '$[key]'), - expected='content', - ) -) -+ test.case.new( - name='single array index', - test=test.expect.eq( - actual=jsonpath.getJSONPath(['content'], '.[0]'), - expected='content', - ) -) -+ test.case.new( - name='single array index without dot prefix', - test=test.expect.eq( - actual=jsonpath.getJSONPath(['content'], '[0]'), - expected='content', - ) -) - -// Nested -+ test.case.new( - name='nested key', - test=test.expect.eq( - actual=jsonpath.getJSONPath( - { key1: { key2: { key3: 'content' } } }, - '.key1.key2.key3' - ), - expected='content', - ) -) -+ test.case.new( - name='nested bracket key', - test=test.expect.eq( - actual=jsonpath.getJSONPath( - { key1: { key2: { key3: 'content' } } }, - '.key1.key2[key3]' - ), - expected='content', - ) -) -+ test.case.new( - name='nested bracket key (quoted)', - test=test.expect.eq( - actual=jsonpath.getJSONPath( - { key1: { key2: { key3: 'content' } } }, - ".key1.key2['key3']" - ), - expected='content', - ) -) -+ test.case.new( - name='nested bracket star key', - test=test.expect.eq( - actual=jsonpath.getJSONPath( - { key1: { key2: { key3: 'content' } } }, - '.key1.key2[*]' - ), - expected={ key3: 'content' }, - ) -) -+ test.case.new( - name='nested array index', - test=test.expect.eq( - actual=jsonpath.getJSONPath( - { key1: { key2: ['content1', 'content2'] } }, - '.key1.key2[1]' - ), - expected='content2', - ) -) -+ test.case.new( - name='nested array index with $', - test=test.expect.eq( - actual=jsonpath.getJSONPath( - { key1: { key2: ['content1', 'content2'] } }, - '$.key1.key2[1]' - ), - expected='content2', - ) -) -+ test.case.new( - name='nested array index without brackets', - test=test.expect.eq( - actual=jsonpath.getJSONPath( - { key1: { key2: ['content1', 'content2'] } }, - '.key1.key2.1' - ), - expected='content2', - ) -) -+ test.case.new( - name='nested array star index', - test=test.expect.eq( - actual=jsonpath.getJSONPath( - { key1: { key2: ['content1', 'content2'] } }, - '.key1.key2[*]' - ), - expected=['content1', 'content2'], - ) -) -+ test.case.new( - name='nested bracket keys and array index combo', - test=test.expect.eq( - actual=jsonpath.getJSONPath( - { key1: { key2: ['content1', 'content2'] } }, - '$.[key1][key2][1]' - ), - expected='content2', - ) -) -+ test.case.new( - name='all keys in bracket and quoted', - test=test.expect.eq( - actual=jsonpath.getJSONPath( - { key1: { key2: ['content1', 'content2'] } }, - "$['key1']['key2']" - ), - expected=['content1', 'content2'], - ) -) - -// index range/slice -+ test.case.new( - name='array with index range (first two)', - test=test.expect.eq( - actual=jsonpath.getJSONPath( - { key: ['content1', 'content2', 'content3'] }, - 'key[0:2]' - ), - expected=['content1', 'content2'], - ) -) -+ test.case.new( - name='array with index range (last two)', - test=test.expect.eq( - actual=jsonpath.getJSONPath( - { key: ['content1', 'content2', 'content3'] }, - 'key[1:3]' - ), - expected=['content2', 'content3'], - ) -) -+ test.case.new( - name='array with index range (until end)', - test=test.expect.eq( - actual=jsonpath.getJSONPath( - { key: ['content1', 'content2', 'content3'] }, - 'key[1:]' - ), - expected=['content2', 'content3'], - ) -) -+ test.case.new( - name='array with index range (from beginning)', - test=test.expect.eq( - actual=jsonpath.getJSONPath( - { key: ['content1', 'content2', 'content3'] }, - 'key[:2]' - ), - expected=['content1', 'content2'], - ) -) -+ test.case.new( - name='array with index range (negative start)', - test=test.expect.eq( - actual=jsonpath.getJSONPath( - { key: ['content1', 'content2', 'content3'] }, - 'key[-2:]' - ), - expected=['content2', 'content3'], - ) -) -+ test.case.new( - name='array with index range (negative end)', - test=test.expect.eq( - actual=jsonpath.getJSONPath( - { key: ['content1', 'content2', 'content3'] }, - 'key[:-1]' - ), - expected=['content1', 'content2'], - ) -) -+ test.case.new( - name='array with index range (step)', - test=test.expect.eq( - actual=jsonpath.getJSONPath( - { key: [ - 'content%s' % i - for i in std.range(1, 10) - ] }, - 'key[:5:2]' - ), - expected=['content1', 'content3', 'content5'], - ) -) - -// filter expr -+ test.case.new( - name='array with filter expression - string', - test=test.expect.eq( - actual=jsonpath.getJSONPath( - { key: [ - { - key: 'content%s' % i, - } - for i in std.range(1, 10) - ] }, - '.key[?(@.key==content2)]' - ), - expected=[{ - key: 'content2', - }], - ) -) -+ test.case.new( - name='array with filter expression - number', - test=test.expect.eq( - actual=jsonpath.getJSONPath( - { key: [ - { - count: i, - } - for i in std.range(1, 10) - ] }, - '.key[?(@.count<=2)]' - ), - expected=[{ - count: 1, - }, { - count: 2, - }], - ) -) -+ test.case.new( - name='array with filter expression - has key', - test=test.expect.eq( - actual=jsonpath.getJSONPath( - { key: [ - { - key1: 'value', - }, - { - key2: 'value', - }, - ] }, - '.key[?(@.key1)]' - ), - expected=[{ - key1: 'value', - }], - ) -) diff --git a/vendor/github.com/jsonnet-libs/xtd/test/url_test.jsonnet b/vendor/github.com/jsonnet-libs/xtd/test/url_test.jsonnet deleted file mode 100644 index f837966..0000000 --- a/vendor/github.com/jsonnet-libs/xtd/test/url_test.jsonnet +++ /dev/null @@ -1,75 +0,0 @@ -local xtd = import '../main.libsonnet'; -local test = import 'github.com/jsonnet-libs/testonnet/main.libsonnet'; - -test.new(std.thisFile) -+ test.case.new( - name='empty', - test=test.expect.eq( - actual=xtd.url.escapeString(''), - expected='', - ) -) - -+ test.case.new( - name='abc', - test=test.expect.eq( - actual=xtd.url.escapeString('abc'), - expected='abc', - ) -) - -+ test.case.new( - name='space', - test=test.expect.eq( - actual=xtd.url.escapeString('one two'), - expected='one%20two', - ) -) - -+ test.case.new( - name='percent', - test=test.expect.eq( - actual=xtd.url.escapeString('10%'), - expected='10%25', - ) -) - -+ test.case.new( - name='complex', - test=test.expect.eq( - actual=xtd.url.escapeString(" ?&=#+%!<>#\"{}|\\^[]`☺\t:/@$'()*,;"), - expected='%20%3F%26%3D%23%2B%25%21%3C%3E%23%22%7B%7D%7C%5C%5E%5B%5D%60%E2%98%BA%09%3A%2F%40%24%27%28%29%2A%2C%3B', - ) -) - -+ test.case.new( - name='exclusions', - test=test.expect.eq( - actual=xtd.url.escapeString('hello, world', [',']), - expected='hello,%20world', - ) -) - -+ test.case.new( - name='multiple exclusions', - test=test.expect.eq( - actual=xtd.url.escapeString('hello, world,&', [',', '&']), - expected='hello,%20world,&', - ) -) - -+ test.case.new( - name='empty', - test=test.expect.eq( - actual=xtd.url.encodeQuery({}), - expected='', - ) -) - -+ test.case.new( - name='simple', - test=test.expect.eq( - actual=xtd.url.encodeQuery({ q: 'puppies', oe: 'utf8' }), - expected='oe=utf8&q=puppies', - ) -) diff --git a/vendor/github.com/jsonnet-libs/xtd/url.libsonnet b/vendor/github.com/jsonnet-libs/xtd/url.libsonnet deleted file mode 100644 index 80f367d..0000000 --- a/vendor/github.com/jsonnet-libs/xtd/url.libsonnet +++ /dev/null @@ -1,21 +0,0 @@ -local d = import 'doc-util/main.libsonnet'; - -{ - '#': d.pkg( - name='url', - url='github.com/jsonnet-libs/xtd/url.libsonnet', - help='`url` implements URL escaping and query building', - ), - - '#escapeString': d.fn('`escapeString` escapes the given string so it can be safely placed inside an URL, replacing special characters with `%XX` sequences', [d.arg('str', d.T.string), d.arg('excludedChars', d.T.array)]), - escapeString(str, excludedChars=[]):: - local allowedChars = '0123456789abcdefghijklmnopqrstuvwqxyzABCDEFGHIJKLMNOPQRSTUVWQXYZ'; - local utf8(char) = std.foldl(function(a, b) a + '%%%02X' % b, std.encodeUTF8(char), ''); - local escapeChar(char) = if std.member(excludedChars, char) || std.member(allowedChars, char) then char else utf8(char); - std.join('', std.map(escapeChar, std.stringChars(str))), - - '#encodeQuery': d.fn('`encodeQuery` takes an object of query parameters and returns them as an escaped `key=value` string', [d.arg('params', d.T.object)]), - encodeQuery(params):: - local fmtParam(p) = '%s=%s' % [self.escapeString(p), self.escapeString(params[p])]; - std.join('&', std.map(fmtParam, std.objectFields(params))), -} diff --git a/vendor/grafonnet-base b/vendor/grafonnet-base deleted file mode 120000 index fc4a3fe..0000000 --- a/vendor/grafonnet-base +++ /dev/null @@ -1 +0,0 @@ -github.com/grafana/grafonnet/grafonnet-base \ No newline at end of file diff --git a/vendor/grafonnet-latest b/vendor/grafonnet-latest deleted file mode 120000 index 803696f..0000000 --- a/vendor/grafonnet-latest +++ /dev/null @@ -1 +0,0 @@ -github.com/grafana/grafonnet/gen/grafonnet-latest \ No newline at end of file diff --git a/vendor/grafonnet-v10.0.0 b/vendor/grafonnet-v10.0.0 deleted file mode 120000 index 3749c7b..0000000 --- a/vendor/grafonnet-v10.0.0 +++ /dev/null @@ -1 +0,0 @@ -github.com/grafana/grafonnet/gen/grafonnet-v10.0.0 \ No newline at end of file diff --git a/vendor/v10.0.0 b/vendor/v10.0.0 deleted file mode 120000 index 5ee7dc4..0000000 --- a/vendor/v10.0.0 +++ /dev/null @@ -1 +0,0 @@ -github.com/grafana/grok/jsonnet/v10.0.0 \ No newline at end of file diff --git a/vendor/validate-libsonnet b/vendor/validate-libsonnet deleted file mode 120000 index d16d8d7..0000000 --- a/vendor/validate-libsonnet +++ /dev/null @@ -1 +0,0 @@ -github.com/crdsonnet/validate-libsonnet \ No newline at end of file diff --git a/vendor/xtd b/vendor/xtd deleted file mode 120000 index 68b106a..0000000 --- a/vendor/xtd +++ /dev/null @@ -1 +0,0 @@ -github.com/jsonnet-libs/xtd \ No newline at end of file