From fc01ce7e779a26d59f076096ffbfcfd362befd07 Mon Sep 17 00:00:00 2001 From: blam Date: Mon, 14 Oct 2024 17:56:00 +0200 Subject: [PATCH] chore: fix api-reports warnings Signed-off-by: blam --- package.json | 2 +- .../app-next-example-plugin/report.api.md | 5 - packages/backend-app-api/report-alpha.api.md | 4 - packages/backend-app-api/report.api.md | 10 - .../backend-defaults/report-discovery.api.md | 5 - .../backend-defaults/report-rootConfig.api.md | 6 - .../backend-defaults/report-rootHealth.api.md | 4 - .../report-rootHttpRouter.api.md | 23 --- .../backend-defaults/report-rootLogger.api.md | 14 -- .../backend-defaults/report-scheduler.api.md | 4 - .../backend-defaults/report-urlReader.api.md | 73 ------- packages/backend-defaults/report.api.md | 4 - .../urlReader/lib/GitlabUrlReader.ts | 3 +- .../report.api.md | 71 ------- packages/backend-openapi-utils/report.api.md | 80 -------- .../backend-plugin-api/report-alpha.api.md | 5 - .../report-testUtils.api.md | 5 - packages/backend-plugin-api/report.api.md | 44 ----- packages/backend-test-utils/report.api.md | 80 -------- .../catalog-client/report-testUtils.api.md | 17 -- packages/catalog-client/report.api.md | 9 - packages/catalog-model/report.api.md | 48 ----- packages/cli-node/report.api.md | 24 --- packages/config-loader/report.api.md | 28 --- packages/core-app-api/report.api.md | 66 ------- packages/core-compat-api/report.api.md | 7 - packages/core-components/report-alpha.api.md | 4 - packages/core-components/report.api.md | 179 ------------------ packages/core-plugin-api/report-alpha.api.md | 31 --- packages/core-plugin-api/report.api.md | 4 - packages/dev-utils/report.api.md | 6 - packages/errors/report.api.md | 12 -- packages/frontend-app-api/report.api.md | 4 - packages/frontend-defaults/report.api.md | 6 - packages/frontend-plugin-api/report.api.md | 102 ---------- packages/frontend-test-utils/report.api.md | 16 -- packages/integration-aws-node/report.api.md | 4 - packages/integration/report.api.md | 123 ------------ .../src/commands/api-reports/api-extractor.ts | 5 +- packages/test-utils/report-alpha.api.md | 7 - packages/test-utils/report.api.md | 29 --- packages/theme/report.api.md | 26 --- packages/yarn-plugin/report.api.md | 4 - .../report.api.md | 4 - plugins/api-docs/report-alpha.api.md | 4 - plugins/api-docs/report.api.md | 34 ---- plugins/app-backend/report-alpha.api.md | 4 - plugins/app-backend/report.api.md | 9 - plugins/app-visualizer/report.api.md | 4 - plugins/app/report.api.md | 4 - .../report.api.md | 5 - .../report.api.md | 5 - .../report.api.md | 6 - .../report.api.md | 8 - .../report.api.md | 5 - .../report.api.md | 5 - .../report.api.md | 6 - .../report.api.md | 5 - .../report.api.md | 5 - .../report.api.md | 5 - .../report.api.md | 5 - .../report.api.md | 4 - .../report.api.md | 6 - .../report.api.md | 5 - .../report.api.md | 5 - .../report.api.md | 5 - .../report.api.md | 5 - .../report.api.md | 5 - .../report.api.md | 8 - .../report.api.md | 8 - plugins/auth-backend/report.api.md | 64 ------- plugins/auth-node/report.api.md | 124 ------------ plugins/bitbucket-cloud-common/report.api.md | 150 --------------- .../report-alpha.api.md | 4 - .../catalog-backend-module-aws/report.api.md | 13 -- .../report-alpha.api.md | 4 - .../report.api.md | 8 - .../report.api.md | 6 - .../report-alpha.api.md | 4 - .../report.api.md | 7 - .../report-alpha.api.md | 4 - .../report.api.md | 16 -- .../catalog-backend-module-gcp/report.api.md | 8 - .../report-alpha.api.md | 4 - .../report.api.md | 9 - .../report-alpha.api.md | 4 - .../report.api.md | 37 ---- .../src/providers/GithubEntityProvider.ts | 6 - .../report-alpha.api.md | 4 - .../report.api.md | 25 --- .../GitlabDiscoveryEntityProvider.ts | 4 +- .../report-alpha.api.md | 18 -- .../report.api.md | 8 - .../src/alpha.ts | 9 - .../src/run.ts | 7 +- .../catalog-backend-module-ldap/report.api.md | 9 - .../report-alpha.api.md | 20 -- .../report.api.md | 10 - .../src/alpha.ts | 11 -- .../src/microsoftGraph/client.ts | 2 +- .../report.api.md | 9 - .../report.api.md | 8 - .../src/providers/PuppetDbEntityProvider.ts | 11 +- .../report.api.md | 6 - .../report.api.md | 5 - plugins/catalog-backend/report-alpha.api.md | 4 - plugins/catalog-backend/report.api.md | 81 -------- plugins/catalog-common/report.api.md | 12 -- plugins/catalog-graph/report-alpha.api.md | 4 - plugins/catalog-graph/report.api.md | 7 - plugins/catalog-import/report-alpha.api.md | 4 - plugins/catalog-import/report.api.md | 42 ---- plugins/catalog-node/report-alpha.api.md | 20 -- plugins/catalog-node/report.api.md | 18 -- plugins/catalog-react/report-alpha.api.md | 6 - plugins/catalog-react/report.api.md | 114 ----------- .../report.api.md | 4 - plugins/catalog/report-alpha.api.md | 5 - plugins/catalog/report.api.md | 127 ------------- plugins/config-schema/report.api.md | 11 -- plugins/devtools-backend/report.api.md | 15 -- plugins/devtools-common/report.api.md | 16 -- plugins/devtools/report-alpha.api.md | 4 - plugins/devtools/report.api.md | 10 - .../report-alpha.api.md | 4 - .../report.api.md | 5 - .../report-alpha.api.md | 5 - .../events-backend-module-azure/report.api.md | 5 - .../report-alpha.api.md | 5 - .../report.api.md | 5 - .../report-alpha.api.md | 5 - .../report.api.md | 5 - .../report.api.md | 5 - .../report.api.md | 5 - .../events-backend-test-utils/report.api.md | 23 --- plugins/events-backend/report-alpha.api.md | 4 - plugins/events-backend/report.api.md | 10 - plugins/events-node/report-alpha.api.md | 9 - plugins/events-node/report.api.md | 22 --- plugins/home-react/report.api.md | 11 -- plugins/home/report-alpha.api.md | 5 - plugins/home/report.api.md | 30 --- .../kubernetes-backend/report-alpha.api.md | 4 - plugins/kubernetes-backend/report.api.md | 114 ----------- plugins/kubernetes-cluster/report.api.md | 5 - plugins/kubernetes-common/report.api.md | 136 ------------- plugins/kubernetes-node/report.api.md | 56 ------ plugins/kubernetes-react/report.api.md | 169 ----------------- plugins/kubernetes/report-alpha.api.md | 4 - plugins/kubernetes/report.api.md | 7 - .../report.api.md | 11 -- plugins/notifications-common/report.api.md | 12 -- plugins/notifications-node/report.api.md | 16 -- plugins/notifications/report.api.md | 24 --- plugins/org-react/report.api.md | 4 - plugins/org/report-alpha.api.md | 4 - plugins/org/report.api.md | 15 -- .../permission-backend/report-alpha.api.md | 4 - plugins/permission-backend/report.api.md | 11 -- plugins/permission-common/report.api.md | 4 - plugins/permission-node/report.api.md | 7 - plugins/permission-react/report.api.md | 6 - plugins/proxy-backend/report-alpha.api.md | 4 - plugins/proxy-backend/report.api.md | 9 - .../report.api.md | 7 - .../report.api.md | 4 - .../report.api.md | 9 - .../report.api.md | 4 - .../scaffolder-backend/report-alpha.api.md | 5 - plugins/scaffolder-backend/report.api.md | 113 ----------- plugins/scaffolder-common/report.api.md | 11 -- plugins/scaffolder-node/report-alpha.api.md | 12 -- plugins/scaffolder-node/report.api.md | 47 ----- plugins/scaffolder-react/report-alpha.api.md | 53 +----- plugins/scaffolder-react/report.api.md | 45 ----- .../src/next/components/Stepper/index.ts | 6 +- plugins/scaffolder/report-alpha.api.md | 10 - plugins/scaffolder/report.api.md | 52 ----- .../report-alpha.api.md | 16 -- .../report.api.md | 10 - .../src/alpha.ts | 11 +- .../report-alpha.api.md | 17 -- .../report.api.md | 97 ---------- .../src/alpha.ts | 11 +- .../report-alpha.api.md | 4 - .../report.api.md | 8 - .../report-alpha.api.md | 4 - .../search-backend-module-pg/report.api.md | 47 ----- .../report.api.md | 10 - .../report-alpha.api.md | 18 -- .../report.api.md | 18 -- .../src/alpha.ts | 11 +- .../search-backend-node/report-alpha.api.md | 6 - plugins/search-backend-node/report.api.md | 20 -- plugins/search-backend/report-alpha.api.md | 4 - plugins/search-backend/report.api.md | 5 - plugins/search-common/report.api.md | 20 -- plugins/search-react/report-alpha.api.md | 7 - plugins/search-react/report.api.md | 21 -- plugins/search/report-alpha.api.md | 7 - plugins/search/report.api.md | 15 -- plugins/signals-backend/report.api.md | 13 -- plugins/signals-node/report.api.md | 12 -- plugins/signals-react/report.api.md | 9 - plugins/signals/report.api.md | 10 - plugins/techdocs-backend/report-alpha.api.md | 4 - plugins/techdocs-backend/report.api.md | 13 -- plugins/techdocs-common/report.api.md | 5 - plugins/techdocs-node/report.api.md | 14 -- plugins/techdocs-react/report.api.md | 13 -- plugins/techdocs/report-alpha.api.md | 5 - plugins/techdocs/report.api.md | 32 ---- .../user-settings-backend/report-alpha.api.md | 4 - plugins/user-settings-common/report.api.md | 4 - plugins/user-settings/report-alpha.api.md | 6 - plugins/user-settings/report.api.md | 32 ---- 216 files changed, 28 insertions(+), 4221 deletions(-) diff --git a/package.json b/package.json index edd114834c..c750f223b2 100644 --- a/package.json +++ b/package.json @@ -17,7 +17,7 @@ "build:all": "backstage-cli repo build --all", "build:api-docs": "LANG=en_EN yarn build:api-reports --docs --exclude 'plugins/@(adr|adr-backend|adr-common|airbrake|airbrake-backend|allure|analytics-module-ga|analytics-module-ga4|analytics-module-newrelic-browser|apache-airflow|api-docs|api-docs-module-protoc-gen-doc|apollo-explorer|app-visualizer|azure-devops|azure-devops-backend|azure-devops-common|azure-sites|azure-sites-backend|azure-sites-common|badges|badges-backend|bazaar|bazaar-backend|bitbucket-cloud-common|bitrise|catalog-graph|catalog-graphql|catalog-import|catalog-unprocessed-entities|cicd-statistics|cicd-statistics-module-gitlab|circleci|cloudbuild|code-climate|code-coverage|code-coverage-backend|codescene|config-schema|cost-insights|cost-insights-common|dynatrace|entity-feedback|entity-feedback-backend|entity-feedback-common|entity-validation|example-todo-list|example-todo-list-backend|example-todo-list-common|firehydrant|fossa|gcalendar|gcp-projects|git-release-manager|github-actions|github-deployments|github-issues|github-pull-requests-board|gitops-profiles|gocd|graphiql|graphql-backend|graphql-voyager|ilert|jenkins|jenkins-backend|jenkins-common|kafka|kafka-backend|lighthouse|lighthouse-backend|lighthouse-common|linguist|linguist-backend|linguist-common|microsoft-calendar|newrelic|newrelic-dashboard|nomad|nomad-backend|octopus-deploy|opencost|pagerduty|periskop|periskop-backend|playlist|playlist-backend|playlist-common|proxy-backend|puppetdb|rollbar|rollbar-backend|sentry|shortcuts|splunk-on-call|stack-overflow|stack-overflow-backend|stackstorm|tech-radar|tech-radar-2|todo|todo-backend|xcmetrics)'", "build:api-reports": "yarn build:api-reports:only --tsc", - "build:api-reports:only": "NODE_OPTIONS=--max-old-space-size=8192 backstage-repo-tools api-reports --allow-warnings 'packages/backend-app-api,packages/core-components,plugins/+(catalog|catalog-import|git-release-manager|jenkins|kubernetes)' -o ae-wrong-input-file-type --validate-release-tags", + "build:api-reports:only": "NODE_OPTIONS=--max-old-space-size=8192 backstage-repo-tools api-reports --allow-warnings 'packages/backend-app-api,packages/core-components,plugins/+(catalog|catalog-import|git-release-manager|jenkins|kubernetes)' -o ae-undocumented,ae-wrong-input-file-type --validate-release-tags", "build:backend": "yarn workspace example-backend build", "build:knip-reports": "backstage-repo-tools knip-reports", "build:plugins-report": "node ./scripts/build-plugins-report", diff --git a/packages/app-next-example-plugin/report.api.md b/packages/app-next-example-plugin/report.api.md index 3094fee56e..1fc58dfc17 100644 --- a/packages/app-next-example-plugin/report.api.md +++ b/packages/app-next-example-plugin/report.api.md @@ -52,10 +52,5 @@ export default examplePlugin; // @public (undocumented) export const ExampleSidebarItem: () => React_2.JSX.Element; -// Warnings were encountered during analysis: -// -// src/ExampleSidebarItem.d.ts:3:22 - (ae-undocumented) Missing documentation for "ExampleSidebarItem". -// src/plugin.d.ts:22:22 - (ae-undocumented) Missing documentation for "examplePlugin". - // (No @packageDocumentation comment for this package) ``` diff --git a/packages/backend-app-api/report-alpha.api.md b/packages/backend-app-api/report-alpha.api.md index e3f11bb800..163cc325a1 100644 --- a/packages/backend-app-api/report-alpha.api.md +++ b/packages/backend-app-api/report-alpha.api.md @@ -13,9 +13,5 @@ export const featureDiscoveryServiceFactory: ServiceFactory< 'singleton' >; -// Warnings were encountered during analysis: -// -// src/alpha/featureDiscoveryServiceFactory.d.ts:5:22 - (ae-undocumented) Missing documentation for "featureDiscoveryServiceFactory". - // (No @packageDocumentation comment for this package) ``` diff --git a/packages/backend-app-api/report.api.md b/packages/backend-app-api/report.api.md index ec32ec9b67..88fa34e6e4 100644 --- a/packages/backend-app-api/report.api.md +++ b/packages/backend-app-api/report.api.md @@ -32,14 +32,4 @@ export interface CreateSpecializedBackendOptions { // (undocumented) defaultServiceFactories: ServiceFactory[]; } - -// Warnings were encountered during analysis: -// -// src/wiring/createSpecializedBackend.d.ts:5:1 - (ae-undocumented) Missing documentation for "createSpecializedBackend". -// src/wiring/types.d.ts:5:1 - (ae-undocumented) Missing documentation for "Backend". -// src/wiring/types.d.ts:6:5 - (ae-undocumented) Missing documentation for "add". -// src/wiring/types.d.ts:9:5 - (ae-undocumented) Missing documentation for "start". -// src/wiring/types.d.ts:10:5 - (ae-undocumented) Missing documentation for "stop". -// src/wiring/types.d.ts:15:1 - (ae-undocumented) Missing documentation for "CreateSpecializedBackendOptions". -// src/wiring/types.d.ts:16:5 - (ae-undocumented) Missing documentation for "defaultServiceFactories". ``` diff --git a/packages/backend-defaults/report-discovery.api.md b/packages/backend-defaults/report-discovery.api.md index e39d281b4e..d168d33a71 100644 --- a/packages/backend-defaults/report-discovery.api.md +++ b/packages/backend-defaults/report-discovery.api.md @@ -23,10 +23,5 @@ export class HostDiscovery implements DiscoveryService { getExternalBaseUrl(pluginId: string): Promise; } -// Warnings were encountered during analysis: -// -// src/entrypoints/discovery/HostDiscovery.d.ts:44:5 - (ae-undocumented) Missing documentation for "getBaseUrl". -// src/entrypoints/discovery/HostDiscovery.d.ts:45:5 - (ae-undocumented) Missing documentation for "getExternalBaseUrl". - // (No @packageDocumentation comment for this package) ``` diff --git a/packages/backend-defaults/report-rootConfig.api.md b/packages/backend-defaults/report-rootConfig.api.md index 6c65d00a3b..2935ad1128 100644 --- a/packages/backend-defaults/report-rootConfig.api.md +++ b/packages/backend-defaults/report-rootConfig.api.md @@ -31,11 +31,5 @@ export const rootConfigServiceFactory: (( ) => ServiceFactory) & ServiceFactory; -// Warnings were encountered during analysis: -// -// src/entrypoints/rootConfig/createConfigSecretEnumerator.d.ts:5:1 - (ae-undocumented) Missing documentation for "createConfigSecretEnumerator". -// src/entrypoints/rootConfig/rootConfigServiceFactory.d.ts:20:5 - (ae-undocumented) Missing documentation for "watch". -// src/entrypoints/rootConfig/rootConfigServiceFactory.d.ts:26:22 - (ae-undocumented) Missing documentation for "rootConfigServiceFactory". - // (No @packageDocumentation comment for this package) ``` diff --git a/packages/backend-defaults/report-rootHealth.api.md b/packages/backend-defaults/report-rootHealth.api.md index fa09590c26..b26de7cfda 100644 --- a/packages/backend-defaults/report-rootHealth.api.md +++ b/packages/backend-defaults/report-rootHealth.api.md @@ -13,9 +13,5 @@ export const rootHealthServiceFactory: ServiceFactory< 'singleton' >; -// Warnings were encountered during analysis: -// -// src/entrypoints/rootHealth/rootHealthServiceFactory.d.ts:5:22 - (ae-undocumented) Missing documentation for "rootHealthServiceFactory". - // (No @packageDocumentation comment for this package) ``` diff --git a/packages/backend-defaults/report-rootHttpRouter.api.md b/packages/backend-defaults/report-rootHttpRouter.api.md index 9a435f5c27..3686f25a12 100644 --- a/packages/backend-defaults/report-rootHttpRouter.api.md +++ b/packages/backend-defaults/report-rootHttpRouter.api.md @@ -154,28 +154,5 @@ export const rootHttpRouterServiceFactory: (( ) => ServiceFactory) & ServiceFactory; -// Warnings were encountered during analysis: -// -// src/entrypoints/rootHttpRouter/DefaultRootHttpRouter.d.ts:23:5 - (ae-undocumented) Missing documentation for "create". -// src/entrypoints/rootHttpRouter/DefaultRootHttpRouter.d.ts:25:5 - (ae-undocumented) Missing documentation for "use". -// src/entrypoints/rootHttpRouter/DefaultRootHttpRouter.d.ts:26:5 - (ae-undocumented) Missing documentation for "handler". -// src/entrypoints/rootHttpRouter/createHealthRouter.d.ts:6:1 - (ae-undocumented) Missing documentation for "createHealthRouter". -// src/entrypoints/rootHttpRouter/http/MiddlewareFactory.d.ts:9:5 - (ae-undocumented) Missing documentation for "config". -// src/entrypoints/rootHttpRouter/http/MiddlewareFactory.d.ts:10:5 - (ae-undocumented) Missing documentation for "logger". -// src/entrypoints/rootHttpRouter/http/types.d.ts:9:5 - (ae-undocumented) Missing documentation for "start". -// src/entrypoints/rootHttpRouter/http/types.d.ts:10:5 - (ae-undocumented) Missing documentation for "stop". -// src/entrypoints/rootHttpRouter/http/types.d.ts:11:5 - (ae-undocumented) Missing documentation for "port". -// src/entrypoints/rootHttpRouter/rootHttpRouterServiceFactory.d.ts:9:1 - (ae-undocumented) Missing documentation for "RootHttpRouterConfigureContext". -// src/entrypoints/rootHttpRouter/rootHttpRouterServiceFactory.d.ts:10:5 - (ae-undocumented) Missing documentation for "app". -// src/entrypoints/rootHttpRouter/rootHttpRouterServiceFactory.d.ts:11:5 - (ae-undocumented) Missing documentation for "server". -// src/entrypoints/rootHttpRouter/rootHttpRouterServiceFactory.d.ts:12:5 - (ae-undocumented) Missing documentation for "middleware". -// src/entrypoints/rootHttpRouter/rootHttpRouterServiceFactory.d.ts:13:5 - (ae-undocumented) Missing documentation for "routes". -// src/entrypoints/rootHttpRouter/rootHttpRouterServiceFactory.d.ts:14:5 - (ae-undocumented) Missing documentation for "config". -// src/entrypoints/rootHttpRouter/rootHttpRouterServiceFactory.d.ts:15:5 - (ae-undocumented) Missing documentation for "logger". -// src/entrypoints/rootHttpRouter/rootHttpRouterServiceFactory.d.ts:16:5 - (ae-undocumented) Missing documentation for "lifecycle". -// src/entrypoints/rootHttpRouter/rootHttpRouterServiceFactory.d.ts:17:5 - (ae-undocumented) Missing documentation for "healthRouter". -// src/entrypoints/rootHttpRouter/rootHttpRouterServiceFactory.d.ts:18:5 - (ae-undocumented) Missing documentation for "applyDefaults". -// src/entrypoints/rootHttpRouter/rootHttpRouterServiceFactory.d.ts:38:22 - (ae-undocumented) Missing documentation for "rootHttpRouterServiceFactory". - // (No @packageDocumentation comment for this package) ``` diff --git a/packages/backend-defaults/report-rootLogger.api.md b/packages/backend-defaults/report-rootLogger.api.md index 59b6242095..b353039c03 100644 --- a/packages/backend-defaults/report-rootLogger.api.md +++ b/packages/backend-defaults/report-rootLogger.api.md @@ -51,19 +51,5 @@ export interface WinstonLoggerOptions { transports?: transport[]; } -// Warnings were encountered during analysis: -// -// src/entrypoints/rootLogger/WinstonLogger.d.ts:8:1 - (ae-undocumented) Missing documentation for "WinstonLoggerOptions". -// src/entrypoints/rootLogger/WinstonLogger.d.ts:9:5 - (ae-undocumented) Missing documentation for "meta". -// src/entrypoints/rootLogger/WinstonLogger.d.ts:10:5 - (ae-undocumented) Missing documentation for "level". -// src/entrypoints/rootLogger/WinstonLogger.d.ts:11:5 - (ae-undocumented) Missing documentation for "format". -// src/entrypoints/rootLogger/WinstonLogger.d.ts:12:5 - (ae-undocumented) Missing documentation for "transports". -// src/entrypoints/rootLogger/WinstonLogger.d.ts:37:5 - (ae-undocumented) Missing documentation for "error". -// src/entrypoints/rootLogger/WinstonLogger.d.ts:38:5 - (ae-undocumented) Missing documentation for "warn". -// src/entrypoints/rootLogger/WinstonLogger.d.ts:39:5 - (ae-undocumented) Missing documentation for "info". -// src/entrypoints/rootLogger/WinstonLogger.d.ts:40:5 - (ae-undocumented) Missing documentation for "debug". -// src/entrypoints/rootLogger/WinstonLogger.d.ts:41:5 - (ae-undocumented) Missing documentation for "child". -// src/entrypoints/rootLogger/WinstonLogger.d.ts:42:5 - (ae-undocumented) Missing documentation for "addRedactions". - // (No @packageDocumentation comment for this package) ``` diff --git a/packages/backend-defaults/report-scheduler.api.md b/packages/backend-defaults/report-scheduler.api.md index 7d886e539c..9879ad7c97 100644 --- a/packages/backend-defaults/report-scheduler.api.md +++ b/packages/backend-defaults/report-scheduler.api.md @@ -26,9 +26,5 @@ export const schedulerServiceFactory: ServiceFactory< 'singleton' >; -// Warnings were encountered during analysis: -// -// src/entrypoints/scheduler/lib/DefaultSchedulerService.d.ts:8:5 - (ae-undocumented) Missing documentation for "create". - // (No @packageDocumentation comment for this package) ``` diff --git a/packages/backend-defaults/report-urlReader.api.md b/packages/backend-defaults/report-urlReader.api.md index 77f0d5ccbd..f8b8db2954 100644 --- a/packages/backend-defaults/report-urlReader.api.md +++ b/packages/backend-defaults/report-urlReader.api.md @@ -447,78 +447,5 @@ export type UrlReadersOptions = { factories?: ReaderFactory[]; }; -// Warnings were encountered during analysis: -// -// src/entrypoints/urlReader/lib/AwsS3UrlReader.d.ts:28:5 - (ae-undocumented) Missing documentation for "factory". -// src/entrypoints/urlReader/lib/AwsS3UrlReader.d.ts:40:5 - (ae-undocumented) Missing documentation for "read". -// src/entrypoints/urlReader/lib/AwsS3UrlReader.d.ts:41:5 - (ae-undocumented) Missing documentation for "readUrl". -// src/entrypoints/urlReader/lib/AwsS3UrlReader.d.ts:42:5 - (ae-undocumented) Missing documentation for "readTree". -// src/entrypoints/urlReader/lib/AwsS3UrlReader.d.ts:43:5 - (ae-undocumented) Missing documentation for "search". -// src/entrypoints/urlReader/lib/AwsS3UrlReader.d.ts:44:5 - (ae-undocumented) Missing documentation for "toString". -// src/entrypoints/urlReader/lib/AzureUrlReader.d.ts:14:5 - (ae-undocumented) Missing documentation for "factory". -// src/entrypoints/urlReader/lib/AzureUrlReader.d.ts:19:5 - (ae-undocumented) Missing documentation for "read". -// src/entrypoints/urlReader/lib/AzureUrlReader.d.ts:20:5 - (ae-undocumented) Missing documentation for "readUrl". -// src/entrypoints/urlReader/lib/AzureUrlReader.d.ts:21:5 - (ae-undocumented) Missing documentation for "readTree". -// src/entrypoints/urlReader/lib/AzureUrlReader.d.ts:22:5 - (ae-undocumented) Missing documentation for "search". -// src/entrypoints/urlReader/lib/AzureUrlReader.d.ts:23:5 - (ae-undocumented) Missing documentation for "toString". -// src/entrypoints/urlReader/lib/BitbucketCloudUrlReader.d.ts:14:5 - (ae-undocumented) Missing documentation for "factory". -// src/entrypoints/urlReader/lib/BitbucketCloudUrlReader.d.ts:18:5 - (ae-undocumented) Missing documentation for "read". -// src/entrypoints/urlReader/lib/BitbucketCloudUrlReader.d.ts:19:5 - (ae-undocumented) Missing documentation for "readUrl". -// src/entrypoints/urlReader/lib/BitbucketCloudUrlReader.d.ts:20:5 - (ae-undocumented) Missing documentation for "readTree". -// src/entrypoints/urlReader/lib/BitbucketCloudUrlReader.d.ts:21:5 - (ae-undocumented) Missing documentation for "search". -// src/entrypoints/urlReader/lib/BitbucketCloudUrlReader.d.ts:22:5 - (ae-undocumented) Missing documentation for "toString". -// src/entrypoints/urlReader/lib/BitbucketServerUrlReader.d.ts:14:5 - (ae-undocumented) Missing documentation for "factory". -// src/entrypoints/urlReader/lib/BitbucketServerUrlReader.d.ts:18:5 - (ae-undocumented) Missing documentation for "read". -// src/entrypoints/urlReader/lib/BitbucketServerUrlReader.d.ts:19:5 - (ae-undocumented) Missing documentation for "readUrl". -// src/entrypoints/urlReader/lib/BitbucketServerUrlReader.d.ts:20:5 - (ae-undocumented) Missing documentation for "readTree". -// src/entrypoints/urlReader/lib/BitbucketServerUrlReader.d.ts:21:5 - (ae-undocumented) Missing documentation for "search". -// src/entrypoints/urlReader/lib/BitbucketServerUrlReader.d.ts:22:5 - (ae-undocumented) Missing documentation for "toString". -// src/entrypoints/urlReader/lib/BitbucketUrlReader.d.ts:17:5 - (ae-undocumented) Missing documentation for "factory". -// src/entrypoints/urlReader/lib/BitbucketUrlReader.d.ts:21:5 - (ae-undocumented) Missing documentation for "read". -// src/entrypoints/urlReader/lib/BitbucketUrlReader.d.ts:22:5 - (ae-undocumented) Missing documentation for "readUrl". -// src/entrypoints/urlReader/lib/BitbucketUrlReader.d.ts:23:5 - (ae-undocumented) Missing documentation for "readTree". -// src/entrypoints/urlReader/lib/BitbucketUrlReader.d.ts:24:5 - (ae-undocumented) Missing documentation for "search". -// src/entrypoints/urlReader/lib/BitbucketUrlReader.d.ts:25:5 - (ae-undocumented) Missing documentation for "toString". -// src/entrypoints/urlReader/lib/FetchUrlReader.d.ts:24:5 - (ae-undocumented) Missing documentation for "read". -// src/entrypoints/urlReader/lib/FetchUrlReader.d.ts:25:5 - (ae-undocumented) Missing documentation for "readUrl". -// src/entrypoints/urlReader/lib/FetchUrlReader.d.ts:26:5 - (ae-undocumented) Missing documentation for "readTree". -// src/entrypoints/urlReader/lib/FetchUrlReader.d.ts:27:5 - (ae-undocumented) Missing documentation for "search". -// src/entrypoints/urlReader/lib/FetchUrlReader.d.ts:28:5 - (ae-undocumented) Missing documentation for "toString". -// src/entrypoints/urlReader/lib/GerritUrlReader.d.ts:29:5 - (ae-undocumented) Missing documentation for "factory". -// src/entrypoints/urlReader/lib/GerritUrlReader.d.ts:33:5 - (ae-undocumented) Missing documentation for "read". -// src/entrypoints/urlReader/lib/GerritUrlReader.d.ts:34:5 - (ae-undocumented) Missing documentation for "readUrl". -// src/entrypoints/urlReader/lib/GerritUrlReader.d.ts:35:5 - (ae-undocumented) Missing documentation for "readTree". -// src/entrypoints/urlReader/lib/GerritUrlReader.d.ts:36:5 - (ae-undocumented) Missing documentation for "search". -// src/entrypoints/urlReader/lib/GerritUrlReader.d.ts:37:5 - (ae-undocumented) Missing documentation for "toString". -// src/entrypoints/urlReader/lib/GiteaUrlReader.d.ts:14:5 - (ae-undocumented) Missing documentation for "factory". -// src/entrypoints/urlReader/lib/GiteaUrlReader.d.ts:18:5 - (ae-undocumented) Missing documentation for "read". -// src/entrypoints/urlReader/lib/GiteaUrlReader.d.ts:19:5 - (ae-undocumented) Missing documentation for "readUrl". -// src/entrypoints/urlReader/lib/GiteaUrlReader.d.ts:20:5 - (ae-undocumented) Missing documentation for "readTree". -// src/entrypoints/urlReader/lib/GiteaUrlReader.d.ts:21:5 - (ae-undocumented) Missing documentation for "search". -// src/entrypoints/urlReader/lib/GiteaUrlReader.d.ts:22:5 - (ae-undocumented) Missing documentation for "toString". -// src/entrypoints/urlReader/lib/GithubUrlReader.d.ts:20:5 - (ae-undocumented) Missing documentation for "factory". -// src/entrypoints/urlReader/lib/GithubUrlReader.d.ts:25:5 - (ae-undocumented) Missing documentation for "read". -// src/entrypoints/urlReader/lib/GithubUrlReader.d.ts:27:5 - (ae-undocumented) Missing documentation for "readUrl". -// src/entrypoints/urlReader/lib/GithubUrlReader.d.ts:28:5 - (ae-undocumented) Missing documentation for "readTree". -// src/entrypoints/urlReader/lib/GithubUrlReader.d.ts:29:5 - (ae-undocumented) Missing documentation for "search". -// src/entrypoints/urlReader/lib/GithubUrlReader.d.ts:30:5 - (ae-undocumented) Missing documentation for "toString". -// src/entrypoints/urlReader/lib/GitlabUrlReader.d.ts:14:5 - (ae-undocumented) Missing documentation for "factory". -// src/entrypoints/urlReader/lib/GitlabUrlReader.d.ts:18:5 - (ae-undocumented) Missing documentation for "read". -// src/entrypoints/urlReader/lib/GitlabUrlReader.d.ts:19:5 - (ae-undocumented) Missing documentation for "readUrl". -// src/entrypoints/urlReader/lib/GitlabUrlReader.d.ts:20:5 - (ae-undocumented) Missing documentation for "readTree". -// src/entrypoints/urlReader/lib/GitlabUrlReader.d.ts:21:5 - (ae-undocumented) Missing documentation for "search". -// src/entrypoints/urlReader/lib/GitlabUrlReader.d.ts:31:8 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// src/entrypoints/urlReader/lib/GitlabUrlReader.d.ts:32:8 - (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration -// src/entrypoints/urlReader/lib/GitlabUrlReader.d.ts:35:5 - (ae-undocumented) Missing documentation for "toString". -// src/entrypoints/urlReader/lib/HarnessUrlReader.d.ts:15:5 - (ae-undocumented) Missing documentation for "factory". -// src/entrypoints/urlReader/lib/HarnessUrlReader.d.ts:19:5 - (ae-undocumented) Missing documentation for "read". -// src/entrypoints/urlReader/lib/HarnessUrlReader.d.ts:20:5 - (ae-undocumented) Missing documentation for "readUrl". -// src/entrypoints/urlReader/lib/HarnessUrlReader.d.ts:21:5 - (ae-undocumented) Missing documentation for "readTree". -// src/entrypoints/urlReader/lib/HarnessUrlReader.d.ts:22:5 - (ae-undocumented) Missing documentation for "search". -// src/entrypoints/urlReader/lib/HarnessUrlReader.d.ts:23:5 - (ae-undocumented) Missing documentation for "toString". -// src/entrypoints/urlReader/lib/types.d.ts:74:5 - (ae-undocumented) Missing documentation for "fromTarArchive". -// src/entrypoints/urlReader/lib/types.d.ts:81:5 - (ae-undocumented) Missing documentation for "fromZipArchive". -// src/entrypoints/urlReader/lib/types.d.ts:82:5 - (ae-undocumented) Missing documentation for "fromReadableArray". - // (No @packageDocumentation comment for this package) ``` diff --git a/packages/backend-defaults/report.api.md b/packages/backend-defaults/report.api.md index 9878336d27..def38beda7 100644 --- a/packages/backend-defaults/report.api.md +++ b/packages/backend-defaults/report.api.md @@ -11,8 +11,4 @@ export function createBackend(): Backend; // @public export const discoveryFeatureLoader: BackendFeature; - -// Warnings were encountered during analysis: -// -// src/CreateBackend.d.ts:6:1 - (ae-undocumented) Missing documentation for "createBackend". ``` diff --git a/packages/backend-defaults/src/entrypoints/urlReader/lib/GitlabUrlReader.ts b/packages/backend-defaults/src/entrypoints/urlReader/lib/GitlabUrlReader.ts index 35123da851..f5050cca5e 100644 --- a/packages/backend-defaults/src/entrypoints/urlReader/lib/GitlabUrlReader.ts +++ b/packages/backend-defaults/src/entrypoints/urlReader/lib/GitlabUrlReader.ts @@ -273,8 +273,7 @@ export class GitlabUrlReader implements UrlReaderService { * * E.g. `catalog/foo/*.yaml` will return `catalog/foo`. * - * @param globPattern the glob pattern - * @private + * @param globPattern - the glob pattern */ private getStaticPart(globPattern: string) { const segments = globPattern.split('/'); diff --git a/packages/backend-dynamic-feature-service/report.api.md b/packages/backend-dynamic-feature-service/report.api.md index edbe48b263..7003b3bc2c 100644 --- a/packages/backend-dynamic-feature-service/report.api.md +++ b/packages/backend-dynamic-feature-service/report.api.md @@ -293,76 +293,5 @@ export interface ScannedPluginPackage { manifest: ScannedPluginManifest; } -// Warnings were encountered during analysis: -// -// src/features/features.d.ts:7:1 - (ae-undocumented) Missing documentation for "DynamicPluginsFeatureLoaderOptions". -// src/loader/types.d.ts:4:1 - (ae-undocumented) Missing documentation for "ModuleLoader". -// src/loader/types.d.ts:5:5 - (ae-undocumented) Missing documentation for "bootstrap". -// src/loader/types.d.ts:6:5 - (ae-undocumented) Missing documentation for "load". -// src/manager/plugin-manager.d.ts:10:1 - (ae-undocumented) Missing documentation for "DynamicPluginManagerOptions". -// src/manager/plugin-manager.d.ts:11:5 - (ae-undocumented) Missing documentation for "config". -// src/manager/plugin-manager.d.ts:12:5 - (ae-undocumented) Missing documentation for "logger". -// src/manager/plugin-manager.d.ts:13:5 - (ae-undocumented) Missing documentation for "preferAlpha". -// src/manager/plugin-manager.d.ts:14:5 - (ae-undocumented) Missing documentation for "moduleLoader". -// src/manager/plugin-manager.d.ts:19:1 - (ae-undocumented) Missing documentation for "DynamicPluginManager". -// src/manager/plugin-manager.d.ts:23:5 - (ae-undocumented) Missing documentation for "create". -// src/manager/plugin-manager.d.ts:27:5 - (ae-undocumented) Missing documentation for "availablePackages". -// src/manager/plugin-manager.d.ts:28:5 - (ae-undocumented) Missing documentation for "addBackendPlugin". -// src/manager/plugin-manager.d.ts:31:5 - (ae-undocumented) Missing documentation for "backendPlugins". -// src/manager/plugin-manager.d.ts:34:5 - (ae-undocumented) Missing documentation for "frontendPlugins". -// src/manager/plugin-manager.d.ts:37:5 - (ae-undocumented) Missing documentation for "plugins". -// src/manager/plugin-manager.d.ts:40:5 - (ae-undocumented) Missing documentation for "getScannedPackage". -// src/manager/plugin-manager.d.ts:45:22 - (ae-undocumented) Missing documentation for "dynamicPluginsServiceRef". -// src/manager/plugin-manager.d.ts:49:1 - (ae-undocumented) Missing documentation for "DynamicPluginsFactoryOptions". -// src/manager/plugin-manager.d.ts:50:5 - (ae-undocumented) Missing documentation for "moduleLoader". -// src/manager/plugin-manager.d.ts:56:22 - (ae-undocumented) Missing documentation for "dynamicPluginsServiceFactoryWithOptions". -// src/manager/plugin-manager.d.ts:61:22 - (ae-undocumented) Missing documentation for "dynamicPluginsServiceFactory". -// src/manager/plugin-manager.d.ts:66:22 - (ae-undocumented) Missing documentation for "dynamicPluginsFeatureDiscoveryServiceFactory". -// src/manager/plugin-manager.d.ts:71:22 - (ae-undocumented) Missing documentation for "dynamicPluginsFeatureDiscoveryLoader". -// src/manager/types.d.ts:28:1 - (ae-undocumented) Missing documentation for "LegacyPluginEnvironment". -// src/manager/types.d.ts:46:1 - (ae-undocumented) Missing documentation for "DynamicPluginProvider". -// src/manager/types.d.ts:47:5 - (ae-undocumented) Missing documentation for "plugins". -// src/manager/types.d.ts:50:5 - (ae-undocumented) Missing documentation for "getScannedPackage". -// src/manager/types.d.ts:55:1 - (ae-undocumented) Missing documentation for "BackendPluginProvider". -// src/manager/types.d.ts:56:5 - (ae-undocumented) Missing documentation for "backendPlugins". -// src/manager/types.d.ts:63:1 - (ae-undocumented) Missing documentation for "FrontendPluginProvider". -// src/manager/types.d.ts:64:5 - (ae-undocumented) Missing documentation for "frontendPlugins". -// src/manager/types.d.ts:71:1 - (ae-undocumented) Missing documentation for "BaseDynamicPlugin". -// src/manager/types.d.ts:72:5 - (ae-undocumented) Missing documentation for "name". -// src/manager/types.d.ts:73:5 - (ae-undocumented) Missing documentation for "version". -// src/manager/types.d.ts:74:5 - (ae-undocumented) Missing documentation for "role". -// src/manager/types.d.ts:75:5 - (ae-undocumented) Missing documentation for "platform". -// src/manager/types.d.ts:76:5 - (ae-undocumented) Missing documentation for "failure". -// src/manager/types.d.ts:81:1 - (ae-undocumented) Missing documentation for "DynamicPlugin". -// src/manager/types.d.ts:85:1 - (ae-undocumented) Missing documentation for "FrontendDynamicPlugin". -// src/manager/types.d.ts:86:5 - (ae-undocumented) Missing documentation for "platform". -// src/manager/types.d.ts:91:1 - (ae-undocumented) Missing documentation for "BackendDynamicPlugin". -// src/manager/types.d.ts:92:5 - (ae-undocumented) Missing documentation for "platform". -// src/manager/types.d.ts:93:5 - (ae-undocumented) Missing documentation for "installer". -// src/manager/types.d.ts:98:1 - (ae-undocumented) Missing documentation for "BackendDynamicPluginInstaller". -// src/manager/types.d.ts:102:1 - (ae-undocumented) Missing documentation for "NewBackendPluginInstaller". -// src/manager/types.d.ts:103:5 - (ae-undocumented) Missing documentation for "kind". -// src/manager/types.d.ts:104:5 - (ae-undocumented) Missing documentation for "install". -// src/manager/types.d.ts:117:1 - (ae-undocumented) Missing documentation for "LegacyBackendPluginInstaller". -// src/manager/types.d.ts:118:5 - (ae-undocumented) Missing documentation for "kind". -// src/manager/types.d.ts:119:5 - (ae-undocumented) Missing documentation for "router". -// src/manager/types.d.ts:123:5 - (ae-undocumented) Missing documentation for "catalog". -// src/manager/types.d.ts:124:5 - (ae-undocumented) Missing documentation for "scaffolder". -// src/manager/types.d.ts:125:5 - (ae-undocumented) Missing documentation for "search". -// src/manager/types.d.ts:126:5 - (ae-undocumented) Missing documentation for "events". -// src/manager/types.d.ts:127:5 - (ae-undocumented) Missing documentation for "permissions". -// src/manager/types.d.ts:134:1 - (ae-undocumented) Missing documentation for "isBackendDynamicPluginInstaller". -// src/scanner/types.d.ts:5:1 - (ae-undocumented) Missing documentation for "ScannedPluginPackage". -// src/scanner/types.d.ts:6:5 - (ae-undocumented) Missing documentation for "location". -// src/scanner/types.d.ts:7:5 - (ae-undocumented) Missing documentation for "manifest". -// src/scanner/types.d.ts:12:1 - (ae-undocumented) Missing documentation for "ScannedPluginManifest". -// src/schemas/frontend.d.ts:5:22 - (ae-undocumented) Missing documentation for "dynamicPluginsFrontendSchemas". -// src/schemas/rootLogger.d.ts:5:1 - (ae-undocumented) Missing documentation for "DynamicPluginsRootLoggerFactoryOptions". -// src/schemas/rootLogger.d.ts:10:22 - (ae-undocumented) Missing documentation for "dynamicPluginsRootLoggerServiceFactory". -// src/schemas/schemas.d.ts:7:1 - (ae-undocumented) Missing documentation for "DynamicPluginsSchemasService". -// src/schemas/schemas.d.ts:8:5 - (ae-undocumented) Missing documentation for "addDynamicPluginsSchemas". -// src/schemas/schemas.d.ts:21:1 - (ae-undocumented) Missing documentation for "DynamicPluginsSchemasOptions". -// src/schemas/schemas.d.ts:37:22 - (ae-undocumented) Missing documentation for "dynamicPluginsSchemasServiceFactory". - // (No @packageDocumentation comment for this package) ``` diff --git a/packages/backend-openapi-utils/report.api.md b/packages/backend-openapi-utils/report.api.md index f543a9cfb7..2f660cd0d6 100644 --- a/packages/backend-openapi-utils/report.api.md +++ b/packages/backend-openapi-utils/report.api.md @@ -722,84 +722,4 @@ export const wrapInOpenApiTestServer: (app: Express_2) => Server | Express_2; // @public export function wrapServer(app: Express_2): Promise; - -// Warnings were encountered during analysis: -// -// src/router.d.ts:8:5 - (ae-undocumented) Missing documentation for "get". -// src/router.d.ts:9:5 - (ae-undocumented) Missing documentation for "post". -// src/router.d.ts:10:5 - (ae-undocumented) Missing documentation for "all". -// src/router.d.ts:11:5 - (ae-undocumented) Missing documentation for "put". -// src/router.d.ts:12:5 - (ae-undocumented) Missing documentation for "delete". -// src/router.d.ts:13:5 - (ae-undocumented) Missing documentation for "patch". -// src/router.d.ts:14:5 - (ae-undocumented) Missing documentation for "options". -// src/router.d.ts:15:5 - (ae-undocumented) Missing documentation for "head". -// src/types/common.d.ts:14:1 - (ae-undocumented) Missing documentation for "PathDoc". -// src/types/common.d.ts:60:1 - (ae-undocumented) Missing documentation for "DocPathTemplate". -// src/types/common.d.ts:64:1 - (ae-undocumented) Missing documentation for "DocPathMethod". -// src/types/common.d.ts:68:1 - (ae-undocumented) Missing documentation for "DocPathTemplateMethod". -// src/types/common.d.ts:72:1 - (ae-undocumented) Missing documentation for "MethodAwareDocPath". -// src/types/common.d.ts:78:1 - (ae-undocumented) Missing documentation for "DocOperation". -// src/types/common.d.ts:82:1 - (ae-undocumented) Missing documentation for "ComponentTypes". -// src/types/common.d.ts:86:1 - (ae-undocumented) Missing documentation for "ComponentRef". -// src/types/common.d.ts:92:1 - (ae-undocumented) Missing documentation for "SchemaRef". -// src/types/common.d.ts:100:1 - (ae-undocumented) Missing documentation for "ObjectWithContentSchema". -// src/types/common.d.ts:114:1 - (ae-undocumented) Missing documentation for "LastOf". -// src/types/common.d.ts:118:1 - (ae-undocumented) Missing documentation for "Push". -// src/types/common.d.ts:122:1 - (ae-undocumented) Missing documentation for "TuplifyUnion". -// src/types/common.d.ts:126:1 - (ae-undocumented) Missing documentation for "ConvertAll". -// src/types/common.d.ts:134:1 - (ae-undocumented) Missing documentation for "UnknownIfNever". -// src/types/common.d.ts:138:1 - (ae-undocumented) Missing documentation for "ToTypeSafe". -// src/types/common.d.ts:142:1 - (ae-undocumented) Missing documentation for "DiscriminateUnion". -// src/types/common.d.ts:146:1 - (ae-undocumented) Missing documentation for "MapDiscriminatedUnion". -// src/types/common.d.ts:152:1 - (ae-undocumented) Missing documentation for "PickOptionalKeys". -// src/types/common.d.ts:160:1 - (ae-undocumented) Missing documentation for "PickRequiredKeys". -// src/types/common.d.ts:168:1 - (ae-undocumented) Missing documentation for "OptionalMap". -// src/types/common.d.ts:176:1 - (ae-undocumented) Missing documentation for "RequiredMap". -// src/types/common.d.ts:184:1 - (ae-undocumented) Missing documentation for "FullMap". -// src/types/common.d.ts:190:1 - (ae-undocumented) Missing documentation for "Filter". -// src/types/express.d.ts:21:5 - (ae-undocumented) Missing documentation for "__call". -// src/types/express.d.ts:22:5 - (ae-undocumented) Missing documentation for "__call". -// src/types/immutable.d.ts:18:1 - (ae-undocumented) Missing documentation for "ImmutableObject". -// src/types/immutable.d.ts:24:1 - (ae-undocumented) Missing documentation for "ImmutableReferenceObject". -// src/types/immutable.d.ts:28:1 - (ae-undocumented) Missing documentation for "ImmutableOpenAPIObject". -// src/types/immutable.d.ts:32:1 - (ae-undocumented) Missing documentation for "ImmutableContentObject". -// src/types/immutable.d.ts:36:1 - (ae-undocumented) Missing documentation for "ImmutableRequestBodyObject". -// src/types/immutable.d.ts:40:1 - (ae-undocumented) Missing documentation for "ImmutableResponseObject". -// src/types/immutable.d.ts:44:1 - (ae-undocumented) Missing documentation for "ImmutableParameterObject". -// src/types/immutable.d.ts:48:1 - (ae-undocumented) Missing documentation for "HeaderObject". -// src/types/immutable.d.ts:49:5 - (ae-undocumented) Missing documentation for "in". -// src/types/immutable.d.ts:50:5 - (ae-undocumented) Missing documentation for "style". -// src/types/immutable.d.ts:55:1 - (ae-undocumented) Missing documentation for "ImmutableHeaderObject". -// src/types/immutable.d.ts:59:1 - (ae-undocumented) Missing documentation for "CookieObject". -// src/types/immutable.d.ts:60:5 - (ae-undocumented) Missing documentation for "in". -// src/types/immutable.d.ts:61:5 - (ae-undocumented) Missing documentation for "style". -// src/types/immutable.d.ts:66:1 - (ae-undocumented) Missing documentation for "ImmutableCookieObject". -// src/types/immutable.d.ts:70:1 - (ae-undocumented) Missing documentation for "QueryObject". -// src/types/immutable.d.ts:71:5 - (ae-undocumented) Missing documentation for "in". -// src/types/immutable.d.ts:72:5 - (ae-undocumented) Missing documentation for "style". -// src/types/immutable.d.ts:77:1 - (ae-undocumented) Missing documentation for "ImmutableQueryObject". -// src/types/immutable.d.ts:81:1 - (ae-undocumented) Missing documentation for "PathObject". -// src/types/immutable.d.ts:82:5 - (ae-undocumented) Missing documentation for "in". -// src/types/immutable.d.ts:83:5 - (ae-undocumented) Missing documentation for "style". -// src/types/immutable.d.ts:88:1 - (ae-undocumented) Missing documentation for "ImmutablePathObject". -// src/types/immutable.d.ts:92:1 - (ae-undocumented) Missing documentation for "ImmutableSchemaObject". -// src/types/params.d.ts:7:1 - (ae-undocumented) Missing documentation for "DocParameter". -// src/types/params.d.ts:16:1 - (ae-undocumented) Missing documentation for "DocParameters". -// src/types/params.d.ts:22:1 - (ae-undocumented) Missing documentation for "ParameterSchema". -// src/types/params.d.ts:26:1 - (ae-undocumented) Missing documentation for "MapToSchema". -// src/types/params.d.ts:32:1 - (ae-undocumented) Missing documentation for "ParametersSchema". -// src/types/params.d.ts:36:1 - (ae-undocumented) Missing documentation for "HeaderSchema". -// src/types/params.d.ts:40:1 - (ae-undocumented) Missing documentation for "CookieSchema". -// src/types/params.d.ts:44:1 - (ae-undocumented) Missing documentation for "PathSchema". -// src/types/params.d.ts:48:1 - (ae-undocumented) Missing documentation for "QuerySchema". -// src/types/requests.d.ts:9:1 - (ae-undocumented) Missing documentation for "RequestBody". -// src/types/requests.d.ts:13:1 - (ae-undocumented) Missing documentation for "RequestBodySchema". -// src/types/responses.d.ts:9:1 - (ae-undocumented) Missing documentation for "Response". -// src/types/responses.d.ts:13:1 - (ae-undocumented) Missing documentation for "ResponseSchemas". -// src/utility.d.ts:5:1 - (ae-undocumented) Missing documentation for "Response". -// src/utility.d.ts:9:1 - (ae-undocumented) Missing documentation for "Request". -// src/utility.d.ts:13:1 - (ae-undocumented) Missing documentation for "HeaderParameters". -// src/utility.d.ts:17:1 - (ae-undocumented) Missing documentation for "CookieParameters". -// src/utility.d.ts:21:1 - (ae-undocumented) Missing documentation for "PathParameters". -// src/utility.d.ts:25:1 - (ae-undocumented) Missing documentation for "QueryParameters". ``` diff --git a/packages/backend-plugin-api/report-alpha.api.md b/packages/backend-plugin-api/report-alpha.api.md index 29c74e7ade..dea357502e 100644 --- a/packages/backend-plugin-api/report-alpha.api.md +++ b/packages/backend-plugin-api/report-alpha.api.md @@ -21,10 +21,5 @@ export const featureDiscoveryServiceRef: ServiceRef< 'singleton' >; -// Warnings were encountered during analysis: -// -// src/alpha.d.ts:3:1 - (ae-undocumented) Missing documentation for "FeatureDiscoveryService". -// src/alpha.d.ts:4:5 - (ae-undocumented) Missing documentation for "getBackendFeatures". - // (No @packageDocumentation comment for this package) ``` diff --git a/packages/backend-plugin-api/report-testUtils.api.md b/packages/backend-plugin-api/report-testUtils.api.md index 8f2f871e90..8c9bba8398 100644 --- a/packages/backend-plugin-api/report-testUtils.api.md +++ b/packages/backend-plugin-api/report-testUtils.api.md @@ -22,10 +22,5 @@ export interface PackagePathResolutionOverride { restore(): void; } -// Warnings were encountered during analysis: -// -// src/testUtils.d.ts:2:1 - (ae-undocumented) Missing documentation for "PackagePathResolutionOverride". -// src/testUtils.d.ts:7:1 - (ae-undocumented) Missing documentation for "OverridePackagePathResolutionOptions". - // (No @packageDocumentation comment for this package) ``` diff --git a/packages/backend-plugin-api/report.api.md b/packages/backend-plugin-api/report.api.md index e03179e851..89dfe40dd9 100644 --- a/packages/backend-plugin-api/report.api.md +++ b/packages/backend-plugin-api/report.api.md @@ -735,48 +735,4 @@ export type UrlReaderServiceSearchResponseFile = { export interface UserInfoService { getUserInfo(credentials: BackstageCredentials): Promise; } - -// Warnings were encountered during analysis: -// -// src/services/definitions/HttpRouterService.d.ts:8:5 - (ae-undocumented) Missing documentation for "path". -// src/services/definitions/HttpRouterService.d.ts:9:5 - (ae-undocumented) Missing documentation for "allow". -// src/services/definitions/LifecycleService.d.ts:5:1 - (ae-undocumented) Missing documentation for "LifecycleServiceStartupHook". -// src/services/definitions/LifecycleService.d.ts:9:1 - (ae-undocumented) Missing documentation for "LifecycleServiceStartupOptions". -// src/services/definitions/LifecycleService.d.ts:18:1 - (ae-undocumented) Missing documentation for "LifecycleServiceShutdownHook". -// src/services/definitions/LifecycleService.d.ts:22:1 - (ae-undocumented) Missing documentation for "LifecycleServiceShutdownOptions". -// src/services/definitions/LoggerService.d.ts:10:5 - (ae-undocumented) Missing documentation for "error". -// src/services/definitions/LoggerService.d.ts:11:5 - (ae-undocumented) Missing documentation for "warn". -// src/services/definitions/LoggerService.d.ts:12:5 - (ae-undocumented) Missing documentation for "info". -// src/services/definitions/LoggerService.d.ts:13:5 - (ae-undocumented) Missing documentation for "debug". -// src/services/definitions/LoggerService.d.ts:14:5 - (ae-undocumented) Missing documentation for "child". -// src/services/definitions/PermissionsService.d.ts:9:5 - (ae-undocumented) Missing documentation for "credentials". -// src/services/definitions/RootHealthService.d.ts:5:1 - (ae-undocumented) Missing documentation for "RootHealthService". -// src/services/definitions/UserInfoService.d.ts:9:5 - (ae-undocumented) Missing documentation for "userEntityRef". -// src/services/definitions/UserInfoService.d.ts:10:5 - (ae-undocumented) Missing documentation for "ownershipEntityRefs". -// src/services/system/types.d.ts:35:1 - (ae-undocumented) Missing documentation for "ServiceFactory". -// src/services/system/types.d.ts:36:5 - (ae-undocumented) Missing documentation for "service". -// src/services/system/types.d.ts:39:1 - (ae-undocumented) Missing documentation for "ServiceRefOptions". -// src/services/system/types.d.ts:40:5 - (ae-undocumented) Missing documentation for "id". -// src/services/system/types.d.ts:41:5 - (ae-undocumented) Missing documentation for "scope". -// src/services/system/types.d.ts:42:5 - (ae-undocumented) Missing documentation for "multiton". -// src/services/system/types.d.ts:43:5 - (ae-undocumented) Missing documentation for "defaultFactory". -// src/services/system/types.d.ts:76:1 - (ae-undocumented) Missing documentation for "RootServiceFactoryOptions". -// src/services/system/types.d.ts:90:5 - (ae-undocumented) Missing documentation for "service". -// src/services/system/types.d.ts:91:5 - (ae-undocumented) Missing documentation for "deps". -// src/services/system/types.d.ts:92:5 - (ae-undocumented) Missing documentation for "factory". -// src/services/system/types.d.ts:95:1 - (ae-undocumented) Missing documentation for "PluginServiceFactoryOptions". -// src/services/system/types.d.ts:109:5 - (ae-undocumented) Missing documentation for "service". -// src/services/system/types.d.ts:110:5 - (ae-undocumented) Missing documentation for "deps". -// src/services/system/types.d.ts:111:5 - (ae-undocumented) Missing documentation for "createRootContext". -// src/services/system/types.d.ts:112:5 - (ae-undocumented) Missing documentation for "factory". -// src/types.d.ts:2:1 - (ae-undocumented) Missing documentation for "BackendFeature". -// src/types.d.ts:3:5 - (ae-undocumented) Missing documentation for "$$type". -// src/wiring/createBackendFeatureLoader.d.ts:10:5 - (ae-undocumented) Missing documentation for "deps". -// src/wiring/createBackendFeatureLoader.d.ts:13:5 - (ae-undocumented) Missing documentation for "loader". -// src/wiring/createBackendModule.d.ts:21:5 - (ae-undocumented) Missing documentation for "register". -// src/wiring/createBackendPlugin.d.ts:17:5 - (ae-undocumented) Missing documentation for "register". -// src/wiring/types.d.ts:30:5 - (ae-undocumented) Missing documentation for "registerExtensionPoint". -// src/wiring/types.d.ts:31:5 - (ae-undocumented) Missing documentation for "registerInit". -// src/wiring/types.d.ts:44:5 - (ae-undocumented) Missing documentation for "registerExtensionPoint". -// src/wiring/types.d.ts:45:5 - (ae-undocumented) Missing documentation for "registerInit". ``` diff --git a/packages/backend-test-utils/report.api.md b/packages/backend-test-utils/report.api.md index d9c1c4c721..263435c920 100644 --- a/packages/backend-test-utils/report.api.md +++ b/packages/backend-test-utils/report.api.md @@ -474,84 +474,4 @@ export class TestDatabases { // (undocumented) supports(id: TestDatabaseId): boolean; } - -// Warnings were encountered during analysis: -// -// src/cache/TestCaches.d.ts:27:5 - (ae-undocumented) Missing documentation for "setDefaults". -// src/cache/TestCaches.d.ts:31:5 - (ae-undocumented) Missing documentation for "supports". -// src/cache/TestCaches.d.ts:32:5 - (ae-undocumented) Missing documentation for "eachSupportedId". -// src/database/TestDatabases.d.ts:29:5 - (ae-undocumented) Missing documentation for "setDefaults". -// src/database/TestDatabases.d.ts:33:5 - (ae-undocumented) Missing documentation for "supports". -// src/database/TestDatabases.d.ts:34:5 - (ae-undocumented) Missing documentation for "eachSupportedId". -// src/next/services/mockCredentials.d.ts:17:1 - (ae-undocumented) Missing documentation for "mockCredentials". -// src/next/services/mockCredentials.d.ts:58:9 - (ae-undocumented) Missing documentation for "invalidToken". -// src/next/services/mockCredentials.d.ts:59:9 - (ae-undocumented) Missing documentation for "invalidHeader". -// src/next/services/mockCredentials.d.ts:84:9 - (ae-undocumented) Missing documentation for "invalidToken". -// src/next/services/mockCredentials.d.ts:85:9 - (ae-undocumented) Missing documentation for "invalidCookie". -// src/next/services/mockCredentials.d.ts:116:9 - (ae-undocumented) Missing documentation for "invalidToken". -// src/next/services/mockCredentials.d.ts:117:9 - (ae-undocumented) Missing documentation for "invalidHeader". -// src/next/services/mockServices.d.ts:5:1 - (ae-undocumented) Missing documentation for "ServiceMock". -// src/next/services/mockServices.d.ts:53:5 - (ae-undocumented) Missing documentation for "rootConfig". -// src/next/services/mockServices.d.ts:54:5 - (ae-undocumented) Missing documentation for "rootConfig". -// src/next/services/mockServices.d.ts:55:9 - (ae-undocumented) Missing documentation for "Options". -// src/next/services/mockServices.d.ts:58:15 - (ae-undocumented) Missing documentation for "factory". -// src/next/services/mockServices.d.ts:59:15 - (ae-undocumented) Missing documentation for "mock". -// src/next/services/mockServices.d.ts:61:5 - (ae-undocumented) Missing documentation for "rootLogger". -// src/next/services/mockServices.d.ts:62:5 - (ae-undocumented) Missing documentation for "rootLogger". -// src/next/services/mockServices.d.ts:63:9 - (ae-undocumented) Missing documentation for "Options". -// src/next/services/mockServices.d.ts:66:15 - (ae-undocumented) Missing documentation for "factory". -// src/next/services/mockServices.d.ts:67:15 - (ae-undocumented) Missing documentation for "mock". -// src/next/services/mockServices.d.ts:69:5 - (ae-undocumented) Missing documentation for "auth". -// src/next/services/mockServices.d.ts:73:5 - (ae-undocumented) Missing documentation for "auth". -// src/next/services/mockServices.d.ts:74:15 - (ae-undocumented) Missing documentation for "factory". -// src/next/services/mockServices.d.ts:75:15 - (ae-undocumented) Missing documentation for "mock". -// src/next/services/mockServices.d.ts:77:5 - (ae-undocumented) Missing documentation for "discovery". -// src/next/services/mockServices.d.ts:78:5 - (ae-undocumented) Missing documentation for "discovery". -// src/next/services/mockServices.d.ts:79:15 - (ae-undocumented) Missing documentation for "factory". -// src/next/services/mockServices.d.ts:80:15 - (ae-undocumented) Missing documentation for "mock". -// src/next/services/mockServices.d.ts:100:5 - (ae-undocumented) Missing documentation for "httpAuth". -// src/next/services/mockServices.d.ts:111:15 - (ae-undocumented) Missing documentation for "mock". -// src/next/services/mockServices.d.ts:121:5 - (ae-undocumented) Missing documentation for "userInfo". -// src/next/services/mockServices.d.ts:129:15 - (ae-undocumented) Missing documentation for "mock". -// src/next/services/mockServices.d.ts:131:5 - (ae-undocumented) Missing documentation for "cache". -// src/next/services/mockServices.d.ts:132:15 - (ae-undocumented) Missing documentation for "factory". -// src/next/services/mockServices.d.ts:133:15 - (ae-undocumented) Missing documentation for "mock". -// src/next/services/mockServices.d.ts:135:5 - (ae-undocumented) Missing documentation for "database". -// src/next/services/mockServices.d.ts:136:15 - (ae-undocumented) Missing documentation for "factory". -// src/next/services/mockServices.d.ts:137:15 - (ae-undocumented) Missing documentation for "mock". -// src/next/services/mockServices.d.ts:139:5 - (ae-undocumented) Missing documentation for "rootHealth". -// src/next/services/mockServices.d.ts:140:15 - (ae-undocumented) Missing documentation for "factory". -// src/next/services/mockServices.d.ts:141:15 - (ae-undocumented) Missing documentation for "mock". -// src/next/services/mockServices.d.ts:143:5 - (ae-undocumented) Missing documentation for "httpRouter". -// src/next/services/mockServices.d.ts:144:15 - (ae-undocumented) Missing documentation for "factory". -// src/next/services/mockServices.d.ts:145:15 - (ae-undocumented) Missing documentation for "mock". -// src/next/services/mockServices.d.ts:147:5 - (ae-undocumented) Missing documentation for "rootHttpRouter". -// src/next/services/mockServices.d.ts:148:15 - (ae-undocumented) Missing documentation for "factory". -// src/next/services/mockServices.d.ts:149:15 - (ae-undocumented) Missing documentation for "mock". -// src/next/services/mockServices.d.ts:151:5 - (ae-undocumented) Missing documentation for "lifecycle". -// src/next/services/mockServices.d.ts:152:15 - (ae-undocumented) Missing documentation for "factory". -// src/next/services/mockServices.d.ts:153:15 - (ae-undocumented) Missing documentation for "mock". -// src/next/services/mockServices.d.ts:155:5 - (ae-undocumented) Missing documentation for "logger". -// src/next/services/mockServices.d.ts:156:15 - (ae-undocumented) Missing documentation for "factory". -// src/next/services/mockServices.d.ts:157:15 - (ae-undocumented) Missing documentation for "mock". -// src/next/services/mockServices.d.ts:159:5 - (ae-undocumented) Missing documentation for "permissions". -// src/next/services/mockServices.d.ts:160:15 - (ae-undocumented) Missing documentation for "factory". -// src/next/services/mockServices.d.ts:161:15 - (ae-undocumented) Missing documentation for "mock". -// src/next/services/mockServices.d.ts:163:5 - (ae-undocumented) Missing documentation for "rootLifecycle". -// src/next/services/mockServices.d.ts:164:15 - (ae-undocumented) Missing documentation for "factory". -// src/next/services/mockServices.d.ts:165:15 - (ae-undocumented) Missing documentation for "mock". -// src/next/services/mockServices.d.ts:167:5 - (ae-undocumented) Missing documentation for "scheduler". -// src/next/services/mockServices.d.ts:168:15 - (ae-undocumented) Missing documentation for "factory". -// src/next/services/mockServices.d.ts:169:15 - (ae-undocumented) Missing documentation for "mock". -// src/next/services/mockServices.d.ts:171:5 - (ae-undocumented) Missing documentation for "urlReader". -// src/next/services/mockServices.d.ts:172:15 - (ae-undocumented) Missing documentation for "factory". -// src/next/services/mockServices.d.ts:173:15 - (ae-undocumented) Missing documentation for "mock". -// src/next/services/mockServices.d.ts:175:5 - (ae-undocumented) Missing documentation for "events". -// src/next/services/mockServices.d.ts:176:15 - (ae-undocumented) Missing documentation for "factory". -// src/next/services/mockServices.d.ts:177:15 - (ae-undocumented) Missing documentation for "mock". -// src/next/wiring/TestBackend.d.ts:5:1 - (ae-undocumented) Missing documentation for "TestBackendOptions". -// src/next/wiring/TestBackend.d.ts:6:5 - (ae-undocumented) Missing documentation for "extensionPoints". -// src/next/wiring/TestBackend.d.ts:14:5 - (ae-undocumented) Missing documentation for "features". -// src/next/wiring/TestBackend.d.ts:19:1 - (ae-undocumented) Missing documentation for "TestBackend". -// src/next/wiring/TestBackend.d.ts:30:1 - (ae-undocumented) Missing documentation for "startTestBackend". ``` diff --git a/packages/catalog-client/report-testUtils.api.md b/packages/catalog-client/report-testUtils.api.md index 9341327554..88d14b4f7a 100644 --- a/packages/catalog-client/report-testUtils.api.md +++ b/packages/catalog-client/report-testUtils.api.md @@ -67,22 +67,5 @@ export class InMemoryCatalogClient implements CatalogApi { ): Promise; } -// Warnings were encountered during analysis: -// -// src/testUtils/InMemoryCatalogClient.d.ts:15:5 - (ae-undocumented) Missing documentation for "getEntities". -// src/testUtils/InMemoryCatalogClient.d.ts:16:5 - (ae-undocumented) Missing documentation for "getEntitiesByRefs". -// src/testUtils/InMemoryCatalogClient.d.ts:17:5 - (ae-undocumented) Missing documentation for "queryEntities". -// src/testUtils/InMemoryCatalogClient.d.ts:18:5 - (ae-undocumented) Missing documentation for "getEntityAncestors". -// src/testUtils/InMemoryCatalogClient.d.ts:19:5 - (ae-undocumented) Missing documentation for "getEntityByRef". -// src/testUtils/InMemoryCatalogClient.d.ts:20:5 - (ae-undocumented) Missing documentation for "removeEntityByUid". -// src/testUtils/InMemoryCatalogClient.d.ts:21:5 - (ae-undocumented) Missing documentation for "refreshEntity". -// src/testUtils/InMemoryCatalogClient.d.ts:22:5 - (ae-undocumented) Missing documentation for "getEntityFacets". -// src/testUtils/InMemoryCatalogClient.d.ts:23:5 - (ae-undocumented) Missing documentation for "getLocationById". -// src/testUtils/InMemoryCatalogClient.d.ts:24:5 - (ae-undocumented) Missing documentation for "getLocationByRef". -// src/testUtils/InMemoryCatalogClient.d.ts:25:5 - (ae-undocumented) Missing documentation for "addLocation". -// src/testUtils/InMemoryCatalogClient.d.ts:26:5 - (ae-undocumented) Missing documentation for "removeLocationById". -// src/testUtils/InMemoryCatalogClient.d.ts:27:5 - (ae-undocumented) Missing documentation for "getLocationByEntity". -// src/testUtils/InMemoryCatalogClient.d.ts:28:5 - (ae-undocumented) Missing documentation for "validateEntity". - // (No @packageDocumentation comment for this package) ``` diff --git a/packages/catalog-client/report.api.md b/packages/catalog-client/report.api.md index aba99961f0..203028edce 100644 --- a/packages/catalog-client/report.api.md +++ b/packages/catalog-client/report.api.md @@ -302,13 +302,4 @@ export type ValidateEntityResponse = valid: false; errors: SerializedError[]; }; - -// Warnings were encountered during analysis: -// -// src/CatalogClient.d.ts:50:5 - (ae-undocumented) Missing documentation for "getEntityByName". -// src/types/api.d.ts:154:5 - (ae-undocumented) Missing documentation for "items". -// src/types/api.d.ts:203:5 - (ae-undocumented) Missing documentation for "entityRef". -// src/types/api.d.ts:211:5 - (ae-undocumented) Missing documentation for "rootEntityRef". -// src/types/api.d.ts:212:5 - (ae-undocumented) Missing documentation for "items". -// src/types/api.d.ts:305:5 - (ae-undocumented) Missing documentation for "token". ``` diff --git a/packages/catalog-model/report.api.md b/packages/catalog-model/report.api.md index 07dc6affd7..ec03ce41e1 100644 --- a/packages/catalog-model/report.api.md +++ b/packages/catalog-model/report.api.md @@ -499,52 +499,4 @@ export type Validators = { isValidAnnotationValue(value: unknown): boolean; isValidTag(value: unknown): boolean; }; - -// Warnings were encountered during analysis: -// -// src/entity/conditions.d.ts:6:1 - (ae-undocumented) Missing documentation for "isApiEntity". -// src/entity/conditions.d.ts:10:1 - (ae-undocumented) Missing documentation for "isComponentEntity". -// src/entity/conditions.d.ts:14:1 - (ae-undocumented) Missing documentation for "isDomainEntity". -// src/entity/conditions.d.ts:18:1 - (ae-undocumented) Missing documentation for "isGroupEntity". -// src/entity/conditions.d.ts:22:1 - (ae-undocumented) Missing documentation for "isLocationEntity". -// src/entity/conditions.d.ts:26:1 - (ae-undocumented) Missing documentation for "isResourceEntity". -// src/entity/conditions.d.ts:30:1 - (ae-undocumented) Missing documentation for "isSystemEntity". -// src/entity/conditions.d.ts:34:1 - (ae-undocumented) Missing documentation for "isUserEntity". -// src/entity/policies/DefaultNamespaceEntityPolicy.d.ts:11:5 - (ae-undocumented) Missing documentation for "enforce". -// src/entity/policies/FieldFormatEntityPolicy.d.ts:17:5 - (ae-undocumented) Missing documentation for "enforce". -// src/entity/policies/GroupDefaultParentEntityPolicy.d.ts:14:5 - (ae-undocumented) Missing documentation for "enforce". -// src/entity/policies/NoForeignRootFieldsEntityPolicy.d.ts:11:5 - (ae-undocumented) Missing documentation for "enforce". -// src/entity/policies/SchemaValidEntityPolicy.d.ts:16:5 - (ae-undocumented) Missing documentation for "enforce". -// src/kinds/ApiEntityV1alpha1.d.ts:12:5 - (ae-undocumented) Missing documentation for "apiVersion". -// src/kinds/ApiEntityV1alpha1.d.ts:13:5 - (ae-undocumented) Missing documentation for "kind". -// src/kinds/ApiEntityV1alpha1.d.ts:14:5 - (ae-undocumented) Missing documentation for "spec". -// src/kinds/ComponentEntityV1alpha1.d.ts:12:5 - (ae-undocumented) Missing documentation for "apiVersion". -// src/kinds/ComponentEntityV1alpha1.d.ts:13:5 - (ae-undocumented) Missing documentation for "kind". -// src/kinds/ComponentEntityV1alpha1.d.ts:14:5 - (ae-undocumented) Missing documentation for "spec". -// src/kinds/DomainEntityV1alpha1.d.ts:12:5 - (ae-undocumented) Missing documentation for "apiVersion". -// src/kinds/DomainEntityV1alpha1.d.ts:13:5 - (ae-undocumented) Missing documentation for "kind". -// src/kinds/DomainEntityV1alpha1.d.ts:14:5 - (ae-undocumented) Missing documentation for "spec". -// src/kinds/GroupEntityV1alpha1.d.ts:8:5 - (ae-undocumented) Missing documentation for "apiVersion". -// src/kinds/GroupEntityV1alpha1.d.ts:9:5 - (ae-undocumented) Missing documentation for "kind". -// src/kinds/GroupEntityV1alpha1.d.ts:10:5 - (ae-undocumented) Missing documentation for "spec". -// src/kinds/LocationEntityV1alpha1.d.ts:8:5 - (ae-undocumented) Missing documentation for "apiVersion". -// src/kinds/LocationEntityV1alpha1.d.ts:9:5 - (ae-undocumented) Missing documentation for "kind". -// src/kinds/LocationEntityV1alpha1.d.ts:10:5 - (ae-undocumented) Missing documentation for "spec". -// src/kinds/ResourceEntityV1alpha1.d.ts:12:5 - (ae-undocumented) Missing documentation for "apiVersion". -// src/kinds/ResourceEntityV1alpha1.d.ts:13:5 - (ae-undocumented) Missing documentation for "kind". -// src/kinds/ResourceEntityV1alpha1.d.ts:14:5 - (ae-undocumented) Missing documentation for "spec". -// src/kinds/SystemEntityV1alpha1.d.ts:12:5 - (ae-undocumented) Missing documentation for "apiVersion". -// src/kinds/SystemEntityV1alpha1.d.ts:13:5 - (ae-undocumented) Missing documentation for "kind". -// src/kinds/SystemEntityV1alpha1.d.ts:14:5 - (ae-undocumented) Missing documentation for "spec". -// src/kinds/UserEntityV1alpha1.d.ts:8:5 - (ae-undocumented) Missing documentation for "apiVersion". -// src/kinds/UserEntityV1alpha1.d.ts:9:5 - (ae-undocumented) Missing documentation for "kind". -// src/kinds/UserEntityV1alpha1.d.ts:10:5 - (ae-undocumented) Missing documentation for "spec". -// src/validation/KubernetesValidatorFunctions.d.ts:11:5 - (ae-undocumented) Missing documentation for "isValidApiVersion". -// src/validation/KubernetesValidatorFunctions.d.ts:12:5 - (ae-undocumented) Missing documentation for "isValidKind". -// src/validation/KubernetesValidatorFunctions.d.ts:13:5 - (ae-undocumented) Missing documentation for "isValidObjectName". -// src/validation/KubernetesValidatorFunctions.d.ts:14:5 - (ae-undocumented) Missing documentation for "isValidNamespace". -// src/validation/KubernetesValidatorFunctions.d.ts:15:5 - (ae-undocumented) Missing documentation for "isValidLabelKey". -// src/validation/KubernetesValidatorFunctions.d.ts:16:5 - (ae-undocumented) Missing documentation for "isValidLabelValue". -// src/validation/KubernetesValidatorFunctions.d.ts:17:5 - (ae-undocumented) Missing documentation for "isValidAnnotationKey". -// src/validation/KubernetesValidatorFunctions.d.ts:18:5 - (ae-undocumented) Missing documentation for "isValidAnnotationValue". ``` diff --git a/packages/cli-node/report.api.md b/packages/cli-node/report.api.md index eb18e2e9f8..7c1a3bc744 100644 --- a/packages/cli-node/report.api.md +++ b/packages/cli-node/report.api.md @@ -176,28 +176,4 @@ export class PackageRoles { static getRoleFromPackage(pkgJson: unknown): PackageRole | undefined; static getRoleInfo(role: string): PackageRoleInfo; } - -// Warnings were encountered during analysis: -// -// src/monorepo/PackageGraph.d.ts:10:5 - (ae-undocumented) Missing documentation for "name". -// src/monorepo/PackageGraph.d.ts:11:5 - (ae-undocumented) Missing documentation for "version". -// src/monorepo/PackageGraph.d.ts:12:5 - (ae-undocumented) Missing documentation for "private". -// src/monorepo/PackageGraph.d.ts:13:5 - (ae-undocumented) Missing documentation for "main". -// src/monorepo/PackageGraph.d.ts:14:5 - (ae-undocumented) Missing documentation for "module". -// src/monorepo/PackageGraph.d.ts:15:5 - (ae-undocumented) Missing documentation for "types". -// src/monorepo/PackageGraph.d.ts:16:5 - (ae-undocumented) Missing documentation for "scripts". -// src/monorepo/PackageGraph.d.ts:19:5 - (ae-undocumented) Missing documentation for "bundled". -// src/monorepo/PackageGraph.d.ts:20:5 - (ae-undocumented) Missing documentation for "backstage". -// src/monorepo/PackageGraph.d.ts:44:5 - (ae-undocumented) Missing documentation for "exports". -// src/monorepo/PackageGraph.d.ts:45:5 - (ae-undocumented) Missing documentation for "typesVersions". -// src/monorepo/PackageGraph.d.ts:46:5 - (ae-undocumented) Missing documentation for "files". -// src/monorepo/PackageGraph.d.ts:47:5 - (ae-undocumented) Missing documentation for "publishConfig". -// src/monorepo/PackageGraph.d.ts:52:5 - (ae-undocumented) Missing documentation for "repository". -// src/monorepo/PackageGraph.d.ts:57:5 - (ae-undocumented) Missing documentation for "dependencies". -// src/monorepo/PackageGraph.d.ts:60:5 - (ae-undocumented) Missing documentation for "peerDependencies". -// src/monorepo/PackageGraph.d.ts:63:5 - (ae-undocumented) Missing documentation for "devDependencies". -// src/monorepo/PackageGraph.d.ts:66:5 - (ae-undocumented) Missing documentation for "optionalDependencies". -// src/roles/types.d.ts:25:5 - (ae-undocumented) Missing documentation for "role". -// src/roles/types.d.ts:26:5 - (ae-undocumented) Missing documentation for "platform". -// src/roles/types.d.ts:27:5 - (ae-undocumented) Missing documentation for "output". ``` diff --git a/packages/config-loader/report.api.md b/packages/config-loader/report.api.md index 7d7047d493..e2741d609c 100644 --- a/packages/config-loader/report.api.md +++ b/packages/config-loader/report.api.md @@ -284,32 +284,4 @@ export type TransformFunc = ( path: string; }, ) => T | undefined; - -// Warnings were encountered during analysis: -// -// src/loader.d.ts:6:1 - (ae-undocumented) Missing documentation for "ConfigTarget". -// src/loader.d.ts:15:1 - (ae-undocumented) Missing documentation for "LoadConfigOptionsWatch". -// src/loader.d.ts:29:1 - (ae-undocumented) Missing documentation for "LoadConfigOptionsRemote". -// src/sources/ConfigSources.d.ts:42:5 - (ae-undocumented) Missing documentation for "watch". -// src/sources/ConfigSources.d.ts:43:5 - (ae-undocumented) Missing documentation for "rootDir". -// src/sources/ConfigSources.d.ts:44:5 - (ae-undocumented) Missing documentation for "remote". -// src/sources/ConfigSources.d.ts:65:5 - (ae-undocumented) Missing documentation for "targets". -// src/sources/ConfigSources.d.ts:73:5 - (ae-undocumented) Missing documentation for "argv". -// src/sources/ConfigSources.d.ts:74:5 - (ae-undocumented) Missing documentation for "env". -// src/sources/EnvConfigSource.d.ts:46:5 - (ae-undocumented) Missing documentation for "readConfigData". -// src/sources/EnvConfigSource.d.ts:47:5 - (ae-undocumented) Missing documentation for "toString". -// src/sources/FileConfigSource.d.ts:44:5 - (ae-undocumented) Missing documentation for "readConfigData". -// src/sources/FileConfigSource.d.ts:45:5 - (ae-undocumented) Missing documentation for "toString". -// src/sources/MutableConfigSource.d.ts:9:5 - (ae-undocumented) Missing documentation for "data". -// src/sources/MutableConfigSource.d.ts:10:5 - (ae-undocumented) Missing documentation for "context". -// src/sources/MutableConfigSource.d.ts:27:5 - (ae-undocumented) Missing documentation for "readConfigData". -// src/sources/MutableConfigSource.d.ts:38:5 - (ae-undocumented) Missing documentation for "toString". -// src/sources/RemoteConfigSource.d.ts:43:5 - (ae-undocumented) Missing documentation for "readConfigData". -// src/sources/RemoteConfigSource.d.ts:44:5 - (ae-undocumented) Missing documentation for "toString". -// src/sources/StaticConfigSource.d.ts:9:5 - (ae-undocumented) Missing documentation for "data". -// src/sources/StaticConfigSource.d.ts:10:5 - (ae-undocumented) Missing documentation for "context". -// src/sources/StaticConfigSource.d.ts:28:5 - (ae-undocumented) Missing documentation for "readConfigData". -// src/sources/StaticConfigSource.d.ts:29:5 - (ae-undocumented) Missing documentation for "toString". -// src/sources/types.d.ts:20:5 - (ae-undocumented) Missing documentation for "signal". -// src/sources/types.d.ts:55:5 - (ae-undocumented) Missing documentation for "readConfigData". ``` diff --git a/packages/core-app-api/report.api.md b/packages/core-app-api/report.api.md index a326555cc1..3d2c44a148 100644 --- a/packages/core-app-api/report.api.md +++ b/packages/core-app-api/report.api.md @@ -683,70 +683,4 @@ export class WebStorage implements StorageApi { // (undocumented) snapshot(key: string): StorageValueSnapshot; } - -// Warnings were encountered during analysis: -// -// src/apis/implementations/AlertApi/AlertApiForwarder.d.ts:10:5 - (ae-undocumented) Missing documentation for "post". -// src/apis/implementations/AlertApi/AlertApiForwarder.d.ts:11:5 - (ae-undocumented) Missing documentation for "alert$". -// src/apis/implementations/AnalyticsApi/NoOpAnalyticsApi.d.ts:8:5 - (ae-undocumented) Missing documentation for "captureEvent". -// src/apis/implementations/AppThemeApi/AppThemeSelector.d.ts:11:5 - (ae-undocumented) Missing documentation for "createWithStorage". -// src/apis/implementations/AppThemeApi/AppThemeSelector.d.ts:15:5 - (ae-undocumented) Missing documentation for "getInstalledThemes". -// src/apis/implementations/AppThemeApi/AppThemeSelector.d.ts:16:5 - (ae-undocumented) Missing documentation for "activeThemeId$". -// src/apis/implementations/AppThemeApi/AppThemeSelector.d.ts:17:5 - (ae-undocumented) Missing documentation for "getActiveThemeId". -// src/apis/implementations/AppThemeApi/AppThemeSelector.d.ts:18:5 - (ae-undocumented) Missing documentation for "setActiveThemeId". -// src/apis/implementations/DiscoveryApi/FrontendHostDiscovery.d.ts:37:5 - (ae-undocumented) Missing documentation for "getBaseUrl". -// src/apis/implementations/DiscoveryApi/UrlPatternDiscovery.d.ts:19:5 - (ae-undocumented) Missing documentation for "getBaseUrl". -// src/apis/implementations/ErrorApi/ErrorAlerter.d.ts:12:5 - (ae-undocumented) Missing documentation for "post". -// src/apis/implementations/ErrorApi/ErrorAlerter.d.ts:13:5 - (ae-undocumented) Missing documentation for "error$". -// src/apis/implementations/ErrorApi/ErrorApiForwarder.d.ts:10:5 - (ae-undocumented) Missing documentation for "post". -// src/apis/implementations/ErrorApi/ErrorApiForwarder.d.ts:11:5 - (ae-undocumented) Missing documentation for "error$". -// src/apis/implementations/FeatureFlagsApi/LocalStorageFeatureFlags.d.ts:12:5 - (ae-undocumented) Missing documentation for "registerFlag". -// src/apis/implementations/FeatureFlagsApi/LocalStorageFeatureFlags.d.ts:13:5 - (ae-undocumented) Missing documentation for "getRegisteredFlags". -// src/apis/implementations/FeatureFlagsApi/LocalStorageFeatureFlags.d.ts:14:5 - (ae-undocumented) Missing documentation for "isActive". -// src/apis/implementations/FeatureFlagsApi/LocalStorageFeatureFlags.d.ts:15:5 - (ae-undocumented) Missing documentation for "save". -// src/apis/implementations/OAuthRequestApi/OAuthRequestManager.d.ts:16:5 - (ae-undocumented) Missing documentation for "createAuthRequester". -// src/apis/implementations/OAuthRequestApi/OAuthRequestManager.d.ts:18:5 - (ae-undocumented) Missing documentation for "authRequest$". -// src/apis/implementations/StorageApi/WebStorage.d.ts:14:5 - (ae-undocumented) Missing documentation for "create". -// src/apis/implementations/StorageApi/WebStorage.d.ts:19:5 - (ae-undocumented) Missing documentation for "get". -// src/apis/implementations/StorageApi/WebStorage.d.ts:20:5 - (ae-undocumented) Missing documentation for "snapshot". -// src/apis/implementations/StorageApi/WebStorage.d.ts:21:5 - (ae-undocumented) Missing documentation for "forBucket". -// src/apis/implementations/StorageApi/WebStorage.d.ts:22:5 - (ae-undocumented) Missing documentation for "set". -// src/apis/implementations/StorageApi/WebStorage.d.ts:23:5 - (ae-undocumented) Missing documentation for "remove". -// src/apis/implementations/StorageApi/WebStorage.d.ts:24:5 - (ae-undocumented) Missing documentation for "observe$". -// src/apis/implementations/auth/atlassian/AtlassianAuth.d.ts:9:5 - (ae-undocumented) Missing documentation for "create". -// src/apis/implementations/auth/bitbucket/BitbucketAuth.d.ts:18:5 - (ae-undocumented) Missing documentation for "create". -// src/apis/implementations/auth/bitbucketServer/BitbucketServerAuth.d.ts:17:5 - (ae-undocumented) Missing documentation for "create". -// src/apis/implementations/auth/github/GithubAuth.d.ts:9:5 - (ae-undocumented) Missing documentation for "create". -// src/apis/implementations/auth/gitlab/GitlabAuth.d.ts:9:5 - (ae-undocumented) Missing documentation for "create". -// src/apis/implementations/auth/google/GoogleAuth.d.ts:9:5 - (ae-undocumented) Missing documentation for "create". -// src/apis/implementations/auth/microsoft/MicrosoftAuth.d.ts:17:5 - (ae-undocumented) Missing documentation for "create". -// src/apis/implementations/auth/microsoft/MicrosoftAuth.d.ts:22:5 - (ae-undocumented) Missing documentation for "getAccessToken". -// src/apis/implementations/auth/microsoft/MicrosoftAuth.d.ts:23:5 - (ae-undocumented) Missing documentation for "getIdToken". -// src/apis/implementations/auth/microsoft/MicrosoftAuth.d.ts:24:5 - (ae-undocumented) Missing documentation for "getProfile". -// src/apis/implementations/auth/microsoft/MicrosoftAuth.d.ts:25:5 - (ae-undocumented) Missing documentation for "getBackstageIdentity". -// src/apis/implementations/auth/microsoft/MicrosoftAuth.d.ts:26:5 - (ae-undocumented) Missing documentation for "signIn". -// src/apis/implementations/auth/microsoft/MicrosoftAuth.d.ts:27:5 - (ae-undocumented) Missing documentation for "signOut". -// src/apis/implementations/auth/microsoft/MicrosoftAuth.d.ts:28:5 - (ae-undocumented) Missing documentation for "sessionState$". -// src/apis/implementations/auth/oauth2/OAuth2.d.ts:33:5 - (ae-undocumented) Missing documentation for "create". -// src/apis/implementations/auth/oauth2/OAuth2.d.ts:37:5 - (ae-undocumented) Missing documentation for "signIn". -// src/apis/implementations/auth/oauth2/OAuth2.d.ts:38:5 - (ae-undocumented) Missing documentation for "signOut". -// src/apis/implementations/auth/oauth2/OAuth2.d.ts:39:5 - (ae-undocumented) Missing documentation for "sessionState$". -// src/apis/implementations/auth/oauth2/OAuth2.d.ts:40:5 - (ae-undocumented) Missing documentation for "getAccessToken". -// src/apis/implementations/auth/oauth2/OAuth2.d.ts:41:5 - (ae-undocumented) Missing documentation for "getIdToken". -// src/apis/implementations/auth/oauth2/OAuth2.d.ts:42:5 - (ae-undocumented) Missing documentation for "getBackstageIdentity". -// src/apis/implementations/auth/oauth2/OAuth2.d.ts:43:5 - (ae-undocumented) Missing documentation for "getProfile". -// src/apis/implementations/auth/okta/OktaAuth.d.ts:9:5 - (ae-undocumented) Missing documentation for "create". -// src/apis/implementations/auth/onelogin/OneLoginAuth.d.ts:19:5 - (ae-undocumented) Missing documentation for "create". -// src/apis/implementations/auth/saml/SamlAuth.d.ts:15:5 - (ae-undocumented) Missing documentation for "create". -// src/apis/implementations/auth/saml/SamlAuth.d.ts:16:5 - (ae-undocumented) Missing documentation for "sessionState$". -// src/apis/implementations/auth/saml/SamlAuth.d.ts:18:5 - (ae-undocumented) Missing documentation for "signIn". -// src/apis/implementations/auth/saml/SamlAuth.d.ts:19:5 - (ae-undocumented) Missing documentation for "signOut". -// src/apis/implementations/auth/saml/SamlAuth.d.ts:20:5 - (ae-undocumented) Missing documentation for "getBackstageIdentity". -// src/apis/implementations/auth/saml/SamlAuth.d.ts:21:5 - (ae-undocumented) Missing documentation for "getProfile". -// src/apis/implementations/auth/vmwareCloud/VMwareCloudAuth.d.ts:9:5 - (ae-undocumented) Missing documentation for "create". -// src/apis/system/ApiFactoryRegistry.d.ts:29:5 - (ae-undocumented) Missing documentation for "get". -// src/apis/system/ApiFactoryRegistry.d.ts:32:5 - (ae-undocumented) Missing documentation for "getAllApis". -// src/apis/system/ApiResolver.d.ts:18:5 - (ae-undocumented) Missing documentation for "get". -// src/apis/system/types.d.ts:5:1 - (ae-undocumented) Missing documentation for "ApiFactoryHolder". -// src/app/AppRouter.d.ts:14:5 - (ae-undocumented) Missing documentation for "children". ``` diff --git a/packages/core-compat-api/report.api.md b/packages/core-compat-api/report.api.md index e6971975b2..ddb3bc6bf4 100644 --- a/packages/core-compat-api/report.api.md +++ b/packages/core-compat-api/report.api.md @@ -113,12 +113,5 @@ export type ToNewRouteRef = ? ExternalRouteRef_2 : never; -// Warnings were encountered during analysis: -// -// src/apis/implementations/AnalyticsApi/NoOpAnalyticsApi.d.ts:9:5 - (ae-undocumented) Missing documentation for "captureEvent". -// src/convertLegacyApp.d.ts:4:1 - (ae-undocumented) Missing documentation for "convertLegacyApp". -// src/convertLegacyPageExtension.d.ts:4:1 - (ae-undocumented) Missing documentation for "convertLegacyPageExtension". -// src/convertLegacyPlugin.d.ts:4:1 - (ae-undocumented) Missing documentation for "convertLegacyPlugin". - // (No @packageDocumentation comment for this package) ``` diff --git a/packages/core-components/report-alpha.api.md b/packages/core-components/report-alpha.api.md index ea44f92093..1f4b999232 100644 --- a/packages/core-components/report-alpha.api.md +++ b/packages/core-components/report-alpha.api.md @@ -54,9 +54,5 @@ export const coreComponentsTranslationRef: TranslationRef< } >; -// Warnings were encountered during analysis: -// -// src/translation.d.ts:2:22 - (ae-undocumented) Missing documentation for "coreComponentsTranslationRef". - // (No @packageDocumentation comment for this package) ``` diff --git a/packages/core-components/report.api.md b/packages/core-components/report.api.md index 7ffb430c7f..b9414eb897 100644 --- a/packages/core-components/report.api.md +++ b/packages/core-components/report.api.md @@ -1578,188 +1578,9 @@ export type WarningPanelClassKey = // Warnings were encountered during analysis: // -// src/components/AutoLogout/AutoLogout.d.ts:3:1 - (ae-undocumented) Missing documentation for "AutoLogoutProps". -// src/components/Avatar/Avatar.d.ts:3:1 - (ae-undocumented) Missing documentation for "AvatarClassKey". -// src/components/DependencyGraph/DefaultLabel.d.ts:4:1 - (ae-undocumented) Missing documentation for "DependencyGraphDefaultLabelClassKey". -// src/components/DependencyGraph/DefaultNode.d.ts:4:1 - (ae-undocumented) Missing documentation for "DependencyGraphDefaultNodeClassKey". -// src/components/DependencyGraph/Edge.d.ts:15:1 - (ae-undocumented) Missing documentation for "DependencyGraphEdgeClassKey". -// src/components/DependencyGraph/Node.d.ts:5:1 - (ae-undocumented) Missing documentation for "DependencyGraphNodeClassKey". // src/components/DependencyGraph/types.d.ts:22:9 - (ae-unresolved-link) The @link reference could not be resolved: The package "@backstage/core-components" does not have an export "DependencyNode" // src/components/DependencyGraph/types.d.ts:26:9 - (ae-unresolved-link) The @link reference could not be resolved: The package "@backstage/core-components" does not have an export "DependencyNode" -// src/components/DependencyGraph/types.d.ts:143:9 - (ae-undocumented) Missing documentation for "LEFT". -// src/components/DependencyGraph/types.d.ts:144:9 - (ae-undocumented) Missing documentation for "RIGHT". -// src/components/DependencyGraph/types.d.ts:145:9 - (ae-undocumented) Missing documentation for "CENTER". -// src/components/DismissableBanner/DismissableBanner.d.ts:3:1 - (ae-undocumented) Missing documentation for "DismissableBannerClassKey". -// src/components/DismissableBanner/DismissableBanner.d.ts:8:1 - (ae-undocumented) Missing documentation for "DismissbleBannerClassKey". -// src/components/DismissableBanner/DismissableBanner.d.ts:16:22 - (ae-undocumented) Missing documentation for "DismissableBanner". -// src/components/EmptyState/EmptyState.d.ts:3:1 - (ae-undocumented) Missing documentation for "EmptyStateClassKey". -// src/components/EmptyState/EmptyStateImage.d.ts:6:1 - (ae-undocumented) Missing documentation for "EmptyStateImageClassKey". -// src/components/EmptyState/MissingAnnotationEmptyState.d.ts:10:1 - (ae-undocumented) Missing documentation for "MissingAnnotationEmptyState". -// src/components/ErrorPanel/ErrorPanel.d.ts:3:1 - (ae-undocumented) Missing documentation for "ErrorPanelClassKey". -// src/components/ErrorPanel/ErrorPanel.d.ts:5:1 - (ae-undocumented) Missing documentation for "ErrorPanelProps". -// src/components/FavoriteToggle/FavoriteToggle.d.ts:6:1 - (ae-undocumented) Missing documentation for "FavoriteToggleIconClassKey". -// src/components/FeatureDiscovery/FeatureCalloutCircular.d.ts:3:1 - (ae-undocumented) Missing documentation for "FeatureCalloutCircleClassKey". -// src/components/HeaderIconLinkRow/HeaderIconLinkRow.d.ts:4:1 - (ae-undocumented) Missing documentation for "HeaderIconLinkRowClassKey". -// src/components/HeaderIconLinkRow/IconLinkVertical.d.ts:2:1 - (ae-undocumented) Missing documentation for "IconLinkVerticalProps". -// src/components/HeaderIconLinkRow/IconLinkVertical.d.ts:12:1 - (ae-undocumented) Missing documentation for "IconLinkVerticalClassKey". -// src/components/HeaderIconLinkRow/IconLinkVertical.d.ts:14:1 - (ae-undocumented) Missing documentation for "IconLinkVertical". -// src/components/HorizontalScrollGrid/HorizontalScrollGrid.d.ts:8:1 - (ae-undocumented) Missing documentation for "HorizontalScrollGridClassKey". -// src/components/Lifecycle/Lifecycle.d.ts:7:1 - (ae-undocumented) Missing documentation for "LifecycleClassKey". -// src/components/Lifecycle/Lifecycle.d.ts:8:1 - (ae-undocumented) Missing documentation for "Lifecycle". -// src/components/Link/Link.d.ts:6:1 - (ae-undocumented) Missing documentation for "LinkClassKey". -// src/components/Link/Link.d.ts:8:1 - (ae-undocumented) Missing documentation for "LinkProps". -// src/components/LinkButton/LinkButton.d.ts:24:22 - (ae-undocumented) Missing documentation for "Button". -// src/components/LinkButton/LinkButton.d.ts:29:1 - (ae-undocumented) Missing documentation for "ButtonProps". -// src/components/MarkdownContent/MarkdownContent.d.ts:3:1 - (ae-undocumented) Missing documentation for "MarkdownContentClassKey". -// src/components/OAuthRequestDialog/LoginRequestListItem.d.ts:3:1 - (ae-undocumented) Missing documentation for "LoginRequestListItemClassKey". -// src/components/OAuthRequestDialog/OAuthRequestDialog.d.ts:2:1 - (ae-undocumented) Missing documentation for "OAuthRequestDialogClassKey". -// src/components/OAuthRequestDialog/OAuthRequestDialog.d.ts:3:1 - (ae-undocumented) Missing documentation for "OAuthRequestDialog". -// src/components/OverflowTooltip/OverflowTooltip.d.ts:9:1 - (ae-undocumented) Missing documentation for "OverflowTooltipClassKey". -// src/components/OverflowTooltip/OverflowTooltip.d.ts:10:1 - (ae-undocumented) Missing documentation for "OverflowTooltip". -// src/components/Progress/Progress.d.ts:3:1 - (ae-undocumented) Missing documentation for "Progress". -// src/components/ProgressBars/Gauge.d.ts:4:1 - (ae-undocumented) Missing documentation for "GaugeClassKey". -// src/components/ProgressBars/Gauge.d.ts:6:1 - (ae-undocumented) Missing documentation for "GaugeProps". -// src/components/ProgressBars/Gauge.d.ts:19:1 - (ae-undocumented) Missing documentation for "GaugePropsGetColorOptions". -// src/components/ProgressBars/Gauge.d.ts:26:1 - (ae-undocumented) Missing documentation for "GaugePropsGetColor". -// src/components/ProgressBars/GaugeCard.d.ts:20:1 - (ae-undocumented) Missing documentation for "GaugeCardClassKey". -// src/components/ProgressBars/LinearGauge.d.ts:11:1 - (ae-undocumented) Missing documentation for "LinearGauge". -// src/components/ResponseErrorPanel/ResponseErrorPanel.d.ts:3:1 - (ae-undocumented) Missing documentation for "ResponseErrorPanelClassKey". -// src/components/Select/Select.d.ts:3:1 - (ae-undocumented) Missing documentation for "SelectInputBaseClassKey". -// src/components/Select/Select.d.ts:5:1 - (ae-undocumented) Missing documentation for "SelectClassKey". -// src/components/Select/Select.d.ts:7:1 - (ae-undocumented) Missing documentation for "SelectItem". -// src/components/Select/Select.d.ts:12:1 - (ae-undocumented) Missing documentation for "SelectedItems". -// src/components/Select/Select.d.ts:27:1 - (ae-undocumented) Missing documentation for "SelectComponent". -// src/components/Select/static/ClosedDropdown.d.ts:3:1 - (ae-undocumented) Missing documentation for "ClosedDropdownClassKey". -// src/components/Select/static/OpenedDropdown.d.ts:2:1 - (ae-undocumented) Missing documentation for "OpenedDropdownClassKey". -// src/components/SimpleStepper/SimpleStepper.d.ts:16:1 - (ae-undocumented) Missing documentation for "SimpleStepper". -// src/components/SimpleStepper/SimpleStepperFooter.d.ts:3:1 - (ae-undocumented) Missing documentation for "SimpleStepperFooterClassKey". -// src/components/SimpleStepper/SimpleStepperStep.d.ts:3:1 - (ae-undocumented) Missing documentation for "SimpleStepperStepClassKey". -// src/components/SimpleStepper/SimpleStepperStep.d.ts:4:1 - (ae-undocumented) Missing documentation for "SimpleStepperStep". -// src/components/Status/Status.d.ts:2:1 - (ae-undocumented) Missing documentation for "StatusClassKey". -// src/components/Status/Status.d.ts:3:1 - (ae-undocumented) Missing documentation for "StatusOK". -// src/components/Status/Status.d.ts:4:1 - (ae-undocumented) Missing documentation for "StatusWarning". -// src/components/Status/Status.d.ts:5:1 - (ae-undocumented) Missing documentation for "StatusError". -// src/components/Status/Status.d.ts:6:1 - (ae-undocumented) Missing documentation for "StatusPending". -// src/components/Status/Status.d.ts:7:1 - (ae-undocumented) Missing documentation for "StatusRunning". -// src/components/Status/Status.d.ts:8:1 - (ae-undocumented) Missing documentation for "StatusAborted". -// src/components/StructuredMetadataTable/MetadataTable.d.ts:3:1 - (ae-undocumented) Missing documentation for "MetadataTableTitleCellClassKey". -// src/components/StructuredMetadataTable/MetadataTable.d.ts:4:1 - (ae-undocumented) Missing documentation for "MetadataTableCellClassKey". -// src/components/StructuredMetadataTable/MetadataTable.d.ts:5:1 - (ae-undocumented) Missing documentation for "MetadataTableListClassKey". -// src/components/StructuredMetadataTable/MetadataTable.d.ts:6:1 - (ae-undocumented) Missing documentation for "MetadataTableListItemClassKey". -// src/components/StructuredMetadataTable/StructuredMetadataTable.d.ts:2:1 - (ae-undocumented) Missing documentation for "StructuredMetadataTableListClassKey". -// src/components/StructuredMetadataTable/StructuredMetadataTable.d.ts:3:1 - (ae-undocumented) Missing documentation for "StructuredMetadataTableNestedListClassKey". -// src/components/StructuredMetadataTable/StructuredMetadataTable.d.ts:5:1 - (ae-undocumented) Missing documentation for "StructuredMetadataTableProps". -// src/components/StructuredMetadataTable/StructuredMetadataTable.d.ts:6:5 - (ae-undocumented) Missing documentation for "metadata". -// src/components/StructuredMetadataTable/StructuredMetadataTable.d.ts:9:5 - (ae-undocumented) Missing documentation for "dense". -// src/components/StructuredMetadataTable/StructuredMetadataTable.d.ts:10:5 - (ae-undocumented) Missing documentation for "options". -// src/components/StructuredMetadataTable/StructuredMetadataTable.d.ts:21:1 - (ae-undocumented) Missing documentation for "StructuredMetadataTable". -// src/components/SupportButton/SupportButton.d.ts:8:1 - (ae-undocumented) Missing documentation for "SupportButtonClassKey". -// src/components/SupportButton/SupportButton.d.ts:9:1 - (ae-undocumented) Missing documentation for "SupportButton". -// src/components/TabbedLayout/RoutedTabs.d.ts:8:1 - (ae-undocumented) Missing documentation for "RoutedTabs". // src/components/TabbedLayout/RoutedTabs.d.ts:9:5 - (ae-forgotten-export) The symbol "SubRoute_2" needs to be exported by the entry point index.d.ts -// src/components/TabbedLayout/TabbedLayout.d.ts:29:1 - (ae-undocumented) Missing documentation for "TabbedLayout". -// src/components/TabbedLayout/TabbedLayout.d.ts:30:9 - (ae-undocumented) Missing documentation for "Route". -// src/components/Table/Filters.d.ts:3:1 - (ae-undocumented) Missing documentation for "TableFiltersClassKey". -// src/components/Table/SubvalueCell.d.ts:2:1 - (ae-undocumented) Missing documentation for "SubvalueCellClassKey". -// src/components/Table/SubvalueCell.d.ts:7:1 - (ae-undocumented) Missing documentation for "SubvalueCell". -// src/components/Table/Table.d.ts:4:1 - (ae-undocumented) Missing documentation for "TableHeaderClassKey". -// src/components/Table/Table.d.ts:5:1 - (ae-undocumented) Missing documentation for "TableToolbarClassKey". -// src/components/Table/Table.d.ts:7:1 - (ae-undocumented) Missing documentation for "FiltersContainerClassKey". -// src/components/Table/Table.d.ts:8:1 - (ae-undocumented) Missing documentation for "TableClassKey". -// src/components/Table/Table.d.ts:9:1 - (ae-undocumented) Missing documentation for "TableColumn". -// src/components/Table/Table.d.ts:10:5 - (ae-undocumented) Missing documentation for "highlight". -// src/components/Table/Table.d.ts:11:5 - (ae-undocumented) Missing documentation for "width". -// src/components/Table/Table.d.ts:13:1 - (ae-undocumented) Missing documentation for "TableFilter". -// src/components/Table/Table.d.ts:17:1 - (ae-undocumented) Missing documentation for "TableState". // src/components/Table/Table.d.ts:20:5 - (ae-forgotten-export) The symbol "SelectedFilters" needs to be exported by the entry point index.d.ts -// src/components/Table/Table.d.ts:22:1 - (ae-undocumented) Missing documentation for "TableProps". -// src/components/Table/Table.d.ts:23:5 - (ae-undocumented) Missing documentation for "columns". -// src/components/Table/Table.d.ts:24:5 - (ae-undocumented) Missing documentation for "subtitle". -// src/components/Table/Table.d.ts:25:5 - (ae-undocumented) Missing documentation for "filters". -// src/components/Table/Table.d.ts:26:5 - (ae-undocumented) Missing documentation for "initialState". -// src/components/Table/Table.d.ts:27:5 - (ae-undocumented) Missing documentation for "emptyContent". -// src/components/Table/Table.d.ts:28:5 - (ae-undocumented) Missing documentation for "isLoading". -// src/components/Table/Table.d.ts:29:5 - (ae-undocumented) Missing documentation for "onStateChange". -// src/components/Table/Table.d.ts:31:1 - (ae-undocumented) Missing documentation for "TableOptions". -// src/components/Table/Table.d.ts:44:1 - (ae-undocumented) Missing documentation for "Table". -// src/components/Table/Table.d.ts:45:1 - (ae-undocumented) Missing documentation for "Table". -// src/components/Table/Table.d.ts:46:9 - (ae-undocumented) Missing documentation for "icons". -// src/components/TrendLine/TrendLine.d.ts:3:1 - (ae-undocumented) Missing documentation for "TrendLine". -// src/components/WarningPanel/WarningPanel.d.ts:2:1 - (ae-undocumented) Missing documentation for "WarningPanelClassKey". -// src/hooks/useQueryParamState.d.ts:2:1 - (ae-undocumented) Missing documentation for "useQueryParamState". -// src/hooks/useSupportConfig.d.ts:1:1 - (ae-undocumented) Missing documentation for "SupportItemLink". -// src/hooks/useSupportConfig.d.ts:5:1 - (ae-undocumented) Missing documentation for "SupportItem". -// src/hooks/useSupportConfig.d.ts:10:1 - (ae-undocumented) Missing documentation for "SupportConfig". -// src/hooks/useSupportConfig.d.ts:14:1 - (ae-undocumented) Missing documentation for "useSupportConfig". -// src/icons/icons.d.ts:27:1 - (ae-undocumented) Missing documentation for "CatalogIcon". -// src/icons/icons.d.ts:29:1 - (ae-undocumented) Missing documentation for "ChatIcon". -// src/icons/icons.d.ts:31:1 - (ae-undocumented) Missing documentation for "DashboardIcon". -// src/icons/icons.d.ts:33:1 - (ae-undocumented) Missing documentation for "DocsIcon". -// src/icons/icons.d.ts:35:1 - (ae-undocumented) Missing documentation for "EmailIcon". -// src/icons/icons.d.ts:37:1 - (ae-undocumented) Missing documentation for "GitHubIcon". -// src/icons/icons.d.ts:39:1 - (ae-undocumented) Missing documentation for "GroupIcon". -// src/icons/icons.d.ts:41:1 - (ae-undocumented) Missing documentation for "HelpIcon". -// src/icons/icons.d.ts:43:1 - (ae-undocumented) Missing documentation for "UserIcon". -// src/icons/icons.d.ts:45:1 - (ae-undocumented) Missing documentation for "WarningIcon". -// src/icons/icons.d.ts:47:1 - (ae-undocumented) Missing documentation for "StarIcon". -// src/icons/icons.d.ts:49:1 - (ae-undocumented) Missing documentation for "UnstarredIcon". -// src/layout/BottomLink/BottomLink.d.ts:3:1 - (ae-undocumented) Missing documentation for "BottomLinkClassKey". -// src/layout/BottomLink/BottomLink.d.ts:5:1 - (ae-undocumented) Missing documentation for "BottomLinkProps". -// src/layout/Breadcrumbs/Breadcrumbs.d.ts:5:1 - (ae-undocumented) Missing documentation for "BreadcrumbsClickableTextClassKey". -// src/layout/Breadcrumbs/Breadcrumbs.d.ts:7:1 - (ae-undocumented) Missing documentation for "BreadcrumbsStyledBoxClassKey". -// src/layout/Breadcrumbs/Breadcrumbs.d.ts:9:1 - (ae-undocumented) Missing documentation for "BreadcrumbsCurrentPageClassKey". -// src/layout/Content/Content.d.ts:3:1 - (ae-undocumented) Missing documentation for "BackstageContentClassKey". -// src/layout/ContentHeader/ContentHeader.d.ts:6:1 - (ae-undocumented) Missing documentation for "ContentHeaderClassKey". -// src/layout/ErrorBoundary/ErrorBoundary.d.ts:7:1 - (ae-undocumented) Missing documentation for "ErrorBoundaryProps". // src/layout/ErrorBoundary/ErrorBoundary.d.ts:8:5 - (ae-forgotten-export) The symbol "SlackChannel" needs to be exported by the entry point index.d.ts -// src/layout/ErrorBoundary/ErrorBoundary.d.ts:16:22 - (ae-undocumented) Missing documentation for "ErrorBoundary". -// src/layout/ErrorPage/ErrorPage.d.ts:10:1 - (ae-undocumented) Missing documentation for "ErrorPageClassKey". -// src/layout/ErrorPage/MicDrop.d.ts:2:1 - (ae-undocumented) Missing documentation for "MicDropClassKey". -// src/layout/ErrorPage/StackDetails.d.ts:6:1 - (ae-undocumented) Missing documentation for "StackDetailsClassKey". -// src/layout/Header/Header.d.ts:3:1 - (ae-undocumented) Missing documentation for "HeaderClassKey". -// src/layout/HeaderActionMenu/HeaderActionMenu.d.ts:6:1 - (ae-undocumented) Missing documentation for "HeaderActionMenuItem". -// src/layout/HeaderActionMenu/HeaderActionMenu.d.ts:16:1 - (ae-undocumented) Missing documentation for "HeaderActionMenuProps". -// src/layout/HeaderActionMenu/HeaderActionMenu.d.ts:22:1 - (ae-undocumented) Missing documentation for "HeaderActionMenu". -// src/layout/HeaderLabel/HeaderLabel.d.ts:3:1 - (ae-undocumented) Missing documentation for "HeaderLabelClassKey". -// src/layout/HeaderTabs/HeaderTabs.d.ts:4:1 - (ae-undocumented) Missing documentation for "HeaderTabsClassKey". -// src/layout/HeaderTabs/HeaderTabs.d.ts:5:1 - (ae-undocumented) Missing documentation for "Tab". -// src/layout/InfoCard/InfoCard.d.ts:6:1 - (ae-undocumented) Missing documentation for "InfoCardClassKey". -// src/layout/InfoCard/InfoCard.d.ts:8:1 - (ae-undocumented) Missing documentation for "CardActionsTopRightClassKey". -// src/layout/InfoCard/InfoCard.d.ts:10:1 - (ae-undocumented) Missing documentation for "InfoCardVariants". -// src/layout/ItemCard/ItemCardGrid.d.ts:4:1 - (ae-undocumented) Missing documentation for "ItemCardGridClassKey". -// src/layout/ItemCard/ItemCardGrid.d.ts:7:1 - (ae-undocumented) Missing documentation for "ItemCardGridProps". -// src/layout/ItemCard/ItemCardHeader.d.ts:4:1 - (ae-undocumented) Missing documentation for "ItemCardHeaderClassKey". -// src/layout/ItemCard/ItemCardHeader.d.ts:7:1 - (ae-undocumented) Missing documentation for "ItemCardHeaderProps". -// src/layout/Page/Page.d.ts:2:1 - (ae-undocumented) Missing documentation for "PageClassKey". -// src/layout/Page/Page.d.ts:7:1 - (ae-undocumented) Missing documentation for "Page". -// src/layout/Page/PageWithHeader.d.ts:6:1 - (ae-undocumented) Missing documentation for "PageWithHeader". -// src/layout/Sidebar/Bar.d.ts:4:1 - (ae-undocumented) Missing documentation for "SidebarClassKey". -// src/layout/Sidebar/Bar.d.ts:6:1 - (ae-undocumented) Missing documentation for "SidebarProps". -// src/layout/Sidebar/Items.d.ts:6:1 - (ae-undocumented) Missing documentation for "SidebarItemClassKey". -// src/layout/Sidebar/Items.d.ts:53:1 - (ae-undocumented) Missing documentation for "SidebarSearchField". -// src/layout/Sidebar/Items.d.ts:54:1 - (ae-undocumented) Missing documentation for "SidebarSpaceClassKey". -// src/layout/Sidebar/Items.d.ts:55:22 - (ae-undocumented) Missing documentation for "SidebarSpace". -// src/layout/Sidebar/Items.d.ts:56:1 - (ae-undocumented) Missing documentation for "SidebarSpacerClassKey". -// src/layout/Sidebar/Items.d.ts:57:22 - (ae-undocumented) Missing documentation for "SidebarSpacer". -// src/layout/Sidebar/Items.d.ts:58:1 - (ae-undocumented) Missing documentation for "SidebarDividerClassKey". -// src/layout/Sidebar/Items.d.ts:59:22 - (ae-undocumented) Missing documentation for "SidebarDivider". -// src/layout/Sidebar/Items.d.ts:60:22 - (ae-undocumented) Missing documentation for "SidebarScrollWrapper". -// src/layout/Sidebar/Page.d.ts:2:1 - (ae-undocumented) Missing documentation for "SidebarPageClassKey". -// src/layout/Sidebar/Page.d.ts:11:1 - (ae-undocumented) Missing documentation for "SidebarPage". -// src/layout/Sidebar/SidebarSubmenu.d.ts:3:1 - (ae-undocumented) Missing documentation for "SidebarSubmenuClassKey". -// src/layout/Sidebar/SidebarSubmenuItem.d.ts:4:1 - (ae-undocumented) Missing documentation for "SidebarSubmenuItemClassKey". -// src/layout/Sidebar/config.d.ts:3:1 - (ae-undocumented) Missing documentation for "SidebarOptions". -// src/layout/Sidebar/config.d.ts:8:1 - (ae-undocumented) Missing documentation for "SubmenuOptions". -// src/layout/Sidebar/config.d.ts:12:22 - (ae-undocumented) Missing documentation for "sidebarConfig". -// src/layout/Sidebar/config.d.ts:52:22 - (ae-undocumented) Missing documentation for "SIDEBAR_INTRO_LOCAL_STORAGE". -// src/layout/SignInPage/SignInPage.d.ts:26:1 - (ae-undocumented) Missing documentation for "SignInPage". -// src/layout/SignInPage/customProvider.d.ts:3:1 - (ae-undocumented) Missing documentation for "CustomProviderClassKey". -// src/layout/SignInPage/styles.d.ts:2:1 - (ae-undocumented) Missing documentation for "SignInPageClassKey". -// src/layout/SignInPage/types.d.ts:3:1 - (ae-undocumented) Missing documentation for "SignInProviderConfig". -// src/layout/SignInPage/types.d.ts:10:1 - (ae-undocumented) Missing documentation for "IdentityProviders". -// src/layout/TabbedCard/TabbedCard.d.ts:5:1 - (ae-undocumented) Missing documentation for "TabbedCardClassKey". -// src/layout/TabbedCard/TabbedCard.d.ts:7:1 - (ae-undocumented) Missing documentation for "BoldHeaderClassKey". -// src/layout/TabbedCard/TabbedCard.d.ts:18:1 - (ae-undocumented) Missing documentation for "TabbedCard". -// src/layout/TabbedCard/TabbedCard.d.ts:20:1 - (ae-undocumented) Missing documentation for "CardTabClassKey". -// src/overridableComponents.d.ts:83:1 - (ae-undocumented) Missing documentation for "BackstageOverrides". ``` diff --git a/packages/core-plugin-api/report-alpha.api.md b/packages/core-plugin-api/report-alpha.api.md index 260e0365a7..c0f0d02535 100644 --- a/packages/core-plugin-api/report-alpha.api.md +++ b/packages/core-plugin-api/report-alpha.api.md @@ -239,36 +239,5 @@ export const useTranslationRef: < t: TranslationFunction; }; -// Warnings were encountered during analysis: -// -// src/apis/definitions/AppLanguageApi.d.ts:4:1 - (ae-undocumented) Missing documentation for "AppLanguageApi". -// src/apis/definitions/AppLanguageApi.d.ts:19:22 - (ae-undocumented) Missing documentation for "appLanguageApiRef". -// src/apis/definitions/TranslationApi.d.ts:228:1 - (ae-undocumented) Missing documentation for "TranslationFunction". -// src/apis/definitions/TranslationApi.d.ts:231:5 - (ae-undocumented) Missing documentation for "__call". -// src/apis/definitions/TranslationApi.d.ts:234:1 - (ae-undocumented) Missing documentation for "TranslationSnapshot". -// src/apis/definitions/TranslationApi.d.ts:243:1 - (ae-undocumented) Missing documentation for "TranslationApi". -// src/apis/definitions/TranslationApi.d.ts:254:22 - (ae-undocumented) Missing documentation for "translationApiRef". -// src/translation/TranslationMessages.d.ts:17:5 - (ae-undocumented) Missing documentation for "$$type". -// src/translation/TranslationMessages.d.ts:33:5 - (ae-undocumented) Missing documentation for "ref". -// src/translation/TranslationMessages.d.ts:34:5 - (ae-undocumented) Missing documentation for "full". -// src/translation/TranslationMessages.d.ts:35:5 - (ae-undocumented) Missing documentation for "messages". -// src/translation/TranslationRef.d.ts:2:1 - (ae-undocumented) Missing documentation for "TranslationRef". -// src/translation/TranslationRef.d.ts:7:5 - (ae-undocumented) Missing documentation for "$$type". -// src/translation/TranslationRef.d.ts:8:5 - (ae-undocumented) Missing documentation for "id". -// src/translation/TranslationRef.d.ts:9:5 - (ae-undocumented) Missing documentation for "T". -// src/translation/TranslationRef.d.ts:30:1 - (ae-undocumented) Missing documentation for "TranslationRefOptions". -// src/translation/TranslationRef.d.ts:37:5 - (ae-undocumented) Missing documentation for "id". -// src/translation/TranslationRef.d.ts:38:5 - (ae-undocumented) Missing documentation for "messages". -// src/translation/TranslationRef.d.ts:39:5 - (ae-undocumented) Missing documentation for "translations". -// src/translation/TranslationRef.d.ts:42:1 - (ae-undocumented) Missing documentation for "createTranslationRef". -// src/translation/TranslationResource.d.ts:3:1 - (ae-undocumented) Missing documentation for "TranslationResource". -// src/translation/TranslationResource.d.ts:4:5 - (ae-undocumented) Missing documentation for "$$type". -// src/translation/TranslationResource.d.ts:5:5 - (ae-undocumented) Missing documentation for "id". -// src/translation/TranslationResource.d.ts:8:1 - (ae-undocumented) Missing documentation for "TranslationResourceOptions". -// src/translation/TranslationResource.d.ts:17:5 - (ae-undocumented) Missing documentation for "ref". -// src/translation/TranslationResource.d.ts:18:5 - (ae-undocumented) Missing documentation for "translations". -// src/translation/TranslationResource.d.ts:21:1 - (ae-undocumented) Missing documentation for "createTranslationResource". -// src/translation/useTranslationRef.d.ts:4:22 - (ae-undocumented) Missing documentation for "useTranslationRef". - // (No @packageDocumentation comment for this package) ``` diff --git a/packages/core-plugin-api/report.api.md b/packages/core-plugin-api/report.api.md index 06333c1fb4..7692d0e8f0 100644 --- a/packages/core-plugin-api/report.api.md +++ b/packages/core-plugin-api/report.api.md @@ -792,8 +792,4 @@ export function withApis( ): React_2.JSX.Element; displayName: string; }; - -// Warnings were encountered during analysis: -// -// src/routing/types.d.ts:13:1 - (ae-undocumented) Missing documentation for "AnyParams". ``` diff --git a/packages/dev-utils/report.api.md b/packages/dev-utils/report.api.md index 18da50026e..1a7b765fab 100644 --- a/packages/dev-utils/report.api.md +++ b/packages/dev-utils/report.api.md @@ -67,10 +67,4 @@ export const SidebarSignOutButton: (props: { icon?: IconComponent; text?: string; }) => React_2.JSX.Element; - -// Warnings were encountered during analysis: -// -// src/components/EntityGridItem/EntityGridItem.d.ts:5:22 - (ae-undocumented) Missing documentation for "EntityGridItem". -// src/components/SidebarLanguageSwitcher/SidebarLanguageSwitcher.d.ts:3:22 - (ae-undocumented) Missing documentation for "SidebarLanguageSwitcher". -// src/devApp/render.d.ts:8:1 - (ae-undocumented) Missing documentation for "DevAppPageOptions". ``` diff --git a/packages/errors/report.api.md b/packages/errors/report.api.md index d2ba2d22ff..894aac8413 100644 --- a/packages/errors/report.api.md +++ b/packages/errors/report.api.md @@ -155,16 +155,4 @@ export class ServiceUnavailableError extends CustomErrorBase {} // @public export function stringifyError(error: unknown): string; - -// Warnings were encountered during analysis: -// -// src/errors/ResponseError.d.ts:32:5 - (ae-undocumented) Missing documentation for "statusCode". -// src/errors/ResponseError.d.ts:33:5 - (ae-undocumented) Missing documentation for "statusText". -// src/errors/common.d.ts:8:5 - (ae-undocumented) Missing documentation for "name". -// src/errors/common.d.ts:16:5 - (ae-undocumented) Missing documentation for "name". -// src/errors/common.d.ts:24:5 - (ae-undocumented) Missing documentation for "name". -// src/errors/common.d.ts:35:5 - (ae-undocumented) Missing documentation for "name". -// src/errors/common.d.ts:44:5 - (ae-undocumented) Missing documentation for "name". -// src/errors/common.d.ts:52:5 - (ae-undocumented) Missing documentation for "name". -// src/errors/common.d.ts:60:5 - (ae-undocumented) Missing documentation for "name". ``` diff --git a/packages/frontend-app-api/report.api.md b/packages/frontend-app-api/report.api.md index b5e5f801e6..4216f1f823 100644 --- a/packages/frontend-app-api/report.api.md +++ b/packages/frontend-app-api/report.api.md @@ -43,8 +43,4 @@ export type FrontendFeature = | { $$type: '@backstage/BackstagePlugin'; }; - -// Warnings were encountered during analysis: -// -// src/wiring/types.d.ts:3:1 - (ae-undocumented) Missing documentation for "FrontendFeature". ``` diff --git a/packages/frontend-defaults/report.api.md b/packages/frontend-defaults/report.api.md index 4822312294..b99232b784 100644 --- a/packages/frontend-defaults/report.api.md +++ b/packages/frontend-defaults/report.api.md @@ -40,10 +40,4 @@ export interface CreateAppOptions { export function createPublicSignInApp(options?: CreateAppOptions): { createRoot(): React_2.JSX.Element; }; - -// Warnings were encountered during analysis: -// -// src/createApp.d.ts:29:5 - (ae-undocumented) Missing documentation for "features". -// src/createApp.d.ts:30:5 - (ae-undocumented) Missing documentation for "configLoader". -// src/createApp.d.ts:33:5 - (ae-undocumented) Missing documentation for "bindRoutes". ``` diff --git a/packages/frontend-plugin-api/report.api.md b/packages/frontend-plugin-api/report.api.md index 5bc2a663d7..acc9efed61 100644 --- a/packages/frontend-plugin-api/report.api.md +++ b/packages/frontend-plugin-api/report.api.md @@ -1747,106 +1747,4 @@ export { useTranslationRef }; export { vmwareCloudAuthApiRef }; export { withApis }; - -// Warnings were encountered during analysis: -// -// src/apis/definitions/AppTreeApi.d.ts:12:5 - (ae-undocumented) Missing documentation for "id". -// src/apis/definitions/AppTreeApi.d.ts:13:5 - (ae-undocumented) Missing documentation for "attachTo". -// src/apis/definitions/AppTreeApi.d.ts:17:5 - (ae-undocumented) Missing documentation for "extension". -// src/apis/definitions/AppTreeApi.d.ts:18:5 - (ae-undocumented) Missing documentation for "disabled". -// src/apis/definitions/AppTreeApi.d.ts:19:5 - (ae-undocumented) Missing documentation for "config". -// src/apis/definitions/AppTreeApi.d.ts:20:5 - (ae-undocumented) Missing documentation for "source". -// src/apis/definitions/AppTreeApi.d.ts:32:5 - (ae-undocumented) Missing documentation for "attachedTo". -// src/apis/definitions/AppTreeApi.d.ts:36:5 - (ae-undocumented) Missing documentation for "attachments". -// src/apis/definitions/ComponentsApi.d.ts:9:5 - (ae-undocumented) Missing documentation for "getComponent". -// src/apis/definitions/IconsApi.d.ts:8:5 - (ae-undocumented) Missing documentation for "getIcon". -// src/apis/definitions/IconsApi.d.ts:9:5 - (ae-undocumented) Missing documentation for "listIconKeys". -// src/apis/definitions/RouteResolutionApi.d.ts:19:1 - (ae-undocumented) Missing documentation for "RouteResolutionApiResolveOptions". -// src/apis/definitions/RouteResolutionApi.d.ts:29:1 - (ae-undocumented) Missing documentation for "RouteResolutionApi". -// src/apis/definitions/RouteResolutionApi.d.ts:30:5 - (ae-undocumented) Missing documentation for "resolve". -// src/blueprints/IconBundleBlueprint.d.ts:3:22 - (ae-undocumented) Missing documentation for "IconBundleBlueprint". -// src/blueprints/RouterBlueprint.d.ts:3:22 - (ae-undocumented) Missing documentation for "RouterBlueprint". -// src/components/ExtensionBoundary.d.ts:4:1 - (ae-undocumented) Missing documentation for "ExtensionBoundaryProps". -// src/components/ExtensionBoundary.d.ts:5:5 - (ae-undocumented) Missing documentation for "node". -// src/components/ExtensionBoundary.d.ts:12:5 - (ae-undocumented) Missing documentation for "children". -// src/components/ExtensionBoundary.d.ts:15:1 - (ae-undocumented) Missing documentation for "ExtensionBoundary". -// src/components/ExtensionBoundary.d.ts:17:1 - (ae-undocumented) Missing documentation for "ExtensionBoundary". -// src/components/ExtensionBoundary.d.ts:18:5 - (ae-undocumented) Missing documentation for "lazy". -// src/components/coreComponentRefs.d.ts:3:22 - (ae-undocumented) Missing documentation for "coreComponentRefs". -// src/components/createComponentRef.d.ts:2:1 - (ae-undocumented) Missing documentation for "ComponentRef". -// src/components/createComponentRef.d.ts:7:1 - (ae-undocumented) Missing documentation for "createComponentRef". -// src/extensions/createComponentExtension.d.ts:4:1 - (ae-undocumented) Missing documentation for "createComponentExtension". -// src/extensions/createComponentExtension.d.ts:31:1 - (ae-undocumented) Missing documentation for "createComponentExtension". -// src/extensions/createComponentExtension.d.ts:32:11 - (ae-undocumented) Missing documentation for "componentDataRef". -// src/routing/ExternalRouteRef.d.ts:12:5 - (ae-undocumented) Missing documentation for "$$type". -// src/routing/ExternalRouteRef.d.ts:13:5 - (ae-undocumented) Missing documentation for "T". -// src/routing/RouteRef.d.ts:12:5 - (ae-undocumented) Missing documentation for "$$type". -// src/routing/RouteRef.d.ts:13:5 - (ae-undocumented) Missing documentation for "T". -// src/routing/SubRouteRef.d.ts:13:5 - (ae-undocumented) Missing documentation for "$$type". -// src/routing/SubRouteRef.d.ts:14:5 - (ae-undocumented) Missing documentation for "T". -// src/routing/SubRouteRef.d.ts:15:5 - (ae-undocumented) Missing documentation for "path". -// src/schema/types.d.ts:3:1 - (ae-undocumented) Missing documentation for "PortableSchema". -// src/types.d.ts:11:1 - (ae-undocumented) Missing documentation for "CoreProgressProps". -// src/types.d.ts:13:1 - (ae-undocumented) Missing documentation for "CoreNotFoundErrorPageProps". -// src/types.d.ts:17:1 - (ae-undocumented) Missing documentation for "CoreErrorBoundaryFallbackProps". -// src/wiring/coreExtensionData.d.ts:4:22 - (ae-undocumented) Missing documentation for "coreExtensionData". -// src/wiring/createExtension.d.ts:31:1 - (ae-undocumented) Missing documentation for "CreateExtensionOptions". -// src/wiring/createExtension.d.ts:61:1 - (ae-undocumented) Missing documentation for "ExtensionDefinitionParameters". -// src/wiring/createExtension.d.ts:80:1 - (ae-undocumented) Missing documentation for "ExtensionDefinition". -// src/wiring/createExtension.d.ts:134:1 - (ae-undocumented) Missing documentation for "createExtension". -// src/wiring/createExtensionBlueprint.d.ts:12:1 - (ae-undocumented) Missing documentation for "CreateExtensionBlueprintOptions". -// src/wiring/createExtensionBlueprint.d.ts:45:1 - (ae-undocumented) Missing documentation for "ExtensionBlueprintParameters". -// src/wiring/createExtensionBlueprint.d.ts:69:1 - (ae-undocumented) Missing documentation for "ExtensionBlueprint". -// src/wiring/createExtensionBlueprint.d.ts:70:5 - (ae-undocumented) Missing documentation for "dataRefs". -// src/wiring/createExtensionBlueprint.d.ts:71:5 - (ae-undocumented) Missing documentation for "make". -// src/wiring/createExtensionDataContainer.d.ts:3:1 - (ae-undocumented) Missing documentation for "ExtensionDataContainer". -// src/wiring/createExtensionDataRef.d.ts:2:1 - (ae-undocumented) Missing documentation for "ExtensionDataValue". -// src/wiring/createExtensionDataRef.d.ts:8:1 - (ae-undocumented) Missing documentation for "ExtensionDataRef". -// src/wiring/createExtensionDataRef.d.ts:17:1 - (ae-undocumented) Missing documentation for "ExtensionDataRefToValue". -// src/wiring/createExtensionDataRef.d.ts:19:1 - (ae-undocumented) Missing documentation for "AnyExtensionDataRef". -// src/wiring/createExtensionDataRef.d.ts:23:1 - (ae-undocumented) Missing documentation for "ConfigurableExtensionDataRef". -// src/wiring/createExtensionDataRef.d.ts:26:5 - (ae-undocumented) Missing documentation for "optional". -// src/wiring/createExtensionDataRef.d.ts:29:5 - (ae-undocumented) Missing documentation for "__call". -// src/wiring/createExtensionDataRef.d.ts:35:1 - (ae-undocumented) Missing documentation for "createExtensionDataRef". -// src/wiring/createExtensionDataRef.d.ts:37:1 - (ae-undocumented) Missing documentation for "createExtensionDataRef". -// src/wiring/createExtensionInput.d.ts:3:1 - (ae-undocumented) Missing documentation for "ExtensionInput". -// src/wiring/createExtensionInput.d.ts:9:5 - (ae-undocumented) Missing documentation for "$$type". -// src/wiring/createExtensionInput.d.ts:10:5 - (ae-undocumented) Missing documentation for "extensionData". -// src/wiring/createExtensionInput.d.ts:11:5 - (ae-undocumented) Missing documentation for "config". -// src/wiring/createExtensionInput.d.ts:12:5 - (ae-undocumented) Missing documentation for "replaces". -// src/wiring/createExtensionInput.d.ts:18:1 - (ae-undocumented) Missing documentation for "createExtensionInput". -// src/wiring/createFrontendModule.d.ts:4:1 - (ae-undocumented) Missing documentation for "CreateFrontendModuleOptions". -// src/wiring/createFrontendModule.d.ts:5:5 - (ae-undocumented) Missing documentation for "pluginId". -// src/wiring/createFrontendModule.d.ts:6:5 - (ae-undocumented) Missing documentation for "extensions". -// src/wiring/createFrontendModule.d.ts:7:5 - (ae-undocumented) Missing documentation for "featureFlags". -// src/wiring/createFrontendModule.d.ts:10:1 - (ae-undocumented) Missing documentation for "FrontendModule". -// src/wiring/createFrontendModule.d.ts:11:5 - (ae-undocumented) Missing documentation for "$$type". -// src/wiring/createFrontendModule.d.ts:12:5 - (ae-undocumented) Missing documentation for "pluginId". -// src/wiring/createFrontendModule.d.ts:15:1 - (ae-undocumented) Missing documentation for "createFrontendModule". -// src/wiring/createFrontendPlugin.d.ts:5:1 - (ae-undocumented) Missing documentation for "FrontendPlugin". -// src/wiring/createFrontendPlugin.d.ts:10:5 - (ae-undocumented) Missing documentation for "$$type". -// src/wiring/createFrontendPlugin.d.ts:11:5 - (ae-undocumented) Missing documentation for "id". -// src/wiring/createFrontendPlugin.d.ts:12:5 - (ae-undocumented) Missing documentation for "routes". -// src/wiring/createFrontendPlugin.d.ts:13:5 - (ae-undocumented) Missing documentation for "externalRoutes". -// src/wiring/createFrontendPlugin.d.ts:14:5 - (ae-undocumented) Missing documentation for "getExtension". -// src/wiring/createFrontendPlugin.d.ts:15:5 - (ae-undocumented) Missing documentation for "withOverrides". -// src/wiring/createFrontendPlugin.d.ts:20:1 - (ae-undocumented) Missing documentation for "PluginOptions". -// src/wiring/createFrontendPlugin.d.ts:21:5 - (ae-undocumented) Missing documentation for "id". -// src/wiring/createFrontendPlugin.d.ts:22:5 - (ae-undocumented) Missing documentation for "routes". -// src/wiring/createFrontendPlugin.d.ts:23:5 - (ae-undocumented) Missing documentation for "externalRoutes". -// src/wiring/createFrontendPlugin.d.ts:24:5 - (ae-undocumented) Missing documentation for "extensions". -// src/wiring/createFrontendPlugin.d.ts:25:5 - (ae-undocumented) Missing documentation for "featureFlags". -// src/wiring/createFrontendPlugin.d.ts:28:1 - (ae-undocumented) Missing documentation for "createFrontendPlugin". -// src/wiring/resolveExtensionDefinition.d.ts:4:1 - (ae-undocumented) Missing documentation for "Extension". -// src/wiring/resolveExtensionDefinition.d.ts:5:5 - (ae-undocumented) Missing documentation for "$$type". -// src/wiring/resolveExtensionDefinition.d.ts:6:5 - (ae-undocumented) Missing documentation for "id". -// src/wiring/resolveExtensionDefinition.d.ts:7:5 - (ae-undocumented) Missing documentation for "attachTo". -// src/wiring/resolveExtensionDefinition.d.ts:11:5 - (ae-undocumented) Missing documentation for "disabled". -// src/wiring/resolveExtensionDefinition.d.ts:12:5 - (ae-undocumented) Missing documentation for "configSchema". -// src/wiring/resolveInputOverrides.d.ts:5:1 - (ae-undocumented) Missing documentation for "ResolveInputValueOverrides". -// src/wiring/types.d.ts:14:1 - (ae-undocumented) Missing documentation for "AnyRoutes". -// src/wiring/types.d.ts:18:1 - (ae-undocumented) Missing documentation for "AnyExternalRoutes". -// src/wiring/types.d.ts:28:1 - (ae-undocumented) Missing documentation for "ExtensionOverrides". -// src/wiring/types.d.ts:29:5 - (ae-undocumented) Missing documentation for "$$type". -// src/wiring/types.d.ts:35:1 - (ae-undocumented) Missing documentation for "FrontendFeature". ``` diff --git a/packages/frontend-test-utils/report.api.md b/packages/frontend-test-utils/report.api.md index dc37ec4fb4..1982315a35 100644 --- a/packages/frontend-test-utils/report.api.md +++ b/packages/frontend-test-utils/report.api.md @@ -146,20 +146,4 @@ export type TestAppOptions = { }; export { withLogCollector }; - -// Warnings were encountered during analysis: -// -// src/apis/AnalyticsApi/MockAnalyticsApi.d.ts:10:5 - (ae-undocumented) Missing documentation for "captureEvent". -// src/apis/AnalyticsApi/MockAnalyticsApi.d.ts:11:5 - (ae-undocumented) Missing documentation for "getEvents". -// src/app/createExtensionTester.d.ts:4:1 - (ae-undocumented) Missing documentation for "ExtensionQuery". -// src/app/createExtensionTester.d.ts:7:5 - (ae-undocumented) Missing documentation for "node". -// src/app/createExtensionTester.d.ts:8:5 - (ae-undocumented) Missing documentation for "instance". -// src/app/createExtensionTester.d.ts:9:5 - (ae-undocumented) Missing documentation for "get". -// src/app/createExtensionTester.d.ts:12:1 - (ae-undocumented) Missing documentation for "ExtensionTester". -// src/app/createExtensionTester.d.ts:14:5 - (ae-undocumented) Missing documentation for "add". -// src/app/createExtensionTester.d.ts:17:5 - (ae-undocumented) Missing documentation for "get". -// src/app/createExtensionTester.d.ts:18:5 - (ae-undocumented) Missing documentation for "query". -// src/app/createExtensionTester.d.ts:19:5 - (ae-undocumented) Missing documentation for "reactElement". -// src/app/createExtensionTester.d.ts:22:1 - (ae-undocumented) Missing documentation for "createExtensionTester". -// src/deprecated.d.ts:5:1 - (ae-undocumented) Missing documentation for "setupRequestMockHandlers". ``` diff --git a/packages/integration-aws-node/report.api.md b/packages/integration-aws-node/report.api.md index 80b1eee3ba..d9ed25e193 100644 --- a/packages/integration-aws-node/report.api.md +++ b/packages/integration-aws-node/report.api.md @@ -35,9 +35,5 @@ export class DefaultAwsCredentialsManager implements AwsCredentialsManager { ): Promise; } -// Warnings were encountered during analysis: -// -// src/DefaultAwsCredentialsManager.d.ts:12:5 - (ae-undocumented) Missing documentation for "fromConfig". - // (No @packageDocumentation comment for this package) ``` diff --git a/packages/integration/report.api.md b/packages/integration/report.api.md index e14a93b9a4..e9b67bb6c1 100644 --- a/packages/integration/report.api.md +++ b/packages/integration/report.api.md @@ -1027,127 +1027,4 @@ export class SingleInstanceGithubCredentialsProvider static create: (config: GithubIntegrationConfig) => GithubCredentialsProvider; getCredentials(opts: { url: string }): Promise; } - -// Warnings were encountered during analysis: -// -// src/ScmIntegrations.d.ts:21:5 - (ae-undocumented) Missing documentation for "awsS3". -// src/ScmIntegrations.d.ts:22:5 - (ae-undocumented) Missing documentation for "awsCodeCommit". -// src/ScmIntegrations.d.ts:23:5 - (ae-undocumented) Missing documentation for "azure". -// src/ScmIntegrations.d.ts:27:5 - (ae-undocumented) Missing documentation for "bitbucket". -// src/ScmIntegrations.d.ts:28:5 - (ae-undocumented) Missing documentation for "bitbucketCloud". -// src/ScmIntegrations.d.ts:29:5 - (ae-undocumented) Missing documentation for "bitbucketServer". -// src/ScmIntegrations.d.ts:30:5 - (ae-undocumented) Missing documentation for "gerrit". -// src/ScmIntegrations.d.ts:31:5 - (ae-undocumented) Missing documentation for "github". -// src/ScmIntegrations.d.ts:32:5 - (ae-undocumented) Missing documentation for "gitlab". -// src/ScmIntegrations.d.ts:33:5 - (ae-undocumented) Missing documentation for "gitea". -// src/ScmIntegrations.d.ts:34:5 - (ae-undocumented) Missing documentation for "harness". -// src/ScmIntegrations.d.ts:43:5 - (ae-undocumented) Missing documentation for "fromConfig". -// src/ScmIntegrations.d.ts:45:5 - (ae-undocumented) Missing documentation for "awsS3". -// src/ScmIntegrations.d.ts:46:5 - (ae-undocumented) Missing documentation for "awsCodeCommit". -// src/ScmIntegrations.d.ts:47:5 - (ae-undocumented) Missing documentation for "azure". -// src/ScmIntegrations.d.ts:51:5 - (ae-undocumented) Missing documentation for "bitbucket". -// src/ScmIntegrations.d.ts:52:5 - (ae-undocumented) Missing documentation for "bitbucketCloud". -// src/ScmIntegrations.d.ts:53:5 - (ae-undocumented) Missing documentation for "bitbucketServer". -// src/ScmIntegrations.d.ts:54:5 - (ae-undocumented) Missing documentation for "gerrit". -// src/ScmIntegrations.d.ts:55:5 - (ae-undocumented) Missing documentation for "github". -// src/ScmIntegrations.d.ts:56:5 - (ae-undocumented) Missing documentation for "gitlab". -// src/ScmIntegrations.d.ts:57:5 - (ae-undocumented) Missing documentation for "gitea". -// src/ScmIntegrations.d.ts:58:5 - (ae-undocumented) Missing documentation for "harness". -// src/ScmIntegrations.d.ts:59:5 - (ae-undocumented) Missing documentation for "list". -// src/ScmIntegrations.d.ts:60:5 - (ae-undocumented) Missing documentation for "byUrl". -// src/ScmIntegrations.d.ts:61:5 - (ae-undocumented) Missing documentation for "byHost". -// src/ScmIntegrations.d.ts:62:5 - (ae-undocumented) Missing documentation for "resolveUrl". -// src/ScmIntegrations.d.ts:67:5 - (ae-undocumented) Missing documentation for "resolveEditUrl". -// src/awsCodeCommit/AwsCodeCommitIntegration.d.ts:10:5 - (ae-undocumented) Missing documentation for "factory". -// src/awsCodeCommit/AwsCodeCommitIntegration.d.ts:11:5 - (ae-undocumented) Missing documentation for "type". -// src/awsCodeCommit/AwsCodeCommitIntegration.d.ts:12:5 - (ae-undocumented) Missing documentation for "config". -// src/awsCodeCommit/AwsCodeCommitIntegration.d.ts:13:5 - (ae-undocumented) Missing documentation for "title". -// src/awsCodeCommit/AwsCodeCommitIntegration.d.ts:15:5 - (ae-undocumented) Missing documentation for "resolveUrl". -// src/awsCodeCommit/AwsCodeCommitIntegration.d.ts:20:5 - (ae-undocumented) Missing documentation for "resolveEditUrl". -// src/awsS3/AwsS3Integration.d.ts:10:5 - (ae-undocumented) Missing documentation for "factory". -// src/awsS3/AwsS3Integration.d.ts:11:5 - (ae-undocumented) Missing documentation for "type". -// src/awsS3/AwsS3Integration.d.ts:12:5 - (ae-undocumented) Missing documentation for "title". -// src/awsS3/AwsS3Integration.d.ts:13:5 - (ae-undocumented) Missing documentation for "config". -// src/awsS3/AwsS3Integration.d.ts:15:5 - (ae-undocumented) Missing documentation for "resolveUrl". -// src/awsS3/AwsS3Integration.d.ts:20:5 - (ae-undocumented) Missing documentation for "resolveEditUrl". -// src/azure/AzureIntegration.d.ts:10:5 - (ae-undocumented) Missing documentation for "factory". -// src/azure/AzureIntegration.d.ts:12:5 - (ae-undocumented) Missing documentation for "type". -// src/azure/AzureIntegration.d.ts:13:5 - (ae-undocumented) Missing documentation for "title". -// src/azure/AzureIntegration.d.ts:14:5 - (ae-undocumented) Missing documentation for "config". -// src/azure/AzureIntegration.d.ts:15:5 - (ae-undocumented) Missing documentation for "resolveUrl". -// src/azure/AzureIntegration.d.ts:20:5 - (ae-undocumented) Missing documentation for "resolveEditUrl". -// src/azure/DefaultAzureDevOpsCredentialsProvider.d.ts:9:5 - (ae-undocumented) Missing documentation for "fromIntegrations". -// src/azure/DefaultAzureDevOpsCredentialsProvider.d.ts:14:5 - (ae-undocumented) Missing documentation for "getCredentials". -// src/azure/types.d.ts:25:5 - (ae-undocumented) Missing documentation for "getCredentials". -// src/bitbucket/BitbucketIntegration.d.ts:11:5 - (ae-undocumented) Missing documentation for "factory". -// src/bitbucket/BitbucketIntegration.d.ts:13:5 - (ae-undocumented) Missing documentation for "type". -// src/bitbucket/BitbucketIntegration.d.ts:14:5 - (ae-undocumented) Missing documentation for "title". -// src/bitbucket/BitbucketIntegration.d.ts:15:5 - (ae-undocumented) Missing documentation for "config". -// src/bitbucket/BitbucketIntegration.d.ts:16:5 - (ae-undocumented) Missing documentation for "resolveUrl". -// src/bitbucket/BitbucketIntegration.d.ts:21:5 - (ae-undocumented) Missing documentation for "resolveEditUrl". -// src/bitbucketCloud/BitbucketCloudIntegration.d.ts:10:5 - (ae-undocumented) Missing documentation for "factory". -// src/bitbucketCloud/BitbucketCloudIntegration.d.ts:12:5 - (ae-undocumented) Missing documentation for "type". -// src/bitbucketCloud/BitbucketCloudIntegration.d.ts:13:5 - (ae-undocumented) Missing documentation for "title". -// src/bitbucketCloud/BitbucketCloudIntegration.d.ts:14:5 - (ae-undocumented) Missing documentation for "config". -// src/bitbucketCloud/BitbucketCloudIntegration.d.ts:15:5 - (ae-undocumented) Missing documentation for "resolveUrl". -// src/bitbucketCloud/BitbucketCloudIntegration.d.ts:20:5 - (ae-undocumented) Missing documentation for "resolveEditUrl". -// src/bitbucketServer/BitbucketServerIntegration.d.ts:10:5 - (ae-undocumented) Missing documentation for "factory". -// src/bitbucketServer/BitbucketServerIntegration.d.ts:12:5 - (ae-undocumented) Missing documentation for "type". -// src/bitbucketServer/BitbucketServerIntegration.d.ts:13:5 - (ae-undocumented) Missing documentation for "title". -// src/bitbucketServer/BitbucketServerIntegration.d.ts:14:5 - (ae-undocumented) Missing documentation for "config". -// src/bitbucketServer/BitbucketServerIntegration.d.ts:15:5 - (ae-undocumented) Missing documentation for "resolveUrl". -// src/bitbucketServer/BitbucketServerIntegration.d.ts:20:5 - (ae-undocumented) Missing documentation for "resolveEditUrl". -// src/gerrit/GerritIntegration.d.ts:10:5 - (ae-undocumented) Missing documentation for "factory". -// src/gerrit/GerritIntegration.d.ts:12:5 - (ae-undocumented) Missing documentation for "type". -// src/gerrit/GerritIntegration.d.ts:13:5 - (ae-undocumented) Missing documentation for "title". -// src/gerrit/GerritIntegration.d.ts:14:5 - (ae-undocumented) Missing documentation for "config". -// src/gerrit/GerritIntegration.d.ts:15:5 - (ae-undocumented) Missing documentation for "resolveUrl". -// src/gerrit/GerritIntegration.d.ts:20:5 - (ae-undocumented) Missing documentation for "resolveEditUrl". -// src/gitea/GiteaIntegration.d.ts:9:5 - (ae-undocumented) Missing documentation for "config". -// src/gitea/GiteaIntegration.d.ts:10:5 - (ae-undocumented) Missing documentation for "factory". -// src/gitea/GiteaIntegration.d.ts:12:5 - (ae-undocumented) Missing documentation for "type". -// src/gitea/GiteaIntegration.d.ts:13:5 - (ae-undocumented) Missing documentation for "title". -// src/gitea/GiteaIntegration.d.ts:14:5 - (ae-undocumented) Missing documentation for "resolveUrl". -// src/gitea/GiteaIntegration.d.ts:19:5 - (ae-undocumented) Missing documentation for "resolveEditUrl". -// src/github/DefaultGithubCredentialsProvider.d.ts:13:5 - (ae-undocumented) Missing documentation for "fromIntegrations". -// src/github/GithubIntegration.d.ts:11:5 - (ae-undocumented) Missing documentation for "factory". -// src/github/GithubIntegration.d.ts:13:5 - (ae-undocumented) Missing documentation for "type". -// src/github/GithubIntegration.d.ts:14:5 - (ae-undocumented) Missing documentation for "title". -// src/github/GithubIntegration.d.ts:15:5 - (ae-undocumented) Missing documentation for "config". -// src/github/GithubIntegration.d.ts:16:5 - (ae-undocumented) Missing documentation for "resolveUrl". -// src/github/GithubIntegration.d.ts:21:5 - (ae-undocumented) Missing documentation for "resolveEditUrl". -// src/github/GithubIntegration.d.ts:22:5 - (ae-undocumented) Missing documentation for "parseRateLimitInfo". -// src/github/SingleInstanceGithubCredentialsProvider.d.ts:12:5 - (ae-undocumented) Missing documentation for "getAllInstallations". -// src/github/SingleInstanceGithubCredentialsProvider.d.ts:13:5 - (ae-undocumented) Missing documentation for "getAppToken". -// src/github/SingleInstanceGithubCredentialsProvider.d.ts:26:5 - (ae-undocumented) Missing documentation for "create". -// src/github/types.d.ts:26:5 - (ae-undocumented) Missing documentation for "getCredentials". -// src/gitlab/DefaultGitlabCredentialsProvider.d.ts:10:5 - (ae-undocumented) Missing documentation for "fromIntegrations". -// src/gitlab/DefaultGitlabCredentialsProvider.d.ts:12:5 - (ae-undocumented) Missing documentation for "getCredentials". -// src/gitlab/GitLabIntegration.d.ts:10:5 - (ae-undocumented) Missing documentation for "factory". -// src/gitlab/GitLabIntegration.d.ts:12:5 - (ae-undocumented) Missing documentation for "type". -// src/gitlab/GitLabIntegration.d.ts:13:5 - (ae-undocumented) Missing documentation for "title". -// src/gitlab/GitLabIntegration.d.ts:14:5 - (ae-undocumented) Missing documentation for "config". -// src/gitlab/GitLabIntegration.d.ts:15:5 - (ae-undocumented) Missing documentation for "resolveUrl". -// src/gitlab/GitLabIntegration.d.ts:20:5 - (ae-undocumented) Missing documentation for "resolveEditUrl". -// src/gitlab/types.d.ts:4:1 - (ae-undocumented) Missing documentation for "GitlabCredentials". -// src/gitlab/types.d.ts:13:1 - (ae-undocumented) Missing documentation for "GitlabCredentialsProvider". -// src/gitlab/types.d.ts:14:5 - (ae-undocumented) Missing documentation for "getCredentials". -// src/harness/HarnessIntegration.d.ts:9:5 - (ae-undocumented) Missing documentation for "config". -// src/harness/HarnessIntegration.d.ts:10:5 - (ae-undocumented) Missing documentation for "factory". -// src/harness/HarnessIntegration.d.ts:12:5 - (ae-undocumented) Missing documentation for "type". -// src/harness/HarnessIntegration.d.ts:13:5 - (ae-undocumented) Missing documentation for "title". -// src/harness/HarnessIntegration.d.ts:14:5 - (ae-undocumented) Missing documentation for "resolveUrl". -// src/harness/HarnessIntegration.d.ts:19:5 - (ae-undocumented) Missing documentation for "resolveEditUrl". -// src/registry.d.ts:19:5 - (ae-undocumented) Missing documentation for "awsS3". -// src/registry.d.ts:20:5 - (ae-undocumented) Missing documentation for "awsCodeCommit". -// src/registry.d.ts:21:5 - (ae-undocumented) Missing documentation for "azure". -// src/registry.d.ts:25:5 - (ae-undocumented) Missing documentation for "bitbucket". -// src/registry.d.ts:26:5 - (ae-undocumented) Missing documentation for "bitbucketCloud". -// src/registry.d.ts:27:5 - (ae-undocumented) Missing documentation for "bitbucketServer". -// src/registry.d.ts:28:5 - (ae-undocumented) Missing documentation for "gerrit". -// src/registry.d.ts:29:5 - (ae-undocumented) Missing documentation for "github". -// src/registry.d.ts:30:5 - (ae-undocumented) Missing documentation for "gitlab". -// src/registry.d.ts:31:5 - (ae-undocumented) Missing documentation for "gitea". -// src/registry.d.ts:32:5 - (ae-undocumented) Missing documentation for "harness". -// src/types.d.ts:93:5 - (ae-undocumented) Missing documentation for "isRateLimited". ``` diff --git a/packages/repo-tools/src/commands/api-reports/api-extractor.ts b/packages/repo-tools/src/commands/api-reports/api-extractor.ts index c1075f92c1..c55410ce4a 100644 --- a/packages/repo-tools/src/commands/api-reports/api-extractor.ts +++ b/packages/repo-tools/src/commands/api-reports/api-extractor.ts @@ -240,8 +240,6 @@ export async function createTemporaryTsConfig(includedPackageDirs: string[]) { } export async function countApiReportWarnings(reportPath: string) { - console.log(reportPath); - try { const content = await fs.readFile(reportPath, 'utf8'); const lines = content.split('\n'); @@ -378,6 +376,7 @@ export async function runApiExtraction({ logLevel: 'none', }; } + const warnings = new Array(); for (const [packageDir, packageEntryPoints] of Object.entries( @@ -605,8 +604,6 @@ export async function runApiExtraction({ const warningCountAfter = await countApiReportWarnings(reportPath); - console.log({ warningCountAfter, warningCountBefore, warnings }); - if (noBail) { console.log(`Skipping warnings check for ${packageDir}`); } diff --git a/packages/test-utils/report-alpha.api.md b/packages/test-utils/report-alpha.api.md index 19a3786fc9..0c0186a8af 100644 --- a/packages/test-utils/report-alpha.api.md +++ b/packages/test-utils/report-alpha.api.md @@ -28,12 +28,5 @@ export class MockTranslationApi implements TranslationApi { >(): Observable>; } -// Warnings were encountered during analysis: -// -// src/testUtils/apis/TranslationApi/MockTranslationApi.d.ts:7:1 - (ae-undocumented) Missing documentation for "MockTranslationApi". -// src/testUtils/apis/TranslationApi/MockTranslationApi.d.ts:9:5 - (ae-undocumented) Missing documentation for "create". -// src/testUtils/apis/TranslationApi/MockTranslationApi.d.ts:11:5 - (ae-undocumented) Missing documentation for "getTranslation". -// src/testUtils/apis/TranslationApi/MockTranslationApi.d.ts:14:5 - (ae-undocumented) Missing documentation for "translation$". - // (No @packageDocumentation comment for this package) ``` diff --git a/packages/test-utils/report.api.md b/packages/test-utils/report.api.md index 11657ce534..126b7236b3 100644 --- a/packages/test-utils/report.api.md +++ b/packages/test-utils/report.api.md @@ -403,33 +403,4 @@ export function wrapInTestApp( Component: ComponentType | ReactNode, options?: TestAppOptions, ): ReactElement; - -// Warnings were encountered during analysis: -// -// src/deprecated.d.ts:5:1 - (ae-undocumented) Missing documentation for "setupRequestMockHandlers". -// src/testUtils/apis/AnalyticsApi/MockAnalyticsApi.d.ts:11:5 - (ae-undocumented) Missing documentation for "captureEvent". -// src/testUtils/apis/AnalyticsApi/MockAnalyticsApi.d.ts:12:5 - (ae-undocumented) Missing documentation for "getEvents". -// src/testUtils/apis/ErrorApi/MockErrorApi.d.ts:28:5 - (ae-undocumented) Missing documentation for "post". -// src/testUtils/apis/ErrorApi/MockErrorApi.d.ts:29:5 - (ae-undocumented) Missing documentation for "error$". -// src/testUtils/apis/ErrorApi/MockErrorApi.d.ts:33:5 - (ae-undocumented) Missing documentation for "getErrors". -// src/testUtils/apis/ErrorApi/MockErrorApi.d.ts:34:5 - (ae-undocumented) Missing documentation for "waitForError". -// src/testUtils/apis/PermissionApi/MockPermissionApi.d.ts:14:5 - (ae-undocumented) Missing documentation for "authorize". -// src/testUtils/apis/StorageApi/MockStorageApi.d.ts:21:5 - (ae-undocumented) Missing documentation for "create". -// src/testUtils/apis/StorageApi/MockStorageApi.d.ts:22:5 - (ae-undocumented) Missing documentation for "forBucket". -// src/testUtils/apis/StorageApi/MockStorageApi.d.ts:23:5 - (ae-undocumented) Missing documentation for "snapshot". -// src/testUtils/apis/StorageApi/MockStorageApi.d.ts:24:5 - (ae-undocumented) Missing documentation for "set". -// src/testUtils/apis/StorageApi/MockStorageApi.d.ts:25:5 - (ae-undocumented) Missing documentation for "remove". -// src/testUtils/apis/StorageApi/MockStorageApi.d.ts:26:5 - (ae-undocumented) Missing documentation for "observe$". -// src/testUtils/apis/mockApis.d.ts:58:15 - (ae-undocumented) Missing documentation for "factory". -// src/testUtils/apis/mockApis.d.ts:59:15 - (ae-undocumented) Missing documentation for "mock". -// src/testUtils/apis/mockApis.d.ts:125:15 - (ae-undocumented) Missing documentation for "factory". -// src/testUtils/apis/mockApis.d.ts:128:15 - (ae-undocumented) Missing documentation for "mock". -// src/testUtils/apis/mockApis.d.ts:150:15 - (ae-undocumented) Missing documentation for "factory". -// src/testUtils/apis/mockApis.d.ts:158:15 - (ae-undocumented) Missing documentation for "mock". -// src/testUtils/apis/mockApis.d.ts:177:15 - (ae-undocumented) Missing documentation for "factory". -// src/testUtils/apis/mockApis.d.ts:180:15 - (ae-undocumented) Missing documentation for "mock". -// src/testUtils/apis/mockApis.d.ts:197:15 - (ae-undocumented) Missing documentation for "factory". -// src/testUtils/apis/mockApis.d.ts:200:15 - (ae-undocumented) Missing documentation for "mock". -// src/testUtils/apis/mockApis.d.ts:215:15 - (ae-undocumented) Missing documentation for "factory". -// src/testUtils/apis/mockApis.d.ts:216:15 - (ae-undocumented) Missing documentation for "mock". ``` diff --git a/packages/theme/report.api.md b/packages/theme/report.api.md index faec0b8456..4462bb4de7 100644 --- a/packages/theme/report.api.md +++ b/packages/theme/report.api.md @@ -462,30 +462,4 @@ export interface UnifiedThemeProviderProps { // (undocumented) theme: UnifiedTheme; } - -// Warnings were encountered during analysis: -// -// src/base/createBaseThemeOptions.d.ts:14:5 - (ae-undocumented) Missing documentation for "palette". -// src/base/createBaseThemeOptions.d.ts:15:5 - (ae-undocumented) Missing documentation for "defaultPageTheme". -// src/base/createBaseThemeOptions.d.ts:16:5 - (ae-undocumented) Missing documentation for "pageTheme". -// src/base/createBaseThemeOptions.d.ts:17:5 - (ae-undocumented) Missing documentation for "fontFamily". -// src/base/createBaseThemeOptions.d.ts:18:5 - (ae-undocumented) Missing documentation for "htmlFontSize". -// src/base/createBaseThemeOptions.d.ts:19:5 - (ae-undocumented) Missing documentation for "typography". -// src/unified/UnifiedTheme.d.ts:17:5 - (ae-undocumented) Missing documentation for "palette". -// src/unified/UnifiedTheme.d.ts:18:5 - (ae-undocumented) Missing documentation for "defaultPageTheme". -// src/unified/UnifiedTheme.d.ts:19:5 - (ae-undocumented) Missing documentation for "pageTheme". -// src/unified/UnifiedTheme.d.ts:20:5 - (ae-undocumented) Missing documentation for "fontFamily". -// src/unified/UnifiedTheme.d.ts:21:5 - (ae-undocumented) Missing documentation for "htmlFontSize". -// src/unified/UnifiedTheme.d.ts:22:5 - (ae-undocumented) Missing documentation for "components". -// src/unified/UnifiedTheme.d.ts:23:5 - (ae-undocumented) Missing documentation for "typography". -// src/unified/UnifiedThemeProvider.d.ts:9:5 - (ae-undocumented) Missing documentation for "children". -// src/unified/UnifiedThemeProvider.d.ts:10:5 - (ae-undocumented) Missing documentation for "theme". -// src/unified/UnifiedThemeProvider.d.ts:11:5 - (ae-undocumented) Missing documentation for "noCssBaseline". -// src/unified/types.d.ts:25:5 - (ae-undocumented) Missing documentation for "getTheme". -// src/v4/types.d.ts:31:5 - (ae-undocumented) Missing documentation for "palette". -// src/v4/types.d.ts:32:5 - (ae-undocumented) Missing documentation for "page". -// src/v4/types.d.ts:33:5 - (ae-undocumented) Missing documentation for "getPageTheme". -// src/v4/types.d.ts:42:5 - (ae-undocumented) Missing documentation for "palette". -// src/v4/types.d.ts:43:5 - (ae-undocumented) Missing documentation for "page". -// src/v4/types.d.ts:44:5 - (ae-undocumented) Missing documentation for "getPageTheme". ``` diff --git a/packages/yarn-plugin/report.api.md b/packages/yarn-plugin/report.api.md index b246b802bb..f0300ec9a1 100644 --- a/packages/yarn-plugin/report.api.md +++ b/packages/yarn-plugin/report.api.md @@ -8,8 +8,4 @@ import { Plugin as Plugin_2 } from '@yarnpkg/core'; // @public (undocumented) const plugin: Plugin_2; export default plugin; - -// Warnings were encountered during analysis: -// -// src/index.d.ts:11:15 - (ae-undocumented) Missing documentation for "plugin". ``` diff --git a/plugins/api-docs-module-protoc-gen-doc/report.api.md b/plugins/api-docs-module-protoc-gen-doc/report.api.md index 355b867e9a..836f8313d8 100644 --- a/plugins/api-docs-module-protoc-gen-doc/report.api.md +++ b/plugins/api-docs-module-protoc-gen-doc/report.api.md @@ -11,8 +11,4 @@ export const grpcDocsApiWidget: { title: string; component: (definition: string) => React_2.JSX.Element; }; - -// Warnings were encountered during analysis: -// -// src/widgets.d.ts:5:22 - (ae-undocumented) Missing documentation for "grpcDocsApiWidget". ``` diff --git a/plugins/api-docs/report-alpha.api.md b/plugins/api-docs/report-alpha.api.md index 274d5d4aac..820978b877 100644 --- a/plugins/api-docs/report-alpha.api.md +++ b/plugins/api-docs/report-alpha.api.md @@ -427,9 +427,5 @@ const _default: FrontendPlugin< >; export default _default; -// Warnings were encountered during analysis: -// -// src/alpha.d.ts:2:15 - (ae-undocumented) Missing documentation for "_default". - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/api-docs/report.api.md b/plugins/api-docs/report.api.md index 74318781c8..3c3f245a3c 100644 --- a/plugins/api-docs/report.api.md +++ b/plugins/api-docs/report.api.md @@ -229,38 +229,4 @@ export const TrpcApiDefinitionWidget: ( export type TrpcApiDefinitionWidgetProps = { definition: string; }; - -// Warnings were encountered during analysis: -// -// src/components/ApiDefinitionCard/ApiDefinitionCard.d.ts:3:22 - (ae-undocumented) Missing documentation for "ApiDefinitionCard". -// src/components/ApiDefinitionCard/ApiDefinitionWidget.d.ts:3:1 - (ae-undocumented) Missing documentation for "ApiDefinitionWidget". -// src/components/ApiDefinitionCard/ApiDefinitionWidget.d.ts:10:1 - (ae-undocumented) Missing documentation for "defaultDefinitionWidgets". -// src/components/ApiDefinitionCard/ApiTypeTitle.d.ts:6:22 - (ae-undocumented) Missing documentation for "ApiTypeTitle". -// src/components/ApisCards/ConsumedApisCard.d.ts:7:22 - (ae-undocumented) Missing documentation for "ConsumedApisCard". -// src/components/ApisCards/HasApisCard.d.ts:7:22 - (ae-undocumented) Missing documentation for "HasApisCard". -// src/components/ApisCards/ProvidedApisCard.d.ts:7:22 - (ae-undocumented) Missing documentation for "ProvidedApisCard". -// src/components/AsyncApiDefinitionWidget/AsyncApiDefinition.d.ts:4:1 - (ae-undocumented) Missing documentation for "AsyncApiResolver". -// src/components/AsyncApiDefinitionWidget/AsyncApiDefinitionWidget.d.ts:4:1 - (ae-undocumented) Missing documentation for "AsyncApiDefinitionWidgetProps". -// src/components/AsyncApiDefinitionWidget/AsyncApiDefinitionWidget.d.ts:9:22 - (ae-undocumented) Missing documentation for "AsyncApiDefinitionWidget". -// src/components/ComponentsCards/ConsumingComponentsCard.d.ts:7:22 - (ae-undocumented) Missing documentation for "ConsumingComponentsCard". -// src/components/ComponentsCards/ProvidingComponentsCard.d.ts:5:22 - (ae-undocumented) Missing documentation for "ProvidingComponentsCard". -// src/components/GraphQlDefinitionWidget/GraphQlDefinitionWidget.d.ts:3:1 - (ae-undocumented) Missing documentation for "GraphQlDefinitionWidgetProps". -// src/components/GraphQlDefinitionWidget/GraphQlDefinitionWidget.d.ts:7:22 - (ae-undocumented) Missing documentation for "GraphQlDefinitionWidget". -// src/components/OpenApiDefinitionWidget/OpenApiDefinitionWidget.d.ts:3:1 - (ae-undocumented) Missing documentation for "OpenApiDefinitionWidgetProps". -// src/components/OpenApiDefinitionWidget/OpenApiDefinitionWidget.d.ts:9:22 - (ae-undocumented) Missing documentation for "OpenApiDefinitionWidget". -// src/components/PlainApiDefinitionWidget/PlainApiDefinitionWidget.d.ts:3:1 - (ae-undocumented) Missing documentation for "PlainApiDefinitionWidgetProps". -// src/components/PlainApiDefinitionWidget/PlainApiDefinitionWidget.d.ts:8:22 - (ae-undocumented) Missing documentation for "PlainApiDefinitionWidget". -// src/components/TrpcDefinitionWidget/TrpcApiDefinitionWidget.d.ts:3:1 - (ae-undocumented) Missing documentation for "TrpcApiDefinitionWidgetProps". -// src/components/TrpcDefinitionWidget/TrpcApiDefinitionWidget.d.ts:7:22 - (ae-undocumented) Missing documentation for "TrpcApiDefinitionWidget". -// src/config.d.ts:4:22 - (ae-undocumented) Missing documentation for "apiDocsConfigRef". -// src/config.d.ts:6:1 - (ae-undocumented) Missing documentation for "ApiDocsConfig". -// src/config.d.ts:7:5 - (ae-undocumented) Missing documentation for "getApiDefinitionWidget". -// src/plugin.d.ts:4:22 - (ae-undocumented) Missing documentation for "apiDocsPlugin". -// src/plugin.d.ts:10:22 - (ae-undocumented) Missing documentation for "ApiExplorerPage". -// src/plugin.d.ts:12:22 - (ae-undocumented) Missing documentation for "EntityApiDefinitionCard". -// src/plugin.d.ts:14:22 - (ae-undocumented) Missing documentation for "EntityConsumedApisCard". -// src/plugin.d.ts:21:22 - (ae-undocumented) Missing documentation for "EntityConsumingComponentsCard". -// src/plugin.d.ts:26:22 - (ae-undocumented) Missing documentation for "EntityProvidedApisCard". -// src/plugin.d.ts:33:22 - (ae-undocumented) Missing documentation for "EntityProvidingComponentsCard". -// src/plugin.d.ts:38:22 - (ae-undocumented) Missing documentation for "EntityHasApisCard". ``` diff --git a/plugins/app-backend/report-alpha.api.md b/plugins/app-backend/report-alpha.api.md index f5bd67554d..78c4b97232 100644 --- a/plugins/app-backend/report-alpha.api.md +++ b/plugins/app-backend/report-alpha.api.md @@ -9,9 +9,5 @@ import { BackendFeature } from '@backstage/backend-plugin-api'; const _appPlugin: BackendFeature; export default _appPlugin; -// Warnings were encountered during analysis: -// -// src/alpha.d.ts:2:15 - (ae-undocumented) Missing documentation for "_appPlugin". - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/app-backend/report.api.md b/plugins/app-backend/report.api.md index 4ec356951f..35e7ea383d 100644 --- a/plugins/app-backend/report.api.md +++ b/plugins/app-backend/report.api.md @@ -35,13 +35,4 @@ export interface RouterOptions { schema?: ConfigSchema; staticFallbackHandler?: express.Handler; } - -// Warnings were encountered during analysis: -// -// src/service/router.d.ts:9:1 - (ae-undocumented) Missing documentation for "RouterOptions". -// src/service/router.d.ts:10:5 - (ae-undocumented) Missing documentation for "config". -// src/service/router.d.ts:11:5 - (ae-undocumented) Missing documentation for "logger". -// src/service/router.d.ts:12:5 - (ae-undocumented) Missing documentation for "auth". -// src/service/router.d.ts:13:5 - (ae-undocumented) Missing documentation for "httpAuth". -// src/service/router.d.ts:61:1 - (ae-undocumented) Missing documentation for "createRouter". ``` diff --git a/plugins/app-visualizer/report.api.md b/plugins/app-visualizer/report.api.md index 15f7384c42..48eca04ed8 100644 --- a/plugins/app-visualizer/report.api.md +++ b/plugins/app-visualizer/report.api.md @@ -71,9 +71,5 @@ const visualizerPlugin: FrontendPlugin< >; export default visualizerPlugin; -// Warnings were encountered during analysis: -// -// src/plugin.d.ts:20:22 - (ae-undocumented) Missing documentation for "visualizerPlugin". - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/app/report.api.md b/plugins/app/report.api.md index 208f9dcfb0..89dde35f78 100644 --- a/plugins/app/report.api.md +++ b/plugins/app/report.api.md @@ -754,9 +754,5 @@ const appPlugin: FrontendPlugin< >; export default appPlugin; -// Warnings were encountered during analysis: -// -// src/plugin.d.ts:3:22 - (ae-undocumented) Missing documentation for "appPlugin". - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/auth-backend-module-atlassian-provider/report.api.md b/plugins/auth-backend-module-atlassian-provider/report.api.md index 7f32330451..7abdf7ee70 100644 --- a/plugins/auth-backend-module-atlassian-provider/report.api.md +++ b/plugins/auth-backend-module-atlassian-provider/report.api.md @@ -27,9 +27,4 @@ export namespace atlassianSignInResolvers { // @public (undocumented) const authModuleAtlassianProvider: BackendFeature; export default authModuleAtlassianProvider; - -// Warnings were encountered during analysis: -// -// src/authenticator.d.ts:3:22 - (ae-undocumented) Missing documentation for "atlassianAuthenticator". -// src/module.d.ts:2:22 - (ae-undocumented) Missing documentation for "authModuleAtlassianProvider". ``` diff --git a/plugins/auth-backend-module-auth0-provider/report.api.md b/plugins/auth-backend-module-auth0-provider/report.api.md index 2d1b9074b4..fb7aa9d0ba 100644 --- a/plugins/auth-backend-module-auth0-provider/report.api.md +++ b/plugins/auth-backend-module-auth0-provider/report.api.md @@ -22,9 +22,4 @@ export const auth0Authenticator: OAuthAuthenticator< // @public (undocumented) const authModuleAuth0Provider: BackendFeature; export default authModuleAuth0Provider; - -// Warnings were encountered during analysis: -// -// src/authenticator.d.ts:3:22 - (ae-undocumented) Missing documentation for "auth0Authenticator". -// src/module.d.ts:2:22 - (ae-undocumented) Missing documentation for "authModuleAuth0Provider". ``` diff --git a/plugins/auth-backend-module-aws-alb-provider/report.api.md b/plugins/auth-backend-module-aws-alb-provider/report.api.md index c7437a1b9d..b3a9ce4517 100644 --- a/plugins/auth-backend-module-aws-alb-provider/report.api.md +++ b/plugins/auth-backend-module-aws-alb-provider/report.api.md @@ -46,10 +46,4 @@ export namespace awsAlbSignInResolvers { unknown >; } - -// Warnings were encountered during analysis: -// -// src/authenticator.d.ts:6:22 - (ae-undocumented) Missing documentation for "awsAlbAuthenticator". -// src/module.d.ts:2:22 - (ae-undocumented) Missing documentation for "authModuleAwsAlbProvider". -// src/resolvers.d.ts:8:11 - (ae-undocumented) Missing documentation for "emailMatchingUserEntityProfileEmail". ``` diff --git a/plugins/auth-backend-module-azure-easyauth-provider/report.api.md b/plugins/auth-backend-module-azure-easyauth-provider/report.api.md index 3292654787..9d337e3f34 100644 --- a/plugins/auth-backend-module-azure-easyauth-provider/report.api.md +++ b/plugins/auth-backend-module-azure-easyauth-provider/report.api.md @@ -36,13 +36,5 @@ export namespace azureEasyAuthSignInResolvers { >; } -// Warnings were encountered during analysis: -// -// src/authenticator.d.ts:5:22 - (ae-undocumented) Missing documentation for "azureEasyAuthAuthenticator". -// src/module.d.ts:2:22 - (ae-undocumented) Missing documentation for "authModuleAzureEasyAuthProvider". -// src/resolvers.d.ts:3:1 - (ae-undocumented) Missing documentation for "azureEasyAuthSignInResolvers". -// src/resolvers.d.ts:4:11 - (ae-undocumented) Missing documentation for "idMatchingUserEntityAnnotation". -// src/types.d.ts:3:1 - (ae-undocumented) Missing documentation for "AzureEasyAuthResult". - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/auth-backend-module-bitbucket-provider/report.api.md b/plugins/auth-backend-module-bitbucket-provider/report.api.md index 210a292050..ceb4141fd9 100644 --- a/plugins/auth-backend-module-bitbucket-provider/report.api.md +++ b/plugins/auth-backend-module-bitbucket-provider/report.api.md @@ -31,9 +31,4 @@ export namespace bitbucketSignInResolvers { unknown >; } - -// Warnings were encountered during analysis: -// -// src/authenticator.d.ts:3:22 - (ae-undocumented) Missing documentation for "bitbucketAuthenticator". -// src/module.d.ts:2:22 - (ae-undocumented) Missing documentation for "authModuleBitbucketProvider". ``` diff --git a/plugins/auth-backend-module-bitbucket-server-provider/report.api.md b/plugins/auth-backend-module-bitbucket-server-provider/report.api.md index 371873027a..d5c484f6e3 100644 --- a/plugins/auth-backend-module-bitbucket-server-provider/report.api.md +++ b/plugins/auth-backend-module-bitbucket-server-provider/report.api.md @@ -30,9 +30,4 @@ export namespace bitbucketServerSignInResolvers { unknown >; } - -// Warnings were encountered during analysis: -// -// src/authenticator.d.ts:3:22 - (ae-undocumented) Missing documentation for "bitbucketServerAuthenticator". -// src/module.d.ts:2:22 - (ae-undocumented) Missing documentation for "authModuleBitbucketServerProvider". ``` diff --git a/plugins/auth-backend-module-cloudflare-access-provider/report.api.md b/plugins/auth-backend-module-cloudflare-access-provider/report.api.md index b9943b2bef..1547190d39 100644 --- a/plugins/auth-backend-module-cloudflare-access-provider/report.api.md +++ b/plugins/auth-backend-module-cloudflare-access-provider/report.api.md @@ -60,10 +60,4 @@ export namespace cloudflareAccessSignInResolvers { export function createCloudflareAccessAuthenticator(options?: { cache?: CacheService; }): ProxyAuthenticator; - -// Warnings were encountered during analysis: -// -// src/types.d.ts:55:1 - (ae-undocumented) Missing documentation for "CloudflareAccessGroup". -// src/types.d.ts:72:1 - (ae-undocumented) Missing documentation for "CloudflareAccessIdentityProfile". -// src/types.d.ts:81:1 - (ae-undocumented) Missing documentation for "CloudflareAccessResult". ``` diff --git a/plugins/auth-backend-module-gcp-iap-provider/report.api.md b/plugins/auth-backend-module-gcp-iap-provider/report.api.md index 72887276d5..1476694f99 100644 --- a/plugins/auth-backend-module-gcp-iap-provider/report.api.md +++ b/plugins/auth-backend-module-gcp-iap-provider/report.api.md @@ -50,10 +50,5 @@ export type GcpIapTokenInfo = { [key: string]: JsonPrimitive; }; -// Warnings were encountered during analysis: -// -// src/authenticator.d.ts:2:22 - (ae-undocumented) Missing documentation for "gcpIapAuthenticator". -// src/module.d.ts:2:22 - (ae-undocumented) Missing documentation for "authModuleGcpIapProvider". - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/auth-backend-module-github-provider/report.api.md b/plugins/auth-backend-module-github-provider/report.api.md index 0578c23d3e..222305adfd 100644 --- a/plugins/auth-backend-module-github-provider/report.api.md +++ b/plugins/auth-backend-module-github-provider/report.api.md @@ -27,9 +27,4 @@ export namespace githubSignInResolvers { unknown >; } - -// Warnings were encountered during analysis: -// -// src/authenticator.d.ts:3:22 - (ae-undocumented) Missing documentation for "githubAuthenticator". -// src/module.d.ts:2:22 - (ae-undocumented) Missing documentation for "authModuleGithubProvider". ``` diff --git a/plugins/auth-backend-module-gitlab-provider/report.api.md b/plugins/auth-backend-module-gitlab-provider/report.api.md index a72c00c6e5..44c5ffb214 100644 --- a/plugins/auth-backend-module-gitlab-provider/report.api.md +++ b/plugins/auth-backend-module-gitlab-provider/report.api.md @@ -27,9 +27,4 @@ export namespace gitlabSignInResolvers { unknown >; } - -// Warnings were encountered during analysis: -// -// src/authenticator.d.ts:3:22 - (ae-undocumented) Missing documentation for "gitlabAuthenticator". -// src/module.d.ts:2:22 - (ae-undocumented) Missing documentation for "authModuleGitlabProvider". ``` diff --git a/plugins/auth-backend-module-google-provider/report.api.md b/plugins/auth-backend-module-google-provider/report.api.md index a2fc1bbce9..eeefb8e837 100644 --- a/plugins/auth-backend-module-google-provider/report.api.md +++ b/plugins/auth-backend-module-google-provider/report.api.md @@ -28,10 +28,5 @@ export namespace googleSignInResolvers { >; } -// Warnings were encountered during analysis: -// -// src/authenticator.d.ts:3:22 - (ae-undocumented) Missing documentation for "googleAuthenticator". -// src/module.d.ts:2:22 - (ae-undocumented) Missing documentation for "authModuleGoogleProvider". - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/auth-backend-module-guest-provider/report.api.md b/plugins/auth-backend-module-guest-provider/report.api.md index b100e5270b..b0ba5386a2 100644 --- a/plugins/auth-backend-module-guest-provider/report.api.md +++ b/plugins/auth-backend-module-guest-provider/report.api.md @@ -8,8 +8,4 @@ import { BackendFeature } from '@backstage/backend-plugin-api'; // @public (undocumented) const authModuleGuestProvider: BackendFeature; export default authModuleGuestProvider; - -// Warnings were encountered during analysis: -// -// src/module.d.ts:2:22 - (ae-undocumented) Missing documentation for "authModuleGuestProvider". ``` diff --git a/plugins/auth-backend-module-microsoft-provider/report.api.md b/plugins/auth-backend-module-microsoft-provider/report.api.md index 3e7775cfa8..6aef395d7c 100644 --- a/plugins/auth-backend-module-microsoft-provider/report.api.md +++ b/plugins/auth-backend-module-microsoft-provider/report.api.md @@ -37,10 +37,4 @@ export namespace microsoftSignInResolvers { unknown >; } - -// Warnings were encountered during analysis: -// -// src/authenticator.d.ts:3:22 - (ae-undocumented) Missing documentation for "microsoftAuthenticator". -// src/deprecated.d.ts:5:22 - (ae-undocumented) Missing documentation for "authModuleMicrosoftProvider". -// src/module.d.ts:2:22 - (ae-undocumented) Missing documentation for "authModuleMicrosoftProvider". ``` diff --git a/plugins/auth-backend-module-oauth2-provider/report.api.md b/plugins/auth-backend-module-oauth2-provider/report.api.md index 5648d043a2..632591ec04 100644 --- a/plugins/auth-backend-module-oauth2-provider/report.api.md +++ b/plugins/auth-backend-module-oauth2-provider/report.api.md @@ -27,9 +27,4 @@ export namespace oauth2SignInResolvers { unknown >; } - -// Warnings were encountered during analysis: -// -// src/authenticator.d.ts:3:22 - (ae-undocumented) Missing documentation for "oauth2Authenticator". -// src/module.d.ts:2:22 - (ae-undocumented) Missing documentation for "authModuleOauth2Provider". ``` diff --git a/plugins/auth-backend-module-oauth2-proxy-provider/report.api.md b/plugins/auth-backend-module-oauth2-proxy-provider/report.api.md index 27b3a9feb2..5c5cefd734 100644 --- a/plugins/auth-backend-module-oauth2-proxy-provider/report.api.md +++ b/plugins/auth-backend-module-oauth2-proxy-provider/report.api.md @@ -32,9 +32,4 @@ export type OAuth2ProxyResult = { headers: IncomingHttpHeaders; getHeader(name: string): string | undefined; }; - -// Warnings were encountered during analysis: -// -// src/authenticator.d.ts:10:22 - (ae-undocumented) Missing documentation for "oauth2ProxyAuthenticator". -// src/module.d.ts:2:22 - (ae-undocumented) Missing documentation for "authModuleOauth2ProxyProvider". ``` diff --git a/plugins/auth-backend-module-oidc-provider/report.api.md b/plugins/auth-backend-module-oidc-provider/report.api.md index bee9a2fdd9..93c000c2ee 100644 --- a/plugins/auth-backend-module-oidc-provider/report.api.md +++ b/plugins/auth-backend-module-oidc-provider/report.api.md @@ -49,9 +49,4 @@ export namespace oidcSignInResolvers { unknown >; } - -// Warnings were encountered during analysis: -// -// src/authenticator.d.ts:13:22 - (ae-undocumented) Missing documentation for "oidcAuthenticator". -// src/module.d.ts:2:22 - (ae-undocumented) Missing documentation for "authModuleOidcProvider". ``` diff --git a/plugins/auth-backend-module-okta-provider/report.api.md b/plugins/auth-backend-module-okta-provider/report.api.md index 97e587df76..a142265100 100644 --- a/plugins/auth-backend-module-okta-provider/report.api.md +++ b/plugins/auth-backend-module-okta-provider/report.api.md @@ -27,9 +27,4 @@ export namespace oktaSignInResolvers { unknown >; } - -// Warnings were encountered during analysis: -// -// src/authenticator.d.ts:3:22 - (ae-undocumented) Missing documentation for "oktaAuthenticator". -// src/module.d.ts:2:22 - (ae-undocumented) Missing documentation for "authModuleOktaProvider". ``` diff --git a/plugins/auth-backend-module-onelogin-provider/report.api.md b/plugins/auth-backend-module-onelogin-provider/report.api.md index a636d96ae0..1991f00e0b 100644 --- a/plugins/auth-backend-module-onelogin-provider/report.api.md +++ b/plugins/auth-backend-module-onelogin-provider/report.api.md @@ -27,9 +27,4 @@ export namespace oneLoginSignInResolvers { unknown >; } - -// Warnings were encountered during analysis: -// -// src/authenticator.d.ts:3:22 - (ae-undocumented) Missing documentation for "oneLoginAuthenticator". -// src/module.d.ts:2:22 - (ae-undocumented) Missing documentation for "authModuleOneLoginProvider". ``` diff --git a/plugins/auth-backend-module-pinniped-provider/report.api.md b/plugins/auth-backend-module-pinniped-provider/report.api.md index a0500f5e74..e15f4ee324 100644 --- a/plugins/auth-backend-module-pinniped-provider/report.api.md +++ b/plugins/auth-backend-module-pinniped-provider/report.api.md @@ -37,12 +37,4 @@ export class PinnipedStrategyCache { client: BaseClient; }>; } - -// Warnings were encountered during analysis: -// -// src/authenticator.d.ts:4:1 - (ae-undocumented) Missing documentation for "PinnipedStrategyCache". -// src/authenticator.d.ts:11:5 - (ae-undocumented) Missing documentation for "getStrategy". -// src/authenticator.d.ts:20:22 - (ae-undocumented) Missing documentation for "pinnipedAuthenticator". -// src/deprecated.d.ts:5:22 - (ae-undocumented) Missing documentation for "authModulePinnipedProvider". -// src/module.d.ts:2:22 - (ae-undocumented) Missing documentation for "authModulePinnipedProvider". ``` diff --git a/plugins/auth-backend-module-vmware-cloud-provider/report.api.md b/plugins/auth-backend-module-vmware-cloud-provider/report.api.md index 1bd10c7eae..46cf7810ca 100644 --- a/plugins/auth-backend-module-vmware-cloud-provider/report.api.md +++ b/plugins/auth-backend-module-vmware-cloud-provider/report.api.md @@ -33,12 +33,4 @@ export interface VMwareCloudAuthenticatorContext { export type VMwarePassportProfile = PassportProfile & { organizationId?: string; }; - -// Warnings were encountered during analysis: -// -// src/authenticator.d.ts:4:1 - (ae-undocumented) Missing documentation for "VMwareCloudAuthenticatorContext". -// src/authenticator.d.ts:5:5 - (ae-undocumented) Missing documentation for "organizationId". -// src/authenticator.d.ts:6:5 - (ae-undocumented) Missing documentation for "providerStrategy". -// src/authenticator.d.ts:7:5 - (ae-undocumented) Missing documentation for "helper". -// src/authenticator.d.ts:10:1 - (ae-undocumented) Missing documentation for "VMwarePassportProfile". ``` diff --git a/plugins/auth-backend/report.api.md b/plugins/auth-backend/report.api.md index 80976525d3..20690528d1 100644 --- a/plugins/auth-backend/report.api.md +++ b/plugins/auth-backend/report.api.md @@ -700,68 +700,4 @@ export const verifyNonce: (req: express.Request, providerId: string) => void; // @public @deprecated (undocumented) export type WebMessageResponse = WebMessageResponse_2; - -// Warnings were encountered during analysis: -// -// src/identity/types.d.ts:13:1 - (ae-undocumented) Missing documentation for "TokenParams". -// src/lib/flow/authFlowHelpers.d.ts:8:22 - (ae-undocumented) Missing documentation for "postMessageResponse". -// src/lib/flow/authFlowHelpers.d.ts:13:22 - (ae-undocumented) Missing documentation for "ensuresXRequestedWith". -// src/lib/flow/types.d.ts:6:1 - (ae-undocumented) Missing documentation for "WebMessageResponse". -// src/lib/oauth/OAuthAdapter.d.ts:10:1 - (ae-undocumented) Missing documentation for "OAuthAdapterOptions". -// src/lib/oauth/OAuthAdapter.d.ts:23:1 - (ae-undocumented) Missing documentation for "OAuthAdapter". -// src/lib/oauth/OAuthAdapter.d.ts:26:5 - (ae-undocumented) Missing documentation for "fromConfig". -// src/lib/oauth/OAuthAdapter.d.ts:29:5 - (ae-undocumented) Missing documentation for "start". -// src/lib/oauth/OAuthAdapter.d.ts:30:5 - (ae-undocumented) Missing documentation for "frameHandler". -// src/lib/oauth/OAuthAdapter.d.ts:31:5 - (ae-undocumented) Missing documentation for "logout". -// src/lib/oauth/OAuthAdapter.d.ts:32:5 - (ae-undocumented) Missing documentation for "refresh". -// src/lib/oauth/OAuthEnvironmentHandler.d.ts:6:22 - (ae-undocumented) Missing documentation for "OAuthEnvironmentHandler". -// src/lib/oauth/helpers.d.ts:7:22 - (ae-undocumented) Missing documentation for "readState". -// src/lib/oauth/helpers.d.ts:12:22 - (ae-undocumented) Missing documentation for "encodeState". -// src/lib/oauth/helpers.d.ts:17:22 - (ae-undocumented) Missing documentation for "verifyNonce". -// src/lib/oauth/types.d.ts:29:1 - (ae-undocumented) Missing documentation for "OAuthResult". -// src/lib/oauth/types.d.ts:44:1 - (ae-undocumented) Missing documentation for "OAuthResponse". -// src/lib/oauth/types.d.ts:53:1 - (ae-undocumented) Missing documentation for "OAuthProviderInfo". -// src/lib/oauth/types.d.ts:75:1 - (ae-undocumented) Missing documentation for "OAuthState". -// src/lib/oauth/types.d.ts:80:1 - (ae-undocumented) Missing documentation for "OAuthStartRequest". -// src/lib/oauth/types.d.ts:88:1 - (ae-undocumented) Missing documentation for "OAuthRefreshRequest". -// src/lib/oauth/types.d.ts:96:1 - (ae-undocumented) Missing documentation for "OAuthLogoutRequest". -// src/lib/oauth/types.d.ts:103:1 - (ae-undocumented) Missing documentation for "OAuthHandlers". -// src/providers/azure-easyauth/index.d.ts:7:1 - (ae-undocumented) Missing documentation for "EasyAuthResult". -// src/providers/bitbucket/provider.d.ts:9:1 - (ae-undocumented) Missing documentation for "BitbucketOAuthResult". -// src/providers/bitbucket/provider.d.ts:23:1 - (ae-undocumented) Missing documentation for "BitbucketPassportProfile". -// src/providers/bitbucketServer/provider.d.ts:9:1 - (ae-undocumented) Missing documentation for "BitbucketServerOAuthResult". -// src/providers/cloudflare-access/provider.d.ts:90:1 - (ae-undocumented) Missing documentation for "CloudflareAccessResult". -// src/providers/github/provider.d.ts:5:1 - (ae-undocumented) Missing documentation for "GithubOAuthResult". -// src/providers/oauth2-proxy/index.d.ts:7:1 - (ae-undocumented) Missing documentation for "OAuth2ProxyResult". -// src/providers/oidc/index.d.ts:7:1 - (ae-undocumented) Missing documentation for "OidcAuthResult". -// src/providers/prepareBackstageIdentityResponse.d.ts:6:22 - (ae-undocumented) Missing documentation for "prepareBackstageIdentityResponse". -// src/providers/router.d.ts:9:1 - (ae-undocumented) Missing documentation for "ProviderFactories". -// src/providers/router.d.ts:27:1 - (ae-undocumented) Missing documentation for "createOriginFilter". -// src/providers/saml/provider.d.ts:6:1 - (ae-undocumented) Missing documentation for "SamlAuthResult". -// src/providers/types.d.ts:7:1 - (ae-undocumented) Missing documentation for "AuthResolverCatalogUserQuery". -// src/providers/types.d.ts:12:1 - (ae-undocumented) Missing documentation for "AuthResolverContext". -// src/providers/types.d.ts:17:1 - (ae-undocumented) Missing documentation for "CookieConfigurer". -// src/providers/types.d.ts:22:1 - (ae-undocumented) Missing documentation for "OAuthStartResponse". -// src/providers/types.d.ts:36:1 - (ae-undocumented) Missing documentation for "AuthProviderConfig". -// src/providers/types.d.ts:41:1 - (ae-undocumented) Missing documentation for "AuthProviderRouteHandlers". -// src/providers/types.d.ts:46:1 - (ae-undocumented) Missing documentation for "AuthProviderFactory". -// src/providers/types.d.ts:51:1 - (ae-undocumented) Missing documentation for "AuthResponse". -// src/providers/types.d.ts:56:1 - (ae-undocumented) Missing documentation for "ProfileInfo". -// src/providers/types.d.ts:61:1 - (ae-undocumented) Missing documentation for "SignInInfo". -// src/providers/types.d.ts:66:1 - (ae-undocumented) Missing documentation for "SignInResolver". -// src/providers/types.d.ts:96:1 - (ae-undocumented) Missing documentation for "StateEncoder". -// src/service/router.d.ts:11:1 - (ae-undocumented) Missing documentation for "RouterOptions". -// src/service/router.d.ts:12:5 - (ae-undocumented) Missing documentation for "logger". -// src/service/router.d.ts:13:5 - (ae-undocumented) Missing documentation for "database". -// src/service/router.d.ts:14:5 - (ae-undocumented) Missing documentation for "config". -// src/service/router.d.ts:15:5 - (ae-undocumented) Missing documentation for "discovery". -// src/service/router.d.ts:16:5 - (ae-undocumented) Missing documentation for "tokenManager". -// src/service/router.d.ts:17:5 - (ae-undocumented) Missing documentation for "auth". -// src/service/router.d.ts:18:5 - (ae-undocumented) Missing documentation for "httpAuth". -// src/service/router.d.ts:19:5 - (ae-undocumented) Missing documentation for "tokenFactoryAlgorithm". -// src/service/router.d.ts:20:5 - (ae-undocumented) Missing documentation for "providerFactories". -// src/service/router.d.ts:21:5 - (ae-undocumented) Missing documentation for "disableDefaultProviderFactories". -// src/service/router.d.ts:22:5 - (ae-undocumented) Missing documentation for "catalogApi". -// src/service/router.d.ts:23:5 - (ae-undocumented) Missing documentation for "ownershipResolver". -// src/service/router.d.ts:29:1 - (ae-undocumented) Missing documentation for "createRouter". ``` diff --git a/plugins/auth-node/report.api.md b/plugins/auth-node/report.api.md index 5d3fce8f23..db61257f7a 100644 --- a/plugins/auth-node/report.api.md +++ b/plugins/auth-node/report.api.md @@ -700,128 +700,4 @@ export type WebMessageResponse = type: 'authorization_response'; error: Error; }; - -// Warnings were encountered during analysis: -// -// src/extensions/AuthOwnershipResolutionExtensionPoint.d.ts:3:1 - (ae-undocumented) Missing documentation for "AuthOwnershipResolutionExtensionPoint". -// src/extensions/AuthOwnershipResolutionExtensionPoint.d.ts:4:5 - (ae-undocumented) Missing documentation for "setAuthOwnershipResolver". -// src/extensions/AuthOwnershipResolutionExtensionPoint.d.ts:7:22 - (ae-undocumented) Missing documentation for "authOwnershipResolutionExtensionPoint". -// src/extensions/AuthProvidersExtensionPoint.d.ts:3:1 - (ae-undocumented) Missing documentation for "AuthProviderRegistrationOptions". -// src/extensions/AuthProvidersExtensionPoint.d.ts:4:5 - (ae-undocumented) Missing documentation for "providerId". -// src/extensions/AuthProvidersExtensionPoint.d.ts:5:5 - (ae-undocumented) Missing documentation for "factory". -// src/extensions/AuthProvidersExtensionPoint.d.ts:8:1 - (ae-undocumented) Missing documentation for "AuthProvidersExtensionPoint". -// src/extensions/AuthProvidersExtensionPoint.d.ts:9:5 - (ae-undocumented) Missing documentation for "registerProvider". -// src/extensions/AuthProvidersExtensionPoint.d.ts:12:22 - (ae-undocumented) Missing documentation for "authProvidersExtensionPoint". -// src/flow/sendWebMessageResponse.d.ts:17:1 - (ae-undocumented) Missing documentation for "sendWebMessageResponse". -// src/identity/DefaultIdentityClient.d.ts:35:5 - (ae-undocumented) Missing documentation for "getIdentity". -// src/identity/IdentityClient.d.ts:13:5 - (ae-undocumented) Missing documentation for "create". -// src/oauth/OAuthEnvironmentHandler.d.ts:5:1 - (ae-undocumented) Missing documentation for "OAuthEnvironmentHandler". -// src/oauth/OAuthEnvironmentHandler.d.ts:7:5 - (ae-undocumented) Missing documentation for "mapConfig". -// src/oauth/OAuthEnvironmentHandler.d.ts:9:5 - (ae-undocumented) Missing documentation for "start". -// src/oauth/OAuthEnvironmentHandler.d.ts:10:5 - (ae-undocumented) Missing documentation for "frameHandler". -// src/oauth/OAuthEnvironmentHandler.d.ts:11:5 - (ae-undocumented) Missing documentation for "refresh". -// src/oauth/OAuthEnvironmentHandler.d.ts:12:5 - (ae-undocumented) Missing documentation for "logout". -// src/oauth/PassportOAuthAuthenticatorHelper.d.ts:6:1 - (ae-undocumented) Missing documentation for "PassportOAuthResult". -// src/oauth/PassportOAuthAuthenticatorHelper.d.ts:17:1 - (ae-undocumented) Missing documentation for "PassportOAuthPrivateInfo". -// src/oauth/PassportOAuthAuthenticatorHelper.d.ts:21:1 - (ae-undocumented) Missing documentation for "PassportOAuthDoneCallback". -// src/oauth/PassportOAuthAuthenticatorHelper.d.ts:23:1 - (ae-undocumented) Missing documentation for "PassportOAuthAuthenticatorHelper". -// src/oauth/PassportOAuthAuthenticatorHelper.d.ts:25:5 - (ae-undocumented) Missing documentation for "defaultProfileTransform". -// src/oauth/PassportOAuthAuthenticatorHelper.d.ts:26:5 - (ae-undocumented) Missing documentation for "from". -// src/oauth/PassportOAuthAuthenticatorHelper.d.ts:28:5 - (ae-undocumented) Missing documentation for "start". -// src/oauth/PassportOAuthAuthenticatorHelper.d.ts:32:5 - (ae-undocumented) Missing documentation for "authenticate". -// src/oauth/PassportOAuthAuthenticatorHelper.d.ts:33:5 - (ae-undocumented) Missing documentation for "refresh". -// src/oauth/PassportOAuthAuthenticatorHelper.d.ts:34:5 - (ae-undocumented) Missing documentation for "fetchProfile". -// src/oauth/createOAuthProviderFactory.d.ts:6:1 - (ae-undocumented) Missing documentation for "createOAuthProviderFactory". -// src/oauth/createOAuthRouteHandlers.d.ts:6:1 - (ae-undocumented) Missing documentation for "OAuthRouteHandlersOptions". -// src/oauth/createOAuthRouteHandlers.d.ts:7:5 - (ae-undocumented) Missing documentation for "authenticator". -// src/oauth/createOAuthRouteHandlers.d.ts:8:5 - (ae-undocumented) Missing documentation for "appUrl". -// src/oauth/createOAuthRouteHandlers.d.ts:9:5 - (ae-undocumented) Missing documentation for "baseUrl". -// src/oauth/createOAuthRouteHandlers.d.ts:10:5 - (ae-undocumented) Missing documentation for "isOriginAllowed". -// src/oauth/createOAuthRouteHandlers.d.ts:11:5 - (ae-undocumented) Missing documentation for "providerId". -// src/oauth/createOAuthRouteHandlers.d.ts:12:5 - (ae-undocumented) Missing documentation for "config". -// src/oauth/createOAuthRouteHandlers.d.ts:13:5 - (ae-undocumented) Missing documentation for "resolverContext". -// src/oauth/createOAuthRouteHandlers.d.ts:14:5 - (ae-undocumented) Missing documentation for "additionalScopes". -// src/oauth/createOAuthRouteHandlers.d.ts:15:5 - (ae-undocumented) Missing documentation for "stateTransform". -// src/oauth/createOAuthRouteHandlers.d.ts:16:5 - (ae-undocumented) Missing documentation for "profileTransform". -// src/oauth/createOAuthRouteHandlers.d.ts:17:5 - (ae-undocumented) Missing documentation for "cookieConfigurer". -// src/oauth/createOAuthRouteHandlers.d.ts:18:5 - (ae-undocumented) Missing documentation for "signInResolver". -// src/oauth/createOAuthRouteHandlers.d.ts:21:1 - (ae-undocumented) Missing documentation for "createOAuthRouteHandlers". -// src/oauth/state.d.ts:16:1 - (ae-undocumented) Missing documentation for "OAuthStateTransform". -// src/oauth/state.d.ts:22:1 - (ae-undocumented) Missing documentation for "encodeOAuthState". -// src/oauth/state.d.ts:24:1 - (ae-undocumented) Missing documentation for "decodeOAuthState". -// src/oauth/types.d.ts:5:1 - (ae-undocumented) Missing documentation for "OAuthSession". -// src/oauth/types.d.ts:6:5 - (ae-undocumented) Missing documentation for "accessToken". -// src/oauth/types.d.ts:7:5 - (ae-undocumented) Missing documentation for "tokenType". -// src/oauth/types.d.ts:8:5 - (ae-undocumented) Missing documentation for "idToken". -// src/oauth/types.d.ts:9:5 - (ae-undocumented) Missing documentation for "scope". -// src/oauth/types.d.ts:10:5 - (ae-undocumented) Missing documentation for "expiresInSeconds". -// src/oauth/types.d.ts:11:5 - (ae-undocumented) Missing documentation for "refreshToken". -// src/oauth/types.d.ts:12:5 - (ae-undocumented) Missing documentation for "refreshTokenExpiresInSeconds". -// src/oauth/types.d.ts:15:1 - (ae-undocumented) Missing documentation for "OAuthAuthenticatorScopeOptions". -// src/oauth/types.d.ts:16:5 - (ae-undocumented) Missing documentation for "persist". -// src/oauth/types.d.ts:17:5 - (ae-undocumented) Missing documentation for "required". -// src/oauth/types.d.ts:18:5 - (ae-undocumented) Missing documentation for "transform". -// src/oauth/types.d.ts:30:1 - (ae-undocumented) Missing documentation for "OAuthAuthenticatorStartInput". -// src/oauth/types.d.ts:31:5 - (ae-undocumented) Missing documentation for "scope". -// src/oauth/types.d.ts:32:5 - (ae-undocumented) Missing documentation for "state". -// src/oauth/types.d.ts:33:5 - (ae-undocumented) Missing documentation for "req". -// src/oauth/types.d.ts:36:1 - (ae-undocumented) Missing documentation for "OAuthAuthenticatorAuthenticateInput". -// src/oauth/types.d.ts:37:5 - (ae-undocumented) Missing documentation for "req". -// src/oauth/types.d.ts:40:1 - (ae-undocumented) Missing documentation for "OAuthAuthenticatorRefreshInput". -// src/oauth/types.d.ts:41:5 - (ae-undocumented) Missing documentation for "scope". -// src/oauth/types.d.ts:42:5 - (ae-undocumented) Missing documentation for "refreshToken". -// src/oauth/types.d.ts:43:5 - (ae-undocumented) Missing documentation for "req". -// src/oauth/types.d.ts:46:1 - (ae-undocumented) Missing documentation for "OAuthAuthenticatorLogoutInput". -// src/oauth/types.d.ts:47:5 - (ae-undocumented) Missing documentation for "accessToken". -// src/oauth/types.d.ts:48:5 - (ae-undocumented) Missing documentation for "refreshToken". -// src/oauth/types.d.ts:49:5 - (ae-undocumented) Missing documentation for "req". -// src/oauth/types.d.ts:52:1 - (ae-undocumented) Missing documentation for "OAuthAuthenticatorResult". -// src/oauth/types.d.ts:53:5 - (ae-undocumented) Missing documentation for "fullProfile". -// src/oauth/types.d.ts:54:5 - (ae-undocumented) Missing documentation for "session". -// src/oauth/types.d.ts:57:1 - (ae-undocumented) Missing documentation for "OAuthAuthenticator". -// src/oauth/types.d.ts:58:5 - (ae-undocumented) Missing documentation for "defaultProfileTransform". -// src/oauth/types.d.ts:60:5 - (ae-undocumented) Missing documentation for "shouldPersistScopes". -// src/oauth/types.d.ts:61:5 - (ae-undocumented) Missing documentation for "scopes". -// src/oauth/types.d.ts:62:5 - (ae-undocumented) Missing documentation for "initialize". -// src/oauth/types.d.ts:66:5 - (ae-undocumented) Missing documentation for "start". -// src/oauth/types.d.ts:70:5 - (ae-undocumented) Missing documentation for "authenticate". -// src/oauth/types.d.ts:71:5 - (ae-undocumented) Missing documentation for "refresh". -// src/oauth/types.d.ts:72:5 - (ae-undocumented) Missing documentation for "logout". -// src/oauth/types.d.ts:75:1 - (ae-undocumented) Missing documentation for "createOAuthAuthenticator". -// src/passport/PassportHelpers.d.ts:6:1 - (ae-undocumented) Missing documentation for "PassportHelpers". -// src/passport/PassportHelpers.d.ts:8:5 - (ae-undocumented) Missing documentation for "transformProfile". -// src/passport/PassportHelpers.d.ts:9:5 - (ae-undocumented) Missing documentation for "executeRedirectStrategy". -// src/passport/PassportHelpers.d.ts:19:5 - (ae-undocumented) Missing documentation for "executeFrameHandlerStrategy". -// src/passport/PassportHelpers.d.ts:23:5 - (ae-undocumented) Missing documentation for "executeRefreshTokenStrategy". -// src/passport/PassportHelpers.d.ts:34:5 - (ae-undocumented) Missing documentation for "executeFetchUserProfileStrategy". -// src/passport/types.d.ts:3:1 - (ae-undocumented) Missing documentation for "PassportProfile". -// src/passport/types.d.ts:9:1 - (ae-undocumented) Missing documentation for "PassportDoneCallback". -// src/proxy/createProxyAuthProviderFactory.d.ts:5:1 - (ae-undocumented) Missing documentation for "createProxyAuthProviderFactory". -// src/proxy/createProxyRouteHandlers.d.ts:5:1 - (ae-undocumented) Missing documentation for "ProxyAuthRouteHandlersOptions". -// src/proxy/createProxyRouteHandlers.d.ts:6:5 - (ae-undocumented) Missing documentation for "authenticator". -// src/proxy/createProxyRouteHandlers.d.ts:7:5 - (ae-undocumented) Missing documentation for "config". -// src/proxy/createProxyRouteHandlers.d.ts:8:5 - (ae-undocumented) Missing documentation for "resolverContext". -// src/proxy/createProxyRouteHandlers.d.ts:9:5 - (ae-undocumented) Missing documentation for "signInResolver". -// src/proxy/createProxyRouteHandlers.d.ts:10:5 - (ae-undocumented) Missing documentation for "profileTransform". -// src/proxy/createProxyRouteHandlers.d.ts:13:1 - (ae-undocumented) Missing documentation for "createProxyAuthRouteHandlers". -// src/proxy/types.d.ts:5:1 - (ae-undocumented) Missing documentation for "ProxyAuthenticator". -// src/proxy/types.d.ts:6:5 - (ae-undocumented) Missing documentation for "defaultProfileTransform". -// src/proxy/types.d.ts:7:5 - (ae-undocumented) Missing documentation for "initialize". -// src/proxy/types.d.ts:10:5 - (ae-undocumented) Missing documentation for "authenticate". -// src/proxy/types.d.ts:18:1 - (ae-undocumented) Missing documentation for "createProxyAuthenticator". -// src/sign-in/createSignInResolverFactory.d.ts:5:1 - (ae-undocumented) Missing documentation for "SignInResolverFactory". -// src/sign-in/createSignInResolverFactory.d.ts:6:5 - (ae-undocumented) Missing documentation for "__call". -// src/sign-in/createSignInResolverFactory.d.ts:7:5 - (ae-undocumented) Missing documentation for "optionsJsonSchema". -// src/sign-in/createSignInResolverFactory.d.ts:10:1 - (ae-undocumented) Missing documentation for "SignInResolverFactoryOptions". -// src/sign-in/createSignInResolverFactory.d.ts:11:5 - (ae-undocumented) Missing documentation for "optionsSchema". -// src/sign-in/createSignInResolverFactory.d.ts:12:5 - (ae-undocumented) Missing documentation for "create". -// src/sign-in/createSignInResolverFactory.d.ts:15:1 - (ae-undocumented) Missing documentation for "createSignInResolverFactory". -// src/sign-in/readDeclarativeSignInResolver.d.ts:5:1 - (ae-undocumented) Missing documentation for "ReadDeclarativeSignInResolverOptions". -// src/sign-in/readDeclarativeSignInResolver.d.ts:6:5 - (ae-undocumented) Missing documentation for "config". -// src/sign-in/readDeclarativeSignInResolver.d.ts:7:5 - (ae-undocumented) Missing documentation for "signInResolverFactories". -// src/sign-in/readDeclarativeSignInResolver.d.ts:12:1 - (ae-undocumented) Missing documentation for "readDeclarativeSignInResolver". -// src/types.d.ts:139:5 - (ae-undocumented) Missing documentation for "resolveOwnershipEntityRefs". -// src/types.d.ts:204:1 - (ae-undocumented) Missing documentation for "AuthProviderConfig". -// src/types.d.ts:224:1 - (ae-undocumented) Missing documentation for "AuthProviderFactory". -// src/types.d.ts:250:1 - (ae-undocumented) Missing documentation for "ClientAuthResponse". ``` diff --git a/plugins/bitbucket-cloud-common/report.api.md b/plugins/bitbucket-cloud-common/report.api.md index ebad8ff878..833a367c03 100644 --- a/plugins/bitbucket-cloud-common/report.api.md +++ b/plugins/bitbucket-cloud-common/report.api.md @@ -482,154 +482,4 @@ export class WithPagination< options?: PaginationOptions, ): AsyncGenerator, void, unknown>; } - -// Warnings were encountered during analysis: -// -// src/BitbucketCloudClient.d.ts:6:1 - (ae-undocumented) Missing documentation for "BitbucketCloudClient". -// src/BitbucketCloudClient.d.ts:8:5 - (ae-undocumented) Missing documentation for "fromConfig". -// src/BitbucketCloudClient.d.ts:10:5 - (ae-undocumented) Missing documentation for "searchCode". -// src/BitbucketCloudClient.d.ts:11:5 - (ae-undocumented) Missing documentation for "listRepositoriesByWorkspace". -// src/BitbucketCloudClient.d.ts:12:5 - (ae-undocumented) Missing documentation for "listProjectsByWorkspace". -// src/BitbucketCloudClient.d.ts:13:5 - (ae-undocumented) Missing documentation for "listWorkspaces". -// src/BitbucketCloudClient.d.ts:14:5 - (ae-undocumented) Missing documentation for "listBranchesByRepository". -// src/events/index.d.ts:3:1 - (ae-undocumented) Missing documentation for "Events". -// src/events/index.d.ts:5:5 - (ae-undocumented) Missing documentation for "RepoEvent". -// src/events/index.d.ts:6:9 - (ae-undocumented) Missing documentation for "repository". -// src/events/index.d.ts:9:9 - (ae-undocumented) Missing documentation for "actor". -// src/events/index.d.ts:12:5 - (ae-undocumented) Missing documentation for "RepoPushEvent". -// src/events/index.d.ts:13:9 - (ae-undocumented) Missing documentation for "push". -// src/events/index.d.ts:16:5 - (ae-undocumented) Missing documentation for "RepoPush". -// src/events/index.d.ts:17:9 - (ae-undocumented) Missing documentation for "changes". -// src/events/index.d.ts:20:5 - (ae-undocumented) Missing documentation for "Change". -// src/events/index.d.ts:21:9 - (ae-undocumented) Missing documentation for "old". -// src/events/index.d.ts:22:9 - (ae-undocumented) Missing documentation for "new". -// src/events/index.d.ts:23:9 - (ae-undocumented) Missing documentation for "truncated". -// src/events/index.d.ts:24:9 - (ae-undocumented) Missing documentation for "created". -// src/events/index.d.ts:25:9 - (ae-undocumented) Missing documentation for "forced". -// src/events/index.d.ts:26:9 - (ae-undocumented) Missing documentation for "closed". -// src/events/index.d.ts:27:9 - (ae-undocumented) Missing documentation for "links". -// src/events/index.d.ts:28:9 - (ae-undocumented) Missing documentation for "commits". -// src/events/index.d.ts:31:5 - (ae-undocumented) Missing documentation for "ChangeLinks". -// src/events/index.d.ts:32:9 - (ae-undocumented) Missing documentation for "commits". -// src/events/index.d.ts:33:9 - (ae-undocumented) Missing documentation for "diff". -// src/events/index.d.ts:34:9 - (ae-undocumented) Missing documentation for "html". -// src/models/index.d.ts:13:1 - (ae-undocumented) Missing documentation for "Models". -// src/models/index.d.ts:19:9 - (ae-undocumented) Missing documentation for "created_on". -// src/models/index.d.ts:20:9 - (ae-undocumented) Missing documentation for "display_name". -// src/models/index.d.ts:21:9 - (ae-undocumented) Missing documentation for "links". -// src/models/index.d.ts:22:9 - (ae-undocumented) Missing documentation for "username". -// src/models/index.d.ts:23:9 - (ae-undocumented) Missing documentation for "uuid". -// src/models/index.d.ts:30:9 - (ae-undocumented) Missing documentation for "__index". -// src/models/index.d.ts:31:9 - (ae-undocumented) Missing documentation for "avatar". -// src/models/index.d.ts:42:9 - (ae-undocumented) Missing documentation for "user". -// src/models/index.d.ts:49:9 - (ae-undocumented) Missing documentation for "author". -// src/models/index.d.ts:50:9 - (ae-undocumented) Missing documentation for "date". -// src/models/index.d.ts:51:9 - (ae-undocumented) Missing documentation for "hash". -// src/models/index.d.ts:52:9 - (ae-undocumented) Missing documentation for "message". -// src/models/index.d.ts:53:9 - (ae-undocumented) Missing documentation for "parents". -// src/models/index.d.ts:54:9 - (ae-undocumented) Missing documentation for "summary". -// src/models/index.d.ts:59:5 - (ae-undocumented) Missing documentation for "BaseCommitSummary". -// src/models/index.d.ts:92:9 - (ae-undocumented) Missing documentation for "links". -// src/models/index.d.ts:97:9 - (ae-undocumented) Missing documentation for "target". -// src/models/index.d.ts:98:9 - (ae-undocumented) Missing documentation for "type". -// src/models/index.d.ts:127:9 - (ae-undocumented) Missing documentation for "participants". -// src/models/index.d.ts:128:9 - (ae-undocumented) Missing documentation for "repository". -// src/models/index.d.ts:135:9 - (ae-undocumented) Missing documentation for "__index". -// src/models/index.d.ts:136:9 - (ae-undocumented) Missing documentation for "attributes". -// src/models/index.d.ts:137:9 - (ae-undocumented) Missing documentation for "commit". -// src/models/index.d.ts:146:9 - (ae-undocumented) Missing documentation for "type". -// src/models/index.d.ts:151:11 - (ae-undocumented) Missing documentation for "CommitFileAttributesEnum". -// src/models/index.d.ts:161:5 - (ae-undocumented) Missing documentation for "CommitFileAttributesEnum". -// src/models/index.d.ts:167:9 - (ae-undocumented) Missing documentation for "href". -// src/models/index.d.ts:168:9 - (ae-undocumented) Missing documentation for "name". -// src/models/index.d.ts:175:9 - (ae-undocumented) Missing documentation for "__index". -// src/models/index.d.ts:176:9 - (ae-undocumented) Missing documentation for "type". -// src/models/index.d.ts:253:9 - (ae-undocumented) Missing documentation for "approved". -// src/models/index.d.ts:258:9 - (ae-undocumented) Missing documentation for "role". -// src/models/index.d.ts:259:9 - (ae-undocumented) Missing documentation for "state". -// src/models/index.d.ts:260:9 - (ae-undocumented) Missing documentation for "user". -// src/models/index.d.ts:265:11 - (ae-undocumented) Missing documentation for "ParticipantRoleEnum". -// src/models/index.d.ts:272:5 - (ae-undocumented) Missing documentation for "ParticipantRoleEnum". -// src/models/index.d.ts:276:11 - (ae-undocumented) Missing documentation for "ParticipantStateEnum". -// src/models/index.d.ts:284:5 - (ae-undocumented) Missing documentation for "ParticipantStateEnum". -// src/models/index.d.ts:291:9 - (ae-undocumented) Missing documentation for "created_on". -// src/models/index.d.ts:292:9 - (ae-undocumented) Missing documentation for "description". -// src/models/index.d.ts:310:9 - (ae-undocumented) Missing documentation for "links". -// src/models/index.d.ts:315:9 - (ae-undocumented) Missing documentation for "owner". -// src/models/index.d.ts:316:9 - (ae-undocumented) Missing documentation for "updated_on". -// src/models/index.d.ts:325:5 - (ae-undocumented) Missing documentation for "ProjectLinks". -// src/models/index.d.ts:326:9 - (ae-undocumented) Missing documentation for "avatar". -// src/models/index.d.ts:327:9 - (ae-undocumented) Missing documentation for "html". -// src/models/index.d.ts:332:5 - (ae-undocumented) Missing documentation for "RefLinks". -// src/models/index.d.ts:333:9 - (ae-undocumented) Missing documentation for "commits". -// src/models/index.d.ts:334:9 - (ae-undocumented) Missing documentation for "html". -// src/models/index.d.ts:335:9 - (ae-undocumented) Missing documentation for "self". -// src/models/index.d.ts:342:9 - (ae-undocumented) Missing documentation for "created_on". -// src/models/index.d.ts:343:9 - (ae-undocumented) Missing documentation for "description". -// src/models/index.d.ts:372:9 - (ae-undocumented) Missing documentation for "is_private". -// src/models/index.d.ts:373:9 - (ae-undocumented) Missing documentation for "language". -// src/models/index.d.ts:374:9 - (ae-undocumented) Missing documentation for "links". -// src/models/index.d.ts:375:9 - (ae-undocumented) Missing documentation for "mainbranch". -// src/models/index.d.ts:376:9 - (ae-undocumented) Missing documentation for "name". -// src/models/index.d.ts:377:9 - (ae-undocumented) Missing documentation for "owner". -// src/models/index.d.ts:378:9 - (ae-undocumented) Missing documentation for "parent". -// src/models/index.d.ts:379:9 - (ae-undocumented) Missing documentation for "project". -// src/models/index.d.ts:380:9 - (ae-undocumented) Missing documentation for "scm". -// src/models/index.d.ts:381:9 - (ae-undocumented) Missing documentation for "size". -// src/models/index.d.ts:386:9 - (ae-undocumented) Missing documentation for "updated_on". -// src/models/index.d.ts:421:11 - (ae-undocumented) Missing documentation for "RepositoryScmEnum". -// src/models/index.d.ts:427:5 - (ae-undocumented) Missing documentation for "RepositoryScmEnum". -// src/models/index.d.ts:431:5 - (ae-undocumented) Missing documentation for "RepositoryLinks". -// src/models/index.d.ts:432:9 - (ae-undocumented) Missing documentation for "avatar". -// src/models/index.d.ts:433:9 - (ae-undocumented) Missing documentation for "clone". -// src/models/index.d.ts:434:9 - (ae-undocumented) Missing documentation for "commits". -// src/models/index.d.ts:435:9 - (ae-undocumented) Missing documentation for "downloads". -// src/models/index.d.ts:436:9 - (ae-undocumented) Missing documentation for "forks". -// src/models/index.d.ts:437:9 - (ae-undocumented) Missing documentation for "hooks". -// src/models/index.d.ts:438:9 - (ae-undocumented) Missing documentation for "html". -// src/models/index.d.ts:439:9 - (ae-undocumented) Missing documentation for "pullrequests". -// src/models/index.d.ts:440:9 - (ae-undocumented) Missing documentation for "self". -// src/models/index.d.ts:441:9 - (ae-undocumented) Missing documentation for "watchers". -// src/models/index.d.ts:446:5 - (ae-undocumented) Missing documentation for "SearchCodeSearchResult". -// src/models/index.d.ts:447:9 - (ae-undocumented) Missing documentation for "content_match_count". -// src/models/index.d.ts:448:9 - (ae-undocumented) Missing documentation for "content_matches". -// src/models/index.d.ts:449:9 - (ae-undocumented) Missing documentation for "file". -// src/models/index.d.ts:450:9 - (ae-undocumented) Missing documentation for "path_matches". -// src/models/index.d.ts:451:9 - (ae-undocumented) Missing documentation for "type". -// src/models/index.d.ts:456:5 - (ae-undocumented) Missing documentation for "SearchContentMatch". -// src/models/index.d.ts:457:9 - (ae-undocumented) Missing documentation for "lines". -// src/models/index.d.ts:462:5 - (ae-undocumented) Missing documentation for "SearchLine". -// src/models/index.d.ts:463:9 - (ae-undocumented) Missing documentation for "line". -// src/models/index.d.ts:464:9 - (ae-undocumented) Missing documentation for "segments". -// src/models/index.d.ts:469:5 - (ae-undocumented) Missing documentation for "SearchResultPage". -// src/models/index.d.ts:470:9 - (ae-undocumented) Missing documentation for "query_substituted". -// src/models/index.d.ts:479:5 - (ae-undocumented) Missing documentation for "SearchSegment". -// src/models/index.d.ts:480:9 - (ae-undocumented) Missing documentation for "match". -// src/models/index.d.ts:481:9 - (ae-undocumented) Missing documentation for "text". -// src/models/index.d.ts:488:9 - (ae-undocumented) Missing documentation for "links". -// src/models/index.d.ts:495:9 - (ae-undocumented) Missing documentation for "html". -// src/models/index.d.ts:496:9 - (ae-undocumented) Missing documentation for "members". -// src/models/index.d.ts:497:9 - (ae-undocumented) Missing documentation for "projects". -// src/models/index.d.ts:498:9 - (ae-undocumented) Missing documentation for "repositories". -// src/models/index.d.ts:499:9 - (ae-undocumented) Missing documentation for "self". -// src/models/index.d.ts:507:9 - (ae-undocumented) Missing documentation for "created_on". -// src/models/index.d.ts:513:9 - (ae-undocumented) Missing documentation for "links". -// src/models/index.d.ts:522:9 - (ae-undocumented) Missing documentation for "updated_on". -// src/models/index.d.ts:531:5 - (ae-undocumented) Missing documentation for "WorkspaceLinks". -// src/models/index.d.ts:532:9 - (ae-undocumented) Missing documentation for "avatar". -// src/models/index.d.ts:533:9 - (ae-undocumented) Missing documentation for "html". -// src/models/index.d.ts:534:9 - (ae-undocumented) Missing documentation for "members". -// src/models/index.d.ts:535:9 - (ae-undocumented) Missing documentation for "owners". -// src/models/index.d.ts:536:9 - (ae-undocumented) Missing documentation for "projects". -// src/models/index.d.ts:537:9 - (ae-undocumented) Missing documentation for "repositories". -// src/models/index.d.ts:538:9 - (ae-undocumented) Missing documentation for "self". -// src/models/index.d.ts:539:9 - (ae-undocumented) Missing documentation for "snippets". -// src/pagination.d.ts:3:1 - (ae-undocumented) Missing documentation for "PaginationOptions". -// src/pagination.d.ts:8:1 - (ae-undocumented) Missing documentation for "WithPagination". -// src/pagination.d.ts:12:5 - (ae-undocumented) Missing documentation for "getPage". -// src/pagination.d.ts:13:5 - (ae-undocumented) Missing documentation for "iteratePages". -// src/pagination.d.ts:14:5 - (ae-undocumented) Missing documentation for "iterateResults". -// src/types.d.ts:3:1 - (ae-undocumented) Missing documentation for "FilterAndSortOptions". -// src/types.d.ts:8:1 - (ae-undocumented) Missing documentation for "PartialResponseOptions". -// src/types.d.ts:12:1 - (ae-undocumented) Missing documentation for "RequestOptions". ``` diff --git a/plugins/catalog-backend-module-aws/report-alpha.api.md b/plugins/catalog-backend-module-aws/report-alpha.api.md index 2d9ceaec2d..efaf350e99 100644 --- a/plugins/catalog-backend-module-aws/report-alpha.api.md +++ b/plugins/catalog-backend-module-aws/report-alpha.api.md @@ -9,9 +9,5 @@ import { BackendFeature } from '@backstage/backend-plugin-api'; const _feature: BackendFeature; export default _feature; -// Warnings were encountered during analysis: -// -// src/alpha.d.ts:2:15 - (ae-undocumented) Missing documentation for "_feature". - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-backend-module-aws/report.api.md b/plugins/catalog-backend-module-aws/report.api.md index c0e5653190..beb951df7e 100644 --- a/plugins/catalog-backend-module-aws/report.api.md +++ b/plugins/catalog-backend-module-aws/report.api.md @@ -117,17 +117,4 @@ export type EksClusterEntityTransformer = ( cluster: Cluster, accountId: string, ) => Promise; - -// Warnings were encountered during analysis: -// -// src/processors/AwsEKSClusterProcessor.d.ts:18:5 - (ae-undocumented) Missing documentation for "fromConfig". -// src/processors/AwsEKSClusterProcessor.d.ts:26:5 - (ae-undocumented) Missing documentation for "getProcessorName". -// src/processors/AwsEKSClusterProcessor.d.ts:27:5 - (ae-undocumented) Missing documentation for "readLocation". -// src/processors/AwsOrganizationCloudAccountProcessor.d.ts:17:5 - (ae-undocumented) Missing documentation for "fromConfig". -// src/processors/AwsOrganizationCloudAccountProcessor.d.ts:21:5 - (ae-undocumented) Missing documentation for "getProcessorName". -// src/processors/AwsOrganizationCloudAccountProcessor.d.ts:22:5 - (ae-undocumented) Missing documentation for "readLocation". -// src/processors/AwsS3DiscoveryProcessor.d.ts:15:5 - (ae-undocumented) Missing documentation for "getProcessorName". -// src/processors/AwsS3DiscoveryProcessor.d.ts:16:5 - (ae-undocumented) Missing documentation for "readLocation". -// src/providers/AwsS3EntityProvider.d.ts:20:5 - (ae-undocumented) Missing documentation for "fromConfig". -// src/providers/AwsS3EntityProvider.d.ts:31:5 - (ae-undocumented) Missing documentation for "refresh". ``` diff --git a/plugins/catalog-backend-module-azure/report-alpha.api.md b/plugins/catalog-backend-module-azure/report-alpha.api.md index 1be3e1481f..3336b07e09 100644 --- a/plugins/catalog-backend-module-azure/report-alpha.api.md +++ b/plugins/catalog-backend-module-azure/report-alpha.api.md @@ -9,9 +9,5 @@ import { BackendFeature } from '@backstage/backend-plugin-api'; const _feature: BackendFeature; export default _feature; -// Warnings were encountered during analysis: -// -// src/alpha.d.ts:2:15 - (ae-undocumented) Missing documentation for "_feature". - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-backend-module-azure/report.api.md b/plugins/catalog-backend-module-azure/report.api.md index b3b7b71158..d11197d7f2 100644 --- a/plugins/catalog-backend-module-azure/report.api.md +++ b/plugins/catalog-backend-module-azure/report.api.md @@ -58,12 +58,4 @@ export class AzureDevOpsEntityProvider implements EntityProvider { // @public const catalogModuleAzureDevOpsEntityProvider: BackendFeature; export default catalogModuleAzureDevOpsEntityProvider; - -// Warnings were encountered during analysis: -// -// src/processors/AzureDevOpsDiscoveryProcessor.d.ts:26:5 - (ae-undocumented) Missing documentation for "fromConfig". -// src/processors/AzureDevOpsDiscoveryProcessor.d.ts:33:5 - (ae-undocumented) Missing documentation for "getProcessorName". -// src/processors/AzureDevOpsDiscoveryProcessor.d.ts:34:5 - (ae-undocumented) Missing documentation for "readLocation". -// src/providers/AzureDevOpsEntityProvider.d.ts:18:5 - (ae-undocumented) Missing documentation for "fromConfig". -// src/providers/AzureDevOpsEntityProvider.d.ts:29:5 - (ae-undocumented) Missing documentation for "refresh". ``` diff --git a/plugins/catalog-backend-module-backstage-openapi/report.api.md b/plugins/catalog-backend-module-backstage-openapi/report.api.md index 88ad499e84..06334182cb 100644 --- a/plugins/catalog-backend-module-backstage-openapi/report.api.md +++ b/plugins/catalog-backend-module-backstage-openapi/report.api.md @@ -18,11 +18,5 @@ export type MetaApiDocsPluginOptions = { // @public (undocumented) export const metaOpenApiDocsPluginId = 'meta-api-docs'; -// Warnings were encountered during analysis: -// -// src/index.d.ts:4:1 - (ae-undocumented) Missing documentation for "MetaApiDocsPluginOptions". -// src/index.d.ts:10:22 - (ae-undocumented) Missing documentation for "metaOpenApiDocsPluginId". -// src/index.d.ts:14:22 - (ae-undocumented) Missing documentation for "catalogModuleInternalOpenApiSpec". - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-backend-module-bitbucket-cloud/report-alpha.api.md b/plugins/catalog-backend-module-bitbucket-cloud/report-alpha.api.md index 418327eb07..ae6ba51eff 100644 --- a/plugins/catalog-backend-module-bitbucket-cloud/report-alpha.api.md +++ b/plugins/catalog-backend-module-bitbucket-cloud/report-alpha.api.md @@ -9,9 +9,5 @@ import { BackendFeature } from '@backstage/backend-plugin-api'; const _feature: BackendFeature; export default _feature; -// Warnings were encountered during analysis: -// -// src/alpha.d.ts:2:15 - (ae-undocumented) Missing documentation for "_feature". - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-backend-module-bitbucket-cloud/report.api.md b/plugins/catalog-backend-module-bitbucket-cloud/report.api.md index 19e835913f..77b20e44f1 100644 --- a/plugins/catalog-backend-module-bitbucket-cloud/report.api.md +++ b/plugins/catalog-backend-module-bitbucket-cloud/report.api.md @@ -41,11 +41,4 @@ export class BitbucketCloudEntityProvider implements EntityProvider { // @public (undocumented) const catalogModuleBitbucketCloudEntityProvider: BackendFeature; export default catalogModuleBitbucketCloudEntityProvider; - -// Warnings were encountered during analysis: -// -// src/module/catalogModuleBitbucketCloudEntityProvider.d.ts:4:22 - (ae-undocumented) Missing documentation for "catalogModuleBitbucketCloudEntityProvider". -// src/providers/BitbucketCloudEntityProvider.d.ts:26:5 - (ae-undocumented) Missing documentation for "fromConfig". -// src/providers/BitbucketCloudEntityProvider.d.ts:42:5 - (ae-undocumented) Missing documentation for "refresh". -// src/providers/BitbucketCloudEntityProvider.d.ts:44:5 - (ae-undocumented) Missing documentation for "onRepoPush". ``` diff --git a/plugins/catalog-backend-module-bitbucket-server/report-alpha.api.md b/plugins/catalog-backend-module-bitbucket-server/report-alpha.api.md index 60f05fac26..06212c3c60 100644 --- a/plugins/catalog-backend-module-bitbucket-server/report-alpha.api.md +++ b/plugins/catalog-backend-module-bitbucket-server/report-alpha.api.md @@ -9,9 +9,5 @@ import { BackendFeature } from '@backstage/backend-plugin-api'; const _feature: BackendFeature; export default _feature; -// Warnings were encountered during analysis: -// -// src/alpha.d.ts:2:15 - (ae-undocumented) Missing documentation for "_feature". - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-backend-module-bitbucket-server/report.api.md b/plugins/catalog-backend-module-bitbucket-server/report.api.md index 41b0d398ab..b2a0a9368a 100644 --- a/plugins/catalog-backend-module-bitbucket-server/report.api.md +++ b/plugins/catalog-backend-module-bitbucket-server/report.api.md @@ -114,20 +114,4 @@ export type BitbucketServerRepository = { // @public (undocumented) const catalogModuleBitbucketServerEntityProvider: BackendFeature; export default catalogModuleBitbucketServerEntityProvider; - -// Warnings were encountered during analysis: -// -// src/lib/BitbucketServerClient.d.ts:11:5 - (ae-undocumented) Missing documentation for "fromConfig". -// src/lib/BitbucketServerClient.d.ts:17:5 - (ae-undocumented) Missing documentation for "listProjects". -// src/lib/BitbucketServerClient.d.ts:20:5 - (ae-undocumented) Missing documentation for "listRepositories". -// src/lib/BitbucketServerClient.d.ts:24:5 - (ae-undocumented) Missing documentation for "getFile". -// src/lib/BitbucketServerClient.d.ts:29:5 - (ae-undocumented) Missing documentation for "getRepository". -// src/lib/BitbucketServerClient.d.ts:33:5 - (ae-undocumented) Missing documentation for "resolvePath". -// src/lib/BitbucketServerClient.d.ts:48:1 - (ae-undocumented) Missing documentation for "BitbucketServerListOptions". -// src/lib/BitbucketServerClient.d.ts:56:1 - (ae-undocumented) Missing documentation for "BitbucketServerPagedResponse". -// src/lib/types.d.ts:2:1 - (ae-undocumented) Missing documentation for "BitbucketServerRepository". -// src/lib/types.d.ts:14:1 - (ae-undocumented) Missing documentation for "BitbucketServerProject". -// src/module/catalogModuleBitbucketServerEntityProvider.d.ts:4:22 - (ae-undocumented) Missing documentation for "catalogModuleBitbucketServerEntityProvider". -// src/providers/BitbucketServerEntityProvider.d.ts:20:5 - (ae-undocumented) Missing documentation for "fromConfig". -// src/providers/BitbucketServerEntityProvider.d.ts:32:5 - (ae-undocumented) Missing documentation for "refresh". ``` diff --git a/plugins/catalog-backend-module-gcp/report.api.md b/plugins/catalog-backend-module-gcp/report.api.md index cf490f09ae..6260d07c88 100644 --- a/plugins/catalog-backend-module-gcp/report.api.md +++ b/plugins/catalog-backend-module-gcp/report.api.md @@ -46,12 +46,4 @@ export class GkeEntityProvider implements EntityProvider { // (undocumented) refresh(): Promise; } - -// Warnings were encountered during analysis: -// -// src/providers/GkeEntityProvider.d.ts:17:5 - (ae-undocumented) Missing documentation for "fromConfig". -// src/providers/GkeEntityProvider.d.ts:22:5 - (ae-undocumented) Missing documentation for "fromConfigWithClient". -// src/providers/GkeEntityProvider.d.ts:28:5 - (ae-undocumented) Missing documentation for "getProviderName". -// src/providers/GkeEntityProvider.d.ts:29:5 - (ae-undocumented) Missing documentation for "connect". -// src/providers/GkeEntityProvider.d.ts:35:5 - (ae-undocumented) Missing documentation for "refresh". ``` diff --git a/plugins/catalog-backend-module-gerrit/report-alpha.api.md b/plugins/catalog-backend-module-gerrit/report-alpha.api.md index 741c105577..59ce95dd4f 100644 --- a/plugins/catalog-backend-module-gerrit/report-alpha.api.md +++ b/plugins/catalog-backend-module-gerrit/report-alpha.api.md @@ -9,9 +9,5 @@ import { BackendFeature } from '@backstage/backend-plugin-api'; const _feature: BackendFeature; export default _feature; -// Warnings were encountered during analysis: -// -// src/alpha.d.ts:2:15 - (ae-undocumented) Missing documentation for "_feature". - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-backend-module-gerrit/report.api.md b/plugins/catalog-backend-module-gerrit/report.api.md index 76866fe76a..8f8cd60e4e 100644 --- a/plugins/catalog-backend-module-gerrit/report.api.md +++ b/plugins/catalog-backend-module-gerrit/report.api.md @@ -34,14 +34,5 @@ export class GerritEntityProvider implements EntityProvider { refresh(logger: LoggerService): Promise; } -// Warnings were encountered during analysis: -// -// src/module/catalogModuleGerritEntityProvider.d.ts:4:22 - (ae-undocumented) Missing documentation for "catalogModuleGerritEntityProvider". -// src/providers/GerritEntityProvider.d.ts:5:1 - (ae-undocumented) Missing documentation for "GerritEntityProvider". -// src/providers/GerritEntityProvider.d.ts:11:5 - (ae-undocumented) Missing documentation for "fromConfig". -// src/providers/GerritEntityProvider.d.ts:17:5 - (ae-undocumented) Missing documentation for "getProviderName". -// src/providers/GerritEntityProvider.d.ts:18:5 - (ae-undocumented) Missing documentation for "connect". -// src/providers/GerritEntityProvider.d.ts:20:5 - (ae-undocumented) Missing documentation for "refresh". - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-backend-module-github/report-alpha.api.md b/plugins/catalog-backend-module-github/report-alpha.api.md index fbe98b714e..4e596df822 100644 --- a/plugins/catalog-backend-module-github/report-alpha.api.md +++ b/plugins/catalog-backend-module-github/report-alpha.api.md @@ -9,9 +9,5 @@ import { BackendFeature } from '@backstage/backend-plugin-api'; const _feature: BackendFeature; export default _feature; -// Warnings were encountered during analysis: -// -// src/alpha.d.ts:2:15 - (ae-undocumented) Missing documentation for "_feature". - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-backend-module-github/report.api.md b/plugins/catalog-backend-module-github/report.api.md index e81d0a0e81..dcc94e47bc 100644 --- a/plugins/catalog-backend-module-github/report.api.md +++ b/plugins/catalog-backend-module-github/report.api.md @@ -323,41 +323,4 @@ export type UserTransformer = ( item: GithubUser, ctx: TransformerContext, ) => Promise; - -// Warnings were encountered during analysis: -// -// src/analyzers/GithubLocationAnalyzer.d.ts:8:1 - (ae-undocumented) Missing documentation for "GithubLocationAnalyzerOptions". -// src/analyzers/GithubLocationAnalyzer.d.ts:17:1 - (ae-undocumented) Missing documentation for "GithubLocationAnalyzer". -// src/analyzers/GithubLocationAnalyzer.d.ts:23:5 - (ae-undocumented) Missing documentation for "supports". -// src/analyzers/GithubLocationAnalyzer.d.ts:24:5 - (ae-undocumented) Missing documentation for "analyze". -// src/deprecated.d.ts:9:1 - (ae-undocumented) Missing documentation for "GitHubOrgEntityProvider". -// src/deprecated.d.ts:10:5 - (ae-undocumented) Missing documentation for "fromConfig". -// src/deprecated.d.ts:16:1 - (ae-undocumented) Missing documentation for "GitHubOrgEntityProviderOptions". -// src/deprecated.d.ts:21:1 - (ae-undocumented) Missing documentation for "GitHubEntityProvider". -// src/deprecated.d.ts:23:5 - (ae-undocumented) Missing documentation for "fromConfig". -// src/deprecated.d.ts:29:5 - (ae-undocumented) Missing documentation for "connect". -// src/deprecated.d.ts:30:5 - (ae-undocumented) Missing documentation for "getProviderName". -// src/deprecated.d.ts:31:5 - (ae-undocumented) Missing documentation for "refresh". -// src/lib/defaultTransformers.d.ts:10:5 - (ae-undocumented) Missing documentation for "client". -// src/lib/defaultTransformers.d.ts:11:5 - (ae-undocumented) Missing documentation for "query". -// src/lib/defaultTransformers.d.ts:12:5 - (ae-undocumented) Missing documentation for "org". -// src/processors/GithubDiscoveryProcessor.d.ts:25:5 - (ae-undocumented) Missing documentation for "fromConfig". -// src/processors/GithubDiscoveryProcessor.d.ts:34:5 - (ae-undocumented) Missing documentation for "getProcessorName". -// src/processors/GithubDiscoveryProcessor.d.ts:35:5 - (ae-undocumented) Missing documentation for "readLocation". -// src/processors/GithubMultiOrgReaderProcessor.d.ts:19:5 - (ae-undocumented) Missing documentation for "fromConfig". -// src/processors/GithubMultiOrgReaderProcessor.d.ts:33:5 - (ae-undocumented) Missing documentation for "getProcessorName". -// src/processors/GithubMultiOrgReaderProcessor.d.ts:34:5 - (ae-undocumented) Missing documentation for "readLocation". -// src/processors/GithubOrgReaderProcessor.d.ts:18:5 - (ae-undocumented) Missing documentation for "fromConfig". -// src/processors/GithubOrgReaderProcessor.d.ts:27:5 - (ae-undocumented) Missing documentation for "getProcessorName". -// src/processors/GithubOrgReaderProcessor.d.ts:28:5 - (ae-undocumented) Missing documentation for "readLocation". -// src/providers/GithubEntityProvider.d.ts:21:5 - (ae-undocumented) Missing documentation for "fromConfig". -// src/providers/GithubEntityProvider.d.ts:33:5 - (ae-undocumented) Missing documentation for "refresh". -// src/providers/GithubEntityProvider.d.ts:51:8 - (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration -// src/providers/GithubEntityProvider.d.ts:60:8 - (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration -// src/providers/GithubEntityProvider.d.ts:71:8 - (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration -// src/providers/GithubEntityProvider.d.ts:81:8 - (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration -// src/providers/GithubEntityProvider.d.ts:93:8 - (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration -// src/providers/GithubEntityProvider.d.ts:102:8 - (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration -// src/providers/GithubMultiOrgEntityProvider.d.ts:84:5 - (ae-undocumented) Missing documentation for "fromConfig". -// src/providers/GithubOrgEntityProvider.d.ts:71:5 - (ae-undocumented) Missing documentation for "fromConfig". ``` diff --git a/plugins/catalog-backend-module-github/src/providers/GithubEntityProvider.ts b/plugins/catalog-backend-module-github/src/providers/GithubEntityProvider.ts index 1c64174ee7..5c6dc75e48 100644 --- a/plugins/catalog-backend-module-github/src/providers/GithubEntityProvider.ts +++ b/plugins/catalog-backend-module-github/src/providers/GithubEntityProvider.ts @@ -472,7 +472,6 @@ export class GithubEntityProvider implements EntityProvider, EventSubscriber { * Removes all entities associated with the repository. * * @param event - The repository archived event. - * @private */ private async onRepoArchived(event: RepositoryArchivedEvent) { const repository = this.createRepoFromEvent(event); @@ -488,7 +487,6 @@ export class GithubEntityProvider implements EntityProvider, EventSubscriber { * Removes all entities associated with the repository. * * @param event - The repository deleted event. - * @private */ private async onRepoDeleted(event: RepositoryDeletedEvent) { const repository = this.createRepoFromEvent(event); @@ -506,7 +504,6 @@ export class GithubEntityProvider implements EntityProvider, EventSubscriber { * Removes all entities associated with the repository if the repository no longer matches the filters. * * @param event - The repository edited event. - * @private */ private async onRepoEdited(event: RepositoryEditedEvent) { const repository = this.createRepoFromEvent(event); @@ -525,7 +522,6 @@ export class GithubEntityProvider implements EntityProvider, EventSubscriber { * Creates new entities for the repository's new name if it still matches the filters. * * @param event - The repository renamed event. - * @private */ private async onRepoRenamed(event: RepositoryRenamedEvent) { const repository = this.createRepoFromEvent(event); @@ -560,7 +556,6 @@ export class GithubEntityProvider implements EntityProvider, EventSubscriber { * Creates new entities for the repository if it matches the filters. * * @param event - The repository unarchived event. - * @private */ private async onRepoTransferred(event: RepositoryTransferredEvent) { const repository = this.createRepoFromEvent(event); @@ -582,7 +577,6 @@ export class GithubEntityProvider implements EntityProvider, EventSubscriber { * Creates new entities for the repository if it matches the filters. * * @param event - The repository unarchived event. - * @private */ private async onRepoUnarchived(event: RepositoryUnarchivedEvent) { const repository = this.createRepoFromEvent(event); diff --git a/plugins/catalog-backend-module-gitlab/report-alpha.api.md b/plugins/catalog-backend-module-gitlab/report-alpha.api.md index 350411a6dc..e8ef479d82 100644 --- a/plugins/catalog-backend-module-gitlab/report-alpha.api.md +++ b/plugins/catalog-backend-module-gitlab/report-alpha.api.md @@ -9,9 +9,5 @@ import { BackendFeature } from '@backstage/backend-plugin-api'; const _feature: BackendFeature; export default _feature; -// Warnings were encountered during analysis: -// -// src/alpha.d.ts:2:15 - (ae-undocumented) Missing documentation for "_feature". - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-backend-module-gitlab/report.api.md b/plugins/catalog-backend-module-gitlab/report.api.md index 07612bca88..890ca29eca 100644 --- a/plugins/catalog-backend-module-gitlab/report.api.md +++ b/plugins/catalog-backend-module-gitlab/report.api.md @@ -176,29 +176,4 @@ export interface UserTransformerOptions { // (undocumented) user: GitLabUser; } - -// Warnings were encountered during analysis: -// -// src/GitLabDiscoveryProcessor.d.ts:14:5 - (ae-undocumented) Missing documentation for "fromConfig". -// src/GitLabDiscoveryProcessor.d.ts:20:5 - (ae-undocumented) Missing documentation for "getProcessorName". -// src/GitLabDiscoveryProcessor.d.ts:21:5 - (ae-undocumented) Missing documentation for "readLocation". -// src/lib/types.d.ts:48:1 - (ae-undocumented) Missing documentation for "GitLabGroupSamlIdentity". -// src/lib/types.d.ts:234:5 - (ae-undocumented) Missing documentation for "group". -// src/lib/types.d.ts:235:5 - (ae-undocumented) Missing documentation for "providerConfig". -// src/lib/types.d.ts:249:5 - (ae-undocumented) Missing documentation for "user". -// src/lib/types.d.ts:250:5 - (ae-undocumented) Missing documentation for "integrationConfig". -// src/lib/types.d.ts:251:5 - (ae-undocumented) Missing documentation for "providerConfig". -// src/lib/types.d.ts:252:5 - (ae-undocumented) Missing documentation for "groupNameTransformer". -// src/lib/types.d.ts:266:5 - (ae-undocumented) Missing documentation for "groups". -// src/lib/types.d.ts:267:5 - (ae-undocumented) Missing documentation for "providerConfig". -// src/lib/types.d.ts:268:5 - (ae-undocumented) Missing documentation for "groupNameTransformer". -// src/providers/GitlabDiscoveryEntityProvider.d.ts:21:5 - (ae-undocumented) Missing documentation for "fromConfig". -// src/providers/GitlabDiscoveryEntityProvider.d.ts:33:5 - (ae-undocumented) Missing documentation for "getProviderName". -// src/providers/GitlabDiscoveryEntityProvider.d.ts:34:5 - (ae-undocumented) Missing documentation for "connect". -// src/providers/GitlabDiscoveryEntityProvider.d.ts:75:15 - (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' -// src/providers/GitlabDiscoveryEntityProvider.d.ts:76:30 - (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag -// src/providers/GitlabDiscoveryEntityProvider.d.ts:76:17 - (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" -// src/providers/GitlabOrgDiscoveryEntityProvider.d.ts:21:5 - (ae-undocumented) Missing documentation for "fromConfig". -// src/providers/GitlabOrgDiscoveryEntityProvider.d.ts:31:5 - (ae-undocumented) Missing documentation for "getProviderName". -// src/providers/GitlabOrgDiscoveryEntityProvider.d.ts:32:5 - (ae-undocumented) Missing documentation for "connect". ``` diff --git a/plugins/catalog-backend-module-gitlab/src/providers/GitlabDiscoveryEntityProvider.ts b/plugins/catalog-backend-module-gitlab/src/providers/GitlabDiscoveryEntityProvider.ts index fdd884e1fd..0ac45b93e1 100644 --- a/plugins/catalog-backend-module-gitlab/src/providers/GitlabDiscoveryEntityProvider.ts +++ b/plugins/catalog-backend-module-gitlab/src/providers/GitlabDiscoveryEntityProvider.ts @@ -418,8 +418,8 @@ export class GitlabDiscoveryEntityProvider implements EntityProvider { /** * Converts a target URL to a LocationSpec object. * - * @param {string} target - The target URL to be converted. - * @returns {LocationSpec} The LocationSpec object representing the URL. + * @param target - The target URL to be converted. + * @returns The LocationSpec object representing the URL. */ private toLocationSpec(target: string): LocationSpec { return { diff --git a/plugins/catalog-backend-module-incremental-ingestion/report-alpha.api.md b/plugins/catalog-backend-module-incremental-ingestion/report-alpha.api.md index 8f3a5fa780..cb1bb63d00 100644 --- a/plugins/catalog-backend-module-incremental-ingestion/report-alpha.api.md +++ b/plugins/catalog-backend-module-incremental-ingestion/report-alpha.api.md @@ -4,28 +4,10 @@ ```ts import { BackendFeature } from '@backstage/backend-plugin-api'; -import { ExtensionPoint } from '@backstage/backend-plugin-api'; -import { IncrementalEntityProvider } from '@backstage/plugin-catalog-backend-module-incremental-ingestion'; -import { IncrementalEntityProviderOptions } from '@backstage/plugin-catalog-backend-module-incremental-ingestion'; // @alpha (undocumented) const _feature: BackendFeature; export default _feature; -// Warning: (ae-forgotten-export) The symbol "IncrementalIngestionProviderExtensionPoint_2" needs to be exported by the entry point alpha.d.ts -// -// @alpha (undocumented) -export type IncrementalIngestionProviderExtensionPoint = - IncrementalIngestionProviderExtensionPoint_2; - -// @alpha (undocumented) -export const incrementalIngestionProvidersExtensionPoint: ExtensionPoint; - -// Warnings were encountered during analysis: -// -// src/alpha.d.ts:3:15 - (ae-undocumented) Missing documentation for "_feature". -// src/alpha.d.ts:6:1 - (ae-undocumented) Missing documentation for "IncrementalIngestionProviderExtensionPoint". -// src/alpha.d.ts:8:22 - (ae-undocumented) Missing documentation for "incrementalIngestionProvidersExtensionPoint". - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-backend-module-incremental-ingestion/report.api.md b/plugins/catalog-backend-module-incremental-ingestion/report.api.md index 4b7e473b48..9686a7ca57 100644 --- a/plugins/catalog-backend-module-incremental-ingestion/report.api.md +++ b/plugins/catalog-backend-module-incremental-ingestion/report.api.md @@ -113,12 +113,4 @@ export type PluginEnvironment = { reader: UrlReaderService; permissions: PermissionEvaluator; }; - -// Warnings were encountered during analysis: -// -// src/service/IncrementalCatalogBuilder.d.ts:6:1 - (ae-undocumented) Missing documentation for "IncrementalCatalogBuilder". -// src/service/IncrementalCatalogBuilder.d.ts:20:5 - (ae-undocumented) Missing documentation for "build". -// src/service/IncrementalCatalogBuilder.d.ts:23:5 - (ae-undocumented) Missing documentation for "addIncrementalEntityProvider". -// src/types.d.ts:106:1 - (ae-undocumented) Missing documentation for "IncrementalEntityProviderOptions". -// src/types.d.ts:145:1 - (ae-undocumented) Missing documentation for "PluginEnvironment". ``` diff --git a/plugins/catalog-backend-module-incremental-ingestion/src/alpha.ts b/plugins/catalog-backend-module-incremental-ingestion/src/alpha.ts index ee9c7ff415..cba672ce49 100644 --- a/plugins/catalog-backend-module-incremental-ingestion/src/alpha.ts +++ b/plugins/catalog-backend-module-incremental-ingestion/src/alpha.ts @@ -15,16 +15,7 @@ */ import { default as feature } from './module'; -import { - IncrementalIngestionProviderExtensionPoint as ExtensionPoint, - incrementalIngestionProvidersExtensionPoint as extensionPoint, -} from './module'; /** @alpha */ const _feature = feature; export default _feature; - -/** @alpha */ -export type IncrementalIngestionProviderExtensionPoint = ExtensionPoint; -/** @alpha */ -export const incrementalIngestionProvidersExtensionPoint = extensionPoint; diff --git a/plugins/catalog-backend-module-incremental-ingestion/src/run.ts b/plugins/catalog-backend-module-incremental-ingestion/src/run.ts index 1a98c478a1..89698da1de 100644 --- a/plugins/catalog-backend-module-incremental-ingestion/src/run.ts +++ b/plugins/catalog-backend-module-incremental-ingestion/src/run.ts @@ -24,10 +24,11 @@ import { createServiceFactory, } from '@backstage/backend-plugin-api'; import { ConfigReader } from '@backstage/config'; -import { IncrementalEntityProvider } from '.'; -import catalogModuleIncrementalIngestionEntityProvider, { +import { + IncrementalEntityProvider, incrementalIngestionProvidersExtensionPoint, -} from './alpha'; +} from '.'; +import catalogModuleIncrementalIngestionEntityProvider from './alpha'; const provider: IncrementalEntityProvider = { getProviderName: () => 'test-provider', diff --git a/plugins/catalog-backend-module-ldap/report.api.md b/plugins/catalog-backend-module-ldap/report.api.md index e8b20073a3..16546cb773 100644 --- a/plugins/catalog-backend-module-ldap/report.api.md +++ b/plugins/catalog-backend-module-ldap/report.api.md @@ -275,13 +275,4 @@ export type VendorConfig = { dnAttributeName?: string; uuidAttributeName?: string; }; - -// Warnings were encountered during analysis: -// -// src/ldap/client.d.ts:16:5 - (ae-undocumented) Missing documentation for "create". -// src/processors/LdapOrgEntityProvider.d.ts:107:5 - (ae-undocumented) Missing documentation for "fromConfig". -// src/processors/LdapOrgEntityProvider.d.ts:108:5 - (ae-undocumented) Missing documentation for "fromLegacyConfig". -// src/processors/LdapOrgReaderProcessor.d.ts:16:5 - (ae-undocumented) Missing documentation for "fromConfig". -// src/processors/LdapOrgReaderProcessor.d.ts:27:5 - (ae-undocumented) Missing documentation for "getProcessorName". -// src/processors/LdapOrgReaderProcessor.d.ts:28:5 - (ae-undocumented) Missing documentation for "readLocation". ``` diff --git a/plugins/catalog-backend-module-msgraph/report-alpha.api.md b/plugins/catalog-backend-module-msgraph/report-alpha.api.md index 416c335bff..da981edd8d 100644 --- a/plugins/catalog-backend-module-msgraph/report-alpha.api.md +++ b/plugins/catalog-backend-module-msgraph/report-alpha.api.md @@ -4,30 +4,10 @@ ```ts import { BackendFeature } from '@backstage/backend-plugin-api'; -import { ExtensionPoint } from '@backstage/backend-plugin-api'; -import { GroupTransformer } from '@backstage/plugin-catalog-backend-module-msgraph'; -import { OrganizationTransformer } from '@backstage/plugin-catalog-backend-module-msgraph'; -import { ProviderConfigTransformer } from '@backstage/plugin-catalog-backend-module-msgraph'; -import { UserTransformer } from '@backstage/plugin-catalog-backend-module-msgraph'; // @alpha (undocumented) const _feature: BackendFeature; export default _feature; -// Warning: (ae-forgotten-export) The symbol "MicrosoftGraphOrgEntityProviderTransformsExtensionPoint_2" needs to be exported by the entry point alpha.d.ts -// -// @alpha (undocumented) -export const microsoftGraphOrgEntityProviderTransformExtensionPoint: ExtensionPoint; - -// @alpha (undocumented) -export type MicrosoftGraphOrgEntityProviderTransformsExtensionPoint = - MicrosoftGraphOrgEntityProviderTransformsExtensionPoint_2; - -// Warnings were encountered during analysis: -// -// src/alpha.d.ts:3:15 - (ae-undocumented) Missing documentation for "_feature". -// src/alpha.d.ts:6:1 - (ae-undocumented) Missing documentation for "MicrosoftGraphOrgEntityProviderTransformsExtensionPoint". -// src/alpha.d.ts:8:22 - (ae-undocumented) Missing documentation for "microsoftGraphOrgEntityProviderTransformExtensionPoint". - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-backend-module-msgraph/report.api.md b/plugins/catalog-backend-module-msgraph/report.api.md index 4d7c0966a5..35ae148a25 100644 --- a/plugins/catalog-backend-module-msgraph/report.api.md +++ b/plugins/catalog-backend-module-msgraph/report.api.md @@ -323,14 +323,4 @@ export type UserTransformer = ( user: MicrosoftGraph.User, userPhoto?: string, ) => Promise; - -// Warnings were encountered during analysis: -// -// src/microsoftGraph/client.d.ts:109:5 - (ae-undocumented) Missing documentation for "getUserPhoto". -// src/microsoftGraph/client.d.ts:129:5 - (ae-undocumented) Missing documentation for "getGroupPhoto". -// src/microsoftGraph/client.d.ts:176:5 - (ae-unresolved-link) The @link reference could not be resolved: The package "@backstage/plugin-catalog-backend-module-msgraph" does not have an export "entityName" -// src/processors/MicrosoftGraphOrgEntityProvider.d.ts:119:5 - (ae-undocumented) Missing documentation for "fromConfig". -// src/processors/MicrosoftGraphOrgReaderProcessor.d.ts:18:5 - (ae-undocumented) Missing documentation for "fromConfig". -// src/processors/MicrosoftGraphOrgReaderProcessor.d.ts:31:5 - (ae-undocumented) Missing documentation for "getProcessorName". -// src/processors/MicrosoftGraphOrgReaderProcessor.d.ts:32:5 - (ae-undocumented) Missing documentation for "readLocation". ``` diff --git a/plugins/catalog-backend-module-msgraph/src/alpha.ts b/plugins/catalog-backend-module-msgraph/src/alpha.ts index 2c0cfe2fb4..cba672ce49 100644 --- a/plugins/catalog-backend-module-msgraph/src/alpha.ts +++ b/plugins/catalog-backend-module-msgraph/src/alpha.ts @@ -15,18 +15,7 @@ */ import { default as feature } from './module'; -import { - MicrosoftGraphOrgEntityProviderTransformsExtensionPoint as ExtensionPoint, - microsoftGraphOrgEntityProviderTransformExtensionPoint as extensionPoint, -} from './module'; /** @alpha */ const _feature = feature; export default _feature; - -/** @alpha */ -export type MicrosoftGraphOrgEntityProviderTransformsExtensionPoint = - ExtensionPoint; -/** @alpha */ -export const microsoftGraphOrgEntityProviderTransformExtensionPoint = - extensionPoint; diff --git a/plugins/catalog-backend-module-msgraph/src/microsoftGraph/client.ts b/plugins/catalog-backend-module-msgraph/src/microsoftGraph/client.ts index c190e2a959..2dc2a65135 100644 --- a/plugins/catalog-backend-module-msgraph/src/microsoftGraph/client.ts +++ b/plugins/catalog-backend-module-msgraph/src/microsoftGraph/client.ts @@ -392,7 +392,7 @@ export class MicrosoftGraphClient { * from Graph API * * @param entityName - type of parent resource, either `User` or `Group` - * @param id - The unique identifier for the {@link entityName | entityName} resource + * @param id - The unique identifier for the `entityName` resource * @param maxSize - Maximum pixel height of the photo * */ diff --git a/plugins/catalog-backend-module-openapi/report.api.md b/plugins/catalog-backend-module-openapi/report.api.md index c913e63294..d79d852387 100644 --- a/plugins/catalog-backend-module-openapi/report.api.md +++ b/plugins/catalog-backend-module-openapi/report.api.md @@ -47,14 +47,5 @@ export class OpenApiRefProcessor implements CatalogProcessor { preProcessEntity(entity: Entity, location: LocationSpec): Promise; } -// Warnings were encountered during analysis: -// -// src/OpenApiRefProcessor.d.ts:12:1 - (ae-undocumented) Missing documentation for "OpenApiRefProcessor". -// src/OpenApiRefProcessor.d.ts:16:5 - (ae-undocumented) Missing documentation for "fromConfig". -// src/OpenApiRefProcessor.d.ts:25:5 - (ae-undocumented) Missing documentation for "getProcessorName". -// src/OpenApiRefProcessor.d.ts:26:5 - (ae-undocumented) Missing documentation for "preProcessEntity". -// src/index.d.ts:8:22 - (ae-undocumented) Missing documentation for "openApiPlaceholderResolver". -// src/jsonSchemaRefPlaceholderResolver.d.ts:4:1 - (ae-undocumented) Missing documentation for "jsonSchemaRefPlaceholderResolver". - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-backend-module-puppetdb/report.api.md b/plugins/catalog-backend-module-puppetdb/report.api.md index 00874a3b2f..f6fa5bfc83 100644 --- a/plugins/catalog-backend-module-puppetdb/report.api.md +++ b/plugins/catalog-backend-module-puppetdb/report.api.md @@ -75,12 +75,4 @@ export type ResourceTransformer = ( node: PuppetNode, config: PuppetDbEntityProviderConfig, ) => Promise; - -// Warnings were encountered during analysis: -// -// src/providers/PuppetDbEntityProvider.d.ts:39:8 - (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration -// src/providers/PuppetDbEntityProvider.d.ts:41:5 - (ae-unresolved-link) The @link reference could not be resolved: The package "@backstage/plugin-catalog-backend-module-puppetdb" does not have an export "LoggerService" -// src/providers/PuppetDbEntityProvider.d.ts:41:5 - (ae-unresolved-link) The @link reference could not be resolved: The package "@backstage/plugin-catalog-backend-module-puppetdb" does not have an export "SchedulerServiceTaskRunner" -// src/providers/PuppetDbEntityProvider.d.ts:51:8 - (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration -// src/providers/PuppetDbEntityProvider.d.ts:53:5 - (ae-unresolved-link) The @link reference could not be resolved: The package "@backstage/plugin-catalog-backend-module-puppetdb" does not have an export "SchedulerServiceTaskRunner" ``` diff --git a/plugins/catalog-backend-module-puppetdb/src/providers/PuppetDbEntityProvider.ts b/plugins/catalog-backend-module-puppetdb/src/providers/PuppetDbEntityProvider.ts index fc13f45c39..8849e32c16 100644 --- a/plugins/catalog-backend-module-puppetdb/src/providers/PuppetDbEntityProvider.ts +++ b/plugins/catalog-backend-module-puppetdb/src/providers/PuppetDbEntityProvider.ts @@ -99,11 +99,10 @@ export class PuppetDbEntityProvider implements EntityProvider { * Creates an instance of {@link PuppetDbEntityProvider}. * * @param config - Configuration of the provider. - * @param logger - The instance of a {@link LoggerService}. - * @param taskRunner - The instance of {@link SchedulerServiceTaskRunner}. + * @param logger - The instance of a {@link @backstage/backend-plugin-api#LoggerService}. + * @param taskRunner - The instance of {@link @backstage/backend-plugin-api#SchedulerServiceTaskRunner}. * @param transformer - A {@link ResourceTransformer} function. * - * @private */ private constructor( config: PuppetDbEntityProviderConfig, @@ -133,9 +132,7 @@ export class PuppetDbEntityProvider implements EntityProvider { /** * Creates a function that can be used to schedule a refresh of the catalog. * - * @param taskRunner - The instance of {@link SchedulerServiceTaskRunner}. - * - * @private + * @param taskRunner - The instance of {@link @backstage/backend-plugin-api#SchedulerServiceTaskRunner}. */ private createScheduleFn( taskRunner: SchedulerServiceTaskRunner, @@ -218,7 +215,7 @@ function withLocations(baseUrl: string, entity: Entity): Entity { /** * Tracks the progress of the PuppetDB read and commit operations. * - * @param logger - The instance of a {@link LoggerService}. + * @param logger - The instance of a {@link @backstage/backend-plugin-api#LoggerService}. */ function trackProgress(logger: LoggerService) { let timestamp = Date.now(); diff --git a/plugins/catalog-backend-module-scaffolder-entity-model/report.api.md b/plugins/catalog-backend-module-scaffolder-entity-model/report.api.md index e4af5d5ef5..49542b0396 100644 --- a/plugins/catalog-backend-module-scaffolder-entity-model/report.api.md +++ b/plugins/catalog-backend-module-scaffolder-entity-model/report.api.md @@ -26,10 +26,4 @@ export class ScaffolderEntitiesProcessor implements CatalogProcessor { // (undocumented) validateEntityKind(entity: Entity): Promise; } - -// Warnings were encountered during analysis: -// -// src/processor/ScaffolderEntitiesProcessor.d.ts:10:5 - (ae-undocumented) Missing documentation for "getProcessorName". -// src/processor/ScaffolderEntitiesProcessor.d.ts:12:5 - (ae-undocumented) Missing documentation for "validateEntityKind". -// src/processor/ScaffolderEntitiesProcessor.d.ts:13:5 - (ae-undocumented) Missing documentation for "postProcessEntity". ``` diff --git a/plugins/catalog-backend-module-unprocessed/report.api.md b/plugins/catalog-backend-module-unprocessed/report.api.md index ea3a9d974c..493082ac7c 100644 --- a/plugins/catalog-backend-module-unprocessed/report.api.md +++ b/plugins/catalog-backend-module-unprocessed/report.api.md @@ -27,9 +27,4 @@ export class UnprocessedEntitiesModule { // (undocumented) registerRoutes(): void; } - -// Warnings were encountered during analysis: -// -// src/UnprocessedEntitiesModule.d.ts:15:5 - (ae-undocumented) Missing documentation for "create". -// src/UnprocessedEntitiesModule.d.ts:26:5 - (ae-undocumented) Missing documentation for "registerRoutes". ``` diff --git a/plugins/catalog-backend/report-alpha.api.md b/plugins/catalog-backend/report-alpha.api.md index 59155670ba..d32ef323c9 100644 --- a/plugins/catalog-backend/report-alpha.api.md +++ b/plugins/catalog-backend/report-alpha.api.md @@ -146,9 +146,5 @@ export const permissionRules: { >; }; -// Warnings were encountered during analysis: -// -// src/alpha.d.ts:2:15 - (ae-undocumented) Missing documentation for "_feature". - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-backend/report.api.md b/plugins/catalog-backend/report.api.md index 9294c71377..a200057a3a 100644 --- a/plugins/catalog-backend/report.api.md +++ b/plugins/catalog-backend/report.api.md @@ -483,85 +483,4 @@ export class UrlReaderProcessor implements CatalogProcessor_2 { cache: CatalogProcessorCache_2, ): Promise; } - -// Warnings were encountered during analysis: -// -// src/constants.d.ts:2:22 - (ae-undocumented) Missing documentation for "CATALOG_CONFLICTS_TOPIC". -// src/constants.d.ts:4:22 - (ae-undocumented) Missing documentation for "CATALOG_ERRORS_TOPIC". -// src/deprecated.d.ts:8:22 - (ae-undocumented) Missing documentation for "locationSpecToMetadataName". -// src/deprecated.d.ts:13:22 - (ae-undocumented) Missing documentation for "locationSpecToLocationEntity". -// src/deprecated.d.ts:18:22 - (ae-undocumented) Missing documentation for "processingResult". -// src/deprecated.d.ts:31:1 - (ae-undocumented) Missing documentation for "EntitiesSearchFilter". -// src/deprecated.d.ts:36:1 - (ae-undocumented) Missing documentation for "EntityFilter". -// src/deprecated.d.ts:41:1 - (ae-undocumented) Missing documentation for "DeferredEntity". -// src/deprecated.d.ts:46:1 - (ae-undocumented) Missing documentation for "EntityRelationSpec". -// src/deprecated.d.ts:51:1 - (ae-undocumented) Missing documentation for "CatalogProcessor". -// src/deprecated.d.ts:56:1 - (ae-undocumented) Missing documentation for "CatalogProcessorParser". -// src/deprecated.d.ts:61:1 - (ae-undocumented) Missing documentation for "CatalogProcessorCache". -// src/deprecated.d.ts:66:1 - (ae-undocumented) Missing documentation for "CatalogProcessorEmit". -// src/deprecated.d.ts:71:1 - (ae-undocumented) Missing documentation for "CatalogProcessorLocationResult". -// src/deprecated.d.ts:76:1 - (ae-undocumented) Missing documentation for "CatalogProcessorEntityResult". -// src/deprecated.d.ts:81:1 - (ae-undocumented) Missing documentation for "CatalogProcessorRelationResult". -// src/deprecated.d.ts:86:1 - (ae-undocumented) Missing documentation for "CatalogProcessorErrorResult". -// src/deprecated.d.ts:91:1 - (ae-undocumented) Missing documentation for "CatalogProcessorRefreshKeysResult". -// src/deprecated.d.ts:96:1 - (ae-undocumented) Missing documentation for "CatalogProcessorResult". -// src/deprecated.d.ts:101:1 - (ae-undocumented) Missing documentation for "EntityProvider". -// src/deprecated.d.ts:106:1 - (ae-undocumented) Missing documentation for "EntityProviderConnection". -// src/deprecated.d.ts:111:1 - (ae-undocumented) Missing documentation for "EntityProviderMutation". -// src/deprecated.d.ts:129:1 - (ae-undocumented) Missing documentation for "AnalyzeOptions". -// src/deprecated.d.ts:134:1 - (ae-undocumented) Missing documentation for "LocationAnalyzer". -// src/deprecated.d.ts:139:1 - (ae-undocumented) Missing documentation for "ScmLocationAnalyzer". -// src/deprecated.d.ts:144:1 - (ae-undocumented) Missing documentation for "PlaceholderResolver". -// src/deprecated.d.ts:149:1 - (ae-undocumented) Missing documentation for "PlaceholderResolverParams". -// src/deprecated.d.ts:154:1 - (ae-undocumented) Missing documentation for "PlaceholderResolverRead". -// src/deprecated.d.ts:159:1 - (ae-undocumented) Missing documentation for "PlaceholderResolverResolveUrl". -// src/deprecated.d.ts:164:1 - (ae-undocumented) Missing documentation for "AnalyzeLocationRequest". -// src/deprecated.d.ts:169:1 - (ae-undocumented) Missing documentation for "AnalyzeLocationResponse". -// src/deprecated.d.ts:202:22 - (ae-undocumented) Missing documentation for "DefaultCatalogCollatorFactory". -// src/deprecated.d.ts:207:22 - (ae-undocumented) Missing documentation for "defaultCatalogCollatorEntityTransformer". -// src/deprecated.d.ts:212:1 - (ae-undocumented) Missing documentation for "DefaultCatalogCollatorFactoryOptions". -// src/deprecated.d.ts:217:1 - (ae-undocumented) Missing documentation for "CatalogCollatorEntityTransformer". -// src/processing/types.d.ts:31:5 - (ae-undocumented) Missing documentation for "start". -// src/processing/types.d.ts:32:5 - (ae-undocumented) Missing documentation for "stop". -// src/processors/AnnotateLocationEntityProcessor.d.ts:6:1 - (ae-undocumented) Missing documentation for "AnnotateLocationEntityProcessor". -// src/processors/AnnotateLocationEntityProcessor.d.ts:11:5 - (ae-undocumented) Missing documentation for "getProcessorName". -// src/processors/AnnotateLocationEntityProcessor.d.ts:12:5 - (ae-undocumented) Missing documentation for "preProcessEntity". -// src/processors/AnnotateScmSlugEntityProcessor.d.ts:7:1 - (ae-undocumented) Missing documentation for "AnnotateScmSlugEntityProcessor". -// src/processors/AnnotateScmSlugEntityProcessor.d.ts:13:5 - (ae-undocumented) Missing documentation for "getProcessorName". -// src/processors/AnnotateScmSlugEntityProcessor.d.ts:14:5 - (ae-undocumented) Missing documentation for "fromConfig". -// src/processors/AnnotateScmSlugEntityProcessor.d.ts:17:5 - (ae-undocumented) Missing documentation for "preProcessEntity". -// src/processors/BuiltinKindsEntityProcessor.d.ts:5:1 - (ae-undocumented) Missing documentation for "BuiltinKindsEntityProcessor". -// src/processors/BuiltinKindsEntityProcessor.d.ts:7:5 - (ae-undocumented) Missing documentation for "getProcessorName". -// src/processors/BuiltinKindsEntityProcessor.d.ts:8:5 - (ae-undocumented) Missing documentation for "validateEntityKind". -// src/processors/BuiltinKindsEntityProcessor.d.ts:9:5 - (ae-undocumented) Missing documentation for "postProcessEntity". -// src/processors/CodeOwnersProcessor.d.ts:8:1 - (ae-undocumented) Missing documentation for "CodeOwnersProcessor". -// src/processors/CodeOwnersProcessor.d.ts:12:5 - (ae-undocumented) Missing documentation for "fromConfig". -// src/processors/CodeOwnersProcessor.d.ts:21:5 - (ae-undocumented) Missing documentation for "getProcessorName". -// src/processors/CodeOwnersProcessor.d.ts:22:5 - (ae-undocumented) Missing documentation for "preProcessEntity". -// src/processors/FileReaderProcessor.d.ts:4:1 - (ae-undocumented) Missing documentation for "FileReaderProcessor". -// src/processors/FileReaderProcessor.d.ts:5:5 - (ae-undocumented) Missing documentation for "getProcessorName". -// src/processors/FileReaderProcessor.d.ts:6:5 - (ae-undocumented) Missing documentation for "readLocation". -// src/processors/LocationEntityProcessor.d.ts:10:1 - (ae-undocumented) Missing documentation for "LocationEntityProcessorOptions". -// src/processors/LocationEntityProcessor.d.ts:28:5 - (ae-undocumented) Missing documentation for "getProcessorName". -// src/processors/LocationEntityProcessor.d.ts:29:5 - (ae-undocumented) Missing documentation for "postProcessEntity". -// src/processors/PlaceholderProcessor.d.ts:8:1 - (ae-undocumented) Missing documentation for "PlaceholderProcessorOptions". -// src/processors/PlaceholderProcessor.d.ts:21:5 - (ae-undocumented) Missing documentation for "getProcessorName". -// src/processors/PlaceholderProcessor.d.ts:22:5 - (ae-undocumented) Missing documentation for "preProcessEntity". -// src/processors/UrlReaderProcessor.d.ts:5:1 - (ae-undocumented) Missing documentation for "UrlReaderProcessor". -// src/processors/UrlReaderProcessor.d.ts:12:5 - (ae-undocumented) Missing documentation for "getProcessorName". -// src/processors/UrlReaderProcessor.d.ts:13:5 - (ae-undocumented) Missing documentation for "readLocation". -// src/search/DefaultCatalogCollator.d.ts:11:1 - (ae-undocumented) Missing documentation for "DefaultCatalogCollator". -// src/search/DefaultCatalogCollator.d.ts:12:5 - (ae-undocumented) Missing documentation for "discovery". -// src/search/DefaultCatalogCollator.d.ts:13:5 - (ae-undocumented) Missing documentation for "locationTemplate". -// src/search/DefaultCatalogCollator.d.ts:14:5 - (ae-undocumented) Missing documentation for "filter". -// src/search/DefaultCatalogCollator.d.ts:15:5 - (ae-undocumented) Missing documentation for "catalogClient". -// src/search/DefaultCatalogCollator.d.ts:16:5 - (ae-undocumented) Missing documentation for "type". -// src/search/DefaultCatalogCollator.d.ts:17:5 - (ae-undocumented) Missing documentation for "visibilityPermission". -// src/search/DefaultCatalogCollator.d.ts:18:5 - (ae-undocumented) Missing documentation for "tokenManager". -// src/search/DefaultCatalogCollator.d.ts:19:5 - (ae-undocumented) Missing documentation for "fromConfig". -// src/search/DefaultCatalogCollator.d.ts:31:5 - (ae-undocumented) Missing documentation for "applyArgsToFormat". -// src/search/DefaultCatalogCollator.d.ts:33:5 - (ae-undocumented) Missing documentation for "execute". -// src/service/CatalogBuilder.d.ts:19:1 - (ae-undocumented) Missing documentation for "CatalogEnvironment". -// src/service/CatalogBuilder.d.ts:233:5 - (ae-undocumented) Missing documentation for "subscribe". -// src/util/parse.d.ts:6:1 - (ae-undocumented) Missing documentation for "parseEntityYaml". ``` diff --git a/plugins/catalog-common/report.api.md b/plugins/catalog-common/report.api.md index 95b1d9b6c6..231c8aac34 100644 --- a/plugins/catalog-common/report.api.md +++ b/plugins/catalog-common/report.api.md @@ -64,16 +64,4 @@ export type LocationSpec = { target: string; presence?: 'optional' | 'required'; }; - -// Warnings were encountered during analysis: -// -// src/ingestion/LocationAnalyzer.d.ts:5:1 - (ae-undocumented) Missing documentation for "AnalyzeLocationRequest". -// src/ingestion/LocationAnalyzer.d.ts:10:1 - (ae-undocumented) Missing documentation for "AnalyzeLocationResponse". -// src/ingestion/LocationAnalyzer.d.ts:39:1 - (ae-undocumented) Missing documentation for "AnalyzeLocationEntityField". -// src/search/CatalogEntityDocument.d.ts:9:5 - (ae-undocumented) Missing documentation for "componentType". -// src/search/CatalogEntityDocument.d.ts:10:5 - (ae-undocumented) Missing documentation for "type". -// src/search/CatalogEntityDocument.d.ts:11:5 - (ae-undocumented) Missing documentation for "namespace". -// src/search/CatalogEntityDocument.d.ts:12:5 - (ae-undocumented) Missing documentation for "kind". -// src/search/CatalogEntityDocument.d.ts:13:5 - (ae-undocumented) Missing documentation for "lifecycle". -// src/search/CatalogEntityDocument.d.ts:14:5 - (ae-undocumented) Missing documentation for "owner". ``` diff --git a/plugins/catalog-graph/report-alpha.api.md b/plugins/catalog-graph/report-alpha.api.md index 944fa203f1..f4699e9ceb 100644 --- a/plugins/catalog-graph/report-alpha.api.md +++ b/plugins/catalog-graph/report-alpha.api.md @@ -165,9 +165,5 @@ const _default: FrontendPlugin< >; export default _default; -// Warnings were encountered during analysis: -// -// src/alpha.d.ts:3:15 - (ae-undocumented) Missing documentation for "_default". - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-graph/report.api.md b/plugins/catalog-graph/report.api.md index b6e7388ac0..3f2dff2560 100644 --- a/plugins/catalog-graph/report.api.md +++ b/plugins/catalog-graph/report.api.md @@ -140,11 +140,4 @@ export type EntityRelationsGraphProps = { // @public export type RelationPairs = [string, string][]; - -// Warnings were encountered during analysis: -// -// src/components/EntityRelationsGraph/DefaultRenderLabel.d.ts:5:1 - (ae-undocumented) Missing documentation for "CustomLabelClassKey". -// src/components/EntityRelationsGraph/DefaultRenderNode.d.ts:5:1 - (ae-undocumented) Missing documentation for "CustomNodeClassKey". -// src/components/EntityRelationsGraph/EntityRelationsGraph.d.ts:7:1 - (ae-undocumented) Missing documentation for "EntityRelationsGraphClassKey". -// src/components/EntityRelationsGraph/EntityRelationsGraph.d.ts:11:1 - (ae-undocumented) Missing documentation for "EntityRelationsGraphProps". ``` diff --git a/plugins/catalog-import/report-alpha.api.md b/plugins/catalog-import/report-alpha.api.md index d966e04e7e..1706404b94 100644 --- a/plugins/catalog-import/report-alpha.api.md +++ b/plugins/catalog-import/report-alpha.api.md @@ -67,9 +67,5 @@ const _default: FrontendPlugin< >; export default _default; -// Warnings were encountered during analysis: -// -// src/alpha.d.ts:3:15 - (ae-undocumented) Missing documentation for "_default". - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-import/report.api.md b/plugins/catalog-import/report.api.md index 8c26da769d..c61aa97b06 100644 --- a/plugins/catalog-import/report.api.md +++ b/plugins/catalog-import/report.api.md @@ -366,46 +366,4 @@ export interface StepPrepareCreatePullRequestProps { // Warnings were encountered during analysis: // // src/api/CatalogImportApi.d.ts:25:5 - (ae-forgotten-export) The symbol "PartialEntity" needs to be exported by the entry point index.d.ts -// src/api/CatalogImportApi.d.ts:33:5 - (ae-undocumented) Missing documentation for "analyzeUrl". -// src/api/CatalogImportApi.d.ts:34:5 - (ae-undocumented) Missing documentation for "preparePullRequest". -// src/api/CatalogImportApi.d.ts:38:5 - (ae-undocumented) Missing documentation for "submitPullRequest". -// src/api/CatalogImportClient.d.ts:26:5 - (ae-undocumented) Missing documentation for "analyzeUrl". -// src/api/CatalogImportClient.d.ts:27:5 - (ae-undocumented) Missing documentation for "preparePullRequest". -// src/api/CatalogImportClient.d.ts:31:5 - (ae-undocumented) Missing documentation for "submitPullRequest". -// src/components/EntityListComponent/EntityListComponent.d.ts:9:5 - (ae-undocumented) Missing documentation for "locations". -// src/components/EntityListComponent/EntityListComponent.d.ts:13:5 - (ae-undocumented) Missing documentation for "locationListItemIcon". -// src/components/EntityListComponent/EntityListComponent.d.ts:14:5 - (ae-undocumented) Missing documentation for "collapsed". -// src/components/EntityListComponent/EntityListComponent.d.ts:15:5 - (ae-undocumented) Missing documentation for "firstListItem". -// src/components/EntityListComponent/EntityListComponent.d.ts:16:5 - (ae-undocumented) Missing documentation for "onItemClick". -// src/components/EntityListComponent/EntityListComponent.d.ts:17:5 - (ae-undocumented) Missing documentation for "withLinks". -// src/components/ImportInfoCard/ImportInfoCard.d.ts:8:5 - (ae-undocumented) Missing documentation for "exampleLocationUrl". -// src/components/ImportInfoCard/ImportInfoCard.d.ts:9:5 - (ae-undocumented) Missing documentation for "exampleRepositoryUrl". -// src/components/ImportStepper/ImportStepper.d.ts:11:5 - (ae-undocumented) Missing documentation for "initialUrl". -// src/components/ImportStepper/ImportStepper.d.ts:12:5 - (ae-undocumented) Missing documentation for "generateStepper". -// src/components/ImportStepper/ImportStepper.d.ts:13:5 - (ae-undocumented) Missing documentation for "variant". -// src/components/StepInitAnalyzeUrl/StepInitAnalyzeUrl.d.ts:10:5 - (ae-undocumented) Missing documentation for "onAnalysis". -// src/components/StepInitAnalyzeUrl/StepInitAnalyzeUrl.d.ts:13:5 - (ae-undocumented) Missing documentation for "disablePullRequest". -// src/components/StepInitAnalyzeUrl/StepInitAnalyzeUrl.d.ts:14:5 - (ae-undocumented) Missing documentation for "analysisUrl". -// src/components/StepInitAnalyzeUrl/StepInitAnalyzeUrl.d.ts:15:5 - (ae-undocumented) Missing documentation for "exampleLocationUrl". -// src/components/StepPrepareCreatePullRequest/AutocompleteTextField.d.ts:10:5 - (ae-undocumented) Missing documentation for "name". -// src/components/StepPrepareCreatePullRequest/AutocompleteTextField.d.ts:11:5 - (ae-undocumented) Missing documentation for "options". -// src/components/StepPrepareCreatePullRequest/AutocompleteTextField.d.ts:12:5 - (ae-undocumented) Missing documentation for "required". -// src/components/StepPrepareCreatePullRequest/AutocompleteTextField.d.ts:13:5 - (ae-undocumented) Missing documentation for "errors". -// src/components/StepPrepareCreatePullRequest/AutocompleteTextField.d.ts:14:5 - (ae-undocumented) Missing documentation for "rules". -// src/components/StepPrepareCreatePullRequest/AutocompleteTextField.d.ts:15:5 - (ae-undocumented) Missing documentation for "loading". -// src/components/StepPrepareCreatePullRequest/AutocompleteTextField.d.ts:16:5 - (ae-undocumented) Missing documentation for "loadingText". -// src/components/StepPrepareCreatePullRequest/AutocompleteTextField.d.ts:17:5 - (ae-undocumented) Missing documentation for "helperText". -// src/components/StepPrepareCreatePullRequest/AutocompleteTextField.d.ts:18:5 - (ae-undocumented) Missing documentation for "errorHelperText". -// src/components/StepPrepareCreatePullRequest/AutocompleteTextField.d.ts:19:5 - (ae-undocumented) Missing documentation for "textFieldProps". -// src/components/StepPrepareCreatePullRequest/PreviewCatalogInfoComponent.d.ts:9:5 - (ae-undocumented) Missing documentation for "repositoryUrl". -// src/components/StepPrepareCreatePullRequest/PreviewCatalogInfoComponent.d.ts:10:5 - (ae-undocumented) Missing documentation for "entities". -// src/components/StepPrepareCreatePullRequest/PreviewCatalogInfoComponent.d.ts:11:5 - (ae-undocumented) Missing documentation for "classes". -// src/components/StepPrepareCreatePullRequest/PreviewPullRequestComponent.d.ts:8:5 - (ae-undocumented) Missing documentation for "title". -// src/components/StepPrepareCreatePullRequest/PreviewPullRequestComponent.d.ts:9:5 - (ae-undocumented) Missing documentation for "description". -// src/components/StepPrepareCreatePullRequest/PreviewPullRequestComponent.d.ts:10:5 - (ae-undocumented) Missing documentation for "classes". -// src/components/StepPrepareCreatePullRequest/StepPrepareCreatePullRequest.d.ts:20:5 - (ae-undocumented) Missing documentation for "analyzeResult". -// src/components/StepPrepareCreatePullRequest/StepPrepareCreatePullRequest.d.ts:23:5 - (ae-undocumented) Missing documentation for "onPrepare". -// src/components/StepPrepareCreatePullRequest/StepPrepareCreatePullRequest.d.ts:26:5 - (ae-undocumented) Missing documentation for "onGoBack". -// src/components/StepPrepareCreatePullRequest/StepPrepareCreatePullRequest.d.ts:27:5 - (ae-undocumented) Missing documentation for "renderFormFields". -// src/components/useImportState.d.ts:80:1 - (ae-undocumented) Missing documentation for "ImportState". ``` diff --git a/plugins/catalog-node/report-alpha.api.md b/plugins/catalog-node/report-alpha.api.md index 4ef79f1f3c..ba02079ceb 100644 --- a/plugins/catalog-node/report-alpha.api.md +++ b/plugins/catalog-node/report-alpha.api.md @@ -98,25 +98,5 @@ export const catalogProcessingExtensionPoint: ExtensionPoint; -// Warnings were encountered during analysis: -// -// src/extensions.d.ts:8:1 - (ae-undocumented) Missing documentation for "CatalogLocationsExtensionPoint". -// src/extensions.d.ts:18:22 - (ae-undocumented) Missing documentation for "catalogLocationsExtensionPoint". -// src/extensions.d.ts:22:1 - (ae-undocumented) Missing documentation for "CatalogProcessingExtensionPoint". -// src/extensions.d.ts:23:5 - (ae-undocumented) Missing documentation for "addProcessor". -// src/extensions.d.ts:24:5 - (ae-undocumented) Missing documentation for "addEntityProvider". -// src/extensions.d.ts:25:5 - (ae-undocumented) Missing documentation for "addPlaceholderResolver". -// src/extensions.d.ts:26:5 - (ae-undocumented) Missing documentation for "setOnProcessingErrorHandler". -// src/extensions.d.ts:32:1 - (ae-undocumented) Missing documentation for "CatalogModelExtensionPoint". -// src/extensions.d.ts:50:22 - (ae-undocumented) Missing documentation for "catalogProcessingExtensionPoint". -// src/extensions.d.ts:54:1 - (ae-undocumented) Missing documentation for "CatalogAnalysisExtensionPoint". -// src/extensions.d.ts:77:22 - (ae-undocumented) Missing documentation for "catalogAnalysisExtensionPoint". -// src/extensions.d.ts:79:22 - (ae-undocumented) Missing documentation for "catalogModelExtensionPoint". -// src/extensions.d.ts:83:1 - (ae-undocumented) Missing documentation for "CatalogPermissionRuleInput". -// src/extensions.d.ts:87:1 - (ae-undocumented) Missing documentation for "CatalogPermissionExtensionPoint". -// src/extensions.d.ts:88:5 - (ae-undocumented) Missing documentation for "addPermissions". -// src/extensions.d.ts:89:5 - (ae-undocumented) Missing documentation for "addPermissionRules". -// src/extensions.d.ts:94:22 - (ae-undocumented) Missing documentation for "catalogPermissionExtensionPoint". - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-node/report.api.md b/plugins/catalog-node/report.api.md index 3702f933ee..43209aa862 100644 --- a/plugins/catalog-node/report.api.md +++ b/plugins/catalog-node/report.api.md @@ -243,22 +243,4 @@ export type ScmLocationAnalyzer = { existing: AnalyzeLocationExistingEntity[]; }>; }; - -// Warnings were encountered during analysis: -// -// src/api/processor.d.ts:10:1 - (ae-undocumented) Missing documentation for "CatalogProcessor". -// src/api/processor.d.ts:105:1 - (ae-undocumented) Missing documentation for "CatalogProcessorEmit". -// src/api/processor.d.ts:107:1 - (ae-undocumented) Missing documentation for "CatalogProcessorLocationResult". -// src/api/processor.d.ts:112:1 - (ae-undocumented) Missing documentation for "CatalogProcessorEntityResult". -// src/api/processor.d.ts:118:1 - (ae-undocumented) Missing documentation for "CatalogProcessorRelationResult". -// src/api/processor.d.ts:123:1 - (ae-undocumented) Missing documentation for "CatalogProcessorErrorResult". -// src/api/processor.d.ts:129:1 - (ae-undocumented) Missing documentation for "CatalogProcessorRefreshKeysResult". -// src/api/processor.d.ts:134:1 - (ae-undocumented) Missing documentation for "CatalogProcessorResult". -// src/processing/types.d.ts:17:1 - (ae-undocumented) Missing documentation for "PlaceholderResolverRead". -// src/processing/types.d.ts:19:1 - (ae-undocumented) Missing documentation for "PlaceholderResolverResolveUrl". -// src/processing/types.d.ts:21:1 - (ae-undocumented) Missing documentation for "PlaceholderResolverParams". -// src/processing/types.d.ts:30:1 - (ae-undocumented) Missing documentation for "PlaceholderResolver". -// src/processing/types.d.ts:32:1 - (ae-undocumented) Missing documentation for "LocationAnalyzer". -// src/processing/types.d.ts:42:1 - (ae-undocumented) Missing documentation for "AnalyzeOptions". -// src/processing/types.d.ts:47:1 - (ae-undocumented) Missing documentation for "ScmLocationAnalyzer". ``` diff --git a/plugins/catalog-react/report-alpha.api.md b/plugins/catalog-react/report-alpha.api.md index 6eec97b815..516d655967 100644 --- a/plugins/catalog-react/report-alpha.api.md +++ b/plugins/catalog-react/report-alpha.api.md @@ -221,11 +221,5 @@ export function useEntityPermission( error?: Error; }; -// Warnings were encountered during analysis: -// -// src/alpha/converters/convertLegacyEntityCardExtension.d.ts:5:1 - (ae-undocumented) Missing documentation for "convertLegacyEntityCardExtension". -// src/alpha/converters/convertLegacyEntityContentExtension.d.ts:5:1 - (ae-undocumented) Missing documentation for "convertLegacyEntityContentExtension". -// src/translation.d.ts:2:22 - (ae-undocumented) Missing documentation for "catalogReactTranslationRef". - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-react/report.api.md b/plugins/catalog-react/report.api.md index 515a3526be..af5102176d 100644 --- a/plugins/catalog-react/report.api.md +++ b/plugins/catalog-react/report.api.md @@ -840,118 +840,4 @@ export function useStarredEntity( toggleStarredEntity: () => void; isStarredEntity: boolean; }; - -// Warnings were encountered during analysis: -// -// src/apis/StarredEntitiesApi/MockStarredEntitiesApi.d.ts:12:5 - (ae-undocumented) Missing documentation for "toggleStarred". -// src/apis/StarredEntitiesApi/MockStarredEntitiesApi.d.ts:13:5 - (ae-undocumented) Missing documentation for "starredEntitie$". -// src/components/CatalogFilterLayout/CatalogFilterLayout.d.ts:15:22 - (ae-undocumented) Missing documentation for "CatalogFilterLayout". -// src/components/DefaultFilters/DefaultFilters.d.ts:16:22 - (ae-undocumented) Missing documentation for "DefaultFilters". -// src/components/EntityAutocompletePicker/EntityAutocompletePicker.d.ts:6:1 - (ae-undocumented) Missing documentation for "AllowedEntityFilters". -// src/components/EntityAutocompletePicker/EntityAutocompletePicker.d.ts:12:1 - (ae-undocumented) Missing documentation for "EntityAutocompletePickerProps". -// src/components/EntityAutocompletePicker/EntityAutocompletePicker.d.ts:25:1 - (ae-undocumented) Missing documentation for "CatalogReactEntityAutocompletePickerClassKey". -// src/components/EntityAutocompletePicker/EntityAutocompletePicker.d.ts:27:1 - (ae-undocumented) Missing documentation for "EntityAutocompletePicker". -// src/components/EntityKindPicker/EntityKindPicker.d.ts:13:5 - (ae-undocumented) Missing documentation for "initialFilter". -// src/components/EntityKindPicker/EntityKindPicker.d.ts:14:5 - (ae-undocumented) Missing documentation for "hidden". -// src/components/EntityKindPicker/EntityKindPicker.d.ts:17:22 - (ae-undocumented) Missing documentation for "EntityKindPicker". -// src/components/EntityLifecyclePicker/EntityLifecyclePicker.d.ts:3:1 - (ae-undocumented) Missing documentation for "CatalogReactEntityLifecyclePickerClassKey". -// src/components/EntityLifecyclePicker/EntityLifecyclePicker.d.ts:5:22 - (ae-undocumented) Missing documentation for "EntityLifecyclePicker". -// src/components/EntityNamespacePicker/EntityNamespacePicker.d.ts:3:1 - (ae-undocumented) Missing documentation for "CatalogReactEntityNamespacePickerClassKey". -// src/components/EntityNamespacePicker/EntityNamespacePicker.d.ts:10:5 - (ae-undocumented) Missing documentation for "initiallySelectedNamespaces". -// src/components/EntityNamespacePicker/EntityNamespacePicker.d.ts:13:22 - (ae-undocumented) Missing documentation for "EntityNamespacePicker". -// src/components/EntityOwnerPicker/EntityOwnerPicker.d.ts:3:1 - (ae-undocumented) Missing documentation for "CatalogReactEntityOwnerPickerClassKey". -// src/components/EntityOwnerPicker/EntityOwnerPicker.d.ts:5:1 - (ae-undocumented) Missing documentation for "FixedWidthFormControlLabelClassKey". -// src/components/EntityOwnerPicker/EntityOwnerPicker.d.ts:9:1 - (ae-undocumented) Missing documentation for "EntityOwnerPickerProps". -// src/components/EntityOwnerPicker/EntityOwnerPicker.d.ts:13:22 - (ae-undocumented) Missing documentation for "EntityOwnerPicker". -// src/components/EntityProcessingStatusPicker/EntityProcessingStatusPicker.d.ts:3:1 - (ae-undocumented) Missing documentation for "CatalogReactEntityProcessingStatusPickerClassKey". -// src/components/EntityProcessingStatusPicker/EntityProcessingStatusPicker.d.ts:5:22 - (ae-undocumented) Missing documentation for "EntityProcessingStatusPicker". -// src/components/EntityRefLink/humanize.d.ts:8:1 - (ae-undocumented) Missing documentation for "humanizeEntityRef". -// src/components/EntitySearchBar/EntitySearchBar.d.ts:3:1 - (ae-undocumented) Missing documentation for "CatalogReactEntitySearchBarClassKey". -// src/components/EntityTable/EntityTable.d.ts:10:5 - (ae-undocumented) Missing documentation for "title". -// src/components/EntityTable/EntityTable.d.ts:11:5 - (ae-undocumented) Missing documentation for "variant". -// src/components/EntityTable/EntityTable.d.ts:12:5 - (ae-undocumented) Missing documentation for "entities". -// src/components/EntityTable/EntityTable.d.ts:13:5 - (ae-undocumented) Missing documentation for "emptyContent". -// src/components/EntityTable/EntityTable.d.ts:14:5 - (ae-undocumented) Missing documentation for "columns". -// src/components/EntityTable/EntityTable.d.ts:15:5 - (ae-undocumented) Missing documentation for "tableOptions". -// src/components/EntityTable/columns.d.ts:4:22 - (ae-undocumented) Missing documentation for "columnFactories". -// src/components/EntityTagPicker/EntityTagPicker.d.ts:3:1 - (ae-undocumented) Missing documentation for "CatalogReactEntityTagPickerClassKey". -// src/components/EntityTagPicker/EntityTagPicker.d.ts:5:1 - (ae-undocumented) Missing documentation for "EntityTagPickerProps". -// src/components/EntityTagPicker/EntityTagPicker.d.ts:9:22 - (ae-undocumented) Missing documentation for "EntityTagPicker". -// src/components/EntityTypePicker/EntityTypePicker.d.ts:8:5 - (ae-undocumented) Missing documentation for "initialFilter". -// src/components/EntityTypePicker/EntityTypePicker.d.ts:9:5 - (ae-undocumented) Missing documentation for "hidden". -// src/components/EntityTypePicker/EntityTypePicker.d.ts:12:22 - (ae-undocumented) Missing documentation for "EntityTypePicker". -// src/components/FavoriteEntity/FavoriteEntity.d.ts:5:1 - (ae-undocumented) Missing documentation for "FavoriteEntityProps". -// src/components/MissingAnnotationEmptyState/MissingAnnotationEmptyState.d.ts:3:1 - (ae-undocumented) Missing documentation for "MissingAnnotationEmptyStateClassKey". -// src/components/UnregisterEntityDialog/UnregisterEntityDialog.d.ts:4:1 - (ae-undocumented) Missing documentation for "UnregisterEntityDialogProps". -// src/components/UnregisterEntityDialog/UnregisterEntityDialog.d.ts:11:22 - (ae-undocumented) Missing documentation for "UnregisterEntityDialog". -// src/components/UserListPicker/UserListPicker.d.ts:5:1 - (ae-undocumented) Missing documentation for "CatalogReactUserListPickerClassKey". -// src/components/UserListPicker/UserListPicker.d.ts:15:1 - (ae-undocumented) Missing documentation for "UserListPickerProps". -// src/components/UserListPicker/UserListPicker.d.ts:20:22 - (ae-undocumented) Missing documentation for "UserListPicker". -// src/deprecated.d.ts:7:1 - (ae-undocumented) Missing documentation for "MockEntityListContextProvider". -// src/filters.d.ts:8:5 - (ae-undocumented) Missing documentation for "value". -// src/filters.d.ts:10:5 - (ae-undocumented) Missing documentation for "getCatalogFilters". -// src/filters.d.ts:11:5 - (ae-undocumented) Missing documentation for "toQueryValue". -// src/filters.d.ts:18:5 - (ae-undocumented) Missing documentation for "value". -// src/filters.d.ts:20:5 - (ae-undocumented) Missing documentation for "getTypes". -// src/filters.d.ts:21:5 - (ae-undocumented) Missing documentation for "getCatalogFilters". -// src/filters.d.ts:22:5 - (ae-undocumented) Missing documentation for "toQueryValue". -// src/filters.d.ts:29:5 - (ae-undocumented) Missing documentation for "values". -// src/filters.d.ts:31:5 - (ae-undocumented) Missing documentation for "filterEntity". -// src/filters.d.ts:32:5 - (ae-undocumented) Missing documentation for "getCatalogFilters". -// src/filters.d.ts:33:5 - (ae-undocumented) Missing documentation for "toQueryValue". -// src/filters.d.ts:40:5 - (ae-undocumented) Missing documentation for "value". -// src/filters.d.ts:42:5 - (ae-undocumented) Missing documentation for "filterEntity". -// src/filters.d.ts:43:5 - (ae-undocumented) Missing documentation for "getFullTextFilters". -// src/filters.d.ts:47:5 - (ae-undocumented) Missing documentation for "toQueryValue". -// src/filters.d.ts:57:5 - (ae-undocumented) Missing documentation for "values". -// src/filters.d.ts:59:5 - (ae-undocumented) Missing documentation for "getCatalogFilters". -// src/filters.d.ts:60:5 - (ae-undocumented) Missing documentation for "filterEntity". -// src/filters.d.ts:72:5 - (ae-undocumented) Missing documentation for "values". -// src/filters.d.ts:74:5 - (ae-undocumented) Missing documentation for "getCatalogFilters". -// src/filters.d.ts:75:5 - (ae-undocumented) Missing documentation for "filterEntity". -// src/filters.d.ts:76:5 - (ae-undocumented) Missing documentation for "toQueryValue". -// src/filters.d.ts:83:5 - (ae-undocumented) Missing documentation for "values". -// src/filters.d.ts:85:5 - (ae-undocumented) Missing documentation for "getCatalogFilters". -// src/filters.d.ts:86:5 - (ae-undocumented) Missing documentation for "filterEntity". -// src/filters.d.ts:87:5 - (ae-undocumented) Missing documentation for "toQueryValue". -// src/filters.d.ts:92:1 - (ae-undocumented) Missing documentation for "EntityUserFilter". -// src/filters.d.ts:93:5 - (ae-undocumented) Missing documentation for "value". -// src/filters.d.ts:94:5 - (ae-undocumented) Missing documentation for "refs". -// src/filters.d.ts:96:5 - (ae-undocumented) Missing documentation for "owned". -// src/filters.d.ts:97:5 - (ae-undocumented) Missing documentation for "all". -// src/filters.d.ts:98:5 - (ae-undocumented) Missing documentation for "starred". -// src/filters.d.ts:99:5 - (ae-undocumented) Missing documentation for "getCatalogFilters". -// src/filters.d.ts:100:5 - (ae-undocumented) Missing documentation for "filterEntity". -// src/filters.d.ts:101:5 - (ae-undocumented) Missing documentation for "toQueryValue". -// src/filters.d.ts:109:5 - (ae-undocumented) Missing documentation for "value". -// src/filters.d.ts:110:5 - (ae-undocumented) Missing documentation for "isOwnedEntity". -// src/filters.d.ts:111:5 - (ae-undocumented) Missing documentation for "isStarredEntity". -// src/filters.d.ts:113:5 - (ae-undocumented) Missing documentation for "filterEntity". -// src/filters.d.ts:114:5 - (ae-undocumented) Missing documentation for "toQueryValue". -// src/filters.d.ts:121:5 - (ae-undocumented) Missing documentation for "value". -// src/filters.d.ts:123:5 - (ae-undocumented) Missing documentation for "getCatalogFilters". -// src/filters.d.ts:124:5 - (ae-undocumented) Missing documentation for "filterEntity". -// src/filters.d.ts:131:5 - (ae-undocumented) Missing documentation for "value". -// src/filters.d.ts:133:5 - (ae-undocumented) Missing documentation for "filterEntity". -// src/hooks/useEntity.d.ts:4:1 - (ae-undocumented) Missing documentation for "EntityLoadingStatus". -// src/hooks/useEntity.d.ts:16:5 - (ae-undocumented) Missing documentation for "children". -// src/hooks/useEntity.d.ts:17:5 - (ae-undocumented) Missing documentation for "entity". -// src/hooks/useEntity.d.ts:18:5 - (ae-undocumented) Missing documentation for "loading". -// src/hooks/useEntity.d.ts:19:5 - (ae-undocumented) Missing documentation for "error". -// src/hooks/useEntity.d.ts:20:5 - (ae-undocumented) Missing documentation for "refresh". -// src/hooks/useEntity.d.ts:34:5 - (ae-undocumented) Missing documentation for "children". -// src/hooks/useEntity.d.ts:35:5 - (ae-undocumented) Missing documentation for "entity". -// src/hooks/useEntityListProvider.d.ts:6:1 - (ae-undocumented) Missing documentation for "DefaultEntityFilters". -// src/hooks/useEntityListProvider.d.ts:19:1 - (ae-undocumented) Missing documentation for "PaginationMode". -// src/hooks/useEntityListProvider.d.ts:21:1 - (ae-undocumented) Missing documentation for "EntityListContextProps". -// src/hooks/useEntityListProvider.d.ts:65:1 - (ae-undocumented) Missing documentation for "EntityListProviderProps". -// src/hooks/useStarredEntities.d.ts:3:1 - (ae-undocumented) Missing documentation for "useStarredEntities". -// src/hooks/useStarredEntity.d.ts:3:1 - (ae-undocumented) Missing documentation for "useStarredEntity". -// src/overridableComponents.d.ts:6:1 - (ae-undocumented) Missing documentation for "CatalogReactComponentsNameToClassKey". -// src/overridableComponents.d.ts:19:1 - (ae-undocumented) Missing documentation for "BackstageOverrides". -// src/types.d.ts:3:1 - (ae-undocumented) Missing documentation for "EntityFilter". -// src/types.d.ts:25:1 - (ae-undocumented) Missing documentation for "UserListFilterKind". -// src/types.d.ts:27:1 - (ae-undocumented) Missing documentation for "EntityListPagination". -// src/utils/getEntitySourceLocation.d.ts:4:1 - (ae-undocumented) Missing documentation for "EntitySourceLocation". -// src/utils/getEntitySourceLocation.d.ts:9:1 - (ae-undocumented) Missing documentation for "getEntitySourceLocation". ``` diff --git a/plugins/catalog-unprocessed-entities/report.api.md b/plugins/catalog-unprocessed-entities/report.api.md index dd0386204a..7d8f6299da 100644 --- a/plugins/catalog-unprocessed-entities/report.api.md +++ b/plugins/catalog-unprocessed-entities/report.api.md @@ -73,9 +73,5 @@ export type UnprocessedEntityError = { }; }; -// Warnings were encountered during analysis: -// -// src/components/UnprocessedEntities.d.ts:3:22 - (ae-undocumented) Missing documentation for "UnprocessedEntitiesContent". - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog/report-alpha.api.md b/plugins/catalog/report-alpha.api.md index b7fa14d003..1b1ce54d92 100644 --- a/plugins/catalog/report-alpha.api.md +++ b/plugins/catalog/report-alpha.api.md @@ -870,10 +870,5 @@ const _default: FrontendPlugin< >; export default _default; -// Warnings were encountered during analysis: -// -// src/alpha/plugin.d.ts:3:15 - (ae-undocumented) Missing documentation for "_default". -// src/alpha/translation.d.ts:2:22 - (ae-undocumented) Missing documentation for "catalogTranslationRef". - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog/report.api.md b/plugins/catalog/report.api.md index a7538900a0..d817118e3a 100644 --- a/plugins/catalog/report.api.md +++ b/plugins/catalog/report.api.md @@ -667,131 +667,4 @@ export type SystemDiagramCardClassKey = | 'componentNode' | 'apiNode' | 'resourceNode'; - -// Warnings were encountered during analysis: -// -// src/apis/StarredEntitiesApi/DefaultStarredEntitiesApi.d.ts:15:5 - (ae-undocumented) Missing documentation for "toggleStarred". -// src/apis/StarredEntitiesApi/DefaultStarredEntitiesApi.d.ts:16:5 - (ae-undocumented) Missing documentation for "starredEntitie$". -// src/components/AboutCard/AboutCard.d.ts:9:5 - (ae-undocumented) Missing documentation for "variant". -// src/components/AboutCard/AboutContent.d.ts:9:5 - (ae-undocumented) Missing documentation for "entity". -// src/components/AboutCard/AboutContent.d.ts:12:1 - (ae-undocumented) Missing documentation for "AboutContent". -// src/components/AboutCard/AboutField.d.ts:8:5 - (ae-undocumented) Missing documentation for "label". -// src/components/AboutCard/AboutField.d.ts:9:5 - (ae-undocumented) Missing documentation for "value". -// src/components/AboutCard/AboutField.d.ts:10:5 - (ae-undocumented) Missing documentation for "gridSizes". -// src/components/AboutCard/AboutField.d.ts:11:5 - (ae-undocumented) Missing documentation for "children". -// src/components/AboutCard/AboutField.d.ts:14:1 - (ae-undocumented) Missing documentation for "AboutField". -// src/components/CatalogKindHeader/CatalogKindHeader.d.ts:23:1 - (ae-undocumented) Missing documentation for "CatalogKindHeader". -// src/components/CatalogPage/DefaultCatalogPage.d.ts:12:5 - (ae-undocumented) Missing documentation for "initiallySelectedFilter". -// src/components/CatalogPage/DefaultCatalogPage.d.ts:13:5 - (ae-undocumented) Missing documentation for "columns". -// src/components/CatalogPage/DefaultCatalogPage.d.ts:14:5 - (ae-undocumented) Missing documentation for "actions". -// src/components/CatalogPage/DefaultCatalogPage.d.ts:15:5 - (ae-undocumented) Missing documentation for "initialKind". -// src/components/CatalogPage/DefaultCatalogPage.d.ts:16:5 - (ae-undocumented) Missing documentation for "tableOptions". -// src/components/CatalogPage/DefaultCatalogPage.d.ts:17:5 - (ae-undocumented) Missing documentation for "emptyContent". -// src/components/CatalogPage/DefaultCatalogPage.d.ts:18:5 - (ae-undocumented) Missing documentation for "ownerPickerMode". -// src/components/CatalogPage/DefaultCatalogPage.d.ts:19:5 - (ae-undocumented) Missing documentation for "filters". -// src/components/CatalogPage/DefaultCatalogPage.d.ts:20:5 - (ae-undocumented) Missing documentation for "initiallySelectedNamespaces". -// src/components/CatalogPage/DefaultCatalogPage.d.ts:21:5 - (ae-undocumented) Missing documentation for "pagination". -// src/components/CatalogSearchResultListItem/CatalogSearchResultListItem.d.ts:4:1 - (ae-undocumented) Missing documentation for "CatalogSearchResultListItemClassKey". -// src/components/CatalogSearchResultListItem/CatalogSearchResultListItem.d.ts:11:5 - (ae-undocumented) Missing documentation for "icon". -// src/components/CatalogSearchResultListItem/CatalogSearchResultListItem.d.ts:12:5 - (ae-undocumented) Missing documentation for "result". -// src/components/CatalogSearchResultListItem/CatalogSearchResultListItem.d.ts:13:5 - (ae-undocumented) Missing documentation for "highlight". -// src/components/CatalogSearchResultListItem/CatalogSearchResultListItem.d.ts:14:5 - (ae-undocumented) Missing documentation for "rank". -// src/components/CatalogSearchResultListItem/CatalogSearchResultListItem.d.ts:15:5 - (ae-undocumented) Missing documentation for "lineClamp". -// src/components/CatalogTable/CatalogTable.d.ts:10:5 - (ae-undocumented) Missing documentation for "columns". -// src/components/CatalogTable/CatalogTable.d.ts:11:5 - (ae-undocumented) Missing documentation for "actions". -// src/components/CatalogTable/CatalogTable.d.ts:12:5 - (ae-undocumented) Missing documentation for "tableOptions". -// src/components/CatalogTable/CatalogTable.d.ts:13:5 - (ae-undocumented) Missing documentation for "emptyContent". -// src/components/CatalogTable/CatalogTable.d.ts:14:5 - (ae-undocumented) Missing documentation for "subtitle". -// src/components/CatalogTable/CatalogTable.d.ts:17:22 - (ae-undocumented) Missing documentation for "CatalogTable". -// src/components/CatalogTable/CatalogTableToolbar.d.ts:3:1 - (ae-undocumented) Missing documentation for "CatalogTableToolbarClassKey". -// src/components/CatalogTable/types.d.ts:5:1 - (ae-undocumented) Missing documentation for "CatalogTableRow". -// src/components/CatalogTable/types.d.ts:6:5 - (ae-undocumented) Missing documentation for "entity". -// src/components/CatalogTable/types.d.ts:7:5 - (ae-undocumented) Missing documentation for "resolved". -// src/components/DependencyOfComponentsCard/DependencyOfComponentsCard.d.ts:5:1 - (ae-undocumented) Missing documentation for "DependencyOfComponentsCardProps". -// src/components/DependencyOfComponentsCard/DependencyOfComponentsCard.d.ts:6:5 - (ae-undocumented) Missing documentation for "variant". -// src/components/DependencyOfComponentsCard/DependencyOfComponentsCard.d.ts:7:5 - (ae-undocumented) Missing documentation for "title". -// src/components/DependencyOfComponentsCard/DependencyOfComponentsCard.d.ts:8:5 - (ae-undocumented) Missing documentation for "columns". -// src/components/DependencyOfComponentsCard/DependencyOfComponentsCard.d.ts:9:5 - (ae-undocumented) Missing documentation for "tableOptions". -// src/components/DependsOnComponentsCard/DependsOnComponentsCard.d.ts:5:1 - (ae-undocumented) Missing documentation for "DependsOnComponentsCardProps". -// src/components/DependsOnComponentsCard/DependsOnComponentsCard.d.ts:6:5 - (ae-undocumented) Missing documentation for "variant". -// src/components/DependsOnComponentsCard/DependsOnComponentsCard.d.ts:7:5 - (ae-undocumented) Missing documentation for "title". -// src/components/DependsOnComponentsCard/DependsOnComponentsCard.d.ts:8:5 - (ae-undocumented) Missing documentation for "columns". -// src/components/DependsOnComponentsCard/DependsOnComponentsCard.d.ts:9:5 - (ae-undocumented) Missing documentation for "tableOptions". -// src/components/DependsOnResourcesCard/DependsOnResourcesCard.d.ts:5:1 - (ae-undocumented) Missing documentation for "DependsOnResourcesCardProps". -// src/components/DependsOnResourcesCard/DependsOnResourcesCard.d.ts:6:5 - (ae-undocumented) Missing documentation for "variant". -// src/components/DependsOnResourcesCard/DependsOnResourcesCard.d.ts:7:5 - (ae-undocumented) Missing documentation for "title". -// src/components/DependsOnResourcesCard/DependsOnResourcesCard.d.ts:8:5 - (ae-undocumented) Missing documentation for "columns". -// src/components/DependsOnResourcesCard/DependsOnResourcesCard.d.ts:9:5 - (ae-undocumented) Missing documentation for "tableOptions". -// src/components/EntityContextMenu/EntityContextMenu.d.ts:5:1 - (ae-undocumented) Missing documentation for "EntityContextMenuClassKey". -// src/components/EntityLabelsCard/EntityLabelsCard.d.ts:4:1 - (ae-undocumented) Missing documentation for "EntityLabelsCardProps". -// src/components/EntityLabelsCard/EntityLabelsCard.d.ts:5:5 - (ae-undocumented) Missing documentation for "variant". -// src/components/EntityLabelsCard/EntityLabelsCard.d.ts:6:5 - (ae-undocumented) Missing documentation for "title". -// src/components/EntityLabelsCard/EntityLabelsEmptyState.d.ts:3:1 - (ae-undocumented) Missing documentation for "EntityLabelsEmptyStateClassKey". -// src/components/EntityLayout/EntityLayout.d.ts:6:1 - (ae-undocumented) Missing documentation for "EntityLayoutRouteProps". -// src/components/EntityLayout/EntityLayout.d.ts:25:1 - (ae-undocumented) Missing documentation for "EntityLayoutProps". -// src/components/EntityLayout/EntityLayout.d.ts:26:5 - (ae-undocumented) Missing documentation for "UNSTABLE_extraContextMenuItems". -// src/components/EntityLayout/EntityLayout.d.ts:27:5 - (ae-undocumented) Missing documentation for "UNSTABLE_contextMenuOptions". -// src/components/EntityLayout/EntityLayout.d.ts:28:5 - (ae-undocumented) Missing documentation for "children". -// src/components/EntityLayout/EntityLayout.d.ts:29:5 - (ae-undocumented) Missing documentation for "NotFoundComponent". -// src/components/EntityLinksCard/EntityLinksCard.d.ts:5:1 - (ae-undocumented) Missing documentation for "EntityLinksCardProps". -// src/components/EntityLinksCard/EntityLinksCard.d.ts:6:5 - (ae-undocumented) Missing documentation for "cols". -// src/components/EntityLinksCard/EntityLinksCard.d.ts:7:5 - (ae-undocumented) Missing documentation for "variant". -// src/components/EntityLinksCard/EntityLinksEmptyState.d.ts:3:1 - (ae-undocumented) Missing documentation for "EntityLinksEmptyStateClassKey". -// src/components/EntityLinksCard/types.d.ts:2:1 - (ae-undocumented) Missing documentation for "Breakpoint". -// src/components/EntityLinksCard/types.d.ts:4:1 - (ae-undocumented) Missing documentation for "ColumnBreakpoints". -// src/components/EntitySwitch/EntitySwitch.d.ts:5:1 - (ae-undocumented) Missing documentation for "EntitySwitchCaseProps". -// src/components/EntitySwitch/EntitySwitch.d.ts:6:5 - (ae-undocumented) Missing documentation for "if". -// src/components/EntitySwitch/EntitySwitch.d.ts:9:5 - (ae-undocumented) Missing documentation for "children". -// src/components/EntitySwitch/EntitySwitch.d.ts:16:5 - (ae-undocumented) Missing documentation for "children". -// src/components/EntitySwitch/EntitySwitch.d.ts:17:5 - (ae-undocumented) Missing documentation for "renderMultipleMatches". -// src/components/EntitySwitch/EntitySwitch.d.ts:20:22 - (ae-undocumented) Missing documentation for "EntitySwitch". -// src/components/EntitySwitch/conditions.d.ts:3:1 - (ae-undocumented) Missing documentation for "EntityPredicates". -// src/components/EntitySwitch/conditions.d.ts:4:5 - (ae-undocumented) Missing documentation for "kind". -// src/components/EntitySwitch/conditions.d.ts:5:5 - (ae-undocumented) Missing documentation for "type". -// src/components/FilteredEntityLayout/index.d.ts:6:22 - (ae-undocumented) Missing documentation for "FilteredEntityLayout". -// src/components/FilteredEntityLayout/index.d.ts:13:22 - (ae-undocumented) Missing documentation for "FilterContainer". -// src/components/FilteredEntityLayout/index.d.ts:24:22 - (ae-undocumented) Missing documentation for "EntityListContainer". -// src/components/HasComponentsCard/HasComponentsCard.d.ts:5:1 - (ae-undocumented) Missing documentation for "HasComponentsCardProps". -// src/components/HasComponentsCard/HasComponentsCard.d.ts:6:5 - (ae-undocumented) Missing documentation for "variant". -// src/components/HasComponentsCard/HasComponentsCard.d.ts:7:5 - (ae-undocumented) Missing documentation for "title". -// src/components/HasComponentsCard/HasComponentsCard.d.ts:8:5 - (ae-undocumented) Missing documentation for "columns". -// src/components/HasComponentsCard/HasComponentsCard.d.ts:9:5 - (ae-undocumented) Missing documentation for "tableOptions". -// src/components/HasResourcesCard/HasResourcesCard.d.ts:5:1 - (ae-undocumented) Missing documentation for "HasResourcesCardProps". -// src/components/HasResourcesCard/HasResourcesCard.d.ts:6:5 - (ae-undocumented) Missing documentation for "variant". -// src/components/HasResourcesCard/HasResourcesCard.d.ts:7:5 - (ae-undocumented) Missing documentation for "title". -// src/components/HasResourcesCard/HasResourcesCard.d.ts:8:5 - (ae-undocumented) Missing documentation for "columns". -// src/components/HasResourcesCard/HasResourcesCard.d.ts:9:5 - (ae-undocumented) Missing documentation for "tableOptions". -// src/components/HasSubcomponentsCard/HasSubcomponentsCard.d.ts:5:1 - (ae-undocumented) Missing documentation for "HasSubcomponentsCardProps". -// src/components/HasSubcomponentsCard/HasSubcomponentsCard.d.ts:6:5 - (ae-undocumented) Missing documentation for "variant". -// src/components/HasSubcomponentsCard/HasSubcomponentsCard.d.ts:7:5 - (ae-undocumented) Missing documentation for "title". -// src/components/HasSubcomponentsCard/HasSubcomponentsCard.d.ts:8:5 - (ae-undocumented) Missing documentation for "columns". -// src/components/HasSubcomponentsCard/HasSubcomponentsCard.d.ts:9:5 - (ae-undocumented) Missing documentation for "tableOptions". -// src/components/HasSubdomainsCard/HasSubdomainsCard.d.ts:4:1 - (ae-undocumented) Missing documentation for "HasSubdomainsCardProps". -// src/components/HasSubdomainsCard/HasSubdomainsCard.d.ts:5:5 - (ae-undocumented) Missing documentation for "variant". -// src/components/HasSubdomainsCard/HasSubdomainsCard.d.ts:6:5 - (ae-undocumented) Missing documentation for "tableOptions". -// src/components/HasSubdomainsCard/HasSubdomainsCard.d.ts:7:5 - (ae-undocumented) Missing documentation for "title". -// src/components/HasSystemsCard/HasSystemsCard.d.ts:5:1 - (ae-undocumented) Missing documentation for "HasSystemsCardProps". -// src/components/HasSystemsCard/HasSystemsCard.d.ts:6:5 - (ae-undocumented) Missing documentation for "variant". -// src/components/HasSystemsCard/HasSystemsCard.d.ts:7:5 - (ae-undocumented) Missing documentation for "title". -// src/components/HasSystemsCard/HasSystemsCard.d.ts:8:5 - (ae-undocumented) Missing documentation for "columns". -// src/components/HasSystemsCard/HasSystemsCard.d.ts:9:5 - (ae-undocumented) Missing documentation for "tableOptions". -// src/components/RelatedEntitiesCard/RelatedEntitiesCard.d.ts:5:1 - (ae-undocumented) Missing documentation for "RelatedEntitiesCardProps". -// src/components/SystemDiagramCard/SystemDiagramCard.d.ts:3:1 - (ae-undocumented) Missing documentation for "SystemDiagramCardClassKey". -// src/overridableComponents.d.ts:10:1 - (ae-undocumented) Missing documentation for "PluginCatalogComponentsNameToClassKey". -// src/overridableComponents.d.ts:19:1 - (ae-undocumented) Missing documentation for "BackstageOverrides". -// src/plugin.d.ts:17:22 - (ae-undocumented) Missing documentation for "catalogPlugin". -// src/plugin.d.ts:38:22 - (ae-undocumented) Missing documentation for "CatalogIndexPage". -// src/plugin.d.ts:40:22 - (ae-undocumented) Missing documentation for "CatalogEntityPage". -// src/plugin.d.ts:55:22 - (ae-undocumented) Missing documentation for "EntityLinksCard". -// src/plugin.d.ts:57:22 - (ae-undocumented) Missing documentation for "EntityLabelsCard". -// src/plugin.d.ts:59:22 - (ae-undocumented) Missing documentation for "EntityHasSystemsCard". -// src/plugin.d.ts:61:22 - (ae-undocumented) Missing documentation for "EntityHasComponentsCard". -// src/plugin.d.ts:63:22 - (ae-undocumented) Missing documentation for "EntityHasSubcomponentsCard". -// src/plugin.d.ts:65:22 - (ae-undocumented) Missing documentation for "EntityHasSubdomainsCard". -// src/plugin.d.ts:67:22 - (ae-undocumented) Missing documentation for "EntityHasResourcesCard". -// src/plugin.d.ts:69:22 - (ae-undocumented) Missing documentation for "EntityDependsOnComponentsCard". -// src/plugin.d.ts:71:22 - (ae-undocumented) Missing documentation for "EntityDependencyOfComponentsCard". -// src/plugin.d.ts:73:22 - (ae-undocumented) Missing documentation for "EntityDependsOnResourcesCard". -// src/plugin.d.ts:75:22 - (ae-undocumented) Missing documentation for "RelatedEntitiesCard". -// src/plugin.d.ts:77:22 - (ae-undocumented) Missing documentation for "CatalogSearchResultListItem". ``` diff --git a/plugins/config-schema/report.api.md b/plugins/config-schema/report.api.md index 00a7a7fe0c..16630ae8d0 100644 --- a/plugins/config-schema/report.api.md +++ b/plugins/config-schema/report.api.md @@ -44,15 +44,4 @@ export class StaticSchemaLoader implements ConfigSchemaApi { // (undocumented) schema$(): Observable; } - -// Warnings were encountered during analysis: -// -// src/api/StaticSchemaLoader.d.ts:13:5 - (ae-undocumented) Missing documentation for "schema$". -// src/api/types.d.ts:4:1 - (ae-undocumented) Missing documentation for "ConfigSchemaResult". -// src/api/types.d.ts:5:5 - (ae-undocumented) Missing documentation for "schema". -// src/api/types.d.ts:8:1 - (ae-undocumented) Missing documentation for "ConfigSchemaApi". -// src/api/types.d.ts:9:5 - (ae-undocumented) Missing documentation for "schema$". -// src/api/types.d.ts:12:22 - (ae-undocumented) Missing documentation for "configSchemaApiRef". -// src/plugin.d.ts:3:22 - (ae-undocumented) Missing documentation for "configSchemaPlugin". -// src/plugin.d.ts:7:22 - (ae-undocumented) Missing documentation for "ConfigSchemaPage". ``` diff --git a/plugins/devtools-backend/report.api.md b/plugins/devtools-backend/report.api.md index 1ca69d686e..5fceda3d46 100644 --- a/plugins/devtools-backend/report.api.md +++ b/plugins/devtools-backend/report.api.md @@ -48,19 +48,4 @@ export interface RouterOptions { // (undocumented) permissions: PermissionsService; } - -// Warnings were encountered during analysis: -// -// src/api/DevToolsBackendApi.d.ts:5:1 - (ae-undocumented) Missing documentation for "DevToolsBackendApi". -// src/api/DevToolsBackendApi.d.ts:9:5 - (ae-undocumented) Missing documentation for "listExternalDependencyDetails". -// src/api/DevToolsBackendApi.d.ts:12:5 - (ae-undocumented) Missing documentation for "listConfig". -// src/api/DevToolsBackendApi.d.ts:13:5 - (ae-undocumented) Missing documentation for "listInfo". -// src/service/router.d.ts:8:1 - (ae-undocumented) Missing documentation for "RouterOptions". -// src/service/router.d.ts:9:5 - (ae-undocumented) Missing documentation for "devToolsBackendApi". -// src/service/router.d.ts:10:5 - (ae-undocumented) Missing documentation for "logger". -// src/service/router.d.ts:11:5 - (ae-undocumented) Missing documentation for "config". -// src/service/router.d.ts:12:5 - (ae-undocumented) Missing documentation for "permissions". -// src/service/router.d.ts:13:5 - (ae-undocumented) Missing documentation for "discovery". -// src/service/router.d.ts:14:5 - (ae-undocumented) Missing documentation for "httpAuth". -// src/service/router.d.ts:20:1 - (ae-undocumented) Missing documentation for "createRouter". ``` diff --git a/plugins/devtools-common/report.api.md b/plugins/devtools-common/report.api.md index bf71f1b87a..83af75d11a 100644 --- a/plugins/devtools-common/report.api.md +++ b/plugins/devtools-common/report.api.md @@ -73,20 +73,4 @@ export type PackageDependency = { name: string; versions: string; }; - -// Warnings were encountered during analysis: -// -// src/permissions.d.ts:4:22 - (ae-undocumented) Missing documentation for "devToolsAdministerPermission". -// src/permissions.d.ts:8:22 - (ae-undocumented) Missing documentation for "devToolsInfoReadPermission". -// src/permissions.d.ts:12:22 - (ae-undocumented) Missing documentation for "devToolsConfigReadPermission". -// src/permissions.d.ts:16:22 - (ae-undocumented) Missing documentation for "devToolsExternalDependenciesReadPermission". -// src/types.d.ts:3:1 - (ae-undocumented) Missing documentation for "Endpoint". -// src/types.d.ts:9:1 - (ae-undocumented) Missing documentation for "ExternalDependency". -// src/types.d.ts:17:1 - (ae-undocumented) Missing documentation for "DevToolsInfo". -// src/types.d.ts:25:1 - (ae-undocumented) Missing documentation for "PackageDependency". -// src/types.d.ts:30:1 - (ae-undocumented) Missing documentation for "ExternalDependencyStatus". -// src/types.d.ts:31:5 - (ae-undocumented) Missing documentation for "healthy". -// src/types.d.ts:32:5 - (ae-undocumented) Missing documentation for "unhealthy". -// src/types.d.ts:35:1 - (ae-undocumented) Missing documentation for "ConfigInfo". -// src/types.d.ts:40:1 - (ae-undocumented) Missing documentation for "ConfigError". ``` diff --git a/plugins/devtools/report-alpha.api.md b/plugins/devtools/report-alpha.api.md index aa1806277e..1b026d1f78 100644 --- a/plugins/devtools/report-alpha.api.md +++ b/plugins/devtools/report-alpha.api.md @@ -89,9 +89,5 @@ const _default: FrontendPlugin< >; export default _default; -// Warnings were encountered during analysis: -// -// src/alpha/plugin.d.ts:53:15 - (ae-undocumented) Missing documentation for "_default". - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/devtools/report.api.md b/plugins/devtools/report.api.md index 75dfdc32f6..bba36a5a9a 100644 --- a/plugins/devtools/report.api.md +++ b/plugins/devtools/report.api.md @@ -57,14 +57,4 @@ export type SubRoute = { } >; }; - -// Warnings were encountered during analysis: -// -// src/components/Content/ConfigContent/ConfigContent.d.ts:7:22 - (ae-undocumented) Missing documentation for "ConfigContent". -// src/components/Content/ExternalDependenciesContent/ExternalDependenciesContent.d.ts:5:22 - (ae-undocumented) Missing documentation for "ExternalDependenciesContent". -// src/components/Content/InfoContent/InfoContent.d.ts:3:22 - (ae-undocumented) Missing documentation for "InfoContent". -// src/components/DevToolsLayout/DevToolsLayout.d.ts:4:1 - (ae-undocumented) Missing documentation for "SubRoute". -// src/components/DevToolsLayout/DevToolsLayout.d.ts:13:1 - (ae-undocumented) Missing documentation for "DevToolsLayoutProps". -// src/plugin.d.ts:3:22 - (ae-undocumented) Missing documentation for "devToolsPlugin". -// src/plugin.d.ts:7:22 - (ae-undocumented) Missing documentation for "DevToolsPage". ``` diff --git a/plugins/events-backend-module-aws-sqs/report-alpha.api.md b/plugins/events-backend-module-aws-sqs/report-alpha.api.md index 38ce74daa9..6770e7b872 100644 --- a/plugins/events-backend-module-aws-sqs/report-alpha.api.md +++ b/plugins/events-backend-module-aws-sqs/report-alpha.api.md @@ -9,9 +9,5 @@ import { BackendFeature } from '@backstage/backend-plugin-api'; const _feature: BackendFeature; export default _feature; -// Warnings were encountered during analysis: -// -// src/alpha.d.ts:2:15 - (ae-undocumented) Missing documentation for "_feature". - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/events-backend-module-aws-sqs/report.api.md b/plugins/events-backend-module-aws-sqs/report.api.md index 5363884ea9..c23e05a3e8 100644 --- a/plugins/events-backend-module-aws-sqs/report.api.md +++ b/plugins/events-backend-module-aws-sqs/report.api.md @@ -25,9 +25,4 @@ export class AwsSqsConsumingEventPublisher { // @public const eventsModuleAwsSqsConsumingEventPublisher: BackendFeature; export default eventsModuleAwsSqsConsumingEventPublisher; - -// Warnings were encountered during analysis: -// -// src/publisher/AwsSqsConsumingEventPublisher.d.ts:21:5 - (ae-undocumented) Missing documentation for "fromConfig". -// src/publisher/AwsSqsConsumingEventPublisher.d.ts:28:5 - (ae-undocumented) Missing documentation for "start". ``` diff --git a/plugins/events-backend-module-azure/report-alpha.api.md b/plugins/events-backend-module-azure/report-alpha.api.md index d9f3a6f000..f90f9bcd13 100644 --- a/plugins/events-backend-module-azure/report-alpha.api.md +++ b/plugins/events-backend-module-azure/report-alpha.api.md @@ -12,10 +12,5 @@ export const eventsModuleAzureDevOpsEventRouter: BackendFeature; const _feature: BackendFeature; export default _feature; -// Warnings were encountered during analysis: -// -// src/alpha.d.ts:2:15 - (ae-undocumented) Missing documentation for "_feature". -// src/alpha.d.ts:5:22 - (ae-undocumented) Missing documentation for "eventsModuleAzureDevOpsEventRouter". - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/events-backend-module-azure/report.api.md b/plugins/events-backend-module-azure/report.api.md index d89a5608e3..a9fe4b176c 100644 --- a/plugins/events-backend-module-azure/report.api.md +++ b/plugins/events-backend-module-azure/report.api.md @@ -20,9 +20,4 @@ export class AzureDevOpsEventRouter extends SubTopicEventRouter { // @public const eventsModuleAzureDevOpsEventRouter: BackendFeature; export default eventsModuleAzureDevOpsEventRouter; - -// Warnings were encountered during analysis: -// -// src/router/AzureDevOpsEventRouter.d.ts:13:5 - (ae-undocumented) Missing documentation for "getSubscriberId". -// src/router/AzureDevOpsEventRouter.d.ts:14:5 - (ae-undocumented) Missing documentation for "determineSubTopic". ``` diff --git a/plugins/events-backend-module-bitbucket-cloud/report-alpha.api.md b/plugins/events-backend-module-bitbucket-cloud/report-alpha.api.md index b081759920..2ddc6dc766 100644 --- a/plugins/events-backend-module-bitbucket-cloud/report-alpha.api.md +++ b/plugins/events-backend-module-bitbucket-cloud/report-alpha.api.md @@ -12,10 +12,5 @@ export const eventsModuleBitbucketCloudEventRouter: BackendFeature; const _feature: BackendFeature; export default _feature; -// Warnings were encountered during analysis: -// -// src/alpha.d.ts:2:15 - (ae-undocumented) Missing documentation for "_feature". -// src/alpha.d.ts:5:22 - (ae-undocumented) Missing documentation for "eventsModuleBitbucketCloudEventRouter". - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/events-backend-module-bitbucket-cloud/report.api.md b/plugins/events-backend-module-bitbucket-cloud/report.api.md index 06bd71e7f7..c844e09cf0 100644 --- a/plugins/events-backend-module-bitbucket-cloud/report.api.md +++ b/plugins/events-backend-module-bitbucket-cloud/report.api.md @@ -20,9 +20,4 @@ export class BitbucketCloudEventRouter extends SubTopicEventRouter { // @public const eventsModuleBitbucketCloudEventRouter: BackendFeature; export default eventsModuleBitbucketCloudEventRouter; - -// Warnings were encountered during analysis: -// -// src/router/BitbucketCloudEventRouter.d.ts:13:5 - (ae-undocumented) Missing documentation for "getSubscriberId". -// src/router/BitbucketCloudEventRouter.d.ts:14:5 - (ae-undocumented) Missing documentation for "determineSubTopic". ``` diff --git a/plugins/events-backend-module-gerrit/report-alpha.api.md b/plugins/events-backend-module-gerrit/report-alpha.api.md index e37ca3050a..2be8d8d7a0 100644 --- a/plugins/events-backend-module-gerrit/report-alpha.api.md +++ b/plugins/events-backend-module-gerrit/report-alpha.api.md @@ -12,10 +12,5 @@ export const eventsModuleGerritEventRouter: BackendFeature; const _feature: BackendFeature; export default _feature; -// Warnings were encountered during analysis: -// -// src/alpha.d.ts:2:15 - (ae-undocumented) Missing documentation for "_feature". -// src/alpha.d.ts:5:22 - (ae-undocumented) Missing documentation for "eventsModuleGerritEventRouter". - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/events-backend-module-gerrit/report.api.md b/plugins/events-backend-module-gerrit/report.api.md index 1206a50c88..8f80412d7b 100644 --- a/plugins/events-backend-module-gerrit/report.api.md +++ b/plugins/events-backend-module-gerrit/report.api.md @@ -20,9 +20,4 @@ export class GerritEventRouter extends SubTopicEventRouter { // (undocumented) protected getSubscriberId(): string; } - -// Warnings were encountered during analysis: -// -// src/router/GerritEventRouter.d.ts:13:5 - (ae-undocumented) Missing documentation for "getSubscriberId". -// src/router/GerritEventRouter.d.ts:14:5 - (ae-undocumented) Missing documentation for "determineSubTopic". ``` diff --git a/plugins/events-backend-module-github/report.api.md b/plugins/events-backend-module-github/report.api.md index a3b8adaaa5..5341f86039 100644 --- a/plugins/events-backend-module-github/report.api.md +++ b/plugins/events-backend-module-github/report.api.md @@ -22,9 +22,4 @@ export class GithubEventRouter extends SubTopicEventRouter { // (undocumented) protected getSubscriberId(): string; } - -// Warnings were encountered during analysis: -// -// src/router/GithubEventRouter.d.ts:13:5 - (ae-undocumented) Missing documentation for "getSubscriberId". -// src/router/GithubEventRouter.d.ts:14:5 - (ae-undocumented) Missing documentation for "determineSubTopic". ``` diff --git a/plugins/events-backend-module-gitlab/report.api.md b/plugins/events-backend-module-gitlab/report.api.md index 9753380364..f348436375 100644 --- a/plugins/events-backend-module-gitlab/report.api.md +++ b/plugins/events-backend-module-gitlab/report.api.md @@ -20,9 +20,4 @@ export class GitlabEventRouter extends SubTopicEventRouter { // (undocumented) protected getSubscriberId(): string; } - -// Warnings were encountered during analysis: -// -// src/router/GitlabEventRouter.d.ts:13:5 - (ae-undocumented) Missing documentation for "getSubscriberId". -// src/router/GitlabEventRouter.d.ts:14:5 - (ae-undocumented) Missing documentation for "determineSubTopic". ``` diff --git a/plugins/events-backend-test-utils/report.api.md b/plugins/events-backend-test-utils/report.api.md index d88a9dbee0..9630c3d4e2 100644 --- a/plugins/events-backend-test-utils/report.api.md +++ b/plugins/events-backend-test-utils/report.api.md @@ -60,27 +60,4 @@ export class TestEventSubscriber implements EventSubscriber { // (undocumented) readonly topics: string[]; } - -// Warnings were encountered during analysis: -// -// src/testUtils/TestEventBroker.d.ts:6:1 - (ae-undocumented) Missing documentation for "TestEventBroker". -// src/testUtils/TestEventBroker.d.ts:7:5 - (ae-undocumented) Missing documentation for "published". -// src/testUtils/TestEventBroker.d.ts:8:5 - (ae-undocumented) Missing documentation for "subscribed". -// src/testUtils/TestEventBroker.d.ts:9:5 - (ae-undocumented) Missing documentation for "publish". -// src/testUtils/TestEventBroker.d.ts:10:5 - (ae-undocumented) Missing documentation for "subscribe". -// src/testUtils/TestEventPublisher.d.ts:6:1 - (ae-undocumented) Missing documentation for "TestEventPublisher". -// src/testUtils/TestEventPublisher.d.ts:8:5 - (ae-undocumented) Missing documentation for "setEventBroker". -// src/testUtils/TestEventPublisher.d.ts:9:5 - (ae-undocumented) Missing documentation for "eventBroker". -// src/testUtils/TestEventSubscriber.d.ts:6:1 - (ae-undocumented) Missing documentation for "TestEventSubscriber". -// src/testUtils/TestEventSubscriber.d.ts:7:5 - (ae-undocumented) Missing documentation for "name". -// src/testUtils/TestEventSubscriber.d.ts:8:5 - (ae-undocumented) Missing documentation for "topics". -// src/testUtils/TestEventSubscriber.d.ts:9:5 - (ae-undocumented) Missing documentation for "receivedEvents". -// src/testUtils/TestEventSubscriber.d.ts:11:5 - (ae-undocumented) Missing documentation for "supportsEventTopics". -// src/testUtils/TestEventSubscriber.d.ts:12:5 - (ae-undocumented) Missing documentation for "onEvent". -// src/testUtils/TestEventsService.d.ts:3:1 - (ae-undocumented) Missing documentation for "TestEventsService". -// src/testUtils/TestEventsService.d.ts:5:5 - (ae-undocumented) Missing documentation for "publish". -// src/testUtils/TestEventsService.d.ts:6:5 - (ae-undocumented) Missing documentation for "subscribe". -// src/testUtils/TestEventsService.d.ts:7:5 - (ae-undocumented) Missing documentation for "published". -// src/testUtils/TestEventsService.d.ts:8:5 - (ae-undocumented) Missing documentation for "subscribed". -// src/testUtils/TestEventsService.d.ts:9:5 - (ae-undocumented) Missing documentation for "reset". ``` diff --git a/plugins/events-backend/report-alpha.api.md b/plugins/events-backend/report-alpha.api.md index c9f56bd226..00e51fd29f 100644 --- a/plugins/events-backend/report-alpha.api.md +++ b/plugins/events-backend/report-alpha.api.md @@ -9,9 +9,5 @@ import { BackendFeature } from '@backstage/backend-plugin-api'; const _feature: BackendFeature; export default _feature; -// Warnings were encountered during analysis: -// -// src/alpha.d.ts:2:15 - (ae-undocumented) Missing documentation for "_feature". - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/events-backend/report.api.md b/plugins/events-backend/report.api.md index e7a33deb07..fb9f5fb237 100644 --- a/plugins/events-backend/report.api.md +++ b/plugins/events-backend/report.api.md @@ -61,14 +61,4 @@ export class HttpPostIngressEventPublisher { logger: LoggerService; }): HttpPostIngressEventPublisher; } - -// Warnings were encountered during analysis: -// -// src/service/DefaultEventBroker.d.ts:21:5 - (ae-undocumented) Missing documentation for "publish". -// src/service/DefaultEventBroker.d.ts:22:5 - (ae-undocumented) Missing documentation for "subscribe". -// src/service/EventsBackend.d.ts:14:5 - (ae-undocumented) Missing documentation for "setEventBroker". -// src/service/EventsBackend.d.ts:15:5 - (ae-undocumented) Missing documentation for "addPublishers". -// src/service/EventsBackend.d.ts:16:5 - (ae-undocumented) Missing documentation for "addSubscribers". -// src/service/http/HttpPostIngressEventPublisher.d.ts:15:5 - (ae-undocumented) Missing documentation for "fromConfig". -// src/service/http/HttpPostIngressEventPublisher.d.ts:24:5 - (ae-undocumented) Missing documentation for "bind". ``` diff --git a/plugins/events-node/report-alpha.api.md b/plugins/events-node/report-alpha.api.md index d11b170365..f61048ac94 100644 --- a/plugins/events-node/report-alpha.api.md +++ b/plugins/events-node/report-alpha.api.md @@ -28,14 +28,5 @@ export interface EventsExtensionPoint { // @alpha (undocumented) export const eventsExtensionPoint: ExtensionPoint; -// Warnings were encountered during analysis: -// -// src/extensions.d.ts:5:1 - (ae-undocumented) Missing documentation for "EventsExtensionPoint". -// src/extensions.d.ts:9:5 - (ae-undocumented) Missing documentation for "setEventBroker". -// src/extensions.d.ts:13:5 - (ae-undocumented) Missing documentation for "addPublishers". -// src/extensions.d.ts:17:5 - (ae-undocumented) Missing documentation for "addSubscribers". -// src/extensions.d.ts:18:5 - (ae-undocumented) Missing documentation for "addHttpPostIngress". -// src/extensions.d.ts:23:22 - (ae-undocumented) Missing documentation for "eventsExtensionPoint". - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/events-node/report.api.md b/plugins/events-node/report.api.md index 2c06f50d56..9ebaf1a536 100644 --- a/plugins/events-node/report.api.md +++ b/plugins/events-node/report.api.md @@ -139,26 +139,4 @@ export abstract class SubTopicEventRouter extends EventRouter { // (undocumented) protected abstract determineSubTopic(params: EventParams): string | undefined; } - -// Warnings were encountered during analysis: -// -// src/api/DefaultEventsService.d.ts:16:5 - (ae-undocumented) Missing documentation for "create". -// src/api/DefaultEventsService.d.ts:31:5 - (ae-undocumented) Missing documentation for "publish". -// src/api/DefaultEventsService.d.ts:32:5 - (ae-undocumented) Missing documentation for "subscribe". -// src/api/EventParams.d.ts:4:1 - (ae-undocumented) Missing documentation for "EventParams". -// src/api/EventPublisher.d.ts:15:5 - (ae-undocumented) Missing documentation for "setEventBroker". -// src/api/EventRouter.d.ts:18:5 - (ae-undocumented) Missing documentation for "getSubscriberId". -// src/api/EventRouter.d.ts:19:5 - (ae-undocumented) Missing documentation for "determineDestinationTopic". -// src/api/EventRouter.d.ts:26:5 - (ae-undocumented) Missing documentation for "onEvent". -// src/api/EventsService.d.ts:26:1 - (ae-undocumented) Missing documentation for "EventsServiceSubscribeOptions". -// src/api/EventsService.d.ts:37:1 - (ae-undocumented) Missing documentation for "EventsServiceEventHandler". -// src/api/SubTopicEventRouter.d.ts:18:5 - (ae-undocumented) Missing documentation for "determineSubTopic". -// src/api/SubTopicEventRouter.d.ts:19:5 - (ae-undocumented) Missing documentation for "determineDestinationTopic". -// src/api/http/HttpPostIngressOptions.d.ts:5:1 - (ae-undocumented) Missing documentation for "HttpPostIngressOptions". -// src/api/http/HttpPostIngressOptions.d.ts:6:5 - (ae-undocumented) Missing documentation for "topic". -// src/api/http/HttpPostIngressOptions.d.ts:7:5 - (ae-undocumented) Missing documentation for "validator". -// src/api/http/validation/RequestDetails.d.ts:4:1 - (ae-undocumented) Missing documentation for "RequestDetails". -// src/api/http/validation/RequestRejectionDetails.d.ts:8:5 - (ae-undocumented) Missing documentation for "status". -// src/api/http/validation/RequestRejectionDetails.d.ts:9:5 - (ae-undocumented) Missing documentation for "payload". -// src/service.d.ts:10:22 - (ae-undocumented) Missing documentation for "eventsServiceFactory". ``` diff --git a/plugins/home-react/report.api.md b/plugins/home-react/report.api.md index 802d73605c..268f598a63 100644 --- a/plugins/home-react/report.api.md +++ b/plugins/home-react/report.api.md @@ -74,15 +74,4 @@ export const SettingsModal: (props: { componentName?: string; children: JSX.Element; }) => React_2.JSX.Element; - -// Warnings were encountered during analysis: -// -// src/components/SettingsModal.d.ts:3:22 - (ae-undocumented) Missing documentation for "SettingsModal". -// src/extensions.d.ts:6:1 - (ae-undocumented) Missing documentation for "ComponentRenderer". -// src/extensions.d.ts:12:1 - (ae-undocumented) Missing documentation for "ComponentParts". -// src/extensions.d.ts:21:1 - (ae-undocumented) Missing documentation for "RendererProps". -// src/extensions.d.ts:27:1 - (ae-undocumented) Missing documentation for "CardExtensionProps". -// src/extensions.d.ts:33:1 - (ae-undocumented) Missing documentation for "CardLayout". -// src/extensions.d.ts:48:1 - (ae-undocumented) Missing documentation for "CardSettings". -// src/extensions.d.ts:55:1 - (ae-undocumented) Missing documentation for "CardConfig". ``` diff --git a/plugins/home/report-alpha.api.md b/plugins/home/report-alpha.api.md index e8f8ddf6a1..429af86a12 100644 --- a/plugins/home/report-alpha.api.md +++ b/plugins/home/report-alpha.api.md @@ -78,10 +78,5 @@ export const titleExtensionDataRef: ConfigurableExtensionDataRef< {} >; -// Warnings were encountered during analysis: -// -// src/alpha.d.ts:5:22 - (ae-undocumented) Missing documentation for "titleExtensionDataRef". -// src/alpha.d.ts:9:15 - (ae-undocumented) Missing documentation for "_default". - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/home/report.api.md b/plugins/home/report.api.md index 985aed50ca..023c649ab4 100644 --- a/plugins/home/report.api.md +++ b/plugins/home/report.api.md @@ -327,34 +327,4 @@ export const WelcomeTitle: ({ export type WelcomeTitleLanguageProps = { language?: string[]; }; - -// Warnings were encountered during analysis: -// -// src/api/VisitsApi.d.ts:106:22 - (ae-undocumented) Missing documentation for "visitsApiRef". -// src/api/VisitsStorageApi.d.ts:4:1 - (ae-undocumented) Missing documentation for "VisitsStorageApiOptions". -// src/api/VisitsStorageApi.d.ts:20:5 - (ae-undocumented) Missing documentation for "create". -// src/api/VisitsWebStorageApi.d.ts:4:1 - (ae-undocumented) Missing documentation for "VisitsWebStorageApiOptions". -// src/api/VisitsWebStorageApi.d.ts:14:5 - (ae-undocumented) Missing documentation for "create". -// src/assets/TemplateBackstageLogo.d.ts:3:22 - (ae-undocumented) Missing documentation for "TemplateBackstageLogo". -// src/assets/TemplateBackstageLogoIcon.d.ts:3:22 - (ae-undocumented) Missing documentation for "TemplateBackstageLogoIcon". -// src/deprecated.d.ts:7:22 - (ae-undocumented) Missing documentation for "createCardExtension". -// src/deprecated.d.ts:12:1 - (ae-undocumented) Missing documentation for "CardExtensionProps". -// src/deprecated.d.ts:17:1 - (ae-undocumented) Missing documentation for "CardLayout". -// src/deprecated.d.ts:22:1 - (ae-undocumented) Missing documentation for "CardSettings". -// src/deprecated.d.ts:27:1 - (ae-undocumented) Missing documentation for "CardConfig". -// src/deprecated.d.ts:32:1 - (ae-undocumented) Missing documentation for "ComponentParts". -// src/deprecated.d.ts:37:1 - (ae-undocumented) Missing documentation for "ComponentRenderer". -// src/deprecated.d.ts:42:1 - (ae-undocumented) Missing documentation for "RendererProps". -// src/deprecated.d.ts:47:22 - (ae-undocumented) Missing documentation for "SettingsModal". -// src/homePageComponents/HeaderWorldClock/HeaderWorldClock.d.ts:3:1 - (ae-undocumented) Missing documentation for "ClockConfig". -// src/homePageComponents/Toolkit/Context.d.ts:3:1 - (ae-undocumented) Missing documentation for "Tool". -// src/homePageComponents/VisitedByType/Content.d.ts:4:1 - (ae-undocumented) Missing documentation for "VisitedByTypeKind". -// src/homePageComponents/VisitedByType/Content.d.ts:6:1 - (ae-undocumented) Missing documentation for "VisitedByTypeProps". -// src/homePageComponents/WelcomeTitle/WelcomeTitle.d.ts:3:1 - (ae-undocumented) Missing documentation for "WelcomeTitleLanguageProps". -// src/plugin.d.ts:5:22 - (ae-undocumented) Missing documentation for "homePlugin". -// src/plugin.d.ts:9:22 - (ae-undocumented) Missing documentation for "HomepageCompositionRoot". -// src/plugin.d.ts:14:22 - (ae-undocumented) Missing documentation for "ComponentAccordion". -// src/plugin.d.ts:24:22 - (ae-undocumented) Missing documentation for "ComponentTabs". -// src/plugin.d.ts:32:22 - (ae-undocumented) Missing documentation for "ComponentTab". -// src/plugin.d.ts:53:22 - (ae-undocumented) Missing documentation for "HomePageRandomJoke". ``` diff --git a/plugins/kubernetes-backend/report-alpha.api.md b/plugins/kubernetes-backend/report-alpha.api.md index b4c4df2287..77bd4e1774 100644 --- a/plugins/kubernetes-backend/report-alpha.api.md +++ b/plugins/kubernetes-backend/report-alpha.api.md @@ -9,9 +9,5 @@ import { BackendFeature } from '@backstage/backend-plugin-api'; const _feature: BackendFeature; export default _feature; -// Warnings were encountered during analysis: -// -// src/alpha.d.ts:2:15 - (ae-undocumented) Missing documentation for "_feature". - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/kubernetes-backend/report.api.md b/plugins/kubernetes-backend/report.api.md index 9bcef16843..281c8e5cac 100644 --- a/plugins/kubernetes-backend/report.api.md +++ b/plugins/kubernetes-backend/report.api.md @@ -430,118 +430,4 @@ export type SigningCreds = { secretAccessKey: string | undefined; sessionToken: string | undefined; }; - -// Warnings were encountered during analysis: -// -// src/auth/AksStrategy.d.ts:7:1 - (ae-undocumented) Missing documentation for "AksStrategy". -// src/auth/AksStrategy.d.ts:8:5 - (ae-undocumented) Missing documentation for "getCredential". -// src/auth/AksStrategy.d.ts:9:5 - (ae-undocumented) Missing documentation for "validateCluster". -// src/auth/AksStrategy.d.ts:10:5 - (ae-undocumented) Missing documentation for "presentAuthMetadata". -// src/auth/AnonymousStrategy.d.ts:6:1 - (ae-undocumented) Missing documentation for "AnonymousStrategy". -// src/auth/AnonymousStrategy.d.ts:7:5 - (ae-undocumented) Missing documentation for "getCredential". -// src/auth/AnonymousStrategy.d.ts:8:5 - (ae-undocumented) Missing documentation for "validateCluster". -// src/auth/AnonymousStrategy.d.ts:9:5 - (ae-undocumented) Missing documentation for "presentAuthMetadata". -// src/auth/AwsIamStrategy.d.ts:7:1 - (ae-undocumented) Missing documentation for "SigningCreds". -// src/auth/AwsIamStrategy.d.ts:16:1 - (ae-undocumented) Missing documentation for "AwsIamStrategy". -// src/auth/AwsIamStrategy.d.ts:21:5 - (ae-undocumented) Missing documentation for "getCredential". -// src/auth/AwsIamStrategy.d.ts:22:5 - (ae-undocumented) Missing documentation for "validateCluster". -// src/auth/AwsIamStrategy.d.ts:24:5 - (ae-undocumented) Missing documentation for "presentAuthMetadata". -// src/auth/AzureIdentityStrategy.d.ts:8:1 - (ae-undocumented) Missing documentation for "AzureIdentityStrategy". -// src/auth/AzureIdentityStrategy.d.ts:14:5 - (ae-undocumented) Missing documentation for "getCredential". -// src/auth/AzureIdentityStrategy.d.ts:15:5 - (ae-undocumented) Missing documentation for "validateCluster". -// src/auth/AzureIdentityStrategy.d.ts:19:5 - (ae-undocumented) Missing documentation for "presentAuthMetadata". -// src/auth/DispatchStrategy.d.ts:7:1 - (ae-undocumented) Missing documentation for "DispatchStrategyOptions". -// src/auth/DispatchStrategy.d.ts:19:5 - (ae-undocumented) Missing documentation for "getCredential". -// src/auth/DispatchStrategy.d.ts:20:5 - (ae-undocumented) Missing documentation for "validateCluster". -// src/auth/DispatchStrategy.d.ts:21:5 - (ae-undocumented) Missing documentation for "presentAuthMetadata". -// src/auth/GoogleServiceAccountStrategy.d.ts:6:1 - (ae-undocumented) Missing documentation for "GoogleServiceAccountStrategy". -// src/auth/GoogleServiceAccountStrategy.d.ts:7:5 - (ae-undocumented) Missing documentation for "getCredential". -// src/auth/GoogleServiceAccountStrategy.d.ts:8:5 - (ae-undocumented) Missing documentation for "validateCluster". -// src/auth/GoogleServiceAccountStrategy.d.ts:9:5 - (ae-undocumented) Missing documentation for "presentAuthMetadata". -// src/auth/GoogleStrategy.d.ts:7:1 - (ae-undocumented) Missing documentation for "GoogleStrategy". -// src/auth/GoogleStrategy.d.ts:8:5 - (ae-undocumented) Missing documentation for "getCredential". -// src/auth/GoogleStrategy.d.ts:9:5 - (ae-undocumented) Missing documentation for "validateCluster". -// src/auth/GoogleStrategy.d.ts:10:5 - (ae-undocumented) Missing documentation for "presentAuthMetadata". -// src/auth/OidcStrategy.d.ts:7:1 - (ae-undocumented) Missing documentation for "OidcStrategy". -// src/auth/OidcStrategy.d.ts:8:5 - (ae-undocumented) Missing documentation for "getCredential". -// src/auth/OidcStrategy.d.ts:9:5 - (ae-undocumented) Missing documentation for "validateCluster". -// src/auth/OidcStrategy.d.ts:10:5 - (ae-undocumented) Missing documentation for "presentAuthMetadata". -// src/auth/ServiceAccountStrategy.d.ts:6:1 - (ae-undocumented) Missing documentation for "ServiceAccountStrategy". -// src/auth/ServiceAccountStrategy.d.ts:7:5 - (ae-undocumented) Missing documentation for "getCredential". -// src/auth/ServiceAccountStrategy.d.ts:8:5 - (ae-undocumented) Missing documentation for "validateCluster". -// src/auth/ServiceAccountStrategy.d.ts:9:5 - (ae-undocumented) Missing documentation for "presentAuthMetadata". -// src/auth/types.d.ts:5:1 - (ae-undocumented) Missing documentation for "AuthenticationStrategy". -// src/auth/types.d.ts:9:1 - (ae-undocumented) Missing documentation for "KubernetesCredential". -// src/service/KubernetesBuilder.d.ts:14:1 - (ae-undocumented) Missing documentation for "KubernetesEnvironment". -// src/service/KubernetesBuilder.d.ts:15:5 - (ae-undocumented) Missing documentation for "logger". -// src/service/KubernetesBuilder.d.ts:16:5 - (ae-undocumented) Missing documentation for "config". -// src/service/KubernetesBuilder.d.ts:17:5 - (ae-undocumented) Missing documentation for "catalogApi". -// src/service/KubernetesBuilder.d.ts:18:5 - (ae-undocumented) Missing documentation for "discovery". -// src/service/KubernetesBuilder.d.ts:19:5 - (ae-undocumented) Missing documentation for "permissions". -// src/service/KubernetesBuilder.d.ts:20:5 - (ae-undocumented) Missing documentation for "auth". -// src/service/KubernetesBuilder.d.ts:21:5 - (ae-undocumented) Missing documentation for "httpAuth". -// src/service/KubernetesBuilder.d.ts:44:1 - (ae-undocumented) Missing documentation for "KubernetesBuilder". -// src/service/KubernetesBuilder.d.ts:45:5 - (ae-undocumented) Missing documentation for "env". -// src/service/KubernetesBuilder.d.ts:53:5 - (ae-undocumented) Missing documentation for "createBuilder". -// src/service/KubernetesBuilder.d.ts:55:5 - (ae-undocumented) Missing documentation for "build". -// src/service/KubernetesBuilder.d.ts:56:5 - (ae-undocumented) Missing documentation for "setClusterSupplier". -// src/service/KubernetesBuilder.d.ts:57:5 - (ae-undocumented) Missing documentation for "setDefaultClusterRefreshInterval". -// src/service/KubernetesBuilder.d.ts:58:5 - (ae-undocumented) Missing documentation for "setObjectsProvider". -// src/service/KubernetesBuilder.d.ts:59:5 - (ae-undocumented) Missing documentation for "setFetcher". -// src/service/KubernetesBuilder.d.ts:60:5 - (ae-undocumented) Missing documentation for "setServiceLocator". -// src/service/KubernetesBuilder.d.ts:61:5 - (ae-undocumented) Missing documentation for "setProxy". -// src/service/KubernetesBuilder.d.ts:62:5 - (ae-undocumented) Missing documentation for "setAuthStrategyMap". -// src/service/KubernetesBuilder.d.ts:65:5 - (ae-undocumented) Missing documentation for "addAuthStrategy". -// src/service/KubernetesBuilder.d.ts:66:5 - (ae-undocumented) Missing documentation for "buildCustomResources". -// src/service/KubernetesBuilder.d.ts:67:5 - (ae-undocumented) Missing documentation for "buildClusterSupplier". -// src/service/KubernetesBuilder.d.ts:68:5 - (ae-undocumented) Missing documentation for "buildObjectsProvider". -// src/service/KubernetesBuilder.d.ts:69:5 - (ae-undocumented) Missing documentation for "buildFetcher". -// src/service/KubernetesBuilder.d.ts:70:5 - (ae-undocumented) Missing documentation for "buildServiceLocator". -// src/service/KubernetesBuilder.d.ts:71:5 - (ae-undocumented) Missing documentation for "buildMultiTenantServiceLocator". -// src/service/KubernetesBuilder.d.ts:72:5 - (ae-undocumented) Missing documentation for "buildSingleTenantServiceLocator". -// src/service/KubernetesBuilder.d.ts:73:5 - (ae-undocumented) Missing documentation for "buildCatalogRelationServiceLocator". -// src/service/KubernetesBuilder.d.ts:74:5 - (ae-undocumented) Missing documentation for "buildHttpServiceLocator". -// src/service/KubernetesBuilder.d.ts:75:5 - (ae-undocumented) Missing documentation for "buildProxy". -// src/service/KubernetesBuilder.d.ts:76:5 - (ae-undocumented) Missing documentation for "buildRouter". -// src/service/KubernetesBuilder.d.ts:77:5 - (ae-undocumented) Missing documentation for "buildAuthStrategyMap". -// src/service/KubernetesBuilder.d.ts:80:5 - (ae-undocumented) Missing documentation for "fetchClusterDetails". -// src/service/KubernetesBuilder.d.ts:83:5 - (ae-undocumented) Missing documentation for "getServiceLocatorMethod". -// src/service/KubernetesBuilder.d.ts:84:5 - (ae-undocumented) Missing documentation for "getFetcher". -// src/service/KubernetesBuilder.d.ts:85:5 - (ae-undocumented) Missing documentation for "getClusterSupplier". -// src/service/KubernetesBuilder.d.ts:86:5 - (ae-undocumented) Missing documentation for "getServiceLocator". -// src/service/KubernetesBuilder.d.ts:87:5 - (ae-undocumented) Missing documentation for "getObjectsProvider". -// src/service/KubernetesBuilder.d.ts:88:5 - (ae-undocumented) Missing documentation for "getObjectTypesToFetch". -// src/service/KubernetesBuilder.d.ts:89:5 - (ae-undocumented) Missing documentation for "getProxy". -// src/service/KubernetesBuilder.d.ts:90:5 - (ae-undocumented) Missing documentation for "getAuthStrategyMap". -// src/service/KubernetesFanOutHandler.d.ts:9:22 - (ae-undocumented) Missing documentation for "DEFAULT_OBJECTS". -// src/service/KubernetesProxy.d.ts:50:5 - (ae-undocumented) Missing documentation for "createRequestHandler". -// src/service/router.d.ts:11:1 - (ae-undocumented) Missing documentation for "RouterOptions". -// src/service/router.d.ts:12:5 - (ae-undocumented) Missing documentation for "logger". -// src/service/router.d.ts:13:5 - (ae-undocumented) Missing documentation for "config". -// src/service/router.d.ts:14:5 - (ae-undocumented) Missing documentation for "catalogApi". -// src/service/router.d.ts:15:5 - (ae-undocumented) Missing documentation for "clusterSupplier". -// src/service/router.d.ts:16:5 - (ae-undocumented) Missing documentation for "discovery". -// src/service/router.d.ts:17:5 - (ae-undocumented) Missing documentation for "permissions". -// src/types/types.d.ts:9:1 - (ae-undocumented) Missing documentation for "ServiceLocatorMethod". -// src/types/types.d.ts:14:1 - (ae-undocumented) Missing documentation for "KubernetesObjectsProviderOptions". -// src/types/types.d.ts:15:5 - (ae-undocumented) Missing documentation for "logger". -// src/types/types.d.ts:16:5 - (ae-undocumented) Missing documentation for "config". -// src/types/types.d.ts:17:5 - (ae-undocumented) Missing documentation for "fetcher". -// src/types/types.d.ts:18:5 - (ae-undocumented) Missing documentation for "serviceLocator". -// src/types/types.d.ts:19:5 - (ae-undocumented) Missing documentation for "customResources". -// src/types/types.d.ts:20:5 - (ae-undocumented) Missing documentation for "objectTypesToFetch". -// src/types/types.d.ts:26:1 - (ae-undocumented) Missing documentation for "ObjectsByEntityRequest". -// src/types/types.d.ts:30:1 - (ae-undocumented) Missing documentation for "KubernetesObjectsProvider". -// src/types/types.d.ts:34:1 - (ae-undocumented) Missing documentation for "CustomResourcesByEntity". -// src/types/types.d.ts:39:1 - (ae-undocumented) Missing documentation for "AuthMetadata". -// src/types/types.d.ts:44:1 - (ae-undocumented) Missing documentation for "ClusterDetails". -// src/types/types.d.ts:49:1 - (ae-undocumented) Missing documentation for "KubernetesClustersSupplier". -// src/types/types.d.ts:53:1 - (ae-undocumented) Missing documentation for "KubernetesObjectTypes". -// src/types/types.d.ts:57:1 - (ae-undocumented) Missing documentation for "ObjectToFetch". -// src/types/types.d.ts:61:1 - (ae-undocumented) Missing documentation for "CustomResource". -// src/types/types.d.ts:65:1 - (ae-undocumented) Missing documentation for "ObjectFetchParams". -// src/types/types.d.ts:69:1 - (ae-undocumented) Missing documentation for "FetchResponseWrapper". -// src/types/types.d.ts:73:1 - (ae-undocumented) Missing documentation for "KubernetesFetcher". -// src/types/types.d.ts:77:1 - (ae-undocumented) Missing documentation for "ServiceLocatorRequestContext". -// src/types/types.d.ts:81:1 - (ae-undocumented) Missing documentation for "KubernetesServiceLocator". ``` diff --git a/plugins/kubernetes-cluster/report.api.md b/plugins/kubernetes-cluster/report.api.md index 5e16134c2d..10d248097a 100644 --- a/plugins/kubernetes-cluster/report.api.md +++ b/plugins/kubernetes-cluster/report.api.md @@ -21,9 +21,4 @@ export const isKubernetesClusterAvailable: (entity: Entity) => boolean; // @public (undocumented) export const Router: () => React_2.JSX.Element; - -// Warnings were encountered during analysis: -// -// src/Router.d.ts:8:22 - (ae-undocumented) Missing documentation for "isKubernetesClusterAvailable". -// src/Router.d.ts:14:22 - (ae-undocumented) Missing documentation for "Router". ``` diff --git a/plugins/kubernetes-common/report.api.md b/plugins/kubernetes-common/report.api.md index 283788cfe5..81e9ca28e7 100644 --- a/plugins/kubernetes-common/report.api.md +++ b/plugins/kubernetes-common/report.api.md @@ -465,140 +465,4 @@ export interface WorkloadsByEntityRequest { // (undocumented) entity: Entity; } - -// Warnings were encountered during analysis: -// -// src/error-detection/types.d.ts:19:5 - (ae-undocumented) Missing documentation for "name". -// src/error-detection/types.d.ts:20:5 - (ae-undocumented) Missing documentation for "namespace". -// src/error-detection/types.d.ts:21:5 - (ae-undocumented) Missing documentation for "kind". -// src/error-detection/types.d.ts:22:5 - (ae-undocumented) Missing documentation for "apiGroup". -// src/error-detection/types.d.ts:30:5 - (ae-undocumented) Missing documentation for "type". -// src/error-detection/types.d.ts:31:5 - (ae-undocumented) Missing documentation for "severity". -// src/error-detection/types.d.ts:32:5 - (ae-undocumented) Missing documentation for "message". -// src/error-detection/types.d.ts:33:5 - (ae-undocumented) Missing documentation for "proposedFix". -// src/error-detection/types.d.ts:34:5 - (ae-undocumented) Missing documentation for "sourceRef". -// src/error-detection/types.d.ts:35:5 - (ae-undocumented) Missing documentation for "occurrenceCount". -// src/error-detection/types.d.ts:38:1 - (ae-undocumented) Missing documentation for "ProposedFix". -// src/error-detection/types.d.ts:40:1 - (ae-undocumented) Missing documentation for "ProposedFixBase". -// src/error-detection/types.d.ts:41:5 - (ae-undocumented) Missing documentation for "errorType". -// src/error-detection/types.d.ts:42:5 - (ae-undocumented) Missing documentation for "rootCauseExplanation". -// src/error-detection/types.d.ts:43:5 - (ae-undocumented) Missing documentation for "actions". -// src/error-detection/types.d.ts:46:1 - (ae-undocumented) Missing documentation for "LogSolution". -// src/error-detection/types.d.ts:47:5 - (ae-undocumented) Missing documentation for "type". -// src/error-detection/types.d.ts:48:5 - (ae-undocumented) Missing documentation for "container". -// src/error-detection/types.d.ts:51:1 - (ae-undocumented) Missing documentation for "DocsSolution". -// src/error-detection/types.d.ts:52:5 - (ae-undocumented) Missing documentation for "type". -// src/error-detection/types.d.ts:53:5 - (ae-undocumented) Missing documentation for "docsLink". -// src/error-detection/types.d.ts:56:1 - (ae-undocumented) Missing documentation for "EventsSolution". -// src/error-detection/types.d.ts:57:5 - (ae-undocumented) Missing documentation for "type". -// src/error-detection/types.d.ts:58:5 - (ae-undocumented) Missing documentation for "podName". -// src/error-detection/types.d.ts:61:1 - (ae-undocumented) Missing documentation for "ErrorMapper". -// src/error-detection/types.d.ts:62:5 - (ae-undocumented) Missing documentation for "detectErrors". -// src/types.d.ts:5:1 - (ae-undocumented) Missing documentation for "KubernetesRequestAuth". -// src/types.d.ts:9:1 - (ae-undocumented) Missing documentation for "CustomResourceMatcher". -// src/types.d.ts:10:5 - (ae-undocumented) Missing documentation for "group". -// src/types.d.ts:11:5 - (ae-undocumented) Missing documentation for "apiVersion". -// src/types.d.ts:12:5 - (ae-undocumented) Missing documentation for "plural". -// src/types.d.ts:15:1 - (ae-undocumented) Missing documentation for "WorkloadsByEntityRequest". -// src/types.d.ts:16:5 - (ae-undocumented) Missing documentation for "auth". -// src/types.d.ts:17:5 - (ae-undocumented) Missing documentation for "entity". -// src/types.d.ts:20:1 - (ae-undocumented) Missing documentation for "CustomObjectsByEntityRequest". -// src/types.d.ts:21:5 - (ae-undocumented) Missing documentation for "auth". -// src/types.d.ts:22:5 - (ae-undocumented) Missing documentation for "customResources". -// src/types.d.ts:23:5 - (ae-undocumented) Missing documentation for "entity". -// src/types.d.ts:26:1 - (ae-undocumented) Missing documentation for "KubernetesRequestBody". -// src/types.d.ts:27:5 - (ae-undocumented) Missing documentation for "auth". -// src/types.d.ts:28:5 - (ae-undocumented) Missing documentation for "entity". -// src/types.d.ts:31:1 - (ae-undocumented) Missing documentation for "ClusterAttributes". -// src/types.d.ts:73:1 - (ae-undocumented) Missing documentation for "ClusterObjects". -// src/types.d.ts:74:5 - (ae-undocumented) Missing documentation for "cluster". -// src/types.d.ts:75:5 - (ae-undocumented) Missing documentation for "resources". -// src/types.d.ts:76:5 - (ae-undocumented) Missing documentation for "podMetrics". -// src/types.d.ts:77:5 - (ae-undocumented) Missing documentation for "errors". -// src/types.d.ts:80:1 - (ae-undocumented) Missing documentation for "ObjectsByEntityResponse". -// src/types.d.ts:81:5 - (ae-undocumented) Missing documentation for "items". -// src/types.d.ts:84:1 - (ae-undocumented) Missing documentation for "AuthProviderType". -// src/types.d.ts:86:1 - (ae-undocumented) Missing documentation for "FetchResponse". -// src/types.d.ts:88:1 - (ae-undocumented) Missing documentation for "PodFetchResponse". -// src/types.d.ts:89:5 - (ae-undocumented) Missing documentation for "type". -// src/types.d.ts:90:5 - (ae-undocumented) Missing documentation for "resources". -// src/types.d.ts:93:1 - (ae-undocumented) Missing documentation for "ServiceFetchResponse". -// src/types.d.ts:94:5 - (ae-undocumented) Missing documentation for "type". -// src/types.d.ts:95:5 - (ae-undocumented) Missing documentation for "resources". -// src/types.d.ts:98:1 - (ae-undocumented) Missing documentation for "ConfigMapFetchResponse". -// src/types.d.ts:99:5 - (ae-undocumented) Missing documentation for "type". -// src/types.d.ts:100:5 - (ae-undocumented) Missing documentation for "resources". -// src/types.d.ts:103:1 - (ae-undocumented) Missing documentation for "DeploymentFetchResponse". -// src/types.d.ts:104:5 - (ae-undocumented) Missing documentation for "type". -// src/types.d.ts:105:5 - (ae-undocumented) Missing documentation for "resources". -// src/types.d.ts:108:1 - (ae-undocumented) Missing documentation for "ReplicaSetsFetchResponse". -// src/types.d.ts:109:5 - (ae-undocumented) Missing documentation for "type". -// src/types.d.ts:110:5 - (ae-undocumented) Missing documentation for "resources". -// src/types.d.ts:113:1 - (ae-undocumented) Missing documentation for "LimitRangeFetchResponse". -// src/types.d.ts:114:5 - (ae-undocumented) Missing documentation for "type". -// src/types.d.ts:115:5 - (ae-undocumented) Missing documentation for "resources". -// src/types.d.ts:118:1 - (ae-undocumented) Missing documentation for "ResourceQuotaFetchResponse". -// src/types.d.ts:119:5 - (ae-undocumented) Missing documentation for "type". -// src/types.d.ts:120:5 - (ae-undocumented) Missing documentation for "resources". -// src/types.d.ts:123:1 - (ae-undocumented) Missing documentation for "HorizontalPodAutoscalersFetchResponse". -// src/types.d.ts:124:5 - (ae-undocumented) Missing documentation for "type". -// src/types.d.ts:125:5 - (ae-undocumented) Missing documentation for "resources". -// src/types.d.ts:128:1 - (ae-undocumented) Missing documentation for "JobsFetchResponse". -// src/types.d.ts:129:5 - (ae-undocumented) Missing documentation for "type". -// src/types.d.ts:130:5 - (ae-undocumented) Missing documentation for "resources". -// src/types.d.ts:133:1 - (ae-undocumented) Missing documentation for "CronJobsFetchResponse". -// src/types.d.ts:134:5 - (ae-undocumented) Missing documentation for "type". -// src/types.d.ts:135:5 - (ae-undocumented) Missing documentation for "resources". -// src/types.d.ts:138:1 - (ae-undocumented) Missing documentation for "IngressesFetchResponse". -// src/types.d.ts:139:5 - (ae-undocumented) Missing documentation for "type". -// src/types.d.ts:140:5 - (ae-undocumented) Missing documentation for "resources". -// src/types.d.ts:143:1 - (ae-undocumented) Missing documentation for "CustomResourceFetchResponse". -// src/types.d.ts:144:5 - (ae-undocumented) Missing documentation for "type". -// src/types.d.ts:145:5 - (ae-undocumented) Missing documentation for "resources". -// src/types.d.ts:148:1 - (ae-undocumented) Missing documentation for "StatefulSetsFetchResponse". -// src/types.d.ts:149:5 - (ae-undocumented) Missing documentation for "type". -// src/types.d.ts:150:5 - (ae-undocumented) Missing documentation for "resources". -// src/types.d.ts:153:1 - (ae-undocumented) Missing documentation for "DaemonSetsFetchResponse". -// src/types.d.ts:154:5 - (ae-undocumented) Missing documentation for "type". -// src/types.d.ts:155:5 - (ae-undocumented) Missing documentation for "resources". -// src/types.d.ts:158:1 - (ae-undocumented) Missing documentation for "PodStatusFetchResponse". -// src/types.d.ts:159:5 - (ae-undocumented) Missing documentation for "type". -// src/types.d.ts:160:5 - (ae-undocumented) Missing documentation for "resources". -// src/types.d.ts:163:1 - (ae-undocumented) Missing documentation for "KubernetesFetchError". -// src/types.d.ts:165:1 - (ae-undocumented) Missing documentation for "StatusError". -// src/types.d.ts:166:5 - (ae-undocumented) Missing documentation for "errorType". -// src/types.d.ts:167:5 - (ae-undocumented) Missing documentation for "statusCode". -// src/types.d.ts:168:5 - (ae-undocumented) Missing documentation for "resourcePath". -// src/types.d.ts:171:1 - (ae-undocumented) Missing documentation for "RawFetchError". -// src/types.d.ts:172:5 - (ae-undocumented) Missing documentation for "errorType". -// src/types.d.ts:173:5 - (ae-undocumented) Missing documentation for "message". -// src/types.d.ts:176:1 - (ae-undocumented) Missing documentation for "KubernetesErrorTypes". -// src/types.d.ts:178:1 - (ae-undocumented) Missing documentation for "ClientCurrentResourceUsage". -// src/types.d.ts:179:5 - (ae-undocumented) Missing documentation for "currentUsage". -// src/types.d.ts:180:5 - (ae-undocumented) Missing documentation for "requestTotal". -// src/types.d.ts:181:5 - (ae-undocumented) Missing documentation for "limitTotal". -// src/types.d.ts:184:1 - (ae-undocumented) Missing documentation for "ClientContainerStatus". -// src/types.d.ts:185:5 - (ae-undocumented) Missing documentation for "container". -// src/types.d.ts:186:5 - (ae-undocumented) Missing documentation for "cpuUsage". -// src/types.d.ts:187:5 - (ae-undocumented) Missing documentation for "memoryUsage". -// src/types.d.ts:190:1 - (ae-undocumented) Missing documentation for "ClientPodStatus". -// src/types.d.ts:191:5 - (ae-undocumented) Missing documentation for "pod". -// src/types.d.ts:192:5 - (ae-undocumented) Missing documentation for "cpu". -// src/types.d.ts:193:5 - (ae-undocumented) Missing documentation for "memory". -// src/types.d.ts:194:5 - (ae-undocumented) Missing documentation for "containers". -// src/types.d.ts:197:1 - (ae-undocumented) Missing documentation for "DeploymentResources". -// src/types.d.ts:198:5 - (ae-undocumented) Missing documentation for "pods". -// src/types.d.ts:199:5 - (ae-undocumented) Missing documentation for "replicaSets". -// src/types.d.ts:200:5 - (ae-undocumented) Missing documentation for "deployments". -// src/types.d.ts:201:5 - (ae-undocumented) Missing documentation for "horizontalPodAutoscalers". -// src/types.d.ts:204:1 - (ae-undocumented) Missing documentation for "GroupedResponses". -// src/types.d.ts:205:5 - (ae-undocumented) Missing documentation for "services". -// src/types.d.ts:206:5 - (ae-undocumented) Missing documentation for "configMaps". -// src/types.d.ts:207:5 - (ae-undocumented) Missing documentation for "ingresses". -// src/types.d.ts:208:5 - (ae-undocumented) Missing documentation for "jobs". -// src/types.d.ts:209:5 - (ae-undocumented) Missing documentation for "cronJobs". -// src/types.d.ts:210:5 - (ae-undocumented) Missing documentation for "customResources". -// src/types.d.ts:211:5 - (ae-undocumented) Missing documentation for "statefulsets". -// src/types.d.ts:212:5 - (ae-undocumented) Missing documentation for "daemonSets". -// src/util/response.d.ts:4:22 - (ae-undocumented) Missing documentation for "groupResponses". ``` diff --git a/plugins/kubernetes-node/report.api.md b/plugins/kubernetes-node/report.api.md index 20c7f76b1f..f5b210b424 100644 --- a/plugins/kubernetes-node/report.api.md +++ b/plugins/kubernetes-node/report.api.md @@ -282,60 +282,4 @@ export interface ServiceLocatorRequestContext { // (undocumented) objectTypesToFetch: Set; } - -// Warnings were encountered during analysis: -// -// src/auth/PinnipedHelper.d.ts:7:1 - (ae-undocumented) Missing documentation for "PinnipedClientCerts". -// src/auth/PinnipedHelper.d.ts:16:1 - (ae-undocumented) Missing documentation for "PinnipedParameters". -// src/auth/PinnipedHelper.d.ts:31:1 - (ae-undocumented) Missing documentation for "PinnipedHelper". -// src/auth/PinnipedHelper.d.ts:34:5 - (ae-undocumented) Missing documentation for "tokenCredentialRequest". -// src/extensions.d.ts:8:5 - (ae-undocumented) Missing documentation for "addObjectsProvider". -// src/extensions.d.ts:22:5 - (ae-undocumented) Missing documentation for "addClusterSupplier". -// src/extensions.d.ts:36:5 - (ae-undocumented) Missing documentation for "addAuthStrategy". -// src/extensions.d.ts:50:5 - (ae-undocumented) Missing documentation for "addFetcher". -// src/extensions.d.ts:64:5 - (ae-undocumented) Missing documentation for "addServiceLocator". -// src/types/types.d.ts:9:1 - (ae-undocumented) Missing documentation for "KubernetesObjectsProvider". -// src/types/types.d.ts:10:5 - (ae-undocumented) Missing documentation for "getKubernetesObjectsByEntity". -// src/types/types.d.ts:13:5 - (ae-undocumented) Missing documentation for "getCustomResourcesByEntity". -// src/types/types.d.ts:21:1 - (ae-undocumented) Missing documentation for "KubernetesObjectsByEntity". -// src/types/types.d.ts:22:5 - (ae-undocumented) Missing documentation for "entity". -// src/types/types.d.ts:23:5 - (ae-undocumented) Missing documentation for "auth". -// src/types/types.d.ts:29:1 - (ae-undocumented) Missing documentation for "CustomResourcesByEntity". -// src/types/types.d.ts:30:5 - (ae-undocumented) Missing documentation for "customResources". -// src/types/types.d.ts:41:1 - (ae-undocumented) Missing documentation for "ClusterDetails". -// src/types/types.d.ts:50:5 - (ae-undocumented) Missing documentation for "url". -// src/types/types.d.ts:51:5 - (ae-undocumented) Missing documentation for "authMetadata". -// src/types/types.d.ts:52:5 - (ae-undocumented) Missing documentation for "skipTLSVerify". -// src/types/types.d.ts:58:5 - (ae-undocumented) Missing documentation for "caData". -// src/types/types.d.ts:59:5 - (ae-undocumented) Missing documentation for "caFile". -// src/types/types.d.ts:131:1 - (ae-undocumented) Missing documentation for "AuthenticationStrategy". -// src/types/types.d.ts:132:5 - (ae-undocumented) Missing documentation for "getCredential". -// src/types/types.d.ts:133:5 - (ae-undocumented) Missing documentation for "validateCluster". -// src/types/types.d.ts:134:5 - (ae-undocumented) Missing documentation for "presentAuthMetadata". -// src/types/types.d.ts:140:1 - (ae-undocumented) Missing documentation for "KubernetesObjectTypes". -// src/types/types.d.ts:145:1 - (ae-undocumented) Missing documentation for "ObjectToFetch". -// src/types/types.d.ts:146:5 - (ae-undocumented) Missing documentation for "objectType". -// src/types/types.d.ts:147:5 - (ae-undocumented) Missing documentation for "group". -// src/types/types.d.ts:148:5 - (ae-undocumented) Missing documentation for "apiVersion". -// src/types/types.d.ts:149:5 - (ae-undocumented) Missing documentation for "plural". -// src/types/types.d.ts:155:1 - (ae-undocumented) Missing documentation for "CustomResource". -// src/types/types.d.ts:156:5 - (ae-undocumented) Missing documentation for "objectType". -// src/types/types.d.ts:162:1 - (ae-undocumented) Missing documentation for "ObjectFetchParams". -// src/types/types.d.ts:163:5 - (ae-undocumented) Missing documentation for "serviceId". -// src/types/types.d.ts:164:5 - (ae-undocumented) Missing documentation for "clusterDetails". -// src/types/types.d.ts:165:5 - (ae-undocumented) Missing documentation for "credential". -// src/types/types.d.ts:166:5 - (ae-undocumented) Missing documentation for "objectTypesToFetch". -// src/types/types.d.ts:167:5 - (ae-undocumented) Missing documentation for "labelSelector". -// src/types/types.d.ts:168:5 - (ae-undocumented) Missing documentation for "customResources". -// src/types/types.d.ts:169:5 - (ae-undocumented) Missing documentation for "namespace". -// src/types/types.d.ts:175:1 - (ae-undocumented) Missing documentation for "FetchResponseWrapper". -// src/types/types.d.ts:176:5 - (ae-undocumented) Missing documentation for "errors". -// src/types/types.d.ts:177:5 - (ae-undocumented) Missing documentation for "responses". -// src/types/types.d.ts:185:5 - (ae-undocumented) Missing documentation for "fetchObjectsForService". -// src/types/types.d.ts:186:5 - (ae-undocumented) Missing documentation for "fetchPodMetricsByNamespaces". -// src/types/types.d.ts:191:1 - (ae-undocumented) Missing documentation for "ServiceLocatorRequestContext". -// src/types/types.d.ts:192:5 - (ae-undocumented) Missing documentation for "objectTypesToFetch". -// src/types/types.d.ts:193:5 - (ae-undocumented) Missing documentation for "customResources". -// src/types/types.d.ts:194:5 - (ae-undocumented) Missing documentation for "credentials". -// src/types/types.d.ts:201:5 - (ae-undocumented) Missing documentation for "getClustersByEntity". ``` diff --git a/plugins/kubernetes-react/report.api.md b/plugins/kubernetes-react/report.api.md index 9b0080f019..adb75a7d60 100644 --- a/plugins/kubernetes-react/report.api.md +++ b/plugins/kubernetes-react/report.api.md @@ -865,173 +865,4 @@ export const usePodMetrics: ( clusterName: string, matcher: PodMetricsMatcher, ) => ClientPodStatus | undefined; - -// Warnings were encountered during analysis: -// -// src/api/KubernetesBackendClient.d.ts:6:1 - (ae-undocumented) Missing documentation for "KubernetesBackendClient". -// src/api/KubernetesBackendClient.d.ts:17:5 - (ae-undocumented) Missing documentation for "getCluster". -// src/api/KubernetesBackendClient.d.ts:23:5 - (ae-undocumented) Missing documentation for "getObjectsByEntity". -// src/api/KubernetesBackendClient.d.ts:24:5 - (ae-undocumented) Missing documentation for "getWorkloadsByEntity". -// src/api/KubernetesBackendClient.d.ts:25:5 - (ae-undocumented) Missing documentation for "getCustomObjectsByEntity". -// src/api/KubernetesBackendClient.d.ts:26:5 - (ae-undocumented) Missing documentation for "getClusters". -// src/api/KubernetesBackendClient.d.ts:30:5 - (ae-undocumented) Missing documentation for "proxy". -// src/api/KubernetesClusterLinkFormatter.d.ts:4:1 - (ae-undocumented) Missing documentation for "KubernetesClusterLinkFormatter". -// src/api/KubernetesClusterLinkFormatter.d.ts:11:5 - (ae-undocumented) Missing documentation for "formatClusterLink". -// src/api/KubernetesProxyClient.d.ts:15:5 - (ae-undocumented) Missing documentation for "getEventsByInvolvedObjectName". -// src/api/KubernetesProxyClient.d.ts:20:5 - (ae-undocumented) Missing documentation for "getPodLogs". -// src/api/formatters/AksClusterLinksFormatter.d.ts:3:1 - (ae-undocumented) Missing documentation for "AksClusterLinksFormatter". -// src/api/formatters/AksClusterLinksFormatter.d.ts:4:5 - (ae-undocumented) Missing documentation for "formatClusterLink". -// src/api/formatters/EksClusterLinksFormatter.d.ts:3:1 - (ae-undocumented) Missing documentation for "EksClusterLinksFormatter". -// src/api/formatters/EksClusterLinksFormatter.d.ts:4:5 - (ae-undocumented) Missing documentation for "formatClusterLink". -// src/api/formatters/GkeClusterLinksFormatter.d.ts:4:1 - (ae-undocumented) Missing documentation for "GkeClusterLinksFormatter". -// src/api/formatters/GkeClusterLinksFormatter.d.ts:7:5 - (ae-undocumented) Missing documentation for "formatClusterLink". -// src/api/formatters/OpenshiftClusterLinksFormatter.d.ts:3:1 - (ae-undocumented) Missing documentation for "OpenshiftClusterLinksFormatter". -// src/api/formatters/OpenshiftClusterLinksFormatter.d.ts:4:5 - (ae-undocumented) Missing documentation for "formatClusterLink". -// src/api/formatters/RancherClusterLinksFormatter.d.ts:3:1 - (ae-undocumented) Missing documentation for "RancherClusterLinksFormatter". -// src/api/formatters/RancherClusterLinksFormatter.d.ts:4:5 - (ae-undocumented) Missing documentation for "formatClusterLink". -// src/api/formatters/StandardClusterLinksFormatter.d.ts:3:1 - (ae-undocumented) Missing documentation for "StandardClusterLinksFormatter". -// src/api/formatters/StandardClusterLinksFormatter.d.ts:4:5 - (ae-undocumented) Missing documentation for "formatClusterLink". -// src/api/formatters/index.d.ts:11:22 - (ae-undocumented) Missing documentation for "DEFAULT_FORMATTER_NAME". -// src/api/formatters/index.d.ts:13:1 - (ae-undocumented) Missing documentation for "getDefaultFormatters". -// src/api/types.d.ts:5:22 - (ae-undocumented) Missing documentation for "kubernetesApiRef". -// src/api/types.d.ts:7:22 - (ae-undocumented) Missing documentation for "kubernetesProxyApiRef". -// src/api/types.d.ts:9:22 - (ae-undocumented) Missing documentation for "kubernetesClusterLinkFormatterApiRef". -// src/api/types.d.ts:11:1 - (ae-undocumented) Missing documentation for "KubernetesApi". -// src/api/types.d.ts:12:5 - (ae-undocumented) Missing documentation for "getObjectsByEntity". -// src/api/types.d.ts:13:5 - (ae-undocumented) Missing documentation for "getClusters". -// src/api/types.d.ts:18:5 - (ae-undocumented) Missing documentation for "getCluster". -// src/api/types.d.ts:24:5 - (ae-undocumented) Missing documentation for "getWorkloadsByEntity". -// src/api/types.d.ts:25:5 - (ae-undocumented) Missing documentation for "getCustomObjectsByEntity". -// src/api/types.d.ts:26:5 - (ae-undocumented) Missing documentation for "proxy". -// src/api/types.d.ts:33:1 - (ae-undocumented) Missing documentation for "KubernetesProxyApi". -// src/api/types.d.ts:34:5 - (ae-undocumented) Missing documentation for "getPodLogs". -// src/api/types.d.ts:43:5 - (ae-undocumented) Missing documentation for "getEventsByInvolvedObjectName". -// src/api/types.d.ts:52:1 - (ae-undocumented) Missing documentation for "FormatClusterLinkOptions". -// src/api/types.d.ts:60:1 - (ae-undocumented) Missing documentation for "KubernetesClusterLinkFormatterApi". -// src/api/types.d.ts:61:5 - (ae-undocumented) Missing documentation for "formatClusterLink". -// src/components/CronJobsAccordions/CronJobsAccordions.d.ts:7:1 - (ae-undocumented) Missing documentation for "CronJobsAccordionsProps". -// src/components/CronJobsAccordions/CronJobsAccordions.d.ts:15:22 - (ae-undocumented) Missing documentation for "CronJobsAccordions". -// src/components/CustomResources/CustomResources.d.ts:7:1 - (ae-undocumented) Missing documentation for "CustomResourcesProps". -// src/components/CustomResources/CustomResources.d.ts:8:5 - (ae-undocumented) Missing documentation for "children". -// src/components/CustomResources/CustomResources.d.ts:15:22 - (ae-undocumented) Missing documentation for "CustomResources". -// src/components/ErrorPanel/ErrorPanel.d.ts:8:1 - (ae-undocumented) Missing documentation for "ErrorPanelProps". -// src/components/ErrorPanel/ErrorPanel.d.ts:19:22 - (ae-undocumented) Missing documentation for "ErrorPanel". -// src/components/ErrorReporting/ErrorReporting.d.ts:8:1 - (ae-undocumented) Missing documentation for "ErrorReportingProps". -// src/components/ErrorReporting/ErrorReporting.d.ts:17:22 - (ae-undocumented) Missing documentation for "ErrorReporting". -// src/components/HorizontalPodAutoscalers/HorizontalPodAutoscalerDrawer.d.ts:4:22 - (ae-undocumented) Missing documentation for "HorizontalPodAutoscalerDrawer". -// src/components/IngressesAccordions/IngressesAccordions.d.ts:7:1 - (ae-undocumented) Missing documentation for "IngressesAccordionsProps". -// src/components/IngressesAccordions/IngressesAccordions.d.ts:13:22 - (ae-undocumented) Missing documentation for "IngressesAccordions". -// src/components/JobsAccordions/JobsAccordions.d.ts:8:1 - (ae-undocumented) Missing documentation for "JobsAccordionsProps". -// src/components/JobsAccordions/JobsAccordions.d.ts:17:22 - (ae-undocumented) Missing documentation for "JobsAccordions". -// src/components/KubernetesDrawer/KubernetesDrawer.d.ts:9:5 - (ae-undocumented) Missing documentation for "kind". -// src/components/KubernetesDrawer/KubernetesDrawer.d.ts:10:5 - (ae-undocumented) Missing documentation for "metadata". -// src/components/KubernetesDrawer/KubernetesDrawer.d.ts:18:5 - (ae-undocumented) Missing documentation for "open". -// src/components/KubernetesDrawer/KubernetesDrawer.d.ts:19:5 - (ae-undocumented) Missing documentation for "kubernetesObject". -// src/components/KubernetesDrawer/KubernetesDrawer.d.ts:20:5 - (ae-undocumented) Missing documentation for "label". -// src/components/KubernetesDrawer/KubernetesDrawer.d.ts:21:5 - (ae-undocumented) Missing documentation for "drawerContentsHeader". -// src/components/KubernetesDrawer/KubernetesDrawer.d.ts:22:5 - (ae-undocumented) Missing documentation for "children". -// src/components/KubernetesDrawer/KubernetesStructuredMetadataTableDrawer.d.ts:9:1 - (ae-undocumented) Missing documentation for "LinkErrorPanelProps". -// src/components/KubernetesDrawer/KubernetesStructuredMetadataTableDrawer.d.ts:19:22 - (ae-undocumented) Missing documentation for "LinkErrorPanel". -// src/components/KubernetesDrawer/KubernetesStructuredMetadataTableDrawer.d.ts:25:1 - (ae-undocumented) Missing documentation for "KubernetesDrawerable". -// src/components/KubernetesDrawer/KubernetesStructuredMetadataTableDrawer.d.ts:26:5 - (ae-undocumented) Missing documentation for "metadata". -// src/components/KubernetesDrawer/KubernetesStructuredMetadataTableDrawer.d.ts:32:1 - (ae-undocumented) Missing documentation for "KubernetesStructuredMetadataTableDrawerProps". -// src/components/KubernetesDrawer/KubernetesStructuredMetadataTableDrawer.d.ts:33:5 - (ae-undocumented) Missing documentation for "object". -// src/components/KubernetesDrawer/KubernetesStructuredMetadataTableDrawer.d.ts:34:5 - (ae-undocumented) Missing documentation for "renderObject". -// src/components/KubernetesDrawer/KubernetesStructuredMetadataTableDrawer.d.ts:35:5 - (ae-undocumented) Missing documentation for "buttonVariant". -// src/components/KubernetesDrawer/KubernetesStructuredMetadataTableDrawer.d.ts:36:5 - (ae-undocumented) Missing documentation for "kind". -// src/components/KubernetesDrawer/KubernetesStructuredMetadataTableDrawer.d.ts:37:5 - (ae-undocumented) Missing documentation for "expanded". -// src/components/KubernetesDrawer/KubernetesStructuredMetadataTableDrawer.d.ts:38:5 - (ae-undocumented) Missing documentation for "children". -// src/components/KubernetesDrawer/KubernetesStructuredMetadataTableDrawer.d.ts:44:22 - (ae-undocumented) Missing documentation for "KubernetesStructuredMetadataTableDrawer". -// src/components/KubernetesDrawer/ManifestYaml.d.ts:8:5 - (ae-undocumented) Missing documentation for "object". -// src/components/PodExecTerminal/PodExecTerminal.d.ts:10:5 - (ae-undocumented) Missing documentation for "cluster". -// src/components/PodExecTerminal/PodExecTerminal.d.ts:11:5 - (ae-undocumented) Missing documentation for "containerName". -// src/components/PodExecTerminal/PodExecTerminal.d.ts:12:5 - (ae-undocumented) Missing documentation for "podName". -// src/components/PodExecTerminal/PodExecTerminal.d.ts:13:5 - (ae-undocumented) Missing documentation for "podNamespace". -// src/components/Pods/ErrorList/ErrorList.d.ts:9:5 - (ae-undocumented) Missing documentation for "podAndErrors". -// src/components/Pods/Events/Events.d.ts:9:5 - (ae-undocumented) Missing documentation for "warningEventsOnly". -// src/components/Pods/Events/Events.d.ts:10:5 - (ae-undocumented) Missing documentation for "events". -// src/components/Pods/Events/Events.d.ts:24:5 - (ae-undocumented) Missing documentation for "involvedObjectName". -// src/components/Pods/Events/Events.d.ts:25:5 - (ae-undocumented) Missing documentation for "namespace". -// src/components/Pods/Events/Events.d.ts:26:5 - (ae-undocumented) Missing documentation for "clusterName". -// src/components/Pods/Events/Events.d.ts:27:5 - (ae-undocumented) Missing documentation for "warningEventsOnly". -// src/components/Pods/Events/useEvents.d.ts:7:5 - (ae-undocumented) Missing documentation for "involvedObjectName". -// src/components/Pods/Events/useEvents.d.ts:8:5 - (ae-undocumented) Missing documentation for "namespace". -// src/components/Pods/Events/useEvents.d.ts:9:5 - (ae-undocumented) Missing documentation for "clusterName". -// src/components/Pods/FixDialog/FixDialog.d.ts:10:5 - (ae-undocumented) Missing documentation for "open". -// src/components/Pods/FixDialog/FixDialog.d.ts:11:5 - (ae-undocumented) Missing documentation for "clusterName". -// src/components/Pods/FixDialog/FixDialog.d.ts:12:5 - (ae-undocumented) Missing documentation for "pod". -// src/components/Pods/FixDialog/FixDialog.d.ts:13:5 - (ae-undocumented) Missing documentation for "error". -// src/components/Pods/PodDrawer/ContainerCard.d.ts:11:5 - (ae-undocumented) Missing documentation for "podScope". -// src/components/Pods/PodDrawer/ContainerCard.d.ts:12:5 - (ae-undocumented) Missing documentation for "containerSpec". -// src/components/Pods/PodDrawer/ContainerCard.d.ts:13:5 - (ae-undocumented) Missing documentation for "containerStatus". -// src/components/Pods/PodDrawer/ContainerCard.d.ts:14:5 - (ae-undocumented) Missing documentation for "containerMetrics". -// src/components/Pods/PodDrawer/PendingPodContent.d.ts:9:5 - (ae-undocumented) Missing documentation for "pod". -// src/components/Pods/PodDrawer/PodDrawer.d.ts:9:5 - (ae-undocumented) Missing documentation for "open". -// src/components/Pods/PodDrawer/PodDrawer.d.ts:10:5 - (ae-undocumented) Missing documentation for "podAndErrors". -// src/components/Pods/PodLogs/PodLogs.d.ts:9:5 - (ae-undocumented) Missing documentation for "containerScope". -// src/components/Pods/PodLogs/PodLogs.d.ts:10:5 - (ae-undocumented) Missing documentation for "previous". -// src/components/Pods/PodLogs/PodLogsDialog.d.ts:9:5 - (ae-undocumented) Missing documentation for "containerScope". -// src/components/Pods/PodLogs/types.d.ts:8:5 - (ae-undocumented) Missing documentation for "podName". -// src/components/Pods/PodLogs/types.d.ts:9:5 - (ae-undocumented) Missing documentation for "podNamespace". -// src/components/Pods/PodLogs/types.d.ts:10:5 - (ae-undocumented) Missing documentation for "cluster". -// src/components/Pods/PodLogs/types.d.ts:18:5 - (ae-undocumented) Missing documentation for "containerName". -// src/components/Pods/PodLogs/usePodLogs.d.ts:8:5 - (ae-undocumented) Missing documentation for "containerScope". -// src/components/Pods/PodLogs/usePodLogs.d.ts:9:5 - (ae-undocumented) Missing documentation for "previous". -// src/components/Pods/PodsTable.d.ts:9:22 - (ae-undocumented) Missing documentation for "READY_COLUMNS". -// src/components/Pods/PodsTable.d.ts:15:22 - (ae-undocumented) Missing documentation for "RESOURCE_COLUMNS". -// src/components/Pods/PodsTable.d.ts:21:1 - (ae-undocumented) Missing documentation for "PodColumns". -// src/components/Pods/PodsTable.d.ts:27:1 - (ae-undocumented) Missing documentation for "PodsTablesProps". -// src/components/Pods/PodsTable.d.ts:37:22 - (ae-undocumented) Missing documentation for "PodsTable". -// src/components/Pods/types.d.ts:9:5 - (ae-undocumented) Missing documentation for "cluster". -// src/components/Pods/types.d.ts:10:5 - (ae-undocumented) Missing documentation for "pod". -// src/components/Pods/types.d.ts:11:5 - (ae-undocumented) Missing documentation for "errors". -// src/components/ResourceUtilization/ResourceUtilization.d.ts:8:5 - (ae-undocumented) Missing documentation for "compressed". -// src/components/ResourceUtilization/ResourceUtilization.d.ts:9:5 - (ae-undocumented) Missing documentation for "title". -// src/components/ResourceUtilization/ResourceUtilization.d.ts:10:5 - (ae-undocumented) Missing documentation for "usage". -// src/components/ResourceUtilization/ResourceUtilization.d.ts:11:5 - (ae-undocumented) Missing documentation for "total". -// src/components/ResourceUtilization/ResourceUtilization.d.ts:12:5 - (ae-undocumented) Missing documentation for "totalFormatted". -// src/components/ServicesAccordions/ServicesAccordions.d.ts:7:1 - (ae-undocumented) Missing documentation for "ServicesAccordionsProps". -// src/components/ServicesAccordions/ServicesAccordions.d.ts:13:22 - (ae-undocumented) Missing documentation for "ServicesAccordions". -// src/hooks/Cluster.d.ts:6:22 - (ae-undocumented) Missing documentation for "ClusterContext". -// src/hooks/GroupedResponses.d.ts:8:22 - (ae-undocumented) Missing documentation for "GroupedResponsesContext". -// src/hooks/PodNamesWithErrors.d.ts:5:22 - (ae-undocumented) Missing documentation for "PodNamesWithErrorsContext". -// src/hooks/PodNamesWithMetrics.d.ts:6:22 - (ae-undocumented) Missing documentation for "PodNamesWithMetricsContext". -// src/hooks/useKubernetesObjects.d.ts:7:1 - (ae-undocumented) Missing documentation for "KubernetesObjects". -// src/hooks/useKubernetesObjects.d.ts:8:5 - (ae-undocumented) Missing documentation for "kubernetesObjects". -// src/hooks/useKubernetesObjects.d.ts:9:5 - (ae-undocumented) Missing documentation for "loading". -// src/hooks/useKubernetesObjects.d.ts:10:5 - (ae-undocumented) Missing documentation for "error". -// src/hooks/useKubernetesObjects.d.ts:16:22 - (ae-undocumented) Missing documentation for "useKubernetesObjects". -// src/hooks/useMatchingErrors.d.ts:15:1 - (ae-undocumented) Missing documentation for "ErrorMatcher". -// src/hooks/usePodMetrics.d.ts:13:1 - (ae-undocumented) Missing documentation for "PodMetricsMatcher". -// src/kubernetes-auth-provider/AksKubernetesAuthProvider.d.ts:5:1 - (ae-undocumented) Missing documentation for "AksKubernetesAuthProvider". -// src/kubernetes-auth-provider/AksKubernetesAuthProvider.d.ts:8:5 - (ae-undocumented) Missing documentation for "decorateRequestBodyForAuth". -// src/kubernetes-auth-provider/AksKubernetesAuthProvider.d.ts:9:5 - (ae-undocumented) Missing documentation for "getCredentials". -// src/kubernetes-auth-provider/GoogleKubernetesAuthProvider.d.ts:5:1 - (ae-undocumented) Missing documentation for "GoogleKubernetesAuthProvider". -// src/kubernetes-auth-provider/GoogleKubernetesAuthProvider.d.ts:6:5 - (ae-undocumented) Missing documentation for "authProvider". -// src/kubernetes-auth-provider/GoogleKubernetesAuthProvider.d.ts:8:5 - (ae-undocumented) Missing documentation for "decorateRequestBodyForAuth". -// src/kubernetes-auth-provider/GoogleKubernetesAuthProvider.d.ts:9:5 - (ae-undocumented) Missing documentation for "getCredentials". -// src/kubernetes-auth-provider/KubernetesAuthProviders.d.ts:5:1 - (ae-undocumented) Missing documentation for "KubernetesAuthProviders". -// src/kubernetes-auth-provider/KubernetesAuthProviders.d.ts:14:5 - (ae-undocumented) Missing documentation for "decorateRequestBodyForAuth". -// src/kubernetes-auth-provider/KubernetesAuthProviders.d.ts:15:5 - (ae-undocumented) Missing documentation for "getCredentials". -// src/kubernetes-auth-provider/OidcKubernetesAuthProvider.d.ts:5:1 - (ae-undocumented) Missing documentation for "OidcKubernetesAuthProvider". -// src/kubernetes-auth-provider/OidcKubernetesAuthProvider.d.ts:6:5 - (ae-undocumented) Missing documentation for "providerName". -// src/kubernetes-auth-provider/OidcKubernetesAuthProvider.d.ts:7:5 - (ae-undocumented) Missing documentation for "authProvider". -// src/kubernetes-auth-provider/OidcKubernetesAuthProvider.d.ts:9:5 - (ae-undocumented) Missing documentation for "decorateRequestBodyForAuth". -// src/kubernetes-auth-provider/OidcKubernetesAuthProvider.d.ts:10:5 - (ae-undocumented) Missing documentation for "getCredentials". -// src/kubernetes-auth-provider/ServerSideAuthProvider.d.ts:9:5 - (ae-undocumented) Missing documentation for "decorateRequestBodyForAuth". -// src/kubernetes-auth-provider/ServerSideAuthProvider.d.ts:10:5 - (ae-undocumented) Missing documentation for "getCredentials". -// src/kubernetes-auth-provider/types.d.ts:3:1 - (ae-undocumented) Missing documentation for "KubernetesAuthProvider". -// src/kubernetes-auth-provider/types.d.ts:4:5 - (ae-undocumented) Missing documentation for "decorateRequestBodyForAuth". -// src/kubernetes-auth-provider/types.d.ts:5:5 - (ae-undocumented) Missing documentation for "getCredentials". -// src/kubernetes-auth-provider/types.d.ts:10:22 - (ae-undocumented) Missing documentation for "kubernetesAuthProvidersApiRef". -// src/kubernetes-auth-provider/types.d.ts:12:1 - (ae-undocumented) Missing documentation for "KubernetesAuthProvidersApi". -// src/kubernetes-auth-provider/types.d.ts:13:5 - (ae-undocumented) Missing documentation for "decorateRequestBodyForAuth". -// src/kubernetes-auth-provider/types.d.ts:14:5 - (ae-undocumented) Missing documentation for "getCredentials". -// src/types/types.d.ts:5:1 - (ae-undocumented) Missing documentation for "ClusterLinksFormatterOptions". -// src/types/types.d.ts:6:5 - (ae-undocumented) Missing documentation for "dashboardUrl". -// src/types/types.d.ts:7:5 - (ae-undocumented) Missing documentation for "dashboardParameters". -// src/types/types.d.ts:8:5 - (ae-undocumented) Missing documentation for "object". -// src/types/types.d.ts:9:5 - (ae-undocumented) Missing documentation for "kind". -// src/types/types.d.ts:14:1 - (ae-undocumented) Missing documentation for "ClusterLinksFormatter". -// src/types/types.d.ts:15:5 - (ae-undocumented) Missing documentation for "formatClusterLink". ``` diff --git a/plugins/kubernetes/report-alpha.api.md b/plugins/kubernetes/report-alpha.api.md index 93919acd47..9ba748577f 100644 --- a/plugins/kubernetes/report-alpha.api.md +++ b/plugins/kubernetes/report-alpha.api.md @@ -162,9 +162,5 @@ const _default: FrontendPlugin< >; export default _default; -// Warnings were encountered during analysis: -// -// src/alpha/plugin.d.ts:2:15 - (ae-undocumented) Missing documentation for "_default". - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/kubernetes/report.api.md b/plugins/kubernetes/report.api.md index e5038b674a..64b56cf786 100644 --- a/plugins/kubernetes/report.api.md +++ b/plugins/kubernetes/report.api.md @@ -47,11 +47,4 @@ export const Router: (props: { }) => React_2.JSX.Element; export * from '@backstage/plugin-kubernetes-react'; - -// Warnings were encountered during analysis: -// -// src/Router.d.ts:3:22 - (ae-undocumented) Missing documentation for "isKubernetesAvailable". -// src/Router.d.ts:4:22 - (ae-undocumented) Missing documentation for "Router". -// src/plugin.d.ts:3:22 - (ae-undocumented) Missing documentation for "kubernetesPlugin". -// src/plugin.d.ts:17:22 - (ae-undocumented) Missing documentation for "EntityKubernetesContent". ``` diff --git a/plugins/notifications-backend-module-email/report.api.md b/plugins/notifications-backend-module-email/report.api.md index 2116bd4ef4..be3b58d1fd 100644 --- a/plugins/notifications-backend-module-email/report.api.md +++ b/plugins/notifications-backend-module-email/report.api.md @@ -29,15 +29,4 @@ export interface NotificationTemplateRenderer { // (undocumented) getText?(notification: Notification_2): Promise; } - -// Warnings were encountered during analysis: -// -// src/extensions.d.ts:5:1 - (ae-undocumented) Missing documentation for "NotificationTemplateRenderer". -// src/extensions.d.ts:6:5 - (ae-undocumented) Missing documentation for "getSubject". -// src/extensions.d.ts:7:5 - (ae-undocumented) Missing documentation for "getText". -// src/extensions.d.ts:8:5 - (ae-undocumented) Missing documentation for "getHtml". -// src/extensions.d.ts:13:1 - (ae-undocumented) Missing documentation for "NotificationsEmailTemplateExtensionPoint". -// src/extensions.d.ts:14:5 - (ae-undocumented) Missing documentation for "setTemplateRenderer". -// src/extensions.d.ts:19:22 - (ae-undocumented) Missing documentation for "notificationsEmailTemplateExtensionPoint". -// src/module.d.ts:4:22 - (ae-undocumented) Missing documentation for "notificationsModuleEmail". ``` diff --git a/plugins/notifications-common/report.api.md b/plugins/notifications-common/report.api.md index a02bfb2eaa..0f59a85849 100644 --- a/plugins/notifications-common/report.api.md +++ b/plugins/notifications-common/report.api.md @@ -67,16 +67,4 @@ export type NotificationStatus = { unread: number; read: number; }; - -// Warnings were encountered during analysis: -// -// src/filters.d.ts:4:22 - (ae-undocumented) Missing documentation for "getProcessorFiltersFromConfig". -// src/types.d.ts:2:1 - (ae-undocumented) Missing documentation for "NotificationSeverity". -// src/types.d.ts:4:1 - (ae-undocumented) Missing documentation for "NotificationPayload". -// src/types.d.ts:36:1 - (ae-undocumented) Missing documentation for "Notification". -// src/types.d.ts:73:1 - (ae-undocumented) Missing documentation for "NotificationStatus". -// src/types.d.ts:84:1 - (ae-undocumented) Missing documentation for "NewNotificationSignal". -// src/types.d.ts:89:1 - (ae-undocumented) Missing documentation for "NotificationReadSignal". -// src/types.d.ts:94:1 - (ae-undocumented) Missing documentation for "NotificationSignal". -// src/types.d.ts:98:1 - (ae-undocumented) Missing documentation for "NotificationProcessorFilters". ``` diff --git a/plugins/notifications-node/report.api.md b/plugins/notifications-node/report.api.md index 869bf6c6bb..995b98bc21 100644 --- a/plugins/notifications-node/report.api.md +++ b/plugins/notifications-node/report.api.md @@ -87,20 +87,4 @@ export interface NotificationsProcessingExtensionPoint { // @public (undocumented) export const notificationsProcessingExtensionPoint: ExtensionPoint; - -// Warnings were encountered during analysis: -// -// src/extensions.d.ts:73:1 - (ae-undocumented) Missing documentation for "NotificationsProcessingExtensionPoint". -// src/extensions.d.ts:74:5 - (ae-undocumented) Missing documentation for "addProcessor". -// src/extensions.d.ts:79:22 - (ae-undocumented) Missing documentation for "notificationsProcessingExtensionPoint". -// src/extensions.d.ts:84:1 - (ae-undocumented) Missing documentation for "NotificationProcessorFilters". -// src/lib.d.ts:3:22 - (ae-undocumented) Missing documentation for "notificationService". -// src/service/DefaultNotificationService.d.ts:5:1 - (ae-undocumented) Missing documentation for "NotificationServiceOptions". -// src/service/DefaultNotificationService.d.ts:10:1 - (ae-undocumented) Missing documentation for "NotificationRecipients". -// src/service/DefaultNotificationService.d.ts:26:1 - (ae-undocumented) Missing documentation for "NotificationSendOptions". -// src/service/DefaultNotificationService.d.ts:31:1 - (ae-undocumented) Missing documentation for "DefaultNotificationService". -// src/service/DefaultNotificationService.d.ts:35:5 - (ae-undocumented) Missing documentation for "create". -// src/service/DefaultNotificationService.d.ts:36:5 - (ae-undocumented) Missing documentation for "send". -// src/service/NotificationService.d.ts:3:1 - (ae-undocumented) Missing documentation for "NotificationService". -// src/service/NotificationService.d.ts:4:5 - (ae-undocumented) Missing documentation for "send". ``` diff --git a/plugins/notifications/report.api.md b/plugins/notifications/report.api.md index ab1fc6d5a1..5e06ae2616 100644 --- a/plugins/notifications/report.api.md +++ b/plugins/notifications/report.api.md @@ -176,29 +176,5 @@ export function useNotificationsApi( value: T; }; -// Warnings were encountered during analysis: -// -// src/api/NotificationsApi.d.ts:3:22 - (ae-undocumented) Missing documentation for "notificationsApiRef". -// src/api/NotificationsApi.d.ts:5:1 - (ae-undocumented) Missing documentation for "GetNotificationsOptions". -// src/api/NotificationsApi.d.ts:17:1 - (ae-undocumented) Missing documentation for "UpdateNotificationsOptions". -// src/api/NotificationsApi.d.ts:23:1 - (ae-undocumented) Missing documentation for "GetNotificationsResponse". -// src/api/NotificationsApi.d.ts:28:1 - (ae-undocumented) Missing documentation for "NotificationsApi". -// src/api/NotificationsApi.d.ts:29:5 - (ae-undocumented) Missing documentation for "getNotifications". -// src/api/NotificationsApi.d.ts:30:5 - (ae-undocumented) Missing documentation for "getNotification". -// src/api/NotificationsApi.d.ts:31:5 - (ae-undocumented) Missing documentation for "getStatus". -// src/api/NotificationsApi.d.ts:32:5 - (ae-undocumented) Missing documentation for "updateNotifications". -// src/api/NotificationsClient.d.ts:5:1 - (ae-undocumented) Missing documentation for "NotificationsClient". -// src/api/NotificationsClient.d.ts:12:5 - (ae-undocumented) Missing documentation for "getNotifications". -// src/api/NotificationsClient.d.ts:13:5 - (ae-undocumented) Missing documentation for "getNotification". -// src/api/NotificationsClient.d.ts:14:5 - (ae-undocumented) Missing documentation for "getStatus". -// src/api/NotificationsClient.d.ts:15:5 - (ae-undocumented) Missing documentation for "updateNotifications". -// src/components/NotificationsPage/NotificationsPage.d.ts:3:1 - (ae-undocumented) Missing documentation for "NotificationsPageProps". -// src/components/NotificationsSideBarItem/NotificationsSideBarItem.d.ts:12:22 - (ae-undocumented) Missing documentation for "NotificationsSidebarItem". -// src/components/NotificationsTable/NotificationsTable.d.ts:5:1 - (ae-undocumented) Missing documentation for "NotificationsTableProps". -// src/components/NotificationsTable/NotificationsTable.d.ts:15:22 - (ae-undocumented) Missing documentation for "NotificationsTable". -// src/hooks/useNotificationsApi.d.ts:3:1 - (ae-undocumented) Missing documentation for "useNotificationsApi". -// src/plugin.d.ts:3:22 - (ae-undocumented) Missing documentation for "notificationsPlugin". -// src/plugin.d.ts:7:22 - (ae-undocumented) Missing documentation for "NotificationsPage". - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/org-react/report.api.md b/plugins/org-react/report.api.md index 924f1ea7ca..5cfe5ca90a 100644 --- a/plugins/org-react/report.api.md +++ b/plugins/org-react/report.api.md @@ -19,9 +19,5 @@ export type GroupListPickerProps = { onChange: (value: GroupEntity | undefined) => void; }; -// Warnings were encountered during analysis: -// -// src/components/GroupListPicker/GroupListPicker.d.ts:15:22 - (ae-undocumented) Missing documentation for "GroupListPicker". - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/org/report-alpha.api.md b/plugins/org/report-alpha.api.md index 14833df450..1040b61733 100644 --- a/plugins/org/report-alpha.api.md +++ b/plugins/org/report-alpha.api.md @@ -161,9 +161,5 @@ const _default: FrontendPlugin< >; export default _default; -// Warnings were encountered during analysis: -// -// src/alpha.d.ts:3:15 - (ae-undocumented) Missing documentation for "_default". - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/org/report.api.md b/plugins/org/report.api.md index 033d363606..af03687240 100644 --- a/plugins/org/report.api.md +++ b/plugins/org/report.api.md @@ -102,19 +102,4 @@ export const UserProfileCard: (props: { variant?: InfoCardVariants; showLinks?: boolean; }) => React_2.JSX.Element; - -// Warnings were encountered during analysis: -// -// src/components/Cards/Group/GroupProfile/GroupProfileCard.d.ts:4:22 - (ae-undocumented) Missing documentation for "GroupProfileCard". -// src/components/Cards/Group/MembersList/MembersListCard.d.ts:4:1 - (ae-undocumented) Missing documentation for "MemberComponentClassKey". -// src/components/Cards/Group/MembersList/MembersListCard.d.ts:6:1 - (ae-undocumented) Missing documentation for "MembersListCardClassKey". -// src/components/Cards/Group/MembersList/MembersListCard.d.ts:8:22 - (ae-undocumented) Missing documentation for "MembersListCard". -// src/components/Cards/OwnershipCard/OwnershipCard.d.ts:5:22 - (ae-undocumented) Missing documentation for "OwnershipCard". -// src/components/Cards/User/UserProfileCard/UserProfileCard.d.ts:4:22 - (ae-undocumented) Missing documentation for "UserProfileCard". -// src/components/Cards/types.d.ts:2:1 - (ae-undocumented) Missing documentation for "EntityRelationAggregation". -// src/plugin.d.ts:3:22 - (ae-undocumented) Missing documentation for "orgPlugin". -// src/plugin.d.ts:7:22 - (ae-undocumented) Missing documentation for "EntityGroupProfileCard". -// src/plugin.d.ts:12:22 - (ae-undocumented) Missing documentation for "EntityMembersListCard". -// src/plugin.d.ts:21:22 - (ae-undocumented) Missing documentation for "EntityOwnershipCard". -// src/plugin.d.ts:30:22 - (ae-undocumented) Missing documentation for "EntityUserProfileCard". ``` diff --git a/plugins/permission-backend/report-alpha.api.md b/plugins/permission-backend/report-alpha.api.md index e2d43b0195..289eb2b685 100644 --- a/plugins/permission-backend/report-alpha.api.md +++ b/plugins/permission-backend/report-alpha.api.md @@ -9,9 +9,5 @@ import { BackendFeature } from '@backstage/backend-plugin-api'; const _feature: BackendFeature; export default _feature; -// Warnings were encountered during analysis: -// -// src/alpha.d.ts:2:15 - (ae-undocumented) Missing documentation for "_feature". - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/permission-backend/report.api.md b/plugins/permission-backend/report.api.md index fd559c4a6a..48395265f7 100644 --- a/plugins/permission-backend/report.api.md +++ b/plugins/permission-backend/report.api.md @@ -40,15 +40,4 @@ export interface RouterOptions { // (undocumented) userInfo?: UserInfoService; } - -// Warnings were encountered during analysis: -// -// src/service/router.d.ts:13:5 - (ae-undocumented) Missing documentation for "logger". -// src/service/router.d.ts:14:5 - (ae-undocumented) Missing documentation for "discovery". -// src/service/router.d.ts:15:5 - (ae-undocumented) Missing documentation for "policy". -// src/service/router.d.ts:16:5 - (ae-undocumented) Missing documentation for "identity". -// src/service/router.d.ts:17:5 - (ae-undocumented) Missing documentation for "config". -// src/service/router.d.ts:18:5 - (ae-undocumented) Missing documentation for "auth". -// src/service/router.d.ts:19:5 - (ae-undocumented) Missing documentation for "httpAuth". -// src/service/router.d.ts:20:5 - (ae-undocumented) Missing documentation for "userInfo". ``` diff --git a/plugins/permission-common/report.api.md b/plugins/permission-common/report.api.md index 856b650dba..465c43846f 100644 --- a/plugins/permission-common/report.api.md +++ b/plugins/permission-common/report.api.md @@ -261,8 +261,4 @@ export type ResourcePermission = export function toPermissionEvaluator( permissionAuthorizer: PermissionAuthorizer, ): PermissionEvaluator; - -// Warnings were encountered during analysis: -// -// src/types/permission.d.ts:71:5 - (ae-undocumented) Missing documentation for "authorize". ``` diff --git a/plugins/permission-node/report.api.md b/plugins/permission-node/report.api.md index 3deb87d141..83730c6050 100644 --- a/plugins/permission-node/report.api.md +++ b/plugins/permission-node/report.api.md @@ -295,11 +295,4 @@ export class ServerPermissionClient implements PermissionsService { }, ): ServerPermissionClient; } - -// Warnings were encountered during analysis: -// -// src/ServerPermissionClient.d.ts:13:5 - (ae-undocumented) Missing documentation for "fromConfig". -// src/ServerPermissionClient.d.ts:20:5 - (ae-undocumented) Missing documentation for "authorizeConditional". -// src/ServerPermissionClient.d.ts:21:5 - (ae-undocumented) Missing documentation for "authorize". -// src/policy/types.d.ts:67:5 - (ae-undocumented) Missing documentation for "handle". ``` diff --git a/plugins/permission-react/report.api.md b/plugins/permission-react/report.api.md index d1b5de1d9e..4c51d16b80 100644 --- a/plugins/permission-react/report.api.md +++ b/plugins/permission-react/report.api.md @@ -100,10 +100,4 @@ export function usePermission( resourceRef: string | undefined; }, ): AsyncPermissionResult; - -// Warnings were encountered during analysis: -// -// src/apis/IdentityPermissionApi.d.ts:14:5 - (ae-undocumented) Missing documentation for "create". -// src/apis/IdentityPermissionApi.d.ts:19:5 - (ae-undocumented) Missing documentation for "authorize". -// src/hooks/usePermission.d.ts:3:1 - (ae-undocumented) Missing documentation for "AsyncPermissionResult". ``` diff --git a/plugins/proxy-backend/report-alpha.api.md b/plugins/proxy-backend/report-alpha.api.md index a32524352e..4b3b1dfdc6 100644 --- a/plugins/proxy-backend/report-alpha.api.md +++ b/plugins/proxy-backend/report-alpha.api.md @@ -9,9 +9,5 @@ import { BackendFeature } from '@backstage/backend-plugin-api'; const _feature: BackendFeature; export default _feature; -// Warnings were encountered during analysis: -// -// src/alpha.d.ts:2:15 - (ae-undocumented) Missing documentation for "_feature". - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/proxy-backend/report.api.md b/plugins/proxy-backend/report.api.md index 0a68a03cfe..c0601eac30 100644 --- a/plugins/proxy-backend/report.api.md +++ b/plugins/proxy-backend/report.api.md @@ -29,13 +29,4 @@ export interface RouterOptions { // (undocumented) skipInvalidProxies?: boolean; } - -// Warnings were encountered during analysis: -// -// src/service/router.d.ts:9:1 - (ae-undocumented) Missing documentation for "RouterOptions". -// src/service/router.d.ts:10:5 - (ae-undocumented) Missing documentation for "logger". -// src/service/router.d.ts:11:5 - (ae-undocumented) Missing documentation for "config". -// src/service/router.d.ts:12:5 - (ae-undocumented) Missing documentation for "discovery". -// src/service/router.d.ts:13:5 - (ae-undocumented) Missing documentation for "skipInvalidProxies". -// src/service/router.d.ts:14:5 - (ae-undocumented) Missing documentation for "reviveConsumedRequestBodies". ``` diff --git a/plugins/scaffolder-backend-module-bitbucket/report.api.md b/plugins/scaffolder-backend-module-bitbucket/report.api.md index 8721760248..952b1665fb 100644 --- a/plugins/scaffolder-backend-module-bitbucket/report.api.md +++ b/plugins/scaffolder-backend-module-bitbucket/report.api.md @@ -56,11 +56,4 @@ export const createPublishBitbucketServerAction: typeof bitbucketServer.createPu // @public @deprecated (undocumented) export const createPublishBitbucketServerPullRequestAction: typeof bitbucketServer.createPublishBitbucketServerPullRequestAction; - -// Warnings were encountered during analysis: -// -// src/deprecated.d.ts:8:22 - (ae-undocumented) Missing documentation for "createPublishBitbucketCloudAction". -// src/deprecated.d.ts:13:22 - (ae-undocumented) Missing documentation for "createBitbucketPipelinesRunAction". -// src/deprecated.d.ts:29:22 - (ae-undocumented) Missing documentation for "createPublishBitbucketServerAction". -// src/deprecated.d.ts:34:22 - (ae-undocumented) Missing documentation for "createPublishBitbucketServerPullRequestAction". ``` diff --git a/plugins/scaffolder-backend-module-confluence-to-markdown/report.api.md b/plugins/scaffolder-backend-module-confluence-to-markdown/report.api.md index 4d08c12e7d..2dd5e244dd 100644 --- a/plugins/scaffolder-backend-module-confluence-to-markdown/report.api.md +++ b/plugins/scaffolder-backend-module-confluence-to-markdown/report.api.md @@ -26,8 +26,4 @@ export const createConfluenceToMarkdownAction: (options: { }, JsonObject >; - -// Warnings were encountered during analysis: -// -// src/actions/confluence/confluenceToMarkdown.d.ts:7:22 - (ae-undocumented) Missing documentation for "createConfluenceToMarkdownAction". ``` diff --git a/plugins/scaffolder-backend-module-gitlab/report.api.md b/plugins/scaffolder-backend-module-gitlab/report.api.md index f00055a876..49bda648f6 100644 --- a/plugins/scaffolder-backend-module-gitlab/report.api.md +++ b/plugins/scaffolder-backend-module-gitlab/report.api.md @@ -277,13 +277,4 @@ export enum IssueType { // (undocumented) TEST = 'test_case', } - -// Warnings were encountered during analysis: -// -// src/commonGitlabConfig.d.ts:23:5 - (ae-undocumented) Missing documentation for "ISSUE". -// src/commonGitlabConfig.d.ts:24:5 - (ae-undocumented) Missing documentation for "INCIDENT". -// src/commonGitlabConfig.d.ts:25:5 - (ae-undocumented) Missing documentation for "TEST". -// src/commonGitlabConfig.d.ts:26:5 - (ae-undocumented) Missing documentation for "TASK". -// src/commonGitlabConfig.d.ts:34:5 - (ae-undocumented) Missing documentation for "CLOSE". -// src/commonGitlabConfig.d.ts:35:5 - (ae-undocumented) Missing documentation for "REOPEN". ``` diff --git a/plugins/scaffolder-backend-module-notifications/report.api.md b/plugins/scaffolder-backend-module-notifications/report.api.md index 7e283573b0..091782449f 100644 --- a/plugins/scaffolder-backend-module-notifications/report.api.md +++ b/plugins/scaffolder-backend-module-notifications/report.api.md @@ -29,8 +29,4 @@ export function createSendNotificationAction(options: { // @public const scaffolderModuleNotifications: BackendFeature; export default scaffolderModuleNotifications; - -// Warnings were encountered during analysis: -// -// src/actions/sendNotification.d.ts:6:1 - (ae-undocumented) Missing documentation for "createSendNotificationAction". ``` diff --git a/plugins/scaffolder-backend/report-alpha.api.md b/plugins/scaffolder-backend/report-alpha.api.md index 89d4fecd8c..c35b743f6a 100644 --- a/plugins/scaffolder-backend/report-alpha.api.md +++ b/plugins/scaffolder-backend/report-alpha.api.md @@ -93,10 +93,5 @@ export const scaffolderTemplateConditions: Conditions<{ >; }>; -// Warnings were encountered during analysis: -// -// src/alpha.d.ts:2:15 - (ae-undocumented) Missing documentation for "_feature". -// src/service/conditionExports.d.ts:48:22 - (ae-undocumented) Missing documentation for "createScaffolderActionConditionalDecision". - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/scaffolder-backend/report.api.md b/plugins/scaffolder-backend/report.api.md index d3dddc21e9..fb7a9361c2 100644 --- a/plugins/scaffolder-backend/report.api.md +++ b/plugins/scaffolder-backend/report.api.md @@ -844,117 +844,4 @@ export type TemplatePermissionRuleInput< typeof RESOURCE_TYPE_SCAFFOLDER_TEMPLATE, TParams >; - -// Warnings were encountered during analysis: -// -// src/deprecated.d.ts:8:1 - (ae-undocumented) Missing documentation for "ActionContext". -// src/deprecated.d.ts:13:22 - (ae-undocumented) Missing documentation for "createTemplateAction". -// src/deprecated.d.ts:18:1 - (ae-undocumented) Missing documentation for "TaskSecrets". -// src/deprecated.d.ts:23:1 - (ae-undocumented) Missing documentation for "TemplateAction". -// src/lib/templating/SecureTemplater.d.ts:6:1 - (ae-undocumented) Missing documentation for "TemplateFilter". -// src/lib/templating/SecureTemplater.d.ts:11:1 - (ae-undocumented) Missing documentation for "TemplateGlobal". -// src/scaffolder/actions/TemplateActionRegistry.d.ts:8:5 - (ae-undocumented) Missing documentation for "register". -// src/scaffolder/actions/TemplateActionRegistry.d.ts:9:5 - (ae-undocumented) Missing documentation for "get". -// src/scaffolder/actions/TemplateActionRegistry.d.ts:10:5 - (ae-undocumented) Missing documentation for "list". -// src/scaffolder/actions/builtin/createBuiltinActions.d.ts:36:5 - (ae-undocumented) Missing documentation for "additionalTemplateGlobals". -// src/scaffolder/actions/deprecated.d.ts:12:22 - (ae-undocumented) Missing documentation for "createGithubActionsDispatchAction". -// src/scaffolder/actions/deprecated.d.ts:17:22 - (ae-undocumented) Missing documentation for "createGithubDeployKeyAction". -// src/scaffolder/actions/deprecated.d.ts:22:22 - (ae-undocumented) Missing documentation for "createGithubEnvironmentAction". -// src/scaffolder/actions/deprecated.d.ts:27:22 - (ae-undocumented) Missing documentation for "createGithubIssuesLabelAction". -// src/scaffolder/actions/deprecated.d.ts:32:1 - (ae-undocumented) Missing documentation for "CreateGithubPullRequestActionOptions". -// src/scaffolder/actions/deprecated.d.ts:37:22 - (ae-undocumented) Missing documentation for "createGithubRepoCreateAction". -// src/scaffolder/actions/deprecated.d.ts:42:22 - (ae-undocumented) Missing documentation for "createGithubRepoPushAction". -// src/scaffolder/actions/deprecated.d.ts:47:22 - (ae-undocumented) Missing documentation for "createGithubWebhookAction". -// src/scaffolder/actions/deprecated.d.ts:52:22 - (ae-undocumented) Missing documentation for "createPublishGithubAction". -// src/scaffolder/actions/deprecated.d.ts:57:22 - (ae-undocumented) Missing documentation for "createPublishGithubPullRequestAction". -// src/scaffolder/actions/deprecated.d.ts:79:22 - (ae-undocumented) Missing documentation for "createPublishBitbucketAction". -// src/scaffolder/actions/deprecated.d.ts:84:22 - (ae-undocumented) Missing documentation for "createPublishBitbucketCloudAction". -// src/scaffolder/actions/deprecated.d.ts:89:22 - (ae-undocumented) Missing documentation for "createPublishBitbucketServerAction". -// src/scaffolder/actions/deprecated.d.ts:94:22 - (ae-undocumented) Missing documentation for "createPublishBitbucketServerPullRequestAction". -// src/scaffolder/actions/deprecated.d.ts:99:22 - (ae-undocumented) Missing documentation for "createPublishAzureAction". -// src/scaffolder/actions/deprecated.d.ts:104:22 - (ae-undocumented) Missing documentation for "createPublishGerritAction". -// src/scaffolder/actions/deprecated.d.ts:109:22 - (ae-undocumented) Missing documentation for "createPublishGerritReviewAction". -// src/scaffolder/actions/deprecated.d.ts:114:22 - (ae-undocumented) Missing documentation for "createPublishGitlabAction". -// src/scaffolder/actions/deprecated.d.ts:119:22 - (ae-undocumented) Missing documentation for "createPublishGitlabMergeRequestAction". -// src/scaffolder/tasks/DatabaseTaskStore.d.ts:42:5 - (ae-undocumented) Missing documentation for "create". -// src/scaffolder/tasks/DatabaseTaskStore.d.ts:49:5 - (ae-undocumented) Missing documentation for "list". -// src/scaffolder/tasks/DatabaseTaskStore.d.ts:68:5 - (ae-undocumented) Missing documentation for "getTask". -// src/scaffolder/tasks/DatabaseTaskStore.d.ts:69:5 - (ae-undocumented) Missing documentation for "createTask". -// src/scaffolder/tasks/DatabaseTaskStore.d.ts:70:5 - (ae-undocumented) Missing documentation for "claimTask". -// src/scaffolder/tasks/DatabaseTaskStore.d.ts:71:5 - (ae-undocumented) Missing documentation for "heartbeatTask". -// src/scaffolder/tasks/DatabaseTaskStore.d.ts:72:5 - (ae-undocumented) Missing documentation for "listStaleTasks". -// src/scaffolder/tasks/DatabaseTaskStore.d.ts:80:5 - (ae-undocumented) Missing documentation for "completeTask". -// src/scaffolder/tasks/DatabaseTaskStore.d.ts:85:5 - (ae-undocumented) Missing documentation for "emitLogEvent". -// src/scaffolder/tasks/DatabaseTaskStore.d.ts:88:5 - (ae-undocumented) Missing documentation for "getTaskState". -// src/scaffolder/tasks/DatabaseTaskStore.d.ts:93:5 - (ae-undocumented) Missing documentation for "saveTaskState". -// src/scaffolder/tasks/DatabaseTaskStore.d.ts:97:5 - (ae-undocumented) Missing documentation for "listEvents". -// src/scaffolder/tasks/DatabaseTaskStore.d.ts:100:5 - (ae-undocumented) Missing documentation for "shutdownTask". -// src/scaffolder/tasks/DatabaseTaskStore.d.ts:101:5 - (ae-undocumented) Missing documentation for "rehydrateWorkspace". -// src/scaffolder/tasks/DatabaseTaskStore.d.ts:105:5 - (ae-undocumented) Missing documentation for "cleanWorkspace". -// src/scaffolder/tasks/DatabaseTaskStore.d.ts:108:5 - (ae-undocumented) Missing documentation for "serializeWorkspace". -// src/scaffolder/tasks/DatabaseTaskStore.d.ts:112:5 - (ae-undocumented) Missing documentation for "cancelTask". -// src/scaffolder/tasks/DatabaseTaskStore.d.ts:115:5 - (ae-undocumented) Missing documentation for "retryTask". -// src/scaffolder/tasks/DatabaseTaskStore.d.ts:118:5 - (ae-undocumented) Missing documentation for "recoverTasks". -// src/scaffolder/tasks/StorageTaskBroker.d.ts:25:5 - (ae-undocumented) Missing documentation for "create". -// src/scaffolder/tasks/StorageTaskBroker.d.ts:27:5 - (ae-undocumented) Missing documentation for "spec". -// src/scaffolder/tasks/StorageTaskBroker.d.ts:28:5 - (ae-undocumented) Missing documentation for "cancelSignal". -// src/scaffolder/tasks/StorageTaskBroker.d.ts:29:5 - (ae-undocumented) Missing documentation for "secrets". -// src/scaffolder/tasks/StorageTaskBroker.d.ts:30:5 - (ae-undocumented) Missing documentation for "createdBy". -// src/scaffolder/tasks/StorageTaskBroker.d.ts:31:5 - (ae-undocumented) Missing documentation for "getWorkspaceName". -// src/scaffolder/tasks/StorageTaskBroker.d.ts:32:5 - (ae-undocumented) Missing documentation for "rehydrateWorkspace". -// src/scaffolder/tasks/StorageTaskBroker.d.ts:36:5 - (ae-undocumented) Missing documentation for "done". -// src/scaffolder/tasks/StorageTaskBroker.d.ts:37:5 - (ae-undocumented) Missing documentation for "emitLog". -// src/scaffolder/tasks/StorageTaskBroker.d.ts:38:5 - (ae-undocumented) Missing documentation for "getTaskState". -// src/scaffolder/tasks/StorageTaskBroker.d.ts:41:5 - (ae-undocumented) Missing documentation for "updateCheckpoint". -// src/scaffolder/tasks/StorageTaskBroker.d.ts:50:5 - (ae-undocumented) Missing documentation for "serializeWorkspace". -// src/scaffolder/tasks/StorageTaskBroker.d.ts:53:5 - (ae-undocumented) Missing documentation for "cleanWorkspace". -// src/scaffolder/tasks/StorageTaskBroker.d.ts:54:5 - (ae-undocumented) Missing documentation for "complete". -// src/scaffolder/tasks/StorageTaskBroker.d.ts:56:5 - (ae-undocumented) Missing documentation for "getInitiatorCredentials". -// src/scaffolder/tasks/TaskWorker.d.ts:60:5 - (ae-undocumented) Missing documentation for "create". -// src/scaffolder/tasks/TaskWorker.d.ts:61:5 - (ae-undocumented) Missing documentation for "recoverTasks". -// src/scaffolder/tasks/TaskWorker.d.ts:62:5 - (ae-undocumented) Missing documentation for "start". -// src/scaffolder/tasks/TaskWorker.d.ts:63:5 - (ae-undocumented) Missing documentation for "stop". -// src/scaffolder/tasks/TaskWorker.d.ts:64:5 - (ae-undocumented) Missing documentation for "onReadyToClaimTask". -// src/scaffolder/tasks/TaskWorker.d.ts:65:5 - (ae-undocumented) Missing documentation for "runOneTask". -// src/scaffolder/tasks/types.d.ts:124:5 - (ae-undocumented) Missing documentation for "cancelTask". -// src/scaffolder/tasks/types.d.ts:125:5 - (ae-undocumented) Missing documentation for "createTask". -// src/scaffolder/tasks/types.d.ts:126:5 - (ae-undocumented) Missing documentation for "retryTask". -// src/scaffolder/tasks/types.d.ts:129:5 - (ae-undocumented) Missing documentation for "recoverTasks". -// src/scaffolder/tasks/types.d.ts:132:5 - (ae-undocumented) Missing documentation for "getTask". -// src/scaffolder/tasks/types.d.ts:133:5 - (ae-undocumented) Missing documentation for "claimTask". -// src/scaffolder/tasks/types.d.ts:134:5 - (ae-undocumented) Missing documentation for "completeTask". -// src/scaffolder/tasks/types.d.ts:139:5 - (ae-undocumented) Missing documentation for "heartbeatTask". -// src/scaffolder/tasks/types.d.ts:140:5 - (ae-undocumented) Missing documentation for "listStaleTasks". -// src/scaffolder/tasks/types.d.ts:147:5 - (ae-undocumented) Missing documentation for "list". -// src/scaffolder/tasks/types.d.ts:167:5 - (ae-undocumented) Missing documentation for "list". -// src/scaffolder/tasks/types.d.ts:186:5 - (ae-undocumented) Missing documentation for "emitLogEvent". -// src/scaffolder/tasks/types.d.ts:187:5 - (ae-undocumented) Missing documentation for "getTaskState". -// src/scaffolder/tasks/types.d.ts:192:5 - (ae-undocumented) Missing documentation for "saveTaskState". -// src/scaffolder/tasks/types.d.ts:196:5 - (ae-undocumented) Missing documentation for "listEvents". -// src/scaffolder/tasks/types.d.ts:199:5 - (ae-undocumented) Missing documentation for "shutdownTask". -// src/scaffolder/tasks/types.d.ts:200:5 - (ae-undocumented) Missing documentation for "rehydrateWorkspace". -// src/scaffolder/tasks/types.d.ts:204:5 - (ae-undocumented) Missing documentation for "cleanWorkspace". -// src/scaffolder/tasks/types.d.ts:207:5 - (ae-undocumented) Missing documentation for "serializeWorkspace". -// src/service/router.d.ts:17:1 - (ae-undocumented) Missing documentation for "TemplatePermissionRuleInput". -// src/service/router.d.ts:22:1 - (ae-undocumented) Missing documentation for "ActionPermissionRuleInput". -// src/service/router.d.ts:30:5 - (ae-undocumented) Missing documentation for "logger". -// src/service/router.d.ts:31:5 - (ae-undocumented) Missing documentation for "config". -// src/service/router.d.ts:32:5 - (ae-undocumented) Missing documentation for "reader". -// src/service/router.d.ts:33:5 - (ae-undocumented) Missing documentation for "lifecycle". -// src/service/router.d.ts:34:5 - (ae-undocumented) Missing documentation for "database". -// src/service/router.d.ts:35:5 - (ae-undocumented) Missing documentation for "catalogClient". -// src/service/router.d.ts:36:5 - (ae-undocumented) Missing documentation for "scheduler". -// src/service/router.d.ts:37:5 - (ae-undocumented) Missing documentation for "actions". -// src/service/router.d.ts:42:5 - (ae-undocumented) Missing documentation for "taskWorkers". -// src/service/router.d.ts:48:5 - (ae-undocumented) Missing documentation for "taskBroker". -// src/service/router.d.ts:49:5 - (ae-undocumented) Missing documentation for "additionalTemplateFilters". -// src/service/router.d.ts:50:5 - (ae-undocumented) Missing documentation for "additionalTemplateGlobals". -// src/service/router.d.ts:51:5 - (ae-undocumented) Missing documentation for "additionalWorkspaceProviders". -// src/service/router.d.ts:52:5 - (ae-undocumented) Missing documentation for "permissions". -// src/service/router.d.ts:53:5 - (ae-undocumented) Missing documentation for "permissionRules". -// src/service/router.d.ts:54:5 - (ae-undocumented) Missing documentation for "auth". -// src/service/router.d.ts:55:5 - (ae-undocumented) Missing documentation for "httpAuth". -// src/service/router.d.ts:56:5 - (ae-undocumented) Missing documentation for "identity". -// src/service/router.d.ts:57:5 - (ae-undocumented) Missing documentation for "discovery". -// src/service/router.d.ts:58:5 - (ae-undocumented) Missing documentation for "autocompleteHandlers". ``` diff --git a/plugins/scaffolder-common/report.api.md b/plugins/scaffolder-common/report.api.md index 2058c08203..8d7a61910d 100644 --- a/plugins/scaffolder-common/report.api.md +++ b/plugins/scaffolder-common/report.api.md @@ -123,15 +123,4 @@ export interface TemplatePresentationV1beta3 extends JsonObject { export interface TemplateRecoveryV1beta3 extends JsonObject { EXPERIMENTAL_strategy?: 'none' | 'startOver'; } - -// Warnings were encountered during analysis: -// -// src/TemplateEntityV1beta3.d.ts:102:5 - (ae-undocumented) Missing documentation for "id". -// src/TemplateEntityV1beta3.d.ts:103:5 - (ae-undocumented) Missing documentation for "name". -// src/TemplateEntityV1beta3.d.ts:104:5 - (ae-undocumented) Missing documentation for "action". -// src/TemplateEntityV1beta3.d.ts:105:5 - (ae-undocumented) Missing documentation for "input". -// src/TemplateEntityV1beta3.d.ts:106:5 - (ae-undocumented) Missing documentation for "if". -// src/TemplateEntityV1beta3.d.ts:107:5 - (ae-undocumented) Missing documentation for ""backstage:permissions"". -// src/TemplateEntityV1beta3.d.ts:115:5 - (ae-undocumented) Missing documentation for ""backstage:permissions"". -// src/TemplateEntityV1beta3.d.ts:123:5 - (ae-undocumented) Missing documentation for "tags". ``` diff --git a/plugins/scaffolder-node/report-alpha.api.md b/plugins/scaffolder-node/report-alpha.api.md index 2258515b6d..c9b8130f0e 100644 --- a/plugins/scaffolder-node/report-alpha.api.md +++ b/plugins/scaffolder-node/report-alpha.api.md @@ -109,17 +109,5 @@ export interface WorkspaceProvider { }): Promise; } -// Warnings were encountered during analysis: -// -// src/alpha.d.ts:9:5 - (ae-undocumented) Missing documentation for "addActions". -// src/alpha.d.ts:23:5 - (ae-undocumented) Missing documentation for "setTaskBroker". -// src/alpha.d.ts:37:5 - (ae-undocumented) Missing documentation for "addTemplateFilters". -// src/alpha.d.ts:38:5 - (ae-undocumented) Missing documentation for "addTemplateGlobals". -// src/alpha.d.ts:64:5 - (ae-undocumented) Missing documentation for "addAutocompleteProvider". -// src/alpha.d.ts:81:5 - (ae-undocumented) Missing documentation for "serializeWorkspace". -// src/alpha.d.ts:85:5 - (ae-undocumented) Missing documentation for "cleanWorkspace". -// src/alpha.d.ts:88:5 - (ae-undocumented) Missing documentation for "rehydrateWorkspace". -// src/alpha.d.ts:99:5 - (ae-undocumented) Missing documentation for "addProviders". - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/scaffolder-node/report.api.md b/plugins/scaffolder-node/report.api.md index c6cabda02c..6328f94bfd 100644 --- a/plugins/scaffolder-node/report.api.md +++ b/plugins/scaffolder-node/report.api.md @@ -481,51 +481,4 @@ export type TemplateFilter = (...args: JsonValue[]) => JsonValue | undefined; export type TemplateGlobal = | ((...args: JsonValue[]) => JsonValue | undefined) | JsonValue; - -// Warnings were encountered during analysis: -// -// src/actions/createTemplateAction.d.ts:6:1 - (ae-undocumented) Missing documentation for "TemplateExample". -// src/actions/createTemplateAction.d.ts:11:1 - (ae-undocumented) Missing documentation for "TemplateActionOptions". -// src/actions/gitHelpers.d.ts:5:1 - (ae-undocumented) Missing documentation for "initRepoAndPush". -// src/actions/gitHelpers.d.ts:27:1 - (ae-undocumented) Missing documentation for "commitAndPushRepo". -// src/actions/gitHelpers.d.ts:49:1 - (ae-undocumented) Missing documentation for "cloneRepo". -// src/actions/gitHelpers.d.ts:66:1 - (ae-undocumented) Missing documentation for "createBranch". -// src/actions/gitHelpers.d.ts:80:1 - (ae-undocumented) Missing documentation for "addFiles". -// src/actions/gitHelpers.d.ts:94:1 - (ae-undocumented) Missing documentation for "commitAndPushBranch". -// src/actions/types.d.ts:60:1 - (ae-undocumented) Missing documentation for "TemplateAction". -// src/actions/util.d.ts:5:22 - (ae-undocumented) Missing documentation for "getRepoSourceDirectory". -// src/actions/util.d.ts:9:22 - (ae-undocumented) Missing documentation for "parseRepoUrl". -// src/files/serializeDirectoryContents.d.ts:6:1 - (ae-undocumented) Missing documentation for "serializeDirectoryContents". -// src/files/types.d.ts:6:1 - (ae-undocumented) Missing documentation for "SerializedFile". -// src/files/types.d.ts:7:5 - (ae-undocumented) Missing documentation for "path". -// src/files/types.d.ts:8:5 - (ae-undocumented) Missing documentation for "content". -// src/files/types.d.ts:9:5 - (ae-undocumented) Missing documentation for "executable". -// src/files/types.d.ts:10:5 - (ae-undocumented) Missing documentation for "symlink". -// src/tasks/types.d.ts:83:5 - (ae-undocumented) Missing documentation for "cancelSignal". -// src/tasks/types.d.ts:84:5 - (ae-undocumented) Missing documentation for "spec". -// src/tasks/types.d.ts:85:5 - (ae-undocumented) Missing documentation for "secrets". -// src/tasks/types.d.ts:86:5 - (ae-undocumented) Missing documentation for "createdBy". -// src/tasks/types.d.ts:87:5 - (ae-undocumented) Missing documentation for "done". -// src/tasks/types.d.ts:88:5 - (ae-undocumented) Missing documentation for "isDryRun". -// src/tasks/types.d.ts:89:5 - (ae-undocumented) Missing documentation for "complete". -// src/tasks/types.d.ts:90:5 - (ae-undocumented) Missing documentation for "emitLog". -// src/tasks/types.d.ts:91:5 - (ae-undocumented) Missing documentation for "getTaskState". -// src/tasks/types.d.ts:94:5 - (ae-undocumented) Missing documentation for "updateCheckpoint". -// src/tasks/types.d.ts:103:5 - (ae-undocumented) Missing documentation for "serializeWorkspace". -// src/tasks/types.d.ts:106:5 - (ae-undocumented) Missing documentation for "cleanWorkspace". -// src/tasks/types.d.ts:107:5 - (ae-undocumented) Missing documentation for "rehydrateWorkspace". -// src/tasks/types.d.ts:111:5 - (ae-undocumented) Missing documentation for "getWorkspaceName". -// src/tasks/types.d.ts:112:5 - (ae-undocumented) Missing documentation for "getInitiatorCredentials". -// src/tasks/types.d.ts:120:5 - (ae-undocumented) Missing documentation for "cancel". -// src/tasks/types.d.ts:121:5 - (ae-undocumented) Missing documentation for "retry". -// src/tasks/types.d.ts:122:5 - (ae-undocumented) Missing documentation for "claim". -// src/tasks/types.d.ts:123:5 - (ae-undocumented) Missing documentation for "recoverTasks". -// src/tasks/types.d.ts:124:5 - (ae-undocumented) Missing documentation for "dispatch". -// src/tasks/types.d.ts:125:5 - (ae-undocumented) Missing documentation for "vacuumTasks". -// src/tasks/types.d.ts:128:5 - (ae-undocumented) Missing documentation for "event$". -// src/tasks/types.d.ts:134:5 - (ae-undocumented) Missing documentation for "get". -// src/tasks/types.d.ts:135:5 - (ae-undocumented) Missing documentation for "list". -// src/tasks/types.d.ts:155:5 - (ae-undocumented) Missing documentation for "list". -// src/types.d.ts:3:1 - (ae-undocumented) Missing documentation for "TemplateFilter". -// src/types.d.ts:5:1 - (ae-undocumented) Missing documentation for "TemplateGlobal". ``` diff --git a/plugins/scaffolder-react/report-alpha.api.md b/plugins/scaffolder-react/report-alpha.api.md index e15ee181d2..7084625ad4 100644 --- a/plugins/scaffolder-react/report-alpha.api.md +++ b/plugins/scaffolder-react/report-alpha.api.md @@ -48,6 +48,12 @@ export type BackstageOverrides = Overrides & { >; }; +// @alpha (undocumented) +export type BackstageTemplateStepperClassKey = + | 'backButton' + | 'footer' + | 'formWrapper'; + // @alpha (undocumented) export const createAsyncValidators: ( rootSchema: JsonObject, @@ -374,52 +380,5 @@ export type WorkflowProps = { | 'layouts' >; -// Warnings were encountered during analysis: -// -// src/next/blueprints/types.d.ts:5:1 - (ae-undocumented) Missing documentation for "FormFieldExtensionData". -// src/next/components/ScaffolderField/ScaffolderField.d.ts:7:5 - (ae-undocumented) Missing documentation for "rawDescription". -// src/next/components/ScaffolderField/ScaffolderField.d.ts:8:5 - (ae-undocumented) Missing documentation for "errors". -// src/next/components/ScaffolderField/ScaffolderField.d.ts:9:5 - (ae-undocumented) Missing documentation for "rawErrors". -// src/next/components/ScaffolderField/ScaffolderField.d.ts:10:5 - (ae-undocumented) Missing documentation for "help". -// src/next/components/ScaffolderField/ScaffolderField.d.ts:11:5 - (ae-undocumented) Missing documentation for "rawHelp". -// src/next/components/ScaffolderField/ScaffolderField.d.ts:12:5 - (ae-undocumented) Missing documentation for "required". -// src/next/components/ScaffolderField/ScaffolderField.d.ts:13:5 - (ae-undocumented) Missing documentation for "disabled". -// src/next/components/ScaffolderField/ScaffolderField.d.ts:14:5 - (ae-undocumented) Missing documentation for "displayLabel". -// src/next/components/ScaffolderPageContextMenu/ScaffolderPageContextMenu.d.ts:5:1 - (ae-undocumented) Missing documentation for "ScaffolderPageContextMenuProps". -// src/next/components/ScaffolderPageContextMenu/ScaffolderPageContextMenu.d.ts:14:1 - (ae-undocumented) Missing documentation for "ScaffolderPageContextMenu". -// src/next/components/Stepper/createAsyncValidators.d.ts:6:1 - (ae-undocumented) Missing documentation for "FormValidation". -// src/next/components/Stepper/createAsyncValidators.d.ts:10:22 - (ae-undocumented) Missing documentation for "createAsyncValidators". -// src/next/components/TaskSteps/TaskSteps.d.ts:10:5 - (ae-undocumented) Missing documentation for "steps". -// src/next/components/TaskSteps/TaskSteps.d.ts:11:5 - (ae-undocumented) Missing documentation for "activeStep". -// src/next/components/TaskSteps/TaskSteps.d.ts:12:5 - (ae-undocumented) Missing documentation for "isComplete". -// src/next/components/TaskSteps/TaskSteps.d.ts:13:5 - (ae-undocumented) Missing documentation for "isError". -// src/next/components/TemplateCard/TemplateCard.d.ts:9:5 - (ae-undocumented) Missing documentation for "template". -// src/next/components/TemplateCard/TemplateCard.d.ts:10:5 - (ae-undocumented) Missing documentation for "additionalLinks". -// src/next/components/TemplateCard/TemplateCard.d.ts:15:5 - (ae-undocumented) Missing documentation for "onSelected". -// src/next/components/TemplateCategoryPicker/TemplateCategoryPicker.d.ts:3:1 - (ae-undocumented) Missing documentation for "ScaffolderReactTemplateCategoryPickerClassKey". -// src/next/components/TemplateGroup/TemplateGroup.d.ts:10:5 - (ae-undocumented) Missing documentation for "templates". -// src/next/components/TemplateGroup/TemplateGroup.d.ts:18:5 - (ae-undocumented) Missing documentation for "onSelected". -// src/next/components/TemplateGroup/TemplateGroup.d.ts:19:5 - (ae-undocumented) Missing documentation for "title". -// src/next/components/TemplateGroup/TemplateGroup.d.ts:20:5 - (ae-undocumented) Missing documentation for "components". -// src/next/components/TemplateGroups/TemplateGroups.d.ts:8:1 - (ae-undocumented) Missing documentation for "TemplateGroupsProps". -// src/next/components/TemplateGroups/TemplateGroups.d.ts:9:5 - (ae-undocumented) Missing documentation for "groups". -// src/next/components/TemplateGroups/TemplateGroups.d.ts:10:5 - (ae-undocumented) Missing documentation for "templateFilter". -// src/next/components/TemplateGroups/TemplateGroups.d.ts:11:5 - (ae-undocumented) Missing documentation for "TemplateCardComponent". -// src/next/components/TemplateGroups/TemplateGroups.d.ts:14:5 - (ae-undocumented) Missing documentation for "onTemplateSelected". -// src/next/components/TemplateGroups/TemplateGroups.d.ts:15:5 - (ae-undocumented) Missing documentation for "additionalLinksForEntity". -// src/next/components/TemplateGroups/TemplateGroups.d.ts:24:22 - (ae-undocumented) Missing documentation for "TemplateGroups". -// src/next/components/Workflow/Workflow.d.ts:7:1 - (ae-undocumented) Missing documentation for "WorkflowProps". -// src/next/components/Workflow/Workflow.d.ts:20:22 - (ae-undocumented) Missing documentation for "Workflow". -// src/next/components/Workflow/Workflow.d.ts:24:22 - (ae-undocumented) Missing documentation for "EmbeddableWorkflow". -// src/next/hooks/useTemplateParameterSchema.d.ts:5:22 - (ae-undocumented) Missing documentation for "useTemplateParameterSchema". -// src/next/hooks/useTemplateSchema.d.ts:10:5 - (ae-undocumented) Missing documentation for "uiSchema". -// src/next/hooks/useTemplateSchema.d.ts:11:5 - (ae-undocumented) Missing documentation for "mergedSchema". -// src/next/hooks/useTemplateSchema.d.ts:12:5 - (ae-undocumented) Missing documentation for "schema". -// src/next/hooks/useTemplateSchema.d.ts:13:5 - (ae-undocumented) Missing documentation for "title". -// src/next/hooks/useTemplateSchema.d.ts:14:5 - (ae-undocumented) Missing documentation for "description". -// src/next/overridableComponents.d.ts:6:1 - (ae-undocumented) Missing documentation for "ScaffolderReactComponentsNameToClassKey". -// src/next/overridableComponents.d.ts:8:5 - (ae-forgotten-export) The symbol "BackstageTemplateStepperClassKey" needs to be exported by the entry point alpha.d.ts -// src/next/overridableComponents.d.ts:11:1 - (ae-undocumented) Missing documentation for "BackstageOverrides". - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/scaffolder-react/report.api.md b/plugins/scaffolder-react/report.api.md index 73573b25c4..5523b52ad9 100644 --- a/plugins/scaffolder-react/report.api.md +++ b/plugins/scaffolder-react/report.api.md @@ -558,50 +558,5 @@ export const useTaskEventStream: (taskId: string) => TaskStream; // @public export const useTemplateSecrets: () => ScaffolderUseTemplateSecrets; -// Warnings were encountered during analysis: -// -// src/api/ref.d.ts:3:22 - (ae-undocumented) Missing documentation for "scaffolderApiRef". -// src/api/types.d.ts:53:1 - (ae-undocumented) Missing documentation for "ScaffolderOutputLink". -// src/api/types.d.ts:60:1 - (ae-undocumented) Missing documentation for "ScaffolderOutputText". -// src/api/types.d.ts:67:1 - (ae-undocumented) Missing documentation for "ScaffolderTaskOutput". -// src/api/types.d.ts:95:5 - (ae-undocumented) Missing documentation for "templateRef". -// src/api/types.d.ts:96:5 - (ae-undocumented) Missing documentation for "values". -// src/api/types.d.ts:97:5 - (ae-undocumented) Missing documentation for "secrets". -// src/api/types.d.ts:105:5 - (ae-undocumented) Missing documentation for "taskId". -// src/api/types.d.ts:113:5 - (ae-undocumented) Missing documentation for "allowedHosts". -// src/api/types.d.ts:121:5 - (ae-undocumented) Missing documentation for "integrations". -// src/api/types.d.ts:133:5 - (ae-undocumented) Missing documentation for "isTaskRecoverable". -// src/api/types.d.ts:134:5 - (ae-undocumented) Missing documentation for "taskId". -// src/api/types.d.ts:135:5 - (ae-undocumented) Missing documentation for "after". -// src/api/types.d.ts:138:1 - (ae-undocumented) Missing documentation for "ScaffolderDryRunOptions". -// src/api/types.d.ts:139:5 - (ae-undocumented) Missing documentation for "template". -// src/api/types.d.ts:140:5 - (ae-undocumented) Missing documentation for "values". -// src/api/types.d.ts:141:5 - (ae-undocumented) Missing documentation for "secrets". -// src/api/types.d.ts:142:5 - (ae-undocumented) Missing documentation for "directoryContents". -// src/api/types.d.ts:148:1 - (ae-undocumented) Missing documentation for "ScaffolderDryRunResponse". -// src/api/types.d.ts:149:5 - (ae-undocumented) Missing documentation for "directoryContents". -// src/api/types.d.ts:154:5 - (ae-undocumented) Missing documentation for "log". -// src/api/types.d.ts:155:5 - (ae-undocumented) Missing documentation for "steps". -// src/api/types.d.ts:156:5 - (ae-undocumented) Missing documentation for "output". -// src/api/types.d.ts:164:5 - (ae-undocumented) Missing documentation for "getTemplateParameterSchema". -// src/api/types.d.ts:172:5 - (ae-undocumented) Missing documentation for "getTask". -// src/api/types.d.ts:185:5 - (ae-undocumented) Missing documentation for "listTasks". -// src/api/types.d.ts:193:5 - (ae-undocumented) Missing documentation for "getIntegrationsList". -// src/api/types.d.ts:198:5 - (ae-undocumented) Missing documentation for "streamLogs". -// src/api/types.d.ts:199:5 - (ae-undocumented) Missing documentation for "dryRun". -// src/api/types.d.ts:200:5 - (ae-undocumented) Missing documentation for "autocomplete". -// src/components/types.d.ts:7:1 - (ae-undocumented) Missing documentation for "TemplateGroupFilter". -// src/extensions/types.d.ts:13:5 - (ae-undocumented) Missing documentation for "uiSchema". -// src/extensions/types.d.ts:30:5 - (ae-undocumented) Missing documentation for ""ui:options"". -// src/layouts/createScaffolderLayout.d.ts:16:5 - (ae-undocumented) Missing documentation for "name". -// src/layouts/createScaffolderLayout.d.ts:17:5 - (ae-undocumented) Missing documentation for "component". -// src/secrets/SecretsContext.d.ts:14:5 - (ae-undocumented) Missing documentation for "setSecrets". -// src/secrets/SecretsContext.d.ts:15:5 - (ae-undocumented) Missing documentation for "secrets". -// src/utils.d.ts:4:1 - (ae-undocumented) Missing documentation for "makeFieldSchema". -// src/utils.d.ts:15:5 - (ae-undocumented) Missing documentation for "type". -// src/utils.d.ts:17:5 - (ae-undocumented) Missing documentation for "uiOptionsType". -// src/utils.d.ts:18:5 - (ae-undocumented) Missing documentation for "schema". -// src/utils.d.ts:19:5 - (ae-undocumented) Missing documentation for "TProps". - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/scaffolder-react/src/next/components/Stepper/index.ts b/plugins/scaffolder-react/src/next/components/Stepper/index.ts index 5f33c2ff78..113d18bf18 100644 --- a/plugins/scaffolder-react/src/next/components/Stepper/index.ts +++ b/plugins/scaffolder-react/src/next/components/Stepper/index.ts @@ -13,7 +13,11 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -export { Stepper, type StepperProps } from './Stepper'; +export { + Stepper, + type StepperProps, + type BackstageTemplateStepperClassKey, +} from './Stepper'; export { createAsyncValidators, type FormValidation, diff --git a/plugins/scaffolder/report-alpha.api.md b/plugins/scaffolder/report-alpha.api.md index 2dcef12726..4253b2b914 100644 --- a/plugins/scaffolder/report-alpha.api.md +++ b/plugins/scaffolder/report-alpha.api.md @@ -379,15 +379,5 @@ export type TemplateWizardPageProps = { }; }; -// Warnings were encountered during analysis: -// -// src/alpha/components/TemplateEditorPage/CustomFieldExplorer.d.ts:4:1 - (ae-undocumented) Missing documentation for "ScaffolderCustomFieldExplorerClassKey". -// src/alpha/components/TemplateEditorPage/TemplateEditor.d.ts:4:1 - (ae-undocumented) Missing documentation for "ScaffolderTemplateEditorClassKey". -// src/alpha/components/TemplateEditorPage/TemplateFormPreviewer.d.ts:4:1 - (ae-undocumented) Missing documentation for "ScaffolderTemplateFormPreviewerClassKey". -// src/alpha/components/TemplateListPage/TemplateListPage.d.ts:7:1 - (ae-undocumented) Missing documentation for "TemplateListPageProps". -// src/alpha/components/TemplateWizardPage/TemplateWizardPage.d.ts:6:1 - (ae-undocumented) Missing documentation for "TemplateWizardPageProps". -// src/alpha/plugin.d.ts:3:15 - (ae-undocumented) Missing documentation for "_default". -// src/translation.d.ts:2:22 - (ae-undocumented) Missing documentation for "scaffolderTranslationRef". - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/scaffolder/report.api.md b/plugins/scaffolder/report.api.md index 35b3dad66e..8a1d3db179 100644 --- a/plugins/scaffolder/report.api.md +++ b/plugins/scaffolder/report.api.md @@ -671,56 +671,4 @@ export const TemplateTypePicker: () => React_2.JSX.Element | null; // @public @deprecated (undocumented) export const useTemplateSecrets: () => ScaffolderUseTemplateSecrets_2; - -// Warnings were encountered during analysis: -// -// src/api.d.ts:23:5 - (ae-undocumented) Missing documentation for "listTasks". -// src/api.d.ts:31:5 - (ae-undocumented) Missing documentation for "getIntegrationsList". -// src/api.d.ts:32:5 - (ae-undocumented) Missing documentation for "getTemplateParameterSchema". -// src/api.d.ts:33:5 - (ae-undocumented) Missing documentation for "scaffold". -// src/api.d.ts:34:5 - (ae-undocumented) Missing documentation for "getTask". -// src/api.d.ts:35:5 - (ae-undocumented) Missing documentation for "streamLogs". -// src/api.d.ts:36:5 - (ae-undocumented) Missing documentation for "dryRun". -// src/api.d.ts:39:5 - (ae-undocumented) Missing documentation for "listActions". -// src/api.d.ts:40:5 - (ae-undocumented) Missing documentation for "cancelTask". -// src/api.d.ts:41:5 - (ae-undocumented) Missing documentation for "retry". -// src/api.d.ts:42:5 - (ae-undocumented) Missing documentation for "autocomplete". -// src/components/OngoingTask/OngoingTask.d.ts:6:22 - (ae-undocumented) Missing documentation for "OngoingTask". -// src/components/fields/EntityPicker/schema.d.ts:15:22 - (ae-undocumented) Missing documentation for "EntityPickerFieldSchema". -// src/components/fields/EntityTagsPicker/schema.d.ts:4:22 - (ae-undocumented) Missing documentation for "EntityTagsPickerFieldSchema". -// src/components/fields/OwnedEntityPicker/schema.d.ts:4:22 - (ae-undocumented) Missing documentation for "OwnedEntityPickerFieldSchema". -// src/components/fields/OwnerPicker/schema.d.ts:4:22 - (ae-undocumented) Missing documentation for "OwnerPickerFieldSchema". -// src/components/fields/RepoUrlPicker/schema.d.ts:4:22 - (ae-undocumented) Missing documentation for "RepoUrlPickerFieldSchema". -// src/components/fields/utils.d.ts:7:1 - (ae-undocumented) Missing documentation for "FieldSchema". -// src/components/fields/utils.d.ts:15:1 - (ae-undocumented) Missing documentation for "makeFieldSchemaFromZod". -// src/deprecated.d.ts:7:22 - (ae-undocumented) Missing documentation for "rootRouteRef". -// src/deprecated.d.ts:12:22 - (ae-undocumented) Missing documentation for "createScaffolderFieldExtension". -// src/deprecated.d.ts:17:22 - (ae-undocumented) Missing documentation for "ScaffolderFieldExtensions". -// src/deprecated.d.ts:24:22 - (ae-undocumented) Missing documentation for "useTemplateSecrets". -// src/deprecated.d.ts:29:22 - (ae-undocumented) Missing documentation for "scaffolderApiRef". -// src/deprecated.d.ts:34:1 - (ae-undocumented) Missing documentation for "ScaffolderApi". -// src/deprecated.d.ts:39:1 - (ae-undocumented) Missing documentation for "ScaffolderUseTemplateSecrets". -// src/deprecated.d.ts:44:1 - (ae-undocumented) Missing documentation for "TemplateParameterSchema". -// src/deprecated.d.ts:49:1 - (ae-undocumented) Missing documentation for "CustomFieldExtensionSchema". -// src/deprecated.d.ts:54:1 - (ae-undocumented) Missing documentation for "CustomFieldValidator". -// src/deprecated.d.ts:59:1 - (ae-undocumented) Missing documentation for "FieldExtensionOptions". -// src/deprecated.d.ts:64:1 - (ae-undocumented) Missing documentation for "FieldExtensionComponentProps". -// src/deprecated.d.ts:69:1 - (ae-undocumented) Missing documentation for "FieldExtensionComponent". -// src/deprecated.d.ts:74:1 - (ae-undocumented) Missing documentation for "ListActionsResponse". -// src/deprecated.d.ts:79:1 - (ae-undocumented) Missing documentation for "LogEvent". -// src/deprecated.d.ts:84:1 - (ae-undocumented) Missing documentation for "ScaffolderDryRunOptions". -// src/deprecated.d.ts:89:1 - (ae-undocumented) Missing documentation for "ScaffolderDryRunResponse". -// src/deprecated.d.ts:94:1 - (ae-undocumented) Missing documentation for "ScaffolderGetIntegrationsListOptions". -// src/deprecated.d.ts:99:1 - (ae-undocumented) Missing documentation for "ScaffolderGetIntegrationsListResponse". -// src/deprecated.d.ts:104:1 - (ae-undocumented) Missing documentation for "ScaffolderOutputlink". -// src/deprecated.d.ts:109:1 - (ae-undocumented) Missing documentation for "ScaffolderScaffoldOptions". -// src/deprecated.d.ts:114:1 - (ae-undocumented) Missing documentation for "ScaffolderScaffoldResponse". -// src/deprecated.d.ts:119:1 - (ae-undocumented) Missing documentation for "ScaffolderStreamLogsOptions". -// src/deprecated.d.ts:124:1 - (ae-undocumented) Missing documentation for "ScaffolderTask". -// src/deprecated.d.ts:129:1 - (ae-undocumented) Missing documentation for "ScaffolderTaskOutput". -// src/deprecated.d.ts:134:1 - (ae-undocumented) Missing documentation for "ScaffolderTaskStatus". -// src/deprecated.d.ts:139:22 - (ae-undocumented) Missing documentation for "createScaffolderLayout". -// src/deprecated.d.ts:144:22 - (ae-undocumented) Missing documentation for "ScaffolderLayouts". -// src/deprecated.d.ts:151:1 - (ae-undocumented) Missing documentation for "LayoutTemplate". -// src/deprecated.d.ts:156:1 - (ae-undocumented) Missing documentation for "LayoutOptions". ``` diff --git a/plugins/search-backend-module-catalog/report-alpha.api.md b/plugins/search-backend-module-catalog/report-alpha.api.md index 8a91ccdb5e..a622e05a3e 100644 --- a/plugins/search-backend-module-catalog/report-alpha.api.md +++ b/plugins/search-backend-module-catalog/report-alpha.api.md @@ -4,26 +4,10 @@ ```ts import { BackendFeature } from '@backstage/backend-plugin-api'; -import { CatalogCollatorEntityTransformer } from '@backstage/plugin-search-backend-module-catalog'; -import { ExtensionPoint } from '@backstage/backend-plugin-api'; - -// Warning: (ae-forgotten-export) The symbol "CatalogCollatorExtensionPoint_2" needs to be exported by the entry point alpha.d.ts -// -// @alpha (undocumented) -export type CatalogCollatorExtensionPoint = CatalogCollatorExtensionPoint_2; - -// @alpha (undocumented) -export const catalogCollatorExtensionPoint: ExtensionPoint; // @alpha (undocumented) const _feature: BackendFeature; export default _feature; -// Warnings were encountered during analysis: -// -// src/alpha.d.ts:3:15 - (ae-undocumented) Missing documentation for "_feature". -// src/alpha.d.ts:6:1 - (ae-undocumented) Missing documentation for "CatalogCollatorExtensionPoint". -// src/alpha.d.ts:8:22 - (ae-undocumented) Missing documentation for "catalogCollatorExtensionPoint". - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/search-backend-module-catalog/report.api.md b/plugins/search-backend-module-catalog/report.api.md index f20907494e..76314dcdf5 100644 --- a/plugins/search-backend-module-catalog/report.api.md +++ b/plugins/search-backend-module-catalog/report.api.md @@ -66,14 +66,4 @@ export type DefaultCatalogCollatorFactoryOptions = { catalogClient?: CatalogApi; entityTransformer?: CatalogCollatorEntityTransformer; }; - -// Warnings were encountered during analysis: -// -// src/collators/CatalogCollatorEntityTransformer.d.ts:4:1 - (ae-undocumented) Missing documentation for "CatalogCollatorEntityTransformer". -// src/collators/DefaultCatalogCollatorFactory.d.ts:14:1 - (ae-undocumented) Missing documentation for "DefaultCatalogCollatorFactoryOptions". -// src/collators/DefaultCatalogCollatorFactory.d.ts:43:5 - (ae-undocumented) Missing documentation for "type". -// src/collators/DefaultCatalogCollatorFactory.d.ts:44:5 - (ae-undocumented) Missing documentation for "visibilityPermission". -// src/collators/DefaultCatalogCollatorFactory.d.ts:51:5 - (ae-undocumented) Missing documentation for "fromConfig". -// src/collators/DefaultCatalogCollatorFactory.d.ts:53:5 - (ae-undocumented) Missing documentation for "getCollator". -// src/collators/defaultCatalogCollatorEntityTransformer.d.ts:3:22 - (ae-undocumented) Missing documentation for "defaultCatalogCollatorEntityTransformer". ``` diff --git a/plugins/search-backend-module-catalog/src/alpha.ts b/plugins/search-backend-module-catalog/src/alpha.ts index b5fbb5e0c6..e5554e85bd 100644 --- a/plugins/search-backend-module-catalog/src/alpha.ts +++ b/plugins/search-backend-module-catalog/src/alpha.ts @@ -14,17 +14,8 @@ * limitations under the License. */ -import { - default as feature, - CatalogCollatorExtensionPoint as ExtensionPoint, - catalogCollatorExtensionPoint as extensionPoint, -} from './module'; +import { default as feature } from './module'; /** @alpha */ const _feature = feature; export default _feature; - -/** @alpha */ -export type CatalogCollatorExtensionPoint = ExtensionPoint; -/** @alpha */ -export const catalogCollatorExtensionPoint = extensionPoint; diff --git a/plugins/search-backend-module-elasticsearch/report-alpha.api.md b/plugins/search-backend-module-elasticsearch/report-alpha.api.md index 344718f5e5..17107defe3 100644 --- a/plugins/search-backend-module-elasticsearch/report-alpha.api.md +++ b/plugins/search-backend-module-elasticsearch/report-alpha.api.md @@ -4,27 +4,10 @@ ```ts import { BackendFeature } from '@backstage/backend-plugin-api'; -import { ElasticSearchQueryTranslator } from '@backstage/plugin-search-backend-module-elasticsearch'; -import { ExtensionPoint } from '@backstage/backend-plugin-api'; - -// Warning: (ae-forgotten-export) The symbol "ElasticSearchQueryTranslatorExtensionPoint_2" needs to be exported by the entry point alpha.d.ts -// -// @alpha (undocumented) -export type ElasticSearchQueryTranslatorExtensionPoint = - ElasticSearchQueryTranslatorExtensionPoint_2; - -// @alpha (undocumented) -export const elasticsearchTranslatorExtensionPoint: ExtensionPoint; // @alpha (undocumented) const _feature: BackendFeature; export default _feature; -// Warnings were encountered during analysis: -// -// src/alpha.d.ts:3:15 - (ae-undocumented) Missing documentation for "_feature". -// src/alpha.d.ts:6:1 - (ae-undocumented) Missing documentation for "ElasticSearchQueryTranslatorExtensionPoint". -// src/alpha.d.ts:8:22 - (ae-undocumented) Missing documentation for "elasticsearchTranslatorExtensionPoint". - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/search-backend-module-elasticsearch/report.api.md b/plugins/search-backend-module-elasticsearch/report.api.md index d1ec3b171d..74e70af364 100644 --- a/plugins/search-backend-module-elasticsearch/report.api.md +++ b/plugins/search-backend-module-elasticsearch/report.api.md @@ -473,101 +473,4 @@ export interface OpenSearchNodeOptions { // (undocumented) url: URL; } - -// Warnings were encountered during analysis: -// -// src/engines/ElasticSearchClientOptions.d.ts:29:5 - (ae-undocumented) Missing documentation for "provider". -// src/engines/ElasticSearchClientOptions.d.ts:30:5 - (ae-undocumented) Missing documentation for "region". -// src/engines/ElasticSearchClientOptions.d.ts:31:5 - (ae-undocumented) Missing documentation for "service". -// src/engines/ElasticSearchClientOptions.d.ts:32:5 - (ae-undocumented) Missing documentation for "auth". -// src/engines/ElasticSearchClientOptions.d.ts:33:5 - (ae-undocumented) Missing documentation for "connection". -// src/engines/ElasticSearchClientOptions.d.ts:34:5 - (ae-undocumented) Missing documentation for "node". -// src/engines/ElasticSearchClientOptions.d.ts:35:5 - (ae-undocumented) Missing documentation for "nodes". -// src/engines/ElasticSearchClientOptions.d.ts:46:5 - (ae-undocumented) Missing documentation for "provider". -// src/engines/ElasticSearchClientOptions.d.ts:47:5 - (ae-undocumented) Missing documentation for "auth". -// src/engines/ElasticSearchClientOptions.d.ts:48:5 - (ae-undocumented) Missing documentation for "Connection". -// src/engines/ElasticSearchClientOptions.d.ts:49:5 - (ae-undocumented) Missing documentation for "node". -// src/engines/ElasticSearchClientOptions.d.ts:50:5 - (ae-undocumented) Missing documentation for "nodes". -// src/engines/ElasticSearchClientOptions.d.ts:51:5 - (ae-undocumented) Missing documentation for "cloud". -// src/engines/ElasticSearchClientOptions.d.ts:64:5 - (ae-undocumented) Missing documentation for "Transport". -// src/engines/ElasticSearchClientOptions.d.ts:65:5 - (ae-undocumented) Missing documentation for "maxRetries". -// src/engines/ElasticSearchClientOptions.d.ts:66:5 - (ae-undocumented) Missing documentation for "requestTimeout". -// src/engines/ElasticSearchClientOptions.d.ts:67:5 - (ae-undocumented) Missing documentation for "pingTimeout". -// src/engines/ElasticSearchClientOptions.d.ts:68:5 - (ae-undocumented) Missing documentation for "sniffInterval". -// src/engines/ElasticSearchClientOptions.d.ts:69:5 - (ae-undocumented) Missing documentation for "sniffOnStart". -// src/engines/ElasticSearchClientOptions.d.ts:70:5 - (ae-undocumented) Missing documentation for "sniffEndpoint". -// src/engines/ElasticSearchClientOptions.d.ts:71:5 - (ae-undocumented) Missing documentation for "sniffOnConnectionFault". -// src/engines/ElasticSearchClientOptions.d.ts:72:5 - (ae-undocumented) Missing documentation for "resurrectStrategy". -// src/engines/ElasticSearchClientOptions.d.ts:73:5 - (ae-undocumented) Missing documentation for "suggestCompression". -// src/engines/ElasticSearchClientOptions.d.ts:74:5 - (ae-undocumented) Missing documentation for "compression". -// src/engines/ElasticSearchClientOptions.d.ts:75:5 - (ae-undocumented) Missing documentation for "ssl". -// src/engines/ElasticSearchClientOptions.d.ts:76:5 - (ae-undocumented) Missing documentation for "agent". -// src/engines/ElasticSearchClientOptions.d.ts:77:5 - (ae-undocumented) Missing documentation for "nodeFilter". -// src/engines/ElasticSearchClientOptions.d.ts:78:5 - (ae-undocumented) Missing documentation for "nodeSelector". -// src/engines/ElasticSearchClientOptions.d.ts:79:5 - (ae-undocumented) Missing documentation for "headers". -// src/engines/ElasticSearchClientOptions.d.ts:80:5 - (ae-undocumented) Missing documentation for "opaqueIdPrefix". -// src/engines/ElasticSearchClientOptions.d.ts:81:5 - (ae-undocumented) Missing documentation for "name". -// src/engines/ElasticSearchClientOptions.d.ts:82:5 - (ae-undocumented) Missing documentation for "proxy". -// src/engines/ElasticSearchClientOptions.d.ts:83:5 - (ae-undocumented) Missing documentation for "enableMetaHeader". -// src/engines/ElasticSearchClientOptions.d.ts:84:5 - (ae-undocumented) Missing documentation for "disablePrototypePoisoningProtection". -// src/engines/ElasticSearchClientOptions.d.ts:89:1 - (ae-undocumented) Missing documentation for "OpenSearchAuth". -// src/engines/ElasticSearchClientOptions.d.ts:96:1 - (ae-undocumented) Missing documentation for "ElasticSearchAuth". -// src/engines/ElasticSearchClientOptions.d.ts:105:1 - (ae-undocumented) Missing documentation for "ElasticSearchNodeOptions". -// src/engines/ElasticSearchClientOptions.d.ts:106:5 - (ae-undocumented) Missing documentation for "url". -// src/engines/ElasticSearchClientOptions.d.ts:107:5 - (ae-undocumented) Missing documentation for "id". -// src/engines/ElasticSearchClientOptions.d.ts:108:5 - (ae-undocumented) Missing documentation for "agent". -// src/engines/ElasticSearchClientOptions.d.ts:109:5 - (ae-undocumented) Missing documentation for "ssl". -// src/engines/ElasticSearchClientOptions.d.ts:110:5 - (ae-undocumented) Missing documentation for "headers". -// src/engines/ElasticSearchClientOptions.d.ts:111:5 - (ae-undocumented) Missing documentation for "roles". -// src/engines/ElasticSearchClientOptions.d.ts:121:1 - (ae-undocumented) Missing documentation for "OpenSearchNodeOptions". -// src/engines/ElasticSearchClientOptions.d.ts:122:5 - (ae-undocumented) Missing documentation for "url". -// src/engines/ElasticSearchClientOptions.d.ts:123:5 - (ae-undocumented) Missing documentation for "id". -// src/engines/ElasticSearchClientOptions.d.ts:124:5 - (ae-undocumented) Missing documentation for "agent". -// src/engines/ElasticSearchClientOptions.d.ts:125:5 - (ae-undocumented) Missing documentation for "ssl". -// src/engines/ElasticSearchClientOptions.d.ts:126:5 - (ae-undocumented) Missing documentation for "headers". -// src/engines/ElasticSearchClientOptions.d.ts:127:5 - (ae-undocumented) Missing documentation for "roles". -// src/engines/ElasticSearchClientOptions.d.ts:136:1 - (ae-undocumented) Missing documentation for "ElasticSearchAgentOptions". -// src/engines/ElasticSearchClientOptions.d.ts:137:5 - (ae-undocumented) Missing documentation for "keepAlive". -// src/engines/ElasticSearchClientOptions.d.ts:138:5 - (ae-undocumented) Missing documentation for "keepAliveMsecs". -// src/engines/ElasticSearchClientOptions.d.ts:139:5 - (ae-undocumented) Missing documentation for "maxSockets". -// src/engines/ElasticSearchClientOptions.d.ts:140:5 - (ae-undocumented) Missing documentation for "maxFreeSockets". -// src/engines/ElasticSearchClientOptions.d.ts:145:1 - (ae-undocumented) Missing documentation for "ElasticSearchConnectionConstructor". -// src/engines/ElasticSearchClientOptions.d.ts:146:5 - (ae-undocumented) Missing documentation for "__new". -// src/engines/ElasticSearchClientOptions.d.ts:147:5 - (ae-undocumented) Missing documentation for "statuses". -// src/engines/ElasticSearchClientOptions.d.ts:151:5 - (ae-undocumented) Missing documentation for "roles". -// src/engines/ElasticSearchClientOptions.d.ts:161:1 - (ae-undocumented) Missing documentation for "OpenSearchConnectionConstructor". -// src/engines/ElasticSearchClientOptions.d.ts:162:5 - (ae-undocumented) Missing documentation for "__new". -// src/engines/ElasticSearchClientOptions.d.ts:163:5 - (ae-undocumented) Missing documentation for "statuses". -// src/engines/ElasticSearchClientOptions.d.ts:167:5 - (ae-undocumented) Missing documentation for "roles". -// src/engines/ElasticSearchClientOptions.d.ts:176:1 - (ae-undocumented) Missing documentation for "ElasticSearchTransportConstructor". -// src/engines/ElasticSearchClientOptions.d.ts:177:5 - (ae-undocumented) Missing documentation for "__new". -// src/engines/ElasticSearchClientOptions.d.ts:178:5 - (ae-undocumented) Missing documentation for "sniffReasons". -// src/engines/ElasticSearchClientWrapper.d.ts:8:1 - (ae-undocumented) Missing documentation for "ElasticSearchAliasAction". -// src/engines/ElasticSearchClientWrapper.d.ts:32:1 - (ae-undocumented) Missing documentation for "ElasticSearchIndexAction". -// src/engines/ElasticSearchClientWrapper.d.ts:57:5 - (ae-undocumented) Missing documentation for "fromClientOptions". -// src/engines/ElasticSearchClientWrapper.d.ts:58:5 - (ae-undocumented) Missing documentation for "search". -// src/engines/ElasticSearchClientWrapper.d.ts:62:5 - (ae-undocumented) Missing documentation for "bulk". -// src/engines/ElasticSearchClientWrapper.d.ts:67:5 - (ae-undocumented) Missing documentation for "putIndexTemplate". -// src/engines/ElasticSearchClientWrapper.d.ts:68:5 - (ae-undocumented) Missing documentation for "listIndices". -// src/engines/ElasticSearchClientWrapper.d.ts:71:5 - (ae-undocumented) Missing documentation for "indexExists". -// src/engines/ElasticSearchClientWrapper.d.ts:74:5 - (ae-undocumented) Missing documentation for "deleteIndex". -// src/engines/ElasticSearchClientWrapper.d.ts:80:5 - (ae-undocumented) Missing documentation for "getAliases". -// src/engines/ElasticSearchClientWrapper.d.ts:83:5 - (ae-undocumented) Missing documentation for "createIndex". -// src/engines/ElasticSearchClientWrapper.d.ts:86:5 - (ae-undocumented) Missing documentation for "updateAliases". -// src/engines/ElasticSearchSearchEngine.d.ts:44:1 - (ae-undocumented) Missing documentation for "ElasticSearchHighlightOptions". -// src/engines/ElasticSearchSearchEngine.d.ts:52:1 - (ae-undocumented) Missing documentation for "ElasticSearchHighlightConfig". -// src/engines/ElasticSearchSearchEngine.d.ts:62:1 - (ae-undocumented) Missing documentation for "ElasticSearchSearchEngine". -// src/engines/ElasticSearchSearchEngine.d.ts:71:5 - (ae-undocumented) Missing documentation for "fromConfig". -// src/engines/ElasticSearchSearchEngine.d.ts:93:5 - (ae-undocumented) Missing documentation for "translator". -// src/engines/ElasticSearchSearchEngine.d.ts:94:5 - (ae-undocumented) Missing documentation for "setTranslator". -// src/engines/ElasticSearchSearchEngine.d.ts:95:5 - (ae-undocumented) Missing documentation for "setIndexTemplate". -// src/engines/ElasticSearchSearchEngine.d.ts:96:5 - (ae-undocumented) Missing documentation for "getIndexer". -// src/engines/ElasticSearchSearchEngine.d.ts:97:5 - (ae-undocumented) Missing documentation for "query". -// src/engines/ElasticSearchSearchEngine.d.ts:107:1 - (ae-undocumented) Missing documentation for "decodePageCursor". -// src/engines/ElasticSearchSearchEngineIndexer.d.ts:28:5 - (ae-undocumented) Missing documentation for "indexName". -// src/engines/ElasticSearchSearchEngineIndexer.d.ts:39:5 - (ae-undocumented) Missing documentation for "initialize". -// src/engines/ElasticSearchSearchEngineIndexer.d.ts:40:5 - (ae-undocumented) Missing documentation for "index". -// src/engines/ElasticSearchSearchEngineIndexer.d.ts:41:5 - (ae-undocumented) Missing documentation for "finalize". -// src/module.d.ts:3:1 - (ae-undocumented) Missing documentation for "ElasticSearchQueryTranslatorExtensionPoint". -// src/module.d.ts:4:5 - (ae-undocumented) Missing documentation for "setTranslator". ``` diff --git a/plugins/search-backend-module-elasticsearch/src/alpha.ts b/plugins/search-backend-module-elasticsearch/src/alpha.ts index 22ff705cd2..e5554e85bd 100644 --- a/plugins/search-backend-module-elasticsearch/src/alpha.ts +++ b/plugins/search-backend-module-elasticsearch/src/alpha.ts @@ -14,17 +14,8 @@ * limitations under the License. */ -import { - default as feature, - ElasticSearchQueryTranslatorExtensionPoint as ExtensionPoint, - elasticsearchTranslatorExtensionPoint as extensionPoint, -} from './module'; +import { default as feature } from './module'; /** @alpha */ const _feature = feature; export default _feature; - -/** @alpha */ -export type ElasticSearchQueryTranslatorExtensionPoint = ExtensionPoint; -/** @alpha */ -export const elasticsearchTranslatorExtensionPoint = extensionPoint; diff --git a/plugins/search-backend-module-explore/report-alpha.api.md b/plugins/search-backend-module-explore/report-alpha.api.md index 0a383dc7d0..bcfdc6b14d 100644 --- a/plugins/search-backend-module-explore/report-alpha.api.md +++ b/plugins/search-backend-module-explore/report-alpha.api.md @@ -9,9 +9,5 @@ import { BackendFeature } from '@backstage/backend-plugin-api'; const _feature: BackendFeature; export default _feature; -// Warnings were encountered during analysis: -// -// src/alpha.d.ts:2:15 - (ae-undocumented) Missing documentation for "_feature". - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/search-backend-module-explore/report.api.md b/plugins/search-backend-module-explore/report.api.md index b8ec1aa9c3..1b764129b2 100644 --- a/plugins/search-backend-module-explore/report.api.md +++ b/plugins/search-backend-module-explore/report.api.md @@ -45,12 +45,4 @@ export type ToolDocumentCollatorFactoryOptions = { tokenManager?: TokenManager; auth?: AuthService; }; - -// Warnings were encountered during analysis: -// -// src/collators/ToolDocumentCollatorFactory.d.ts:19:1 - (ae-undocumented) Missing documentation for "ToolDocumentCollatorFactoryOptions". -// src/collators/ToolDocumentCollatorFactory.d.ts:32:5 - (ae-undocumented) Missing documentation for "type". -// src/collators/ToolDocumentCollatorFactory.d.ts:37:5 - (ae-undocumented) Missing documentation for "fromConfig". -// src/collators/ToolDocumentCollatorFactory.d.ts:38:5 - (ae-undocumented) Missing documentation for "getCollator". -// src/collators/ToolDocumentCollatorFactory.d.ts:39:5 - (ae-undocumented) Missing documentation for "execute". ``` diff --git a/plugins/search-backend-module-pg/report-alpha.api.md b/plugins/search-backend-module-pg/report-alpha.api.md index c5d011b95f..ce87037e02 100644 --- a/plugins/search-backend-module-pg/report-alpha.api.md +++ b/plugins/search-backend-module-pg/report-alpha.api.md @@ -9,9 +9,5 @@ import { BackendFeature } from '@backstage/backend-plugin-api'; const _feature: BackendFeature; export default _feature; -// Warnings were encountered during analysis: -// -// src/alpha.d.ts:2:15 - (ae-undocumented) Missing documentation for "_feature". - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/search-backend-module-pg/report.api.md b/plugins/search-backend-module-pg/report.api.md index 77e795321a..104821328c 100644 --- a/plugins/search-backend-module-pg/report.api.md +++ b/plugins/search-backend-module-pg/report.api.md @@ -193,51 +193,4 @@ export interface RawDocumentRow { // (undocumented) type: string; } - -// Warnings were encountered during analysis: -// -// src/PgSearchEngine/PgSearchEngine.d.ts:51:1 - (ae-undocumented) Missing documentation for "PgSearchEngine". -// src/PgSearchEngine/PgSearchEngine.d.ts:63:5 - (ae-undocumented) Missing documentation for "from". -// src/PgSearchEngine/PgSearchEngine.d.ts:68:5 - (ae-undocumented) Missing documentation for "fromConfig". -// src/PgSearchEngine/PgSearchEngine.d.ts:69:5 - (ae-undocumented) Missing documentation for "supported". -// src/PgSearchEngine/PgSearchEngine.d.ts:70:5 - (ae-undocumented) Missing documentation for "translator". -// src/PgSearchEngine/PgSearchEngine.d.ts:71:5 - (ae-undocumented) Missing documentation for "setTranslator". -// src/PgSearchEngine/PgSearchEngine.d.ts:72:5 - (ae-undocumented) Missing documentation for "getIndexer". -// src/PgSearchEngine/PgSearchEngine.d.ts:73:5 - (ae-undocumented) Missing documentation for "query". -// src/PgSearchEngine/PgSearchEngineIndexer.d.ts:6:1 - (ae-undocumented) Missing documentation for "PgSearchEngineIndexerOptions". -// src/PgSearchEngine/PgSearchEngineIndexer.d.ts:13:1 - (ae-undocumented) Missing documentation for "PgSearchEngineIndexer". -// src/PgSearchEngine/PgSearchEngineIndexer.d.ts:20:5 - (ae-undocumented) Missing documentation for "initialize". -// src/PgSearchEngine/PgSearchEngineIndexer.d.ts:21:5 - (ae-undocumented) Missing documentation for "index". -// src/PgSearchEngine/PgSearchEngineIndexer.d.ts:22:5 - (ae-undocumented) Missing documentation for "finalize". -// src/database/DatabaseDocumentStore.d.ts:6:1 - (ae-undocumented) Missing documentation for "DatabaseDocumentStore". -// src/database/DatabaseDocumentStore.d.ts:8:5 - (ae-undocumented) Missing documentation for "create". -// src/database/DatabaseDocumentStore.d.ts:9:5 - (ae-undocumented) Missing documentation for "supported". -// src/database/DatabaseDocumentStore.d.ts:11:5 - (ae-undocumented) Missing documentation for "transaction". -// src/database/DatabaseDocumentStore.d.ts:12:5 - (ae-undocumented) Missing documentation for "getTransaction". -// src/database/DatabaseDocumentStore.d.ts:13:5 - (ae-undocumented) Missing documentation for "prepareInsert". -// src/database/DatabaseDocumentStore.d.ts:14:5 - (ae-undocumented) Missing documentation for "completeInsert". -// src/database/DatabaseDocumentStore.d.ts:15:5 - (ae-undocumented) Missing documentation for "insertDocuments". -// src/database/DatabaseDocumentStore.d.ts:16:5 - (ae-undocumented) Missing documentation for "query". -// src/database/types.d.ts:5:1 - (ae-undocumented) Missing documentation for "PgSearchQuery". -// src/database/types.d.ts:6:5 - (ae-undocumented) Missing documentation for "fields". -// src/database/types.d.ts:7:5 - (ae-undocumented) Missing documentation for "types". -// src/database/types.d.ts:8:5 - (ae-undocumented) Missing documentation for "pgTerm". -// src/database/types.d.ts:9:5 - (ae-undocumented) Missing documentation for "offset". -// src/database/types.d.ts:10:5 - (ae-undocumented) Missing documentation for "limit". -// src/database/types.d.ts:11:5 - (ae-undocumented) Missing documentation for "options". -// src/database/types.d.ts:14:1 - (ae-undocumented) Missing documentation for "DatabaseStore". -// src/database/types.d.ts:15:5 - (ae-undocumented) Missing documentation for "transaction". -// src/database/types.d.ts:16:5 - (ae-undocumented) Missing documentation for "getTransaction". -// src/database/types.d.ts:17:5 - (ae-undocumented) Missing documentation for "prepareInsert". -// src/database/types.d.ts:18:5 - (ae-undocumented) Missing documentation for "insertDocuments". -// src/database/types.d.ts:19:5 - (ae-undocumented) Missing documentation for "completeInsert". -// src/database/types.d.ts:20:5 - (ae-undocumented) Missing documentation for "query". -// src/database/types.d.ts:23:1 - (ae-undocumented) Missing documentation for "RawDocumentRow". -// src/database/types.d.ts:24:5 - (ae-undocumented) Missing documentation for "document". -// src/database/types.d.ts:25:5 - (ae-undocumented) Missing documentation for "type". -// src/database/types.d.ts:26:5 - (ae-undocumented) Missing documentation for "hash". -// src/database/types.d.ts:29:1 - (ae-undocumented) Missing documentation for "DocumentResultRow". -// src/database/types.d.ts:30:5 - (ae-undocumented) Missing documentation for "document". -// src/database/types.d.ts:31:5 - (ae-undocumented) Missing documentation for "type". -// src/database/types.d.ts:32:5 - (ae-undocumented) Missing documentation for "highlight". ``` diff --git a/plugins/search-backend-module-stack-overflow-collator/report.api.md b/plugins/search-backend-module-stack-overflow-collator/report.api.md index aeb7bd03ea..3b9b79c597 100644 --- a/plugins/search-backend-module-stack-overflow-collator/report.api.md +++ b/plugins/search-backend-module-stack-overflow-collator/report.api.md @@ -58,14 +58,4 @@ export type StackOverflowQuestionsCollatorFactoryOptions = { export type StackOverflowQuestionsRequestParams = { [key: string]: string | string[] | number; }; - -// Warnings were encountered during analysis: -// -// src/collators/StackOverflowQuestionsCollatorFactory.d.ts:12:5 - (ae-undocumented) Missing documentation for "answers". -// src/collators/StackOverflowQuestionsCollatorFactory.d.ts:13:5 - (ae-undocumented) Missing documentation for "tags". -// src/collators/StackOverflowQuestionsCollatorFactory.d.ts:43:5 - (ae-undocumented) Missing documentation for "requestParams". -// src/collators/StackOverflowQuestionsCollatorFactory.d.ts:50:5 - (ae-undocumented) Missing documentation for "type". -// src/collators/StackOverflowQuestionsCollatorFactory.d.ts:52:5 - (ae-undocumented) Missing documentation for "fromConfig". -// src/collators/StackOverflowQuestionsCollatorFactory.d.ts:53:5 - (ae-undocumented) Missing documentation for "getCollator". -// src/collators/StackOverflowQuestionsCollatorFactory.d.ts:54:5 - (ae-undocumented) Missing documentation for "execute". ``` diff --git a/plugins/search-backend-module-techdocs/report-alpha.api.md b/plugins/search-backend-module-techdocs/report-alpha.api.md index 678f9a679d..6a68382919 100644 --- a/plugins/search-backend-module-techdocs/report-alpha.api.md +++ b/plugins/search-backend-module-techdocs/report-alpha.api.md @@ -4,28 +4,10 @@ ```ts import { BackendFeature } from '@backstage/backend-plugin-api'; -import { ExtensionPoint } from '@backstage/backend-plugin-api'; -import { TechDocsCollatorDocumentTransformer } from '@backstage/plugin-search-backend-module-techdocs'; -import { TechDocsCollatorEntityTransformer } from '@backstage/plugin-search-backend-module-techdocs'; // @alpha (undocumented) const _feature: BackendFeature; export default _feature; -// Warning: (ae-forgotten-export) The symbol "TechDocsCollatorEntityTransformerExtensionPoint_2" needs to be exported by the entry point alpha.d.ts -// -// @alpha (undocumented) -export type TechDocsCollatorEntityTransformerExtensionPoint = - TechDocsCollatorEntityTransformerExtensionPoint_2; - -// @alpha (undocumented) -export const techdocsCollatorEntityTransformerExtensionPoint: ExtensionPoint; - -// Warnings were encountered during analysis: -// -// src/alpha.d.ts:3:15 - (ae-undocumented) Missing documentation for "_feature". -// src/alpha.d.ts:6:1 - (ae-undocumented) Missing documentation for "TechDocsCollatorEntityTransformerExtensionPoint". -// src/alpha.d.ts:8:22 - (ae-undocumented) Missing documentation for "techdocsCollatorEntityTransformerExtensionPoint". - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/search-backend-module-techdocs/report.api.md b/plugins/search-backend-module-techdocs/report.api.md index 9f03812e44..ef041e6900 100644 --- a/plugins/search-backend-module-techdocs/report.api.md +++ b/plugins/search-backend-module-techdocs/report.api.md @@ -104,22 +104,4 @@ export type TechDocsCollatorFactoryOptions = { entityTransformer?: TechDocsCollatorEntityTransformer; documentTransformer?: TechDocsCollatorDocumentTransformer; }; - -// Warnings were encountered during analysis: -// -// src/collators/DefaultTechDocsCollatorFactory.d.ts:38:5 - (ae-undocumented) Missing documentation for "type". -// src/collators/DefaultTechDocsCollatorFactory.d.ts:39:5 - (ae-undocumented) Missing documentation for "visibilityPermission". -// src/collators/DefaultTechDocsCollatorFactory.d.ts:50:5 - (ae-undocumented) Missing documentation for "fromConfig". -// src/collators/DefaultTechDocsCollatorFactory.d.ts:51:5 - (ae-undocumented) Missing documentation for "getCollator". -// src/collators/TechDocsCollatorDocumentTransformer.d.ts:3:1 - (ae-undocumented) Missing documentation for "MkSearchIndexDoc". -// src/collators/TechDocsCollatorDocumentTransformer.d.ts:4:5 - (ae-undocumented) Missing documentation for "title". -// src/collators/TechDocsCollatorDocumentTransformer.d.ts:5:5 - (ae-undocumented) Missing documentation for "text". -// src/collators/TechDocsCollatorDocumentTransformer.d.ts:6:5 - (ae-undocumented) Missing documentation for "location". -// src/collators/TechDocsCollatorDocumentTransformer.d.ts:7:5 - (ae-undocumented) Missing documentation for "tags". -// src/collators/TechDocsCollatorDocumentTransformer.d.ts:10:1 - (ae-undocumented) Missing documentation for "TechDocsCollatorDocumentTransformer". -// src/collators/TechDocsCollatorEntityTransformer.d.ts:4:1 - (ae-undocumented) Missing documentation for "TechDocsCollatorEntityTransformer". -// src/collators/defaultTechDocsCollatorEntityTransformer.d.ts:3:22 - (ae-undocumented) Missing documentation for "defaultTechDocsCollatorEntityTransformer". -// src/module.d.ts:3:1 - (ae-undocumented) Missing documentation for "TechDocsCollatorEntityTransformerExtensionPoint". -// src/module.d.ts:4:5 - (ae-undocumented) Missing documentation for "setTransformer". -// src/module.d.ts:5:5 - (ae-undocumented) Missing documentation for "setDocumentTransformer". ``` diff --git a/plugins/search-backend-module-techdocs/src/alpha.ts b/plugins/search-backend-module-techdocs/src/alpha.ts index ecd56a9af1..e5554e85bd 100644 --- a/plugins/search-backend-module-techdocs/src/alpha.ts +++ b/plugins/search-backend-module-techdocs/src/alpha.ts @@ -14,17 +14,8 @@ * limitations under the License. */ -import { - default as feature, - TechDocsCollatorEntityTransformerExtensionPoint as ExtensionPoint, - techdocsCollatorEntityTransformerExtensionPoint as extensionPoint, -} from './module'; +import { default as feature } from './module'; /** @alpha */ const _feature = feature; export default _feature; - -/** @alpha */ -export type TechDocsCollatorEntityTransformerExtensionPoint = ExtensionPoint; -/** @alpha */ -export const techdocsCollatorEntityTransformerExtensionPoint = extensionPoint; diff --git a/plugins/search-backend-node/report-alpha.api.md b/plugins/search-backend-node/report-alpha.api.md index 5c5503db13..e1d5bd024d 100644 --- a/plugins/search-backend-node/report-alpha.api.md +++ b/plugins/search-backend-node/report-alpha.api.md @@ -52,11 +52,5 @@ export const searchIndexServiceRef: ServiceRef< 'singleton' >; -// Warnings were encountered during analysis: -// -// src/alpha.d.ts:39:5 - (ae-undocumented) Missing documentation for "addCollator". -// src/alpha.d.ts:40:5 - (ae-undocumented) Missing documentation for "addDecorator". -// src/alpha.d.ts:47:5 - (ae-undocumented) Missing documentation for "setSearchEngine". - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/search-backend-node/report.api.md b/plugins/search-backend-node/report.api.md index 2086e3a351..4e769d0eae 100644 --- a/plugins/search-backend-node/report.api.md +++ b/plugins/search-backend-node/report.api.md @@ -210,24 +210,4 @@ export type TestPipelineResult = { error: unknown; documents: IndexableDocument[]; }; - -// Warnings were encountered during analysis: -// -// src/collators/NewlineDelimitedJsonCollatorFactory.d.ts:51:5 - (ae-undocumented) Missing documentation for "type". -// src/collators/NewlineDelimitedJsonCollatorFactory.d.ts:52:5 - (ae-undocumented) Missing documentation for "visibilityPermission". -// src/collators/NewlineDelimitedJsonCollatorFactory.d.ts:64:5 - (ae-undocumented) Missing documentation for "getCollator". -// src/engines/LunrSearchEngine.d.ts:25:5 - (ae-undocumented) Missing documentation for "lunrIndices". -// src/engines/LunrSearchEngine.d.ts:26:5 - (ae-undocumented) Missing documentation for "docStore". -// src/engines/LunrSearchEngine.d.ts:27:5 - (ae-undocumented) Missing documentation for "logger". -// src/engines/LunrSearchEngine.d.ts:28:5 - (ae-undocumented) Missing documentation for "highlightPreTag". -// src/engines/LunrSearchEngine.d.ts:29:5 - (ae-undocumented) Missing documentation for "highlightPostTag". -// src/engines/LunrSearchEngine.d.ts:33:5 - (ae-undocumented) Missing documentation for "translator". -// src/engines/LunrSearchEngine.d.ts:34:5 - (ae-undocumented) Missing documentation for "setTranslator". -// src/engines/LunrSearchEngine.d.ts:35:5 - (ae-undocumented) Missing documentation for "getIndexer". -// src/engines/LunrSearchEngine.d.ts:36:5 - (ae-undocumented) Missing documentation for "query". -// src/engines/LunrSearchEngineIndexer.d.ts:13:5 - (ae-undocumented) Missing documentation for "initialize". -// src/engines/LunrSearchEngineIndexer.d.ts:14:5 - (ae-undocumented) Missing documentation for "finalize". -// src/engines/LunrSearchEngineIndexer.d.ts:15:5 - (ae-undocumented) Missing documentation for "index". -// src/engines/LunrSearchEngineIndexer.d.ts:16:5 - (ae-undocumented) Missing documentation for "buildIndex". -// src/engines/LunrSearchEngineIndexer.d.ts:17:5 - (ae-undocumented) Missing documentation for "getDocumentStore". ``` diff --git a/plugins/search-backend/report-alpha.api.md b/plugins/search-backend/report-alpha.api.md index 9cae91f291..ec826f4ad2 100644 --- a/plugins/search-backend/report-alpha.api.md +++ b/plugins/search-backend/report-alpha.api.md @@ -9,9 +9,5 @@ import { BackendFeature } from '@backstage/backend-plugin-api'; const _feature: BackendFeature; export default _feature; -// Warnings were encountered during analysis: -// -// src/alpha.d.ts:2:15 - (ae-undocumented) Missing documentation for "_feature". - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/search-backend/report.api.md b/plugins/search-backend/report.api.md index e1cf271dc9..a866fca174 100644 --- a/plugins/search-backend/report.api.md +++ b/plugins/search-backend/report.api.md @@ -33,9 +33,4 @@ export type RouterOptions = { auth?: AuthService; httpAuth?: HttpAuthService; }; - -// Warnings were encountered during analysis: -// -// src/service/router.d.ts:11:1 - (ae-undocumented) Missing documentation for "RouterOptions". -// src/service/router.d.ts:25:1 - (ae-undocumented) Missing documentation for "createRouter". ``` diff --git a/plugins/search-common/report.api.md b/plugins/search-common/report.api.md index 8cda7b0168..497defc46d 100644 --- a/plugins/search-common/report.api.md +++ b/plugins/search-common/report.api.md @@ -116,24 +116,4 @@ export type SearchResult = Result; // @public (undocumented) export type SearchResultSet = ResultSet; - -// Warnings were encountered during analysis: -// -// src/types.d.ts:8:1 - (ae-undocumented) Missing documentation for "SearchQuery". -// src/types.d.ts:9:5 - (ae-undocumented) Missing documentation for "term". -// src/types.d.ts:10:5 - (ae-undocumented) Missing documentation for "types". -// src/types.d.ts:11:5 - (ae-undocumented) Missing documentation for "filters". -// src/types.d.ts:12:5 - (ae-undocumented) Missing documentation for "pageLimit". -// src/types.d.ts:13:5 - (ae-undocumented) Missing documentation for "pageCursor". -// src/types.d.ts:30:5 - (ae-undocumented) Missing documentation for "fields". -// src/types.d.ts:41:1 - (ae-undocumented) Missing documentation for "Result". -// src/types.d.ts:64:1 - (ae-undocumented) Missing documentation for "ResultSet". -// src/types.d.ts:65:5 - (ae-undocumented) Missing documentation for "results". -// src/types.d.ts:66:5 - (ae-undocumented) Missing documentation for "nextPageCursor". -// src/types.d.ts:67:5 - (ae-undocumented) Missing documentation for "previousPageCursor". -// src/types.d.ts:68:5 - (ae-undocumented) Missing documentation for "numberOfResults". -// src/types.d.ts:73:1 - (ae-undocumented) Missing documentation for "SearchResult". -// src/types.d.ts:77:1 - (ae-undocumented) Missing documentation for "SearchResultSet". -// src/types.d.ts:81:1 - (ae-undocumented) Missing documentation for "IndexableResult". -// src/types.d.ts:85:1 - (ae-undocumented) Missing documentation for "IndexableResultSet". ``` diff --git a/plugins/search-react/report-alpha.api.md b/plugins/search-react/report-alpha.api.md index 2397995355..e49b0bbeee 100644 --- a/plugins/search-react/report-alpha.api.md +++ b/plugins/search-react/report-alpha.api.md @@ -71,12 +71,5 @@ export interface SearchResultListItemBlueprintParams { predicate?: SearchResultItemExtensionPredicate; } -// Warnings were encountered during analysis: -// -// src/alpha/blueprints/SearchResultListItemBlueprint.d.ts:3:1 - (ae-undocumented) Missing documentation for "SearchResultListItemBlueprintParams". -// src/alpha/blueprints/types.d.ts:5:1 - (ae-undocumented) Missing documentation for "BaseSearchResultListItemProps". -// src/alpha/blueprints/types.d.ts:10:1 - (ae-undocumented) Missing documentation for "SearchResultItemExtensionComponent". -// src/alpha/blueprints/types.d.ts:12:1 - (ae-undocumented) Missing documentation for "SearchResultItemExtensionPredicate". - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/search-react/report.api.md b/plugins/search-react/report.api.md index e0698da6e2..3efed073d8 100644 --- a/plugins/search-react/report.api.md +++ b/plugins/search-react/report.api.md @@ -483,25 +483,4 @@ export const useSearchContextCheck: () => boolean; export const useSearchResultListItemExtensions: ( children: ReactNode, ) => (result: SearchResult_2, key?: number) => React_2.JSX.Element; - -// Warnings were encountered during analysis: -// -// src/api.d.ts:5:22 - (ae-undocumented) Missing documentation for "searchApiRef". -// src/api.d.ts:9:1 - (ae-undocumented) Missing documentation for "SearchApi". -// src/api.d.ts:10:5 - (ae-undocumented) Missing documentation for "query". -// src/api.d.ts:18:5 - (ae-undocumented) Missing documentation for "mockedResults". -// src/api.d.ts:20:5 - (ae-undocumented) Missing documentation for "query". -// src/components/DefaultResultListItem/DefaultResultListItem.d.ts:26:15 - (ae-undocumented) Missing documentation for "HigherOrderDefaultResultListItem". -// src/components/HighlightedSearchResultText/HighlightedSearchResultText.d.ts:3:1 - (ae-undocumented) Missing documentation for "HighlightedSearchResultTextClassKey". -// src/components/HighlightedSearchResultText/HighlightedSearchResultText.d.ts:17:22 - (ae-undocumented) Missing documentation for "HighlightedSearchResultText". -// src/components/SearchFilter/SearchFilter.Autocomplete.d.ts:6:1 - (ae-undocumented) Missing documentation for "SearchAutocompleteFilterProps". -// src/components/SearchFilter/SearchFilter.Autocomplete.d.ts:14:22 - (ae-undocumented) Missing documentation for "AutocompleteFilter". -// src/components/SearchFilter/SearchFilter.d.ts:6:1 - (ae-undocumented) Missing documentation for "SearchFilterComponentProps". -// src/components/SearchFilter/SearchFilter.d.ts:27:1 - (ae-undocumented) Missing documentation for "SearchFilterWrapperProps". -// src/components/SearchFilter/SearchFilter.d.ts:34:22 - (ae-undocumented) Missing documentation for "CheckboxFilter". -// src/components/SearchFilter/SearchFilter.d.ts:38:22 - (ae-undocumented) Missing documentation for "SelectFilter". -// src/components/SearchFilter/SearchFilter.d.ts:42:15 - (ae-undocumented) Missing documentation for "SearchFilter". -// src/components/SearchResultPager/SearchResultPager.d.ts:5:22 - (ae-undocumented) Missing documentation for "SearchResultPager". -// src/context/SearchContext.d.ts:9:1 - (ae-undocumented) Missing documentation for "SearchContextValue". -// src/context/SearchContext.d.ts:23:1 - (ae-undocumented) Missing documentation for "SearchContextState". ``` diff --git a/plugins/search/report-alpha.api.md b/plugins/search/report-alpha.api.md index 1d9bd7a6f6..9b8f21fa43 100644 --- a/plugins/search/report-alpha.api.md +++ b/plugins/search/report-alpha.api.md @@ -194,12 +194,5 @@ export const searchPage: ExtensionDefinition<{ }; }>; -// Warnings were encountered during analysis: -// -// src/alpha.d.ts:3:22 - (ae-undocumented) Missing documentation for "searchApi". -// src/alpha.d.ts:15:22 - (ae-undocumented) Missing documentation for "searchPage". -// src/alpha.d.ts:47:22 - (ae-undocumented) Missing documentation for "searchNavItem". -// src/alpha.d.ts:65:15 - (ae-undocumented) Missing documentation for "_default". - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/search/report.api.md b/plugins/search/report.api.md index 7bb1dca05e..a47c11b194 100644 --- a/plugins/search/report.api.md +++ b/plugins/search/report.api.md @@ -140,19 +140,4 @@ export type SidebarSearchProps = { // @public export function useSearchModal(initialState?: boolean): SearchModalValue; - -// Warnings were encountered during analysis: -// -// src/components/SearchModal/SearchModal.d.ts:6:1 - (ae-undocumented) Missing documentation for "SearchModalChildrenProps". -// src/components/SearchModal/SearchModal.d.ts:19:1 - (ae-undocumented) Missing documentation for "SearchModalProps". -// src/components/SearchModal/SearchModal.d.ts:50:22 - (ae-undocumented) Missing documentation for "SearchModal". -// src/components/SearchPage/SearchPage.d.ts:6:22 - (ae-undocumented) Missing documentation for "SearchPage". -// src/components/SearchType/SearchType.Accordion.d.ts:5:1 - (ae-undocumented) Missing documentation for "SearchTypeAccordionProps". -// src/components/SearchType/SearchType.Tabs.d.ts:5:1 - (ae-undocumented) Missing documentation for "SearchTypeTabsProps". -// src/components/SearchType/SearchType.d.ts:18:15 - (ae-undocumented) Missing documentation for "SearchType". -// src/components/SidebarSearch/SidebarSearch.d.ts:14:22 - (ae-undocumented) Missing documentation for "SidebarSearch". -// src/plugin.d.ts:7:22 - (ae-undocumented) Missing documentation for "searchPlugin". -// src/plugin.d.ts:13:22 - (ae-undocumented) Missing documentation for "SearchPage". -// src/plugin.d.ts:17:22 - (ae-undocumented) Missing documentation for "SidebarSearchModal". -// src/plugin.d.ts:21:22 - (ae-undocumented) Missing documentation for "HomePageSearchBar". ``` diff --git a/plugins/signals-backend/report.api.md b/plugins/signals-backend/report.api.md index df68dcd62b..10f74ba37e 100644 --- a/plugins/signals-backend/report.api.md +++ b/plugins/signals-backend/report.api.md @@ -41,18 +41,5 @@ export interface RouterOptions { const signalsPlugin: BackendFeature; export default signalsPlugin; -// Warnings were encountered during analysis: -// -// src/deprecated.d.ts:10:1 - (ae-undocumented) Missing documentation for "RouterOptions". -// src/deprecated.d.ts:11:5 - (ae-undocumented) Missing documentation for "logger". -// src/deprecated.d.ts:12:5 - (ae-undocumented) Missing documentation for "events". -// src/deprecated.d.ts:13:5 - (ae-undocumented) Missing documentation for "identity". -// src/deprecated.d.ts:14:5 - (ae-undocumented) Missing documentation for "discovery". -// src/deprecated.d.ts:15:5 - (ae-undocumented) Missing documentation for "config". -// src/deprecated.d.ts:16:5 - (ae-undocumented) Missing documentation for "lifecycle". -// src/deprecated.d.ts:17:5 - (ae-undocumented) Missing documentation for "auth". -// src/deprecated.d.ts:18:5 - (ae-undocumented) Missing documentation for "userInfo". -// src/deprecated.d.ts:24:1 - (ae-undocumented) Missing documentation for "createRouter". - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/signals-node/report.api.md b/plugins/signals-node/report.api.md index 97f06a8ede..a368dd2ece 100644 --- a/plugins/signals-node/report.api.md +++ b/plugins/signals-node/report.api.md @@ -58,17 +58,5 @@ export const signalsServiceRef: ServiceRef< 'singleton' >; -// Warnings were encountered during analysis: -// -// src/DefaultSignalsService.d.ts:5:1 - (ae-undocumented) Missing documentation for "DefaultSignalsService". -// src/DefaultSignalsService.d.ts:7:5 - (ae-undocumented) Missing documentation for "create". -// src/DefaultSignalsService.d.ts:19:22 - (ae-undocumented) Missing documentation for "DefaultSignalService". -// src/SignalsService.d.ts:4:1 - (ae-undocumented) Missing documentation for "SignalsService". -// src/SignalsService.d.ts:15:1 - (ae-undocumented) Missing documentation for "SignalService". -// src/lib.d.ts:3:22 - (ae-undocumented) Missing documentation for "signalsServiceRef". -// src/lib.d.ts:8:22 - (ae-undocumented) Missing documentation for "signalService". -// src/types.d.ts:6:1 - (ae-undocumented) Missing documentation for "SignalsServiceOptions". -// src/types.d.ts:10:1 - (ae-undocumented) Missing documentation for "SignalPayload". - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/signals-react/report.api.md b/plugins/signals-react/report.api.md index f17f53366a..87d856288b 100644 --- a/plugins/signals-react/report.api.md +++ b/plugins/signals-react/report.api.md @@ -32,14 +32,5 @@ export const useSignal: ( isSignalsAvailable: boolean; }; -// Warnings were encountered during analysis: -// -// src/api/SignalApi.d.ts:3:22 - (ae-undocumented) Missing documentation for "signalApiRef". -// src/api/SignalApi.d.ts:5:1 - (ae-undocumented) Missing documentation for "SignalSubscriber". -// src/api/SignalApi.d.ts:6:5 - (ae-undocumented) Missing documentation for "unsubscribe". -// src/api/SignalApi.d.ts:9:1 - (ae-undocumented) Missing documentation for "SignalApi". -// src/api/SignalApi.d.ts:10:5 - (ae-undocumented) Missing documentation for "subscribe". -// src/hooks/useSignal.d.ts:3:22 - (ae-undocumented) Missing documentation for "useSignal". - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/signals/report.api.md b/plugins/signals/report.api.md index 049f50b2f2..ca7695aeec 100644 --- a/plugins/signals/report.api.md +++ b/plugins/signals/report.api.md @@ -36,15 +36,5 @@ export const SignalsDisplay: () => null; // @public (undocumented) export const signalsPlugin: BackstagePlugin<{}, {}>; -// Warnings were encountered during analysis: -// -// src/api/SignalClient.d.ts:5:1 - (ae-undocumented) Missing documentation for "SignalClient". -// src/api/SignalClient.d.ts:10:5 - (ae-undocumented) Missing documentation for "DEFAULT_CONNECT_TIMEOUT_MS". -// src/api/SignalClient.d.ts:11:5 - (ae-undocumented) Missing documentation for "DEFAULT_RECONNECT_TIMEOUT_MS". -// src/api/SignalClient.d.ts:16:5 - (ae-undocumented) Missing documentation for "create". -// src/api/SignalClient.d.ts:23:5 - (ae-undocumented) Missing documentation for "subscribe". -// src/plugin.d.ts:2:22 - (ae-undocumented) Missing documentation for "signalsPlugin". -// src/plugin.d.ts:4:22 - (ae-undocumented) Missing documentation for "SignalsDisplay". - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/techdocs-backend/report-alpha.api.md b/plugins/techdocs-backend/report-alpha.api.md index d97dc13982..20512c41b9 100644 --- a/plugins/techdocs-backend/report-alpha.api.md +++ b/plugins/techdocs-backend/report-alpha.api.md @@ -9,9 +9,5 @@ import { BackendFeature } from '@backstage/backend-plugin-api'; const _feature: BackendFeature; export default _feature; -// Warnings were encountered during analysis: -// -// src/alpha.d.ts:2:15 - (ae-undocumented) Missing documentation for "_feature". - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/techdocs-backend/report.api.md b/plugins/techdocs-backend/report.api.md index 569df8ee7c..b03a220c4d 100644 --- a/plugins/techdocs-backend/report.api.md +++ b/plugins/techdocs-backend/report.api.md @@ -117,17 +117,4 @@ const techdocsPlugin: BackendFeature; export default techdocsPlugin; export * from '@backstage/plugin-techdocs-node'; - -// Warnings were encountered during analysis: -// -// src/index.d.ts:17:1 - (ae-undocumented) Missing documentation for "DocsBuildStrategy". -// src/index.d.ts:22:1 - (ae-undocumented) Missing documentation for "ShouldBuildParameters". -// src/index.d.ts:29:1 - (ae-undocumented) Missing documentation for "TechDocsDocument". -// src/search/DefaultTechDocsCollator.d.ts:32:5 - (ae-undocumented) Missing documentation for "type". -// src/search/DefaultTechDocsCollator.d.ts:33:5 - (ae-undocumented) Missing documentation for "visibilityPermission". -// src/search/DefaultTechDocsCollator.d.ts:35:5 - (ae-undocumented) Missing documentation for "fromConfig". -// src/search/DefaultTechDocsCollator.d.ts:36:5 - (ae-undocumented) Missing documentation for "execute". -// src/search/DefaultTechDocsCollator.d.ts:37:5 - (ae-undocumented) Missing documentation for "applyArgsToFormat". -// src/search/index.d.ts:12:1 - (ae-undocumented) Missing documentation for "TechDocsCollatorFactoryOptions". -// src/search/index.d.ts:17:22 - (ae-undocumented) Missing documentation for "DefaultTechDocsCollatorFactory". ``` diff --git a/plugins/techdocs-common/report.api.md b/plugins/techdocs-common/report.api.md index 1b0ee6797a..c7e1829a28 100644 --- a/plugins/techdocs-common/report.api.md +++ b/plugins/techdocs-common/report.api.md @@ -8,9 +8,4 @@ export const TECHDOCS_ANNOTATION = 'backstage.io/techdocs-ref'; // @public (undocumented) export const TECHDOCS_EXTERNAL_ANNOTATION = 'backstage.io/techdocs-entity'; - -// Warnings were encountered during analysis: -// -// src/constants.d.ts:2:22 - (ae-undocumented) Missing documentation for "TECHDOCS_ANNOTATION". -// src/constants.d.ts:4:22 - (ae-undocumented) Missing documentation for "TECHDOCS_EXTERNAL_ANNOTATION". ``` diff --git a/plugins/techdocs-node/report.api.md b/plugins/techdocs-node/report.api.md index 1bd93d1b57..c6f626dca8 100644 --- a/plugins/techdocs-node/report.api.md +++ b/plugins/techdocs-node/report.api.md @@ -378,18 +378,4 @@ export class UrlPreparer implements PreparerBase { prepare(entity: Entity, options?: PreparerOptions): Promise; shouldCleanPreparedDirectory(): boolean; } - -// Warnings were encountered during analysis: -// -// src/extensions.d.ts:11:5 - (ae-undocumented) Missing documentation for "setBuildStrategy". -// src/extensions.d.ts:12:5 - (ae-undocumented) Missing documentation for "setBuildLogTransport". -// src/extensions.d.ts:26:5 - (ae-undocumented) Missing documentation for "setTechdocsGenerator". -// src/extensions.d.ts:40:5 - (ae-undocumented) Missing documentation for "registerPreparer". -// src/extensions.d.ts:54:5 - (ae-undocumented) Missing documentation for "registerPublisher". -// src/extensions.d.ts:55:5 - (ae-undocumented) Missing documentation for "registerPublisherSettings". -// src/stages/generate/index.d.ts:10:22 - (ae-undocumented) Missing documentation for "getMkDocsYml". -// src/stages/publish/publish.d.ts:10:5 - (ae-undocumented) Missing documentation for "register". -// src/stages/publish/publish.d.ts:11:5 - (ae-undocumented) Missing documentation for "get". -// src/stages/publish/types.d.ts:21:5 - (ae-undocumented) Missing documentation for "googleGcs". -// src/techdocsTypes.d.ts:39:5 - (ae-undocumented) Missing documentation for "shouldBuild". ``` diff --git a/plugins/techdocs-react/report.api.md b/plugins/techdocs-react/report.api.md index 73f122068e..c158bbd81e 100644 --- a/plugins/techdocs-react/report.api.md +++ b/plugins/techdocs-react/report.api.md @@ -192,17 +192,4 @@ export const useTechDocsAddons: () => { // @public export const useTechDocsReaderPage: () => TechDocsReaderPageValue; - -// Warnings were encountered during analysis: -// -// src/api.d.ts:9:5 - (ae-undocumented) Missing documentation for "getCookie". -// src/api.d.ts:12:5 - (ae-undocumented) Missing documentation for "getApiOrigin". -// src/api.d.ts:13:5 - (ae-undocumented) Missing documentation for "getTechDocsMetadata". -// src/api.d.ts:14:5 - (ae-undocumented) Missing documentation for "getEntityMetadata". -// src/api.d.ts:34:5 - (ae-undocumented) Missing documentation for "getApiOrigin". -// src/api.d.ts:35:5 - (ae-undocumented) Missing documentation for "getStorageUrl". -// src/api.d.ts:36:5 - (ae-undocumented) Missing documentation for "getBuilder". -// src/api.d.ts:37:5 - (ae-undocumented) Missing documentation for "getEntityDocs". -// src/api.d.ts:38:5 - (ae-undocumented) Missing documentation for "syncEntityDocs". -// src/api.d.ts:39:5 - (ae-undocumented) Missing documentation for "getBaseUrl". ``` diff --git a/plugins/techdocs/report-alpha.api.md b/plugins/techdocs/report-alpha.api.md index faaf6d6a83..63e078dd43 100644 --- a/plugins/techdocs/report-alpha.api.md +++ b/plugins/techdocs/report-alpha.api.md @@ -316,10 +316,5 @@ export const techDocsSearchResultListItemExtension: ExtensionDefinition<{ params: SearchResultListItemBlueprintParams; }>; -// Warnings were encountered during analysis: -// -// src/alpha.d.ts:3:22 - (ae-undocumented) Missing documentation for "techDocsSearchResultListItemExtension". -// src/alpha.d.ts:35:15 - (ae-undocumented) Missing documentation for "_default". - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/techdocs/report.api.md b/plugins/techdocs/report.api.md index 3ecf2cf7d2..c58a946287 100644 --- a/plugins/techdocs/report.api.md +++ b/plugins/techdocs/report.api.md @@ -506,36 +506,4 @@ export class TechDocsStorageClient implements TechDocsStorageApi_2 { logHandler?: (line: string) => void, ): Promise; } - -// Warnings were encountered during analysis: -// -// src/api.d.ts:31:5 - (ae-undocumented) Missing documentation for "getApiOrigin". -// src/api.d.ts:32:5 - (ae-undocumented) Missing documentation for "getStorageUrl". -// src/api.d.ts:33:5 - (ae-undocumented) Missing documentation for "getBuilder". -// src/api.d.ts:34:5 - (ae-undocumented) Missing documentation for "getEntityDocs". -// src/api.d.ts:35:5 - (ae-undocumented) Missing documentation for "syncEntityDocs". -// src/api.d.ts:36:5 - (ae-undocumented) Missing documentation for "getBaseUrl". -// src/api.d.ts:45:5 - (ae-undocumented) Missing documentation for "getApiOrigin". -// src/api.d.ts:46:5 - (ae-undocumented) Missing documentation for "getTechDocsMetadata". -// src/api.d.ts:47:5 - (ae-undocumented) Missing documentation for "getEntityMetadata". -// src/client.d.ts:11:5 - (ae-undocumented) Missing documentation for "configApi". -// src/client.d.ts:12:5 - (ae-undocumented) Missing documentation for "discoveryApi". -// src/client.d.ts:19:5 - (ae-undocumented) Missing documentation for "getCookie". -// src/client.d.ts:22:5 - (ae-undocumented) Missing documentation for "getApiOrigin". -// src/client.d.ts:49:5 - (ae-undocumented) Missing documentation for "configApi". -// src/client.d.ts:50:5 - (ae-undocumented) Missing documentation for "discoveryApi". -// src/client.d.ts:59:5 - (ae-undocumented) Missing documentation for "getApiOrigin". -// src/client.d.ts:60:5 - (ae-undocumented) Missing documentation for "getStorageUrl". -// src/client.d.ts:61:5 - (ae-undocumented) Missing documentation for "getBuilder". -// src/client.d.ts:80:5 - (ae-undocumented) Missing documentation for "getBaseUrl". -// src/home/components/TechDocsCustomHome.d.ts:16:5 - (ae-undocumented) Missing documentation for "title". -// src/home/components/TechDocsCustomHome.d.ts:17:5 - (ae-undocumented) Missing documentation for "description". -// src/home/components/TechDocsCustomHome.d.ts:18:5 - (ae-undocumented) Missing documentation for "panelType". -// src/home/components/TechDocsCustomHome.d.ts:19:5 - (ae-undocumented) Missing documentation for "panelCSS". -// src/home/components/TechDocsCustomHome.d.ts:20:5 - (ae-undocumented) Missing documentation for "filterPredicate". -// src/home/components/TechDocsCustomHome.d.ts:28:5 - (ae-undocumented) Missing documentation for "label". -// src/home/components/TechDocsCustomHome.d.ts:29:5 - (ae-undocumented) Missing documentation for "panels". -// src/index.d.ts:21:1 - (ae-undocumented) Missing documentation for "DeprecatedTechDocsMetadata". -// src/index.d.ts:27:1 - (ae-undocumented) Missing documentation for "DeprecatedTechDocsEntityMetadata". -// src/reader/components/TechDocsReaderPage/TechDocsReaderPage.d.ts:27:1 - (ae-undocumented) Missing documentation for "TechDocsReaderPageProps". ``` diff --git a/plugins/user-settings-backend/report-alpha.api.md b/plugins/user-settings-backend/report-alpha.api.md index 02c93f9aee..8ed6505934 100644 --- a/plugins/user-settings-backend/report-alpha.api.md +++ b/plugins/user-settings-backend/report-alpha.api.md @@ -9,9 +9,5 @@ import { BackendFeature } from '@backstage/backend-plugin-api'; const _feature: BackendFeature; export default _feature; -// Warnings were encountered during analysis: -// -// src/alpha.d.ts:2:15 - (ae-undocumented) Missing documentation for "_feature". - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/user-settings-common/report.api.md b/plugins/user-settings-common/report.api.md index a984f71e47..b69f4a4190 100644 --- a/plugins/user-settings-common/report.api.md +++ b/plugins/user-settings-common/report.api.md @@ -9,9 +9,5 @@ export type UserSettingsSignal = { key: string; }; -// Warnings were encountered during analysis: -// -// src/types.d.ts:2:1 - (ae-undocumented) Missing documentation for "UserSettingsSignal". - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/user-settings/report-alpha.api.md b/plugins/user-settings/report-alpha.api.md index d9dad32623..63db1defe0 100644 --- a/plugins/user-settings/report-alpha.api.md +++ b/plugins/user-settings/report-alpha.api.md @@ -127,11 +127,5 @@ export const userSettingsTranslationRef: TranslationRef< } >; -// Warnings were encountered during analysis: -// -// src/alpha.d.ts:4:22 - (ae-undocumented) Missing documentation for "settingsNavItem". -// src/alpha.d.ts:24:15 - (ae-undocumented) Missing documentation for "_default". -// src/translation.d.ts:2:22 - (ae-undocumented) Missing documentation for "userSettingsTranslationRef". - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/user-settings/report.api.md b/plugins/user-settings/report.api.md index 6169668adc..cee35724bb 100644 --- a/plugins/user-settings/report.api.md +++ b/plugins/user-settings/report.api.md @@ -179,36 +179,4 @@ export const useUserProfile: () => displayName: string; loading: false; }; - -// Warnings were encountered during analysis: -// -// src/apis/StorageApi/UserSettingsStorage.d.ts:21:5 - (ae-undocumented) Missing documentation for "create". -// src/apis/StorageApi/UserSettingsStorage.d.ts:29:5 - (ae-undocumented) Missing documentation for "forBucket". -// src/apis/StorageApi/UserSettingsStorage.d.ts:30:5 - (ae-undocumented) Missing documentation for "remove". -// src/apis/StorageApi/UserSettingsStorage.d.ts:31:5 - (ae-undocumented) Missing documentation for "set". -// src/apis/StorageApi/UserSettingsStorage.d.ts:32:5 - (ae-undocumented) Missing documentation for "observe$". -// src/apis/StorageApi/UserSettingsStorage.d.ts:33:5 - (ae-undocumented) Missing documentation for "snapshot". -// src/components/AuthProviders/DefaultProviderSettings.d.ts:3:22 - (ae-undocumented) Missing documentation for "DefaultProviderSettings". -// src/components/AuthProviders/ProviderSettingsItem.d.ts:4:22 - (ae-undocumented) Missing documentation for "ProviderSettingsItem". -// src/components/AuthProviders/UserSettingsAuthProviders.d.ts:3:22 - (ae-undocumented) Missing documentation for "UserSettingsAuthProviders". -// src/components/FeatureFlags/UserSettingsFeatureFlags.d.ts:5:22 - (ae-undocumented) Missing documentation for "UserSettingsFeatureFlags". -// src/components/General/UserSettingsAppearanceCard.d.ts:3:22 - (ae-undocumented) Missing documentation for "UserSettingsAppearanceCard". -// src/components/General/UserSettingsGeneral.d.ts:3:22 - (ae-undocumented) Missing documentation for "UserSettingsGeneral". -// src/components/General/UserSettingsIdentityCard.d.ts:3:22 - (ae-undocumented) Missing documentation for "UserSettingsIdentityCard". -// src/components/General/UserSettingsLanguageToggle.d.ts:3:22 - (ae-undocumented) Missing documentation for "UserSettingsLanguageToggle". -// src/components/General/UserSettingsMenu.d.ts:3:22 - (ae-undocumented) Missing documentation for "UserSettingsMenu". -// src/components/General/UserSettingsPinToggle.d.ts:3:22 - (ae-undocumented) Missing documentation for "UserSettingsPinToggle". -// src/components/General/UserSettingsProfileCard.d.ts:3:22 - (ae-undocumented) Missing documentation for "UserSettingsProfileCard". -// src/components/General/UserSettingsSignInAvatar.d.ts:3:22 - (ae-undocumented) Missing documentation for "UserSettingsSignInAvatar". -// src/components/General/UserSettingsThemeToggle.d.ts:3:22 - (ae-undocumented) Missing documentation for "UserSettingsThemeToggle". -// src/components/Settings.d.ts:4:22 - (ae-undocumented) Missing documentation for "Settings". -// src/components/SettingsLayout/SettingsLayout.d.ts:4:1 - (ae-undocumented) Missing documentation for "SettingsLayoutRouteProps". -// src/components/SettingsLayout/SettingsLayout.d.ts:15:1 - (ae-undocumented) Missing documentation for "SettingsLayoutProps". -// src/components/SettingsLayout/SettingsLayout.d.ts:23:22 - (ae-undocumented) Missing documentation for "SettingsLayout". -// src/components/SettingsPage/SettingsPage.d.ts:3:22 - (ae-undocumented) Missing documentation for "SettingsPage". -// src/components/UserSettingsTab/UserSettingsTab.d.ts:3:22 - (ae-undocumented) Missing documentation for "USER_SETTINGS_TAB_KEY". -// src/components/UserSettingsTab/UserSettingsTab.d.ts:5:1 - (ae-undocumented) Missing documentation for "UserSettingsTabProps". -// src/components/useUserProfileInfo.d.ts:3:22 - (ae-undocumented) Missing documentation for "useUserProfile". -// src/plugin.d.ts:4:22 - (ae-undocumented) Missing documentation for "userSettingsPlugin". -// src/plugin.d.ts:8:22 - (ae-undocumented) Missing documentation for "UserSettingsPage". ```