From f7ca7a56270eab3c62cb0554b5ce012989668583 Mon Sep 17 00:00:00 2001 From: Isaiah Thiessen Date: Thu, 2 Jun 2022 13:09:44 -0700 Subject: [PATCH] docs: add api report Signed-off-by: Isaiah Thiessen --- .changeset/many-yaks-occur.md | 2 +- microsite/data/plugins/dynatrace.yaml | 2 +- plugins/dynatrace/api-report.md | 33 +++++++++++++++++++++++++++ 3 files changed, 35 insertions(+), 2 deletions(-) create mode 100644 plugins/dynatrace/api-report.md diff --git a/.changeset/many-yaks-occur.md b/.changeset/many-yaks-occur.md index d4535c4913..d8f617bf11 100644 --- a/.changeset/many-yaks-occur.md +++ b/.changeset/many-yaks-occur.md @@ -2,4 +2,4 @@ '@backstage/plugin-dynatrace': minor --- -Adds dynatrace plugin +Adds Dynatrace plugin diff --git a/microsite/data/plugins/dynatrace.yaml b/microsite/data/plugins/dynatrace.yaml index 30629928b3..a9843ab1d8 100644 --- a/microsite/data/plugins/dynatrace.yaml +++ b/microsite/data/plugins/dynatrace.yaml @@ -6,7 +6,7 @@ category: Monitoring description: View monitoring info from dynatrace for services in your software catalog. documentation: https://github.com/backstage/backstage/tree/master/plugins/dynatrace iconUrl: img/dynatrace.svg -npmPackageName: "@backstage/backstage-plugin-dynatrace" +npmPackageName: "@backstage/plugin-dynatrace" tags: - dynatrace - monitoring diff --git a/plugins/dynatrace/api-report.md b/plugins/dynatrace/api-report.md new file mode 100644 index 0000000000..c1647650f8 --- /dev/null +++ b/plugins/dynatrace/api-report.md @@ -0,0 +1,33 @@ +## API Report File for "@backstage/plugin-dynatrace" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts +/// + +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; + }, + {} +>; + +// 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; + +// (No @packageDocumentation comment for this package) +```