paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 45 Packages Projects Releases Wiki Activity

Merge pull request #12396 from andrewthauer/fix-cost-insights-api-docs

Browse Source 
fix: cost-insights api docs warnings
This commit is contained in:
Fredrik Adelöw
2022-07-04 14:08:02 +02:00
committed by GitHub
parent a225c50c2c 50c698f345
commit efb835c97c
2 changed files with 50 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/cost-insights/api-report.md
-11
View File
@@ -272,7 +272,6 @@ export type BarChartTooltipProps = {
actions?: ReactNode;
};
// Warning: (tsdoc-characters-after-block-tag) The token "@backstage" looks like a TSDoc tag but contains an invalid character "/"; if it is not a tag, use a backslash to escape the "@"
// Warning: (ae-missing-release-tag) "ChangeStatistic" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public @deprecated (undocumented)
@@ -296,7 +295,6 @@ export type ChartData = {
[key: string]: number;
};
// Warning: (tsdoc-characters-after-block-tag) The token "@backstage" looks like a TSDoc tag but contains an invalid character "/"; if it is not a tag, use a backslash to escape the "@"
// Warning: (ae-missing-release-tag) "Cost" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public @deprecated (undocumented)
@@ -450,7 +448,6 @@ export enum DataKey {
Previous = 'previous',
}
// Warning: (tsdoc-characters-after-block-tag) The token "@backstage" looks like a TSDoc tag but contains an invalid character "/"; if it is not a tag, use a backslash to escape the "@"
// Warning: (ae-missing-release-tag) "DateAggregation" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public @deprecated (undocumented)
@@ -478,7 +475,6 @@ export enum Duration {
// @public (undocumented)
export const EngineerThreshold = 0.5;
// Warning: (tsdoc-characters-after-block-tag) The token "@backstage" looks like a TSDoc tag but contains an invalid character "/"; if it is not a tag, use a backslash to escape the "@"
// Warning: (ae-missing-release-tag) "Entity" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public @deprecated (undocumented)
@@ -506,7 +502,6 @@ export class ExampleCostInsightsClient implements CostInsightsApi {
getUserGroups(userId: string): Promise<Group[]>;
}
// Warning: (tsdoc-characters-after-block-tag) The token "@backstage" looks like a TSDoc tag but contains an invalid character "/"; if it is not a tag, use a backslash to escape the "@"
// Warning: (ae-missing-release-tag) "Group" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public @deprecated (undocumented)
@@ -574,19 +569,16 @@ export type LegendItemProps = {
// @public (undocumented)
export type Loading = Record<string, boolean>;
// Warning: (tsdoc-characters-after-block-tag) The token "@backstage" looks like a TSDoc tag but contains an invalid character "/"; if it is not a tag, use a backslash to escape the "@"
// Warning: (ae-missing-release-tag) "Maybe" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public @deprecated (undocumented)
export type Maybe<T> = common.Maybe<T>;
// Warning: (tsdoc-characters-after-block-tag) The token "@backstage" looks like a TSDoc tag but contains an invalid character "/"; if it is not a tag, use a backslash to escape the "@"
// Warning: (ae-missing-release-tag) "Metric" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public @deprecated (undocumented)
export type Metric = common.Metric;
// Warning: (tsdoc-characters-after-block-tag) The token "@backstage" looks like a TSDoc tag but contains an invalid character "/"; if it is not a tag, use a backslash to escape the "@"
// Warning: (ae-missing-release-tag) "MetricData" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public @deprecated (undocumented)
@@ -622,7 +614,6 @@ export interface PageFilters {
project: Maybe_2<string>;
}
// Warning: (tsdoc-characters-after-block-tag) The token "@backstage" looks like a TSDoc tag but contains an invalid character "/"; if it is not a tag, use a backslash to escape the "@"
// Warning: (ae-missing-release-tag) "Product" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public @deprecated (undocumented)
@@ -649,7 +640,6 @@ export interface ProductPeriod {
productType: string;
}
// Warning: (tsdoc-characters-after-block-tag) The token "@backstage" looks like a TSDoc tag but contains an invalid character "/"; if it is not a tag, use a backslash to escape the "@"
// Warning: (ae-missing-release-tag) "Project" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public @deprecated (undocumented)
@@ -711,7 +701,6 @@ export type TooltipItem = {
value: string;
};
// Warning: (tsdoc-characters-after-block-tag) The token "@backstage" looks like a TSDoc tag but contains an invalid character "/"; if it is not a tag, use a backslash to escape the "@"
// Warning: (ae-missing-release-tag) "Trendline" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public @deprecated (undocumented)
plugins/cost-insights/src/types/index.ts
+50 -24
View File
@@ -14,30 +14,6 @@
* limitations under the License.
*/
import * as common from '@backstage/plugin-cost-insights-common';
/** * @deprecated use the same type from @backstage/plugin-cost-insights-common instead */
export type ChangeStatistic = common.ChangeStatistic;
/** * @deprecated use the same type from @backstage/plugin-cost-insights-common instead */
export type Cost = common.Cost;
/** * @deprecated use the same type from @backstage/plugin-cost-insights-common instead */
export type DateAggregation = common.DateAggregation;
/** * @deprecated use the same type from @backstage/plugin-cost-insights-common instead */
export type Entity = common.Entity;
/** * @deprecated use the same type from @backstage/plugin-cost-insights-common instead */
export type Group = common.Group;
/** * @deprecated use the same type from @backstage/plugin-cost-insights-common instead */
export type Maybe<T> = common.Maybe<T>;
/** * @deprecated use the same type from @backstage/plugin-cost-insights-common instead */
export type Metric = common.Metric;
/** * @deprecated use the same type from @backstage/plugin-cost-insights-common instead */
export type MetricData = common.MetricData;
/** * @deprecated use the same type from @backstage/plugin-cost-insights-common instead */
export type Product = common.Product;
/** * @deprecated use the same type from @backstage/plugin-cost-insights-common instead */
export type Project = common.Project;
/** * @deprecated use the same type from @backstage/plugin-cost-insights-common instead */
export type Trendline = common.Trendline;
// TODO: Split some of these up into `@backstage/plugin-cost-insights-react` for presentation types
// and `@backstage/plugin-cost-insights-common` for data transfer object types.
export * from './Alert';
@@ -51,3 +27,53 @@ export * from './Filters';
export * from './Icon';
export * from './Loading';
export * from './Theme';
/**
* Deprecated types moved to `@backstage/plugin-cost-insights-common`
*/
import * as common from '@backstage/plugin-cost-insights-common';
/**
* @deprecated use the same type from `@backstage/plugin-cost-insights-common` instead
*/
export type ChangeStatistic = common.ChangeStatistic;
/**
* @deprecated use the same type from `@backstage/plugin-cost-insights-common` instead
*/
export type Cost = common.Cost;
/**
* @deprecated use the same type from `@backstage/plugin-cost-insights-common` instead
*/
export type DateAggregation = common.DateAggregation;
/**
* @deprecated use the same type from `@backstage/plugin-cost-insights-common` instead
*/
export type Entity = common.Entity;
/**
* @deprecated use the same type from `@backstage/plugin-cost-insights-common` instead
*/
export type Group = common.Group;
/**
* @deprecated use the same type from `@backstage/plugin-cost-insights-common` instead
*/
export type Maybe<T> = common.Maybe<T>;
/**
* @deprecated use the same type from `@backstage/plugin-cost-insights-common` instead
*/
export type Metric = common.Metric;
/**
* @deprecated use the same type from `@backstage/plugin-cost-insights-common` instead
*/
export type MetricData = common.MetricData;
/**
* @deprecated use the same type from `@backstage/plugin-cost-insights-common` instead
*/
export type Product = common.Product;
/**
* @deprecated use the same type from `@backstage/plugin-cost-insights-common` instead
*/
export type Project = common.Project;
/**
* @deprecated use the same type from `@backstage/plugin-cost-insights-common` instead
*/
export type Trendline = common.Trendline;