add changeset

Signed-off-by: Emma Indal <emma.indahl@gmail.com>
2022-02-21 13:23:50 +01:00
parent e60175e87a
commit a925ba8385
1 changed files with 19 additions and 0 deletions
@@ -0,0 +1,19 @@
+---
+'@backstage/plugin-techdocs-backend': minor
+---
+
+BREAKING: constructor based initialization of DefaultTechDocsCollator now deprecated. Use static fromConfig method instead.
+
+```diff
+indexBuilder.addCollator({
+  defaultRefreshIntervalSeconds: 600,
+-   collator: new DefaultTechDocsCollator({
+   collator: DefaultTechDocsCollator.fromConfig(config, {
+    discovery,
+    logger,
+    tokenManager,
+  }),
+});
+```
+
+Note: in an upcoming release, TechDocs backend's /sync/:namespace/:kind/:name endpoint will only respond to text/event-stream-based requests. Update any custom code at your organization accordingly.