diff --git a/.changeset/curvy-trainers-hide.md b/.changeset/curvy-trainers-hide.md new file mode 100644 index 0000000000..32403a0f18 --- /dev/null +++ b/.changeset/curvy-trainers-hide.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-catalog-backend-module-incremental-ingestion': patch +--- + +Update installation guide to fix inconsistency in type names diff --git a/plugins/catalog-backend-module-incremental-ingestion/README.md b/plugins/catalog-backend-module-incremental-ingestion/README.md index f85321e613..6ba3e7c3ca 100644 --- a/plugins/catalog-backend-module-incremental-ingestion/README.md +++ b/plugins/catalog-backend-module-incremental-ingestion/README.md @@ -175,17 +175,17 @@ import { IncrementalEntityProvider } from '@backstage/plugin-catalog-backend-mod // This will include your pagination information, let's say our API accepts a `page` parameter. // In this case, the cursor will include `page` -interface MyApiCursor { +interface Cursor { page: number; } // This interface describes the type of data that will be passed to your burst function. -interface MyContext { +interface Context { apiClient: MyApiClient; } export class MyIncrementalEntityProvider - implements IncrementalEntityProvider + implements IncrementalEntityProvider { getProviderName() { return `MyIncrementalEntityProvider`; @@ -203,7 +203,7 @@ export class MyIncrementalEntityProvider return `MyIncrementalEntityProvider`; } - async around(burst: (context: MyContext) => Promise): Promise { + async around(burst: (context: Context) => Promise): Promise { const apiClient = new MyApiClient(); await burst({ apiClient }); @@ -229,7 +229,7 @@ export class MyIncrementalEntityProvider return `MyIncrementalEntityProvider`; } - async around(burst: (context: MyContext) => Promise): Promise { + async around(burst: (context: Context) => Promise): Promise { const apiClient = new MyApiClient(this.token); await burst({ apiClient }); @@ -240,7 +240,7 @@ export class MyIncrementalEntityProvider The last step is to implement the actual `next` method that will accept the cursor, call the API, process the result and return the result. ```ts -export class MyIncrementalEntityProvider implements IncrementalEntityProvider { +export class MyIncrementalEntityProvider implements IncrementalEntityProvider { token: string; @@ -253,14 +253,14 @@ export class MyIncrementalEntityProvider implements IncrementalEntityProvider Promise): Promise { + async around(burst: (context: Context) => Promise): Promise { const apiClient = new MyApiClient(this.token) await burst({ apiClient }) } - async next(context: MyContext, cursor?: MyApiCursor = { page: 1 }): Promise> { + async next(context: Context, cursor?: Cursor = { page: 1 }): Promise> { const { apiClient } = context; // call your API with the current cursor