docs: update api reports

Signed-off-by: Camila Belo <camilaibs@gmail.com>

packages/backend-common/api-report.md

@@ -9,14 +9,7 @@
 import { AppConfig } from '@backstage/config';
 import { AuthCallback } from 'isomorphic-git';
 import { AuthService } from '@backstage/backend-plugin-api';
-import { AwsCredentialsManager } from '@backstage/integration-aws-node';
-import { AwsS3Integration } from '@backstage/integration';
-import { AzureDevOpsCredentialsProvider } from '@backstage/integration';
-import { AzureIntegration } from '@backstage/integration';
 import { BackendFeatureCompat } from '@backstage/backend-plugin-api';
-import { BitbucketCloudIntegration } from '@backstage/integration';
-import { BitbucketIntegration } from '@backstage/integration';
-import { BitbucketServerIntegration } from '@backstage/integration';
 import { CacheService } from '@backstage/backend-plugin-api';
 import { CacheServiceOptions } from '@backstage/backend-plugin-api';
 import { CacheServiceSetOptions } from '@backstage/backend-plugin-api';
@@ -28,12 +21,6 @@ import { DiscoveryService } from '@backstage/backend-plugin-api';
 import Docker from 'dockerode';
 import { ErrorRequestHandler } from 'express';
 import express from 'express';
-import { GerritIntegration } from '@backstage/integration';
-import { GiteaIntegration } from '@backstage/integration';
-import { GithubCredentialsProvider } from '@backstage/integration';
-import { GithubIntegration } from '@backstage/integration';
-import { GitLabIntegration } from '@backstage/integration';
-import { HarnessIntegration } from '@backstage/integration';
 import { HttpAuthService } from '@backstage/backend-plugin-api';
 import { IdentityService } from '@backstage/backend-plugin-api';
 import { isChildPath as isChildPath_2 } from '@backstage/backend-plugin-api';
@@ -47,34 +34,18 @@ import { MergeResult } from 'isomorphic-git';
 import { PermissionsService } from '@backstage/backend-plugin-api';
 import { PluginMetadataService } from '@backstage/backend-plugin-api';
 import { PushResult } from 'isomorphic-git';
-import { Readable } from 'stream';
 import { ReadCommitResult } from 'isomorphic-git';
-import { ReadTreeOptions as ReadTreeOptions_2 } from '@backstage/backend-plugin-api';
-import { ReadTreeResponse as ReadTreeResponse_2 } from '@backstage/backend-plugin-api';
-import { ReadTreeResponseDirOptions as ReadTreeResponseDirOptions_2 } from '@backstage/backend-plugin-api';
-import { ReadTreeResponseFile as ReadTreeResponseFile_2 } from '@backstage/backend-plugin-api';
-import { ReadUrlOptions as ReadUrlOptions_2 } from '@backstage/backend-plugin-api';
-import { ReadUrlResponse as ReadUrlResponse_2 } from '@backstage/backend-plugin-api';
 import { RequestHandler } from 'express';
 import { resolvePackagePath as resolvePackagePath_2 } from '@backstage/backend-plugin-api';
 import { resolveSafeChildPath as resolveSafeChildPath_2 } from '@backstage/backend-plugin-api';
 import { RootConfigService } from '@backstage/backend-plugin-api';
 import { Router } from 'express';
 import { SchedulerService } from '@backstage/backend-plugin-api';
-import { SearchOptions as SearchOptions_2 } from '@backstage/backend-plugin-api';
-import { SearchResponse as SearchResponse_2 } from '@backstage/backend-plugin-api';
-import { SearchResponseFile as SearchResponseFile_2 } from '@backstage/backend-plugin-api';
 import { Server } from 'http';
 import { ServiceRef } from '@backstage/backend-plugin-api';
 import { TokenManagerService } from '@backstage/backend-plugin-api';
 import { TransportStreamOptions } from 'winston-transport';
 import { UrlReaderService } from '@backstage/backend-plugin-api';
