backend-common: Deprecate read in favour of readUrl in UrlReader

Signed-off-by: Johan Haals <johan.haals@gmail.com>

plugins/techdocs-node/src/helpers.test.ts

@@ -16,6 +16,8 @@
 
 import {
   ReadTreeResponse,
+  ReadUrlOptions,
+  ReadUrlResponse,
   SearchResponse,
   UrlReader,
 } from '@backstage/backend-common';
@@ -292,6 +294,13 @@ describe('getDocFilesFromRepository', () => {
         return Buffer.from('mock');
       }
 
+      async readUrl(
+        _url: string,
+        _options?: ReadUrlOptions | undefined,
+      ): Promise<ReadUrlResponse> {
+        throw new Error('Method not implemented.');
+      }
+
       async readTree(): Promise<ReadTreeResponse> {
         return {
           dir: async () => {

plugins/techdocs-node/src/stages/prepare/dir.test.ts

@@ -46,6 +46,7 @@ const createMockEntity = (annotations: {}) => {
 const mockConfig = new ConfigReader({});
 const mockUrlReader: jest.Mocked<UrlReader> = {
   read: jest.fn(),
+  readUrl: jest.fn(),
   readTree: jest.fn(),
   search: jest.fn(),
 };