Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(analytics-utilities): drop docs build script #1690

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

docs(analytics-utilities): drop docs build script #1690

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
241d612
docs(analytics-utilities): update docs build script
mihai-peteu Oct 3, 2024
ff0534c
feat: drop analytics utils docs
mihai-peteu Oct 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
151 changes: 151 additions & 0 deletions packages/analytics/analytics-utilities/docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,151 @@
**@kong-ui-public/analytics-utilities** • **Docs**

***

# @kong-ui-public/analytics-utilities

## Enumerations

- [TimeframeKeys](enumerations/TimeframeKeys.md)

## Classes

- [DeltaQueryTime](classes/DeltaQueryTime.md)
- [SeededRandom](classes/SeededRandom.md)
- [Timeframe](classes/Timeframe.md)
- [TimeseriesQueryTime](classes/TimeseriesQueryTime.md)
- [UnaryQueryTime](classes/UnaryQueryTime.md)

## Interfaces

- [AbsoluteTimeRangeV4](interfaces/AbsoluteTimeRangeV4.md)
- [AdvancedDatasourceQuery](interfaces/AdvancedDatasourceQuery.md)
- [AiDatasourceQuery](interfaces/AiDatasourceQuery.md)
- [AiExploreFilter](interfaces/AiExploreFilter.md)
- [AiExploreQuery](interfaces/AiExploreQuery.md)
- [AnalyticsBridge](interfaces/AnalyticsBridge.md)
- [AnalyticsConfigV2](interfaces/AnalyticsConfigV2.md)
- [AnalyticsExploreRecord](interfaces/AnalyticsExploreRecord.md)
- [ApiAnalyticsV2](interfaces/ApiAnalyticsV2.md)
- [ApiRequestsV2](interfaces/ApiRequestsV2.md)
- [BasicDatasourceQuery](interfaces/BasicDatasourceQuery.md)
- [BasicExploreFilter](interfaces/BasicExploreFilter.md)
- [BasicExploreQuery](interfaces/BasicExploreQuery.md)
- [ControlPlaneConfig](interfaces/ControlPlaneConfig.md)
- [DatePickerSelection](interfaces/DatePickerSelection.md)
- [DimensionMap](interfaces/DimensionMap.md)
- [Display](interfaces/Display.md)
- [DisplayBlob](interfaces/DisplayBlob.md)
- [DruidGranularity](interfaces/DruidGranularity.md)
- [ExploreFilter](interfaces/ExploreFilter.md)
- [ExploreQuery](interfaces/ExploreQuery.md)
- [ExploreResultV4](interfaces/ExploreResultV4.md)
- [FilterTypeMap](interfaces/FilterTypeMap.md)
- [GroupByResult](interfaces/GroupByResult.md)
- [ITimeframe](interfaces/ITimeframe.md)
- [Metric](interfaces/Metric.md)
- [QueryResponseMeta](interfaces/QueryResponseMeta.md)
- [QueryTime](interfaces/QueryTime.md)
- [RecordEvent](interfaces/RecordEvent.md)
- [RelativeTimeRangeRequestV2](interfaces/RelativeTimeRangeRequestV2.md)
- [RelativeTimeRangeV4](interfaces/RelativeTimeRangeV4.md)
- [RequestEmptyFilter](interfaces/RequestEmptyFilter.md)
- [RequestEqualsFilter](interfaces/RequestEqualsFilter.md)
- [RequestInFilter](interfaces/RequestInFilter.md)
- [RequestMetricFilter](interfaces/RequestMetricFilter.md)
- [RequestQuery](interfaces/RequestQuery.md)
- [RequestWildcardFilter](interfaces/RequestWildcardFilter.md)
- [TimeFormatOptions](interfaces/TimeFormatOptions.md)
- [TimeframeOptions](interfaces/TimeframeOptions.md)
- [TimePeriod](interfaces/TimePeriod.md)

## Type Aliases

