From 5fd97b92404bc3b9a7d2653f0e1fae9eed85a0dd Mon Sep 17 00:00:00 2001 From: Wesley Date: Mon, 12 Sep 2022 05:23:52 +0200 Subject: [PATCH] add missing api-report.md Signed-off-by: Wesley --- plugins/azure-functions-backend/api-report.md | 86 ++++++++++++++++++ plugins/azure-functions/api-report.md | 89 +++++++++++++++++++ 2 files changed, 175 insertions(+) create mode 100644 plugins/azure-functions-backend/api-report.md create mode 100644 plugins/azure-functions/api-report.md diff --git a/plugins/azure-functions-backend/api-report.md b/plugins/azure-functions-backend/api-report.md new file mode 100644 index 0000000000..1811249ca2 --- /dev/null +++ b/plugins/azure-functions-backend/api-report.md @@ -0,0 +1,86 @@ +## API Report File for "@backstage/plugin-azure-functions-backend" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts +import { Config } from '@backstage/config'; +import express from 'express'; +import { Logger } from 'winston'; + +// Warning: (ae-missing-release-tag) "AzureFunctionsAllowedSubscriptionsConfig" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export interface AzureFunctionsAllowedSubscriptionsConfig { + // (undocumented) + id: string; + // (undocumented) + name: string; +} + +// Warning: (ae-missing-release-tag) "AzureFunctionsConfig" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export class AzureFunctionsConfig { + constructor( + tenantId: string, + clientId: string, + clientSecret: string, + domain: string, + allowedSubscriptions: AzureFunctionsAllowedSubscriptionsConfig[], + ); + // (undocumented) + readonly allowedSubscriptions: AzureFunctionsAllowedSubscriptionsConfig[]; + // (undocumented) + readonly clientId: string; + // (undocumented) + readonly clientSecret: string; + // (undocumented) + readonly domain: string; + // (undocumented) + static fromConfig(config: Config): AzureFunctionsConfig; + // (undocumented) + readonly tenantId: string; +} + +// Warning: (ae-missing-release-tag) "AzureWebManagementApi" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export class AzureWebManagementApi { + constructor(config: AzureFunctionsConfig); + // (undocumented) + static fromConfig(config: Config): AzureWebManagementApi; + // (undocumented) + list({ functionName }: { functionName: string }): Promise; +} + +// Warning: (ae-missing-release-tag) "createRouter" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export function createRouter(options: RouterOptions): Promise; + +// Warning: (ae-missing-release-tag) "FunctionsData" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export type FunctionsData = { + href: string; + logstreamHref: string; + functionName: string; + location: string; + state: string; + usageState: string; + containerSize: number; + lastModifiedDate: Date; +}; + +// Warning: (ae-missing-release-tag) "RouterOptions" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export interface RouterOptions { + // (undocumented) + azureWebManagementApi: AzureWebManagementApi; + // (undocumented) + logger: Logger; +} + +// (No @packageDocumentation comment for this package) +``` diff --git a/plugins/azure-functions/api-report.md b/plugins/azure-functions/api-report.md new file mode 100644 index 0000000000..881c5bdf5e --- /dev/null +++ b/plugins/azure-functions/api-report.md @@ -0,0 +1,89 @@ +## API Report File for "@backstage/plugin-azure-functions" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts +/// + +import { ApiRef } from '@backstage/core-plugin-api'; +import { BackstagePlugin } from '@backstage/core-plugin-api'; +import { DiscoveryApi } from '@backstage/core-plugin-api'; +import { Entity } from '@backstage/catalog-model'; +import { IdentityApi } from '@backstage/core-plugin-api'; +import { RouteRef } from '@backstage/core-plugin-api'; + +// Warning: (ae-missing-release-tag) "AzureFunctionsApi" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export type AzureFunctionsApi = { + list: ({ + functionName, + }: { + functionName: string; + }) => Promise; +}; + +// Warning: (ae-missing-release-tag) "azureFunctionsApiRef" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export const azureFunctionsApiRef: ApiRef; + +// Warning: (ae-missing-release-tag) "AzureFunctionsBackendClient" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export class AzureFunctionsBackendClient implements AzureFunctionsApi { + constructor(options: { + discoveryApi: DiscoveryApi; + identityApi: IdentityApi; + }); + // (undocumented) + list({ functionName }: { functionName: string }): Promise; +} + +// Warning: (ae-missing-release-tag) "AzureFunctionsOverviewWidget" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export const AzureFunctionsOverviewWidget: () => JSX.Element; + +// Warning: (ae-missing-release-tag) "azureFunctionsPlugin" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export const azureFunctionsPlugin: BackstagePlugin< + { + entityContent: RouteRef; + }, + {}, + {} +>; + +// Warning: (ae-missing-release-tag) "EntityAzureFunctionsOverviewCard" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export const EntityAzureFunctionsOverviewCard: () => JSX.Element; + +// Warning: (ae-missing-release-tag) "entityContentRouteRef" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export const entityContentRouteRef: RouteRef; + +// Warning: (ae-missing-release-tag) "FunctionsData" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export type FunctionsData = { + href: string; + logstreamHref: string; + functionName: string; + location: string; + state: string; + usageState: string; + containerSize: number; + lastModifiedDate: Date; +}; + +// Warning: (ae-missing-release-tag) "isAzureFunctionsAvailable" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export const isAzureFunctionsAvailable: (entity: Entity) => string | undefined; + +// (No @packageDocumentation comment for this package) +```