From 5a2df6c0c83700a376059d31321725cd87b2aaa6 Mon Sep 17 00:00:00 2001
From: Kacper Nowacki <kacper.nowacki@dynatrace.com>
Date: Wed, 1 Mar 2023 14:14:31 +0100
Subject: [PATCH] Change variable name to documentType

Signed-off-by: Kacper Nowacki <kacper.nowacki@dynatrace.com>
---
 .changeset/wet-pugs-exist.md                                | 2 +-
 docs/features/search/how-to-guides.md                       | 6 +++---
 plugins/catalog-backend/api-report.md                       | 2 +-
 .../src/search/DefaultCatalogCollatorFactory.ts             | 6 +++---
 4 files changed, 8 insertions(+), 8 deletions(-)

diff --git a/.changeset/wet-pugs-exist.md b/.changeset/wet-pugs-exist.md
index dbc2c735c9..509fb19f8d 100644
--- a/.changeset/wet-pugs-exist.md
+++ b/.changeset/wet-pugs-exist.md
@@ -2,4 +2,4 @@
 '@backstage/plugin-catalog-backend': patch
 ---
 
-Added optional parameter `type` to `DefaultCatalogCollatorFactoryOptions` which allows to override default document type `software-catalog`. For more details, see [How to customize document type in the Software Catalog index](../docs/features/search/how-to-guides.md#how-to-customize-document-type-in-the-software-catalog-index).
+Added optional parameter `documentType` to `DefaultCatalogCollatorFactoryOptions` which allows to override default document type `software-catalog`. For more details, see [How to customize document type in the Software Catalog index](../docs/features/search/how-to-guides.md#how-to-customize-document-type-in-the-software-catalog-index).
diff --git a/docs/features/search/how-to-guides.md b/docs/features/search/how-to-guides.md
index be8bac43fb..d2c8c537f2 100644
--- a/docs/features/search/how-to-guides.md
+++ b/docs/features/search/how-to-guides.md
@@ -189,7 +189,7 @@ entities are indexed by the search engine.
 In some cases you might want to have the ability to change the document type in which catalog entities will be indexed by catalog collator.
 Such option gives a possibility to customize SearchPage results and filters depending on which document type you would like to see results for.
 
-You can achieve that by passing additional parameter `type` to the `DefaultCatalogCollatorFactory`.
+You can achieve that by passing additional parameter `documentType` to the `DefaultCatalogCollatorFactory`.
 
 Let's say that you want to have two different document types for some entities.
 Our example will cover a use case in which we want to:
@@ -197,7 +197,7 @@ Our example will cover a use case in which we want to:
 - Store entities of kind `User` or `Group` under document type `yourCustomDocumentType`,
 - Store rest of entities under default document type `software-catalog`
 
-To achieve that you will have to remove `User` and `Group` from your previous collator `filter` and register new `DefaultCatalogCollatorFactory` with new parameter `type`.
+To achieve that you will have to remove `User` and `Group` from your previous collator `filter` and register new `DefaultCatalogCollatorFactory` with new parameter `documentType`.
 
 ```diff
 // packages/backend/src/plugins/search.ts
@@ -222,7 +222,7 @@ To achieve that you will have to remove `User` and `Group` from your previous co
 +      filter: {
 +        kind: ['User', 'Group'],
 +      },
-+      type: 'yourCustomDocumentType',
++      documentType: 'yourCustomDocumentType',
 +    }),
 +  });
 ```
diff --git a/plugins/catalog-backend/api-report.md b/plugins/catalog-backend/api-report.md
index dcca23c069..78c883a912 100644
--- a/plugins/catalog-backend/api-report.md
+++ b/plugins/catalog-backend/api-report.md
@@ -382,7 +382,7 @@ export type DefaultCatalogCollatorFactoryOptions = {
   batchSize?: number;
   catalogClient?: CatalogApi;
   entityTransformer?: CatalogCollatorEntityTransformer;
-  type?: string;
+  documentType?: string;
 };
 
 export { DeferredEntity };
diff --git a/plugins/catalog-backend/src/search/DefaultCatalogCollatorFactory.ts b/plugins/catalog-backend/src/search/DefaultCatalogCollatorFactory.ts
index fc5c465ccb..07da2da03a 100644
--- a/plugins/catalog-backend/src/search/DefaultCatalogCollatorFactory.ts
+++ b/plugins/catalog-backend/src/search/DefaultCatalogCollatorFactory.ts
@@ -44,7 +44,7 @@ export type DefaultCatalogCollatorFactoryOptions = {
   batchSize?: number;
   catalogClient?: CatalogApi;
   entityTransformer?: CatalogCollatorEntityTransformer;
-  type?: string;
+  documentType?: string;
 };
 
 /** @public */
@@ -76,7 +76,7 @@ export class DefaultCatalogCollatorFactory implements DocumentCollatorFactory {
       catalogClient,
       tokenManager,
       entityTransformer,
-      type,
+      documentType,
     } = options;
 
     this.locationTemplate =
@@ -88,7 +88,7 @@ export class DefaultCatalogCollatorFactory implements DocumentCollatorFactory {
     this.tokenManager = tokenManager;
     this.entityTransformer =
       entityTransformer ?? defaultCatalogCollatorEntityTransformer;
-    this.type = type ?? 'software-catalog';
+    this.type = documentType ?? 'software-catalog';
   }
 
   async getCollator(): Promise<Readable> {