From a3374141585af49f094e64f12bd96c4e11d88146 Mon Sep 17 00:00:00 2001
From: Patrizio Bekerle <patrizio@bekerle.com>
Date: Wed, 10 Feb 2021 10:12:28 +0100
Subject: [PATCH] Add more documentation
---
packages/auth/README.md | 8 ++++++++
packages/check-in-place-select/README.md | 1 +
packages/common/src/eventbus.js | 5 +++++
packages/knowledge-base-web-page-element-view/README.md | 3 ++-
packages/person-profile/README.md | 3 ++-
packages/person-select/README.md | 3 ++-
6 files changed, 20 insertions(+), 3 deletions(-)
diff --git a/packages/auth/README.md b/packages/auth/README.md
index 238f9e16..c017ac9e 100644
--- a/packages/auth/README.md
+++ b/packages/auth/README.md
@@ -60,6 +60,14 @@ The component emits a `dbp-set-property` event for the attribute `auth`:
<script type="module" src="node_modules/@dbp-toolkit/auth/dist/dbp-auth.js"></script>
```
+### Attributes
+
+- `lang` (optional, default: `de`): set to `de` or `en` for German or English
+ - example `<dbp-auth-keycloak lang="de" </dbp-auth-keycloak>`
+- `auth` object: you need to set that object property for the auth token
+ - example auth property: `{token: "THE_BEARER_TOKEN"}`
+ - note: most often this should be an attribute that is not set directly, but subscribed at a provider
+
## Local development
```bash
diff --git a/packages/check-in-place-select/README.md b/packages/check-in-place-select/README.md
index 65a93300..a7290e94 100644
--- a/packages/check-in-place-select/README.md
+++ b/packages/check-in-place-select/README.md
@@ -34,6 +34,7 @@ npm i @dbp-toolkit/check-in-place-select
- example `<dbp-check-in-place-select show-reload-button reload-button-text="Reload result list"></dbp-check-in-place-select>`
- `auth` object: you need to set that object property for the auth token
- example auth property: `{token: "THE_BEARER_TOKEN"}`
+ - note: most often this should be an attribute that is not set directly, but subscribed at a provider
## Local development
diff --git a/packages/common/src/eventbus.js b/packages/common/src/eventbus.js
index f9cc4b12..d77662e9 100644
--- a/packages/common/src/eventbus.js
+++ b/packages/common/src/eventbus.js
@@ -1,3 +1,8 @@
+/**
+ * EventBus system
+ *
+ * DEPRECATED: Migrated to provider
+ */
const OPERATION_FETCH_RETAINED = 'fetch-retained';
diff --git a/packages/knowledge-base-web-page-element-view/README.md b/packages/knowledge-base-web-page-element-view/README.md
index 82a96017..99ad0fd5 100644
--- a/packages/knowledge-base-web-page-element-view/README.md
+++ b/packages/knowledge-base-web-page-element-view/README.md
@@ -24,7 +24,8 @@ npm i @dbp-toolkit/knowledge-base-web-page-element-view
- `text` (optional): text to click to show the information loaded from the webpage
- example `<dbp-knowledge-base-web-page-element-view text="Click me to show more information"></dbp-knowledge-base-web-page-element-view>`
- `auth` object: you need to set that object property for the auth token
- - example auth property: `{token: "THE_BEARER_TOKEN"}`
+ - example auth property: `{token: "THE_BEARER_TOKEN"}`
+ - note: most often this should be an attribute that is not set directly, but subscribed at a provider
## Local development
diff --git a/packages/person-profile/README.md b/packages/person-profile/README.md
index 6918a023..44880913 100644
--- a/packages/person-profile/README.md
+++ b/packages/person-profile/README.md
@@ -22,7 +22,8 @@ npm i @dbp-toolkit/person-profile
- `value` (optional): api path of person to preload the selector with
- example `<dbp-person-profile value="/people/testuser"></dbp-person-profile>`
- `auth` object: you need to set that object property for the auth token
- - example auth property: `{token: "THE_BEARER_TOKEN"}`
+ - example auth property: `{token: "THE_BEARER_TOKEN"}`
+ - note: most often this should be an attribute that is not set directly, but subscribed at a provider
## Local development
diff --git a/packages/person-select/README.md b/packages/person-select/README.md
index 64590b36..c9f31fe2 100644
--- a/packages/person-select/README.md
+++ b/packages/person-select/README.md
@@ -34,7 +34,8 @@ npm i @dbp-toolkit/person-select
- `reload-button-title` (optional): sets a title text on the reload button
- example `<dbp-person-select show-reload-button reload-button-text="Reload result list"></dbp-person-select>`
- `auth` object: you need to set that object property for the auth token
- - example auth property: `{token: "THE_BEARER_TOKEN"}`
+ - example auth property: `{token: "THE_BEARER_TOKEN"}`
+ - note: most often this should be an attribute that is not set directly, but subscribed at a provider
## Local development
--
GitLab