chore(badges): Enhance warning in readme and describe how to allow configuration reading from frontend. Move remaining tests files beside the tested code

Signed-off-by: Rbillon59 <r.billon@celonis.com>
This commit is contained in:
Rbillon59
2023-04-28 18:38:07 +02:00
parent 00979497ac
commit 29078a6c05
5 changed files with 19 additions and 4 deletions
+1 -1
View File
@@ -127,7 +127,7 @@ app:
obfuscate: true
```
:warning: **Warning**: The only endpoint to be publicly available is the `/entity/:entityUuid/:badgeId` endpoint. The other endpoints are meant to be called from the frontend plugin.
:warning: **Warning**: The only endpoint to be publicly available is the `/entity/:entityUuid/:badgeId` endpoint. The other endpoints are meant for trusted internal users and should not be publicly exposed.
> Note that you cannot use env vars to set the `obfuscate` value. It must be a boolean value and env vars are always strings.
@@ -26,5 +26,8 @@ exports.up = async function up(knex) {
};
exports.down = async function down(knex) {
await knex.schema.alterTable('badges', table => {
table.dropIndex('', 'badges_uuid_index');
});
await knex.schema.dropTable('badges');
};
@@ -25,7 +25,7 @@ import {
import { CatalogApi } from '@backstage/catalog-client';
import type { Entity } from '@backstage/catalog-model';
import { Config, ConfigReader } from '@backstage/config';
import { createRouter } from '../service/router';
import { createRouter } from './router';
import { BadgeBuilder } from '../lib';
import {
BackstageIdentityResponse,
@@ -25,7 +25,7 @@ import {
import { CatalogApi } from '@backstage/catalog-client';
import type { Entity } from '@backstage/catalog-model';
import { Config, ConfigReader } from '@backstage/config';
import { createRouter } from '../service/router';
import { createRouter } from './router';
import { BadgeBuilder } from '../lib';
import {
BackstageIdentityResponse,