-import { UrlReaderServiceReadTreeOptions } from '@backstage/backend-plugin-api';
-import { UrlReaderServiceReadTreeResponse } from '@backstage/backend-plugin-api';
-import { UrlReaderServiceReadUrlOptions } from '@backstage/backend-plugin-api';
-import { UrlReaderServiceReadUrlResponse } from '@backstage/backend-plugin-api';
-import { UrlReaderServiceSearchOptions } from '@backstage/backend-plugin-api';
-import { UrlReaderServiceSearchResponse } from '@backstage/backend-plugin-api';
 import { UserInfoService } from '@backstage/backend-plugin-api';
 import { V1PodTemplateSpec } from '@kubernetes/client-node';
 import * as winston from 'winston';
@@ -86,31 +57,6 @@ export type AuthCallbackOptions = {
   logger?: LoggerService;
 };
 
-// Warning: (ae-forgotten-export) The symbol "AwsS3UrlReader_2" needs to be exported by the entry point index.d.ts
-//
-// @public @deprecated (undocumented)
-export class AwsS3UrlReader extends AwsS3UrlReader_2 {}
-
-// Warning: (ae-forgotten-export) The symbol "AzureUrlReader_2" needs to be exported by the entry point index.d.ts
-//
-// @public @deprecated (undocumented)
-export class AzureUrlReader extends AzureUrlReader_2 {}
-
-// Warning: (ae-forgotten-export) The symbol "BitbucketCloudUrlReader_2" needs to be exported by the entry point index.d.ts
-//
-// @public @deprecated (undocumented)
-export class BitbucketCloudUrlReader extends BitbucketCloudUrlReader_2 {}
-
-// Warning: (ae-forgotten-export) The symbol "BitbucketServerUrlReader_2" needs to be exported by the entry point index.d.ts
-//
-// @public @deprecated (undocumented)
-export class BitbucketServerUrlReader extends BitbucketServerUrlReader_2 {}
-
-// Warning: (ae-forgotten-export) The symbol "BitbucketUrlReader_2" needs to be exported by the entry point index.d.ts
-//
-// @public @deprecated (undocumented)
-export class BitbucketUrlReader extends BitbucketUrlReader_2 {}
-
 // @public @deprecated (undocumented)
 export type CacheClient = CacheService;
 
@@ -245,21 +191,6 @@ export type ErrorHandlerOptions = {
   logClientErrors?: boolean;
 };
 
-// Warning: (ae-forgotten-export) The symbol "FetchUrlReader_2" needs to be exported by the entry point index.d.ts
-//
-// @public @deprecated (undocumented)
-export class FetchUrlReader extends FetchUrlReader_2 {}
-
-// Warning: (ae-forgotten-export) The symbol "FromReadableArrayOptions_2" needs to be exported by the entry point index.d.ts
-//
-// @public @deprecated (undocumented)
-export type FromReadableArrayOptions = FromReadableArrayOptions_2;
-
-// Warning: (ae-forgotten-export) The symbol "GerritUrlReader_2" needs to be exported by the entry point index.d.ts
-//
-// @public @deprecated (undocumented)
-export class GerritUrlReader extends GerritUrlReader_2 {}
-
 // @public @deprecated
 export function getRootLogger(): winston.Logger;
 
@@ -342,26 +273,6 @@ export class Git {
   resolveRef(options: { dir: string; ref: string }): Promise<string>;
 }
 
