fix: resolve warnings from api-report.md, add jsDoc comments
Signed-off-by: Isaiah Thiessen <isaiah.thiessen@telus.com>
This commit is contained in:
@@ -7,25 +7,13 @@
|
||||
|
||||
import { BackstagePlugin } from '@backstage/core-plugin-api';
|
||||
import { Entity } from '@backstage/catalog-model';
|
||||
import { RouteRef } from '@backstage/core-plugin-api';
|
||||
|
||||
// Warning: (ae-missing-release-tag) "dynatracePlugin" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
|
||||
//
|
||||
// @public (undocumented)
|
||||
export const dynatracePlugin: BackstagePlugin<
|
||||
{
|
||||
root: RouteRef<undefined>;
|
||||
},
|
||||
{}
|
||||
>;
|
||||
export const dynatracePlugin: BackstagePlugin<{}, {}>;
|
||||
|
||||
// Warning: (ae-missing-release-tag) "DynatraceTab" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
|
||||
//
|
||||
// @public (undocumented)
|
||||
export const DynatraceTab: () => JSX.Element;
|
||||
|
||||
// Warning: (ae-missing-release-tag) "isDynatraceAvailable" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
|
||||
//
|
||||
// @public (undocumented)
|
||||
export const isDynatraceAvailable: (entity: Entity) => boolean;
|
||||
|
||||
|
||||
@@ -27,7 +27,10 @@ import { DYNATRACE_ID_ANNOTATION } from './constants';
|
||||
|
||||
import { rootRouteRef } from './routes';
|
||||
|
||||
// @public (undocumented)
|
||||
/**
|
||||
* Create the Dynatrace plugin.
|
||||
* @public
|
||||
*/
|
||||
export const dynatracePlugin = createPlugin({
|
||||
id: 'dynatrace',
|
||||
apis: [
|
||||
@@ -46,11 +49,18 @@ export const dynatracePlugin = createPlugin({
|
||||
],
|
||||
});
|
||||
|
||||
// @public (undocumented)
|
||||
/**
|
||||
* Checks if the entity has a dynatrace id annotation.
|
||||
* @public
|
||||
* @param entity {Entity} - The entity to check for the dynatrace id annotation.
|
||||
*/
|
||||
export const isDynatraceAvailable = (entity: Entity) =>
|
||||
Boolean(entity.metadata.annotations?.[DYNATRACE_ID_ANNOTATION]);
|
||||
|
||||
// @public (undocumented)
|
||||
/**
|
||||
* Creates a routable extension for the dynatrace plugin tab.
|
||||
* @public
|
||||
*/
|
||||
export const DynatraceTab = dynatracePlugin.provide(
|
||||
createRoutableExtension({
|
||||
name: 'DynatraceTab',
|
||||
|
||||
Reference in New Issue
Block a user