added /** @public */ to exports for api-report
Signed-off-by: Wesley <wpattison08@gmail.com>
This commit is contained in:
@@ -7,8 +7,6 @@ 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)
|
||||
@@ -17,8 +15,6 @@ export interface AzureFunctionsAllowedSubscriptionsConfig {
|
||||
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(
|
||||
@@ -42,8 +38,6 @@ export class AzureFunctionsConfig {
|
||||
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);
|
||||
@@ -53,13 +47,9 @@ export class AzureWebManagementApi {
|
||||
list({ functionName }: { functionName: string }): Promise<FunctionsData[]>;
|
||||
}
|
||||
|
||||
// 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<express.Router>;
|
||||
|
||||
// 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;
|
||||
@@ -72,8 +62,6 @@ export type FunctionsData = {
|
||||
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)
|
||||
|
||||
@@ -22,6 +22,7 @@ import {
|
||||
FunctionsData,
|
||||
} from './types';
|
||||
|
||||
/** @public */
|
||||
export class AzureFunctionsConfig {
|
||||
constructor(
|
||||
public readonly tenantId: string,
|
||||
@@ -49,6 +50,7 @@ export class AzureFunctionsConfig {
|
||||
}
|
||||
}
|
||||
|
||||
/** @public */
|
||||
export class AzureWebManagementApi {
|
||||
private readonly baseHref = (domain: string) =>
|
||||
`https://portal.azure.com/#@${domain}/resource`;
|
||||
|
||||
@@ -14,11 +14,13 @@
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
/** @public */
|
||||
export interface AzureFunctionsAllowedSubscriptionsConfig {
|
||||
name: string;
|
||||
id: string;
|
||||
}
|
||||
|
||||
/** @public */
|
||||
export type FunctionsData = {
|
||||
href: string;
|
||||
logstreamHref: string;
|
||||
|
||||
@@ -21,11 +21,13 @@ import { Logger } from 'winston';
|
||||
|
||||
import { AzureWebManagementApi } from '../api';
|
||||
|
||||
/** @public */
|
||||
export interface RouterOptions {
|
||||
logger: Logger;
|
||||
azureWebManagementApi: AzureWebManagementApi;
|
||||
}
|
||||
|
||||
/** @public */
|
||||
export async function createRouter(
|
||||
options: RouterOptions,
|
||||
): Promise<express.Router> {
|
||||
|
||||
@@ -12,8 +12,6 @@ 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: ({
|
||||
@@ -23,13 +21,9 @@ export type AzureFunctionsApi = {
|
||||
}) => Promise<FunctionsData[]>;
|
||||
};
|
||||
|
||||
// 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<AzureFunctionsApi>;
|
||||
|
||||
// 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: {
|
||||
@@ -40,13 +34,9 @@ export class AzureFunctionsBackendClient implements AzureFunctionsApi {
|
||||
list({ functionName }: { functionName: string }): Promise<FunctionsData[]>;
|
||||
}
|
||||
|
||||
// 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<
|
||||
{
|
||||
@@ -56,18 +46,12 @@ export const azureFunctionsPlugin: BackstagePlugin<
|
||||
{}
|
||||
>;
|
||||
|
||||
// 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<undefined>;
|
||||
|
||||
// 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;
|
||||
@@ -80,8 +64,6 @@ export type FunctionsData = {
|
||||
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;
|
||||
|
||||
|
||||
@@ -17,10 +17,12 @@
|
||||
import { createApiRef } from '@backstage/core-plugin-api';
|
||||
import { FunctionsData } from './types';
|
||||
|
||||
/** @public */
|
||||
export const azureFunctionsApiRef = createApiRef<AzureFunctionsApi>({
|
||||
id: 'plugin.azurefunctions.service',
|
||||
});
|
||||
|
||||
/** @public */
|
||||
export type AzureFunctionsApi = {
|
||||
list: ({
|
||||
functionName,
|
||||
|
||||
@@ -18,6 +18,7 @@ import { AzureFunctionsApi } from './AzureFunctionsApi';
|
||||
import { FunctionsData } from './types';
|
||||
import { DiscoveryApi, IdentityApi } from '@backstage/core-plugin-api';
|
||||
|
||||
/** @public */
|
||||
export class AzureFunctionsBackendClient implements AzureFunctionsApi {
|
||||
private readonly identityApi: IdentityApi;
|
||||
private readonly discoveryApi: DiscoveryApi;
|
||||
|
||||
@@ -14,6 +14,7 @@
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
/** @public */
|
||||
export type FunctionsData = {
|
||||
href: string;
|
||||
logstreamHref: string;
|
||||
|
||||
+2
@@ -26,6 +26,7 @@ import ErrorBoundary from '../ErrorBoundary';
|
||||
import { useEntity } from '@backstage/plugin-catalog-react';
|
||||
import { OverviewTable } from '../OverviewTableComponent/OverviewTable';
|
||||
|
||||
/** @public */
|
||||
export const isAzureFunctionsAvailable = (entity: Entity) =>
|
||||
entity?.metadata.annotations?.[AZURE_FUNCTIONS_ANNOTATION];
|
||||
|
||||
@@ -46,6 +47,7 @@ const AzureFunctionsOverview = ({ entity }: { entity: Entity }) => {
|
||||
);
|
||||
};
|
||||
|
||||
/** @public */
|
||||
export const AzureFunctionsOverviewWidget = () => {
|
||||
const { entity } = useEntity();
|
||||
|
||||
|
||||
@@ -89,6 +89,7 @@ const DEFAULT_COLUMNS: TableColumn<FunctionsData>[] = [
|
||||
},
|
||||
];
|
||||
|
||||
/** @public */
|
||||
export const OverviewTable = ({ data, loading }: FunctionTableProps) => {
|
||||
const columns: TableColumn<FunctionsData>[] = [...DEFAULT_COLUMNS];
|
||||
const tableStyle = {
|
||||
|
||||
@@ -24,10 +24,12 @@ import {
|
||||
} from '@backstage/core-plugin-api';
|
||||
import { azureFunctionsApiRef, AzureFunctionsBackendClient } from './api';
|
||||
|
||||
/** @public */
|
||||
export const entityContentRouteRef = createRouteRef({
|
||||
id: 'Azure Functions Entity Content',
|
||||
});
|
||||
|
||||
/** @public */
|
||||
export const azureFunctionsPlugin = createPlugin({
|
||||
id: 'azure-functions',
|
||||
apis: [
|
||||
@@ -46,6 +48,7 @@ export const azureFunctionsPlugin = createPlugin({
|
||||
},
|
||||
});
|
||||
|
||||
/** @public */
|
||||
export const EntityAzureFunctionsOverviewCard = azureFunctionsPlugin.provide(
|
||||
createComponentExtension({
|
||||
name: 'EntityAzureFunctionsOverviewCard',
|
||||
|
||||
Reference in New Issue
Block a user