- [AiExploreAggregations](type-aliases/AiExploreAggregations.md)
- [AllAggregations](type-aliases/AllAggregations.md)
- [AllFilters](type-aliases/AllFilters.md)
- [AnalyticsRetentionMs](type-aliases/AnalyticsRetentionMs.md)
- [BasicExploreAggregations](type-aliases/BasicExploreAggregations.md)
- [DatasourceAwareQuery](type-aliases/DatasourceAwareQuery.md)
- [ExploreAggregations](type-aliases/ExploreAggregations.md)
- [ExploreFilterTypesV2](type-aliases/ExploreFilterTypesV2.md)
- [FilterableAiExploreDimensions](type-aliases/FilterableAiExploreDimensions.md)
- [FilterableBasicExploreDimensions](type-aliases/FilterableBasicExploreDimensions.md)
- [FilterableExploreDimensions](type-aliases/FilterableExploreDimensions.md)
- [FilterableRequestDimensions](type-aliases/FilterableRequestDimensions.md)
- [FilterableRequestMetrics](type-aliases/FilterableRequestMetrics.md)
- [FilterableRequestWildcardDimensions](type-aliases/FilterableRequestWildcardDimensions.md)
- [GranularityValues](type-aliases/GranularityValues.md)
- [MetricUnit](type-aliases/MetricUnit.md)
- [QueryableAiExploreDimensions](type-aliases/QueryableAiExploreDimensions.md)
- [QueryableBasicExploreDimensions](type-aliases/QueryableBasicExploreDimensions.md)
- [QueryableExploreDimensions](type-aliases/QueryableExploreDimensions.md)
- [QueryableRequestDimensions](type-aliases/QueryableRequestDimensions.md)
- [QueryableRequestMetrics](type-aliases/QueryableRequestMetrics.md)
- [QueryableRequestWildcardDimensions](type-aliases/QueryableRequestWildcardDimensions.md)
- [QueryDatasource](type-aliases/QueryDatasource.md)
- [RelativeTimeRangeValuesRequestV2](type-aliases/RelativeTimeRangeValuesRequestV2.md)
- [RelativeTimeRangeValuesV4](type-aliases/RelativeTimeRangeValuesV4.md)
- [ReportChartTypes](type-aliases/ReportChartTypes.md)
- [RequestFilter](type-aliases/RequestFilter.md)
- [RequestFilterTypeEmptyV2](type-aliases/RequestFilterTypeEmptyV2.md)
- [RequestFilterTypeEqualsV2](type-aliases/RequestFilterTypeEqualsV2.md)
- [RequestFilterTypeMetricV2](type-aliases/RequestFilterTypeMetricV2.md)
- [RequestFilterTypeWildcardV2](type-aliases/RequestFilterTypeWildcardV2.md)
- [RequestsRetentionMs](type-aliases/RequestsRetentionMs.md)
- [TimeRangeRequestV2](type-aliases/TimeRangeRequestV2.md)
- [TimeRangeTypeV2](type-aliases/TimeRangeTypeV2.md)
- [TimeRangeV4](type-aliases/TimeRangeV4.md)

## Variables

- [aiExploreAggregations](variables/aiExploreAggregations.md)
- [basicExploreAggregations](variables/basicExploreAggregations.md)
- [datasourceToFilterableDimensions](variables/datasourceToFilterableDimensions.md)
- [exploreAggregations](variables/exploreAggregations.md)
- [exploreFilterTypesV2](variables/exploreFilterTypesV2.md)
- [filterableAiExploreDimensions](variables/filterableAiExploreDimensions.md)
- [filterableBasicExploreDimensions](variables/filterableBasicExploreDimensions.md)
- [filterableExploreDimensions](variables/filterableExploreDimensions.md)
- [filterableRequestDimensions](variables/filterableRequestDimensions.md)
- [filterableRequestMetrics](variables/filterableRequestMetrics.md)
- [filterableRequestWildcardDimensions](variables/filterableRequestWildcardDimensions.md)
- [Granularities](variables/Granularities.md)
- [granularityValues](variables/granularityValues.md)
- [queryableAiExploreDimensions](variables/queryableAiExploreDimensions.md)
- [queryableBasicExploreDimensions](variables/queryableBasicExploreDimensions.md)
- [queryableExploreDimensions](variables/queryableExploreDimensions.md)
- [queryableRequestDimensions](variables/queryableRequestDimensions.md)
- [queryableRequestMetrics](variables/queryableRequestMetrics.md)
- [queryableRequestWildcardDimensions](variables/queryableRequestWildcardDimensions.md)
- [queryDatasources](variables/queryDatasources.md)
- [REFRESH\_INTERVAL\_MS](variables/REFRESH_INTERVAL_MS.md)
- [relativeTimeRangeValuesRequestV2](variables/relativeTimeRangeValuesRequestV2.md)
- [relativeTimeRangeValuesV4](variables/relativeTimeRangeValuesV4.md)
- [reportChartTypes](variables/reportChartTypes.md)
- [requestFilterTypeEmptyV2](variables/requestFilterTypeEmptyV2.md)
- [requestFilterTypeEqualsV2](variables/requestFilterTypeEqualsV2.md)
- [requestFilterTypeMetricV2](variables/requestFilterTypeMetricV2.md)
- [requestFilterTypeWildcardV2](variables/requestFilterTypeWildcardV2.md)
- [TimePeriods](variables/TimePeriods.md)
- [timeRangeTypeV2](variables/timeRangeTypeV2.md)

## Functions

- [ceilToNearestTimeGrain](functions/ceilToNearestTimeGrain.md)
- [datePickerSelectionToTimeframe](functions/datePickerSelectionToTimeframe.md)
- [dstOffsetHours](functions/dstOffsetHours.md)
- [floorToNearestTimeGrain](functions/floorToNearestTimeGrain.md)
- [formatISOTimeWithTZ](functions/formatISOTimeWithTZ.md)
- [formatTime](functions/formatTime.md)
- [formatTimeRange](functions/formatTimeRange.md)
- [generateCrossSectionalData](functions/generateCrossSectionalData.md)
- [generateMultipleMetricTimeSeriesData](functions/generateMultipleMetricTimeSeriesData.md)
- [generateSingleMetricTimeSeriesData](functions/generateSingleMetricTimeSeriesData.md)
- [granularitiesToOptions](functions/granularitiesToOptions.md)
- [granularityMsToQuery](functions/granularityMsToQuery.md)
- [msToGranularity](functions/msToGranularity.md)
- [rand](functions/rand.md)
- [stripUnknownFilters](functions/stripUnknownFilters.md)
- [timeframeToDatepickerSelection](functions/timeframeToDatepickerSelection.md)
- [timeframeToDatepickerTimeperiod](functions/timeframeToDatepickerTimeperiod.md)
Loading
Loading