Skip to content

Commit e5f4a3a

Browse files
authored
Lightspeed: update questionValidation config doc (#795)
* add RHDH system prompt Signed-off-by: Stephanie <yangcao@redhat.com> * rename configuration Signed-off-by: Stephanie <yangcao@redhat.com> * update question validation config doc Signed-off-by: Stephanie <yangcao@redhat.com> * add questionValidation in frontend config Signed-off-by: Stephanie <yangcao@redhat.com> * to be consistent with frontend Signed-off-by: Stephanie <yangcao@redhat.com> --------- Signed-off-by: Stephanie <yangcao@redhat.com>
1 parent 5a734ba commit e5f4a3a

3 files changed

Lines changed: 25 additions & 2 deletions

File tree

workspaces/lightspeed/plugins/lightspeed-backend/README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,8 @@ lightspeed:
3434
servers:
3535
- id: <server id>
3636
url: <serverURL>
37-
token: <api key> # dummy token
37+
token: <api key>
38+
questionValidation: true # Optional - To disable question (prompt) validation set it to false.
3839
```
3940
4041
Example local development configuration:
@@ -47,6 +48,17 @@ lightspeed:
4748
token: 'js92n-ssj28dbdk902' # dummy token
4849
```
4950
51+
`questionValidation` is default to be enabled with topic restriction on RHDH related topics.
52+
If you want to disable the validation, set the value to be `false`.
53+
54+
Example configuration to disable `questionValidation`:
55+
56+
```yaml
57+
lightspeed:
58+
questionValidation: false
59+
servers: ... ...
60+
```
61+
5062
#### Permission Framework Support
5163

5264
The Lightspeed Backend plugin has support for the permission framework.

workspaces/lightspeed/plugins/lightspeed-backend/config.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ export interface Config {
3838
token?: string;
3939
}>;
4040
/**
41-
* If turn on query restriction validation.
41+
* query restriction validation (Enabled by default).
4242
* @visibility frontend
4343
*/
4444
questionValidation?: boolean;

workspaces/lightspeed/plugins/lightspeed/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,17 @@ lightspeed:
125125
questionValidation: true # Optional - To disable question (prompt) validation set it to false.
126126
```
127127

128+
`questionValidation` is default to be enabled with topic restriction on RHDH related topics.
129+
If you want to disable the validation, set the value to be `false`.
130+
131+
Example configuration to disable `questionValidation`:
132+
133+
```yaml
134+
lightspeed:
135+
questionValidation: false
136+
servers: ... ...
137+
```
138+
128139
---
129140
130141
#### To install this plugin locally in [backstage-showcase](https://github.com/janus-idp/backstage-showcase) application as a dynamic plugin.

0 commit comments

Comments
 (0)