-// Warning: (ae-forgotten-export) The symbol "GiteaUrlReader_2" needs to be exported by the entry point index.d.ts
-//
-// @public @deprecated (undocumented)
-export class GiteaUrlReader extends GiteaUrlReader_2 {}
-
-// Warning: (ae-forgotten-export) The symbol "GithubUrlReader_2" needs to be exported by the entry point index.d.ts
-//
-// @public @deprecated (undocumented)
-export class GithubUrlReader extends GithubUrlReader_2 {}
-
-// Warning: (ae-forgotten-export) The symbol "GitlabUrlReader_2" needs to be exported by the entry point index.d.ts
-//
-// @public @deprecated (undocumented)
-export class GitlabUrlReader extends GitlabUrlReader_2 {}
-
-// Warning: (ae-forgotten-export) The symbol "HarnessUrlReader_2" needs to be exported by the entry point index.d.ts
-//
-// @public @deprecated (undocumented)
-export class HarnessUrlReader extends HarnessUrlReader_2 {}
-
 // @public @deprecated
 class HostDiscovery implements DiscoveryService {
   static fromConfig(
@@ -506,50 +417,6 @@ export interface PullOptions {
   };
 }
 
-// Warning: (ae-forgotten-export) The symbol "ReaderFactory_2" needs to be exported by the entry point index.d.ts
-//
-// @public @deprecated (undocumented)
-export type ReaderFactory = ReaderFactory_2;
-
-// @public @deprecated (undocumented)
-export type ReadTreeOptions = ReadTreeOptions_2;
-
-// @public @deprecated (undocumented)
-export type ReadTreeResponse = ReadTreeResponse_2;
-
-// @public @deprecated (undocumented)
-export type ReadTreeResponseDirOptions = ReadTreeResponseDirOptions_2;
-
-// Warning: (ae-forgotten-export) The symbol "ReadTreeResponseFactory_2" needs to be exported by the entry point index.d.ts
-//
-// @public @deprecated (undocumented)
-export type ReadTreeResponseFactory = ReadTreeResponseFactory_2;
-
-// Warning: (ae-forgotten-export) The symbol "ReadTreeResponseFactoryOptions_2" needs to be exported by the entry point index.d.ts
-//
-// @public @deprecated (undocumented)
-export type ReadTreeResponseFactoryOptions = ReadTreeResponseFactoryOptions_2;
-
-// @public @deprecated (undocumented)
-export type ReadTreeResponseFile = ReadTreeResponseFile_2;
-
-// @public @deprecated (undocumented)
-export type ReadUrlOptions = ReadUrlOptions_2;
-
-// @public @deprecated (undocumented)
-export type ReadUrlResponse = ReadUrlResponse_2;
-
-// Warning: (ae-forgotten-export) The symbol "ReadUrlResponseFactory_2" needs to be exported by the entry point index.d.ts
-//
-// @public @deprecated (undocumented)
-export class ReadUrlResponseFactory extends ReadUrlResponseFactory_2 {}
-
-// Warning: (ae-forgotten-export) The symbol "ReadUrlResponseFactoryFromStreamOptions_2" needs to be exported by the entry point index.d.ts
-//
-// @public @deprecated (undocumented)
-export type ReadUrlResponseFactoryFromStreamOptions =
-  ReadUrlResponseFactoryFromStreamOptions_2;
-
 // @public @deprecated
 export function redactWinstonLogLine(
   info: winston.Logform.TransformableInfo,
@@ -583,15 +450,6 @@ export type RunContainerOptions = {
   pullOptions?: PullOptions;
 };
 
-// @public @deprecated (undocumented)
-export type SearchOptions = SearchOptions_2;
-
-// @public @deprecated (undocumented)
-export type SearchResponse = SearchResponse_2;
-
-// @public @deprecated (undocumented)
-export type SearchResponseFile = SearchResponseFile_2;
-
 // @public @deprecated
 export class ServerTokenManager implements TokenManager {
   // (undocumented)
@@ -667,24 +525,6 @@ export interface StatusCheckHandlerOptions {
 // @public @deprecated (undocumented)
 export type TokenManager = TokenManagerService;
 
-// @public @deprecated (undocumented)
-export type UrlReader = UrlReaderService;
-
-// Warning: (ae-forgotten-export) The symbol "UrlReaderPredicateTuple_2" needs to be exported by the entry point index.d.ts
-//
-// @public @deprecated (undocumented)
-export type UrlReaderPredicateTuple = UrlReaderPredicateTuple_2;
-
-// Warning: (ae-forgotten-export) The symbol "UrlReaders_2" needs to be exported by the entry point index.d.ts
-//
-// @public @deprecated (undocumented)
-export class UrlReaders extends UrlReaders_2 {}
-
-// Warning: (ae-forgotten-export) The symbol "UrlReadersOptions_2" needs to be exported by the entry point index.d.ts
-//
-// @public @deprecated (undocumented)
-export type UrlReadersOptions = UrlReadersOptions_2;
-
 // @public @deprecated
 export function useHotCleanup(
   _module: NodeModule,

packages/backend-dynamic-feature-service/api-report.md

@@ -33,7 +33,7 @@ import { ServiceRef } from '@backstage/backend-plugin-api';
 import { TaskRunner } from '@backstage/backend-tasks';
 import { TemplateAction } from '@backstage/plugin-scaffolder-node';
 import { TokenManager } from '@backstage/backend-common';
-import { UrlReader } from '@backstage/backend-common';
+import { UrlReaderService } from '@backstage/backend-plugin-api';
 
 // @public (undocumented)
 export interface BackendDynamicPlugin extends BaseDynamicPlugin {
@@ -221,7 +221,7 @@ export type LegacyPluginEnvironment = {
   cache: PluginCacheManager;
   database: PluginDatabaseManager;
   config: Config;
-  reader: UrlReader;
+  reader: UrlReaderService;
   discovery: PluginEndpointDiscovery;
   tokenManager: TokenManager;
   permissions: PermissionEvaluator;

plugins/catalog-backend-module-aws/api-report.md

@@ -17,7 +17,7 @@ import { LocationSpec } from '@backstage/plugin-catalog-common';
 import { LoggerService } from '@backstage/backend-plugin-api';
 import { PluginTaskScheduler } from '@backstage/backend-tasks';
 import { TaskRunner } from '@backstage/backend-tasks';
-import { UrlReader } from '@backstage/backend-common';
+import { UrlReaderService } from '@backstage/backend-plugin-api';
 
 // @public
 export const ANNOTATION_AWS_ACCOUNT_ID: string;
@@ -75,7 +75,7 @@ export class AwsOrganizationCloudAccountProcessor implements CatalogProcessor {
 
 // @public @deprecated
 export class AwsS3DiscoveryProcessor implements CatalogProcessor {
-  constructor(reader: UrlReader);
+  constructor(reader: UrlReaderService);
   // (undocumented)
   getProcessorName(): string;
   // (undocumented)

plugins/catalog-backend-module-incremental-ingestion/api-report.md

@@ -16,7 +16,7 @@ import type { PermissionEvaluator } from '@backstage/plugin-permission-common';
 import type { PluginDatabaseManager } from '@backstage/backend-common';
 import type { PluginTaskScheduler } from '@backstage/backend-tasks';
 import { Router } from 'express';
-import type { UrlReader } from '@backstage/backend-common';
+import { UrlReaderService } from '@backstage/backend-plugin-api';
 
 // @public
 export type EntityIteratorResult<T> =
@@ -91,7 +91,7 @@ export type PluginEnvironment = {
   database: PluginDatabaseManager;
   scheduler: PluginTaskScheduler;
   config: Config;
-  reader: UrlReader;
+  reader: UrlReaderService;
   permissions: PermissionEvaluator;
 };
 ```

plugins/catalog-backend-module-openapi/api-report.md

@@ -12,7 +12,7 @@ import { LocationSpec } from '@backstage/plugin-catalog-common';
 import { Logger } from 'winston';
 import { PlaceholderResolverParams } from '@backstage/plugin-catalog-backend';
 import { ScmIntegrations } from '@backstage/integration';
-import { UrlReader } from '@backstage/backend-common';
+import { UrlReaderService } from '@backstage/backend-plugin-api';
 
 // @public
 const catalogModuleJsonSchemaRefPlaceholderResolver: BackendFeatureCompat;
@@ -31,14 +31,14 @@ export class OpenApiRefProcessor implements CatalogProcessor {
   constructor(options: {
     integrations: ScmIntegrations;
     logger: Logger;
-    reader: UrlReader;
+    reader: UrlReaderService;
   });
   // (undocumented)
   static fromConfig(
     config: Config,
     options: {
       logger: Logger;
-      reader: UrlReader;
+      reader: UrlReaderService;
     },
   ): OpenApiRefProcessor;
   // (undocumented)

plugins/catalog-backend/api-report.md

@@ -63,7 +63,7 @@ import { Router } from 'express';
 import { ScmIntegrationRegistry } from '@backstage/integration';
 import { ScmLocationAnalyzer as ScmLocationAnalyzer_2 } from '@backstage/plugin-catalog-node';
 import { TokenManager } from '@backstage/backend-common';
-import { UrlReader } from '@backstage/backend-common';
+import { UrlReaderService } from '@backstage/backend-plugin-api';
 import { Validators } from '@backstage/catalog-model';
 
 // @public @deprecated
@@ -197,7 +197,7 @@ export type CatalogEnvironment = {
   logger: LoggerService;
   database: PluginDatabaseManager;
   config: Config;
-  reader: UrlReader;
+  reader: UrlReaderService;
   permissions: PermissionsService | PermissionAuthorizer;
   scheduler?: PluginTaskScheduler;
   discovery?: DiscoveryService;
@@ -254,14 +254,14 @@ export class CodeOwnersProcessor implements CatalogProcessor_2 {
   constructor(options: {
     integrations: ScmIntegrationRegistry;
     logger: LoggerService;
-    reader: UrlReader;
+    reader: UrlReaderService;
   });
   // (undocumented)
   static fromConfig(
     config: Config,
     options: {
       logger: LoggerService;
-      reader: UrlReader;
+      reader: UrlReaderService;
     },
   ): CodeOwnersProcessor;
   // (undocumented)
@@ -413,7 +413,7 @@ export class PlaceholderProcessor implements CatalogProcessor_2 {
 // @public (undocumented)
 export type PlaceholderProcessorOptions = {
   resolvers: Record<string, PlaceholderResolver_2>;
-  reader: UrlReader;
+  reader: UrlReaderService;
   integrations: ScmIntegrationRegistry;
 };
 
@@ -465,7 +465,7 @@ export function transformLegacyPolicyToProcessor(
 
 // @public (undocumented)
 export class UrlReaderProcessor implements CatalogProcessor_2 {
-  constructor(options: { reader: UrlReader; logger: LoggerService });
+  constructor(options: { reader: UrlReaderService; logger: LoggerService });
   // (undocumented)
   getProcessorName(): string;
   // (undocumented)

plugins/scaffolder-backend-module-confluence-to-markdown/api-report.md

@@ -8,7 +8,7 @@ import { Config } from '@backstage/config';
 import { JsonObject } from '@backstage/types';
 import { ScmIntegrations } from '@backstage/integration';
 import { TemplateAction } from '@backstage/plugin-scaffolder-node';
-import { UrlReader } from '@backstage/backend-common';
+import { UrlReaderService } from '@backstage/backend-plugin-api';
 
 // @public
 const confluenceToMarkdownModule: BackendFeatureCompat;
@@ -16,7 +16,7 @@ export default confluenceToMarkdownModule;
 
 // @public (undocumented)
 export const createConfluenceToMarkdownAction: (options: {
-  reader: UrlReader;
+  reader: UrlReaderService;
   integrations: ScmIntegrations;
   config: Config;
 }) => TemplateAction<

plugins/scaffolder-backend-module-cookiecutter/api-report.md

@@ -10,7 +10,7 @@ import { ContainerRunner } from '@backstage/backend-common';
 import { JsonObject } from '@backstage/types';
 import { ScmIntegrations } from '@backstage/integration';
 import { TemplateAction } from '@backstage/plugin-scaffolder-node';
-import { UrlReader } from '@backstage/backend-common';
+import { UrlReaderService } from '@backstage/backend-plugin-api';
 
 // @public
 const cookiecutterModule: BackendFeatureCompat;
@@ -18,7 +18,7 @@ export default cookiecutterModule;
 
 // @public
 export function createFetchCookiecutterAction(options: {
-  reader: UrlReader;
+  reader: UrlReaderService;
   integrations: ScmIntegrations;
   containerRunner?: ContainerRunner;
 }): TemplateAction<

plugins/scaffolder-backend-module-rails/api-report.md

@@ -8,11 +8,11 @@ import { ContainerRunner } from '@backstage/backend-common';
 import { JsonObject } from '@backstage/types';
 import { ScmIntegrations } from '@backstage/integration';
 import { TemplateAction } from '@backstage/plugin-scaffolder-node';
-import { UrlReader } from '@backstage/backend-common';
+import { UrlReaderService } from '@backstage/backend-plugin-api';
 
 // @public
 export function createFetchRailsAction(options: {
-  reader: UrlReader;
+  reader: UrlReaderService;
   integrations: ScmIntegrations;
   containerRunner?: ContainerRunner;
   allowedImageNames?: string[];

plugins/scaffolder-backend/api-report.md

@@ -63,7 +63,7 @@ import { TemplateEntityStepV1beta3 } from '@backstage/plugin-scaffolder-common';
 import { TemplateFilter as TemplateFilter_2 } from '@backstage/plugin-scaffolder-node';
 import { TemplateGlobal as TemplateGlobal_2 } from '@backstage/plugin-scaffolder-node';
 import { TemplateParametersV1beta3 } from '@backstage/plugin-scaffolder-common';
-import { UrlReader } from '@backstage/backend-common';
+import { UrlReaderService } from '@backstage/backend-plugin-api';
 import { WorkspaceProvider } from '@backstage/plugin-scaffolder-node/alpha';
 import { ZodType } from 'zod';
 import { ZodTypeDef } from 'zod';
@@ -95,7 +95,7 @@ export interface CreateBuiltInActionsOptions {
   catalogClient: CatalogApi;
   config: Config;
   integrations: ScmIntegrations;
-  reader: UrlReader;
+  reader: UrlReaderService;
 }
 
 // @public
@@ -154,7 +154,7 @@ export function createFetchCatalogEntityAction(options: {
 
 // @public
 export function createFetchPlainAction(options: {
-  reader: UrlReader;
+  reader: UrlReaderService;
   integrations: ScmIntegrations;
 }): TemplateAction_2<
   {
@@ -167,7 +167,7 @@ export function createFetchPlainAction(options: {
 
 // @public
 export function createFetchPlainFileAction(options: {
-  reader: UrlReader;
+  reader: UrlReaderService;
   integrations: ScmIntegrations;
 }): TemplateAction_2<
   {
@@ -180,7 +180,7 @@ export function createFetchPlainFileAction(options: {
 
 // @public
 export function createFetchTemplateAction(options: {
-  reader: UrlReader;
+  reader: UrlReaderService;
   integrations: ScmIntegrations;
   additionalTemplateFilters?: Record<string, TemplateFilter_2>;
   additionalTemplateGlobals?: Record<string, TemplateGlobal_2>;
@@ -507,7 +507,7 @@ export interface RouterOptions {
   // (undocumented)
   permissions?: PermissionsService;
   // (undocumented)
-  reader: UrlReader;
+  reader: UrlReaderService;
   // (undocumented)
   scheduler?: PluginTaskScheduler;
   // (undocumented)

plugins/scaffolder-node/api-report.md

@@ -16,7 +16,7 @@ import { ScmIntegrations } from '@backstage/integration';
 import { SpawnOptionsWithoutStdio } from 'child_process';
 import { TaskSpec } from '@backstage/plugin-scaffolder-common';
 import { TemplateInfo } from '@backstage/plugin-scaffolder-common';
-import { UrlReader } from '@backstage/backend-common';
+import { UrlReaderService } from '@backstage/backend-plugin-api';
 import { UserEntity } from '@backstage/catalog-model';
 import { Writable } from 'stream';
 import { z } from 'zod';
@@ -196,7 +196,7 @@ export type ExecuteShellCommandOptions = {
 
 // @public
 export function fetchContents(options: {
-  reader: UrlReader;
+  reader: UrlReaderService;
   integrations: ScmIntegrations;
   baseUrl?: string;
   fetchUrl?: string;
@@ -206,7 +206,7 @@ export function fetchContents(options: {
 
 // @public
 export function fetchFile(options: {
-  reader: UrlReader;
+  reader: UrlReaderService;
   integrations: ScmIntegrations;
   baseUrl?: string;
   fetchUrl?: string;

plugins/techdocs-node/api-report.md

@@ -15,7 +15,7 @@ import { IndexableDocument } from '@backstage/plugin-search-common';
 import { Logger } from 'winston';
 import { PluginEndpointDiscovery } from '@backstage/backend-common';
 import { ScmIntegrationRegistry } from '@backstage/integration';
-import { UrlReader } from '@backstage/backend-common';
+import { UrlReaderService } from '@backstage/backend-plugin-api';
 import * as winston from 'winston';
 import { Writable } from 'stream';
 
@@ -82,7 +82,7 @@ export class Generators implements GeneratorBuilder {
 
 // @public
 export const getDocFilesFromRepository: (
-  reader: UrlReader,
+  reader: UrlReaderService,
   entity: Entity,
   opts?: {
     etag?: string;
@@ -157,7 +157,7 @@ export type PreparerBuilder = {
 // @public
 export type PreparerConfig = {
   logger: Logger;
-  reader: UrlReader;
+  reader: UrlReaderService;
 };
 
 // @public