Skip to content

docs(#4697): extend @visibility guidance to entity provider packages #4700

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
fullsend-ai-coder wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(#4697): extend @visibility guidance to entity provider packages #4700

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions workspaces/boost/AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,25 @@ failures or config-surface drift.

When reviewing PRs that add or modify `boost.*` config keys, verify all five registration steps above were completed.

### Config declarations in entity provider packages

@fullsend-ai-review fullsend-ai-review Bot Sep 10, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[low] docs-accuracy

States kagenti-entity-provider maintains its own config.d.ts, but this package has no config.d.ts file. Only ogx-entity-provider has one. kagenti-entity-provider reads config fields (boost.entityProviders.kagenti.*) not declared in any config.d.ts within the package.

Suggested fix: Reword to: The ogx-entity-provider package maintains its own config.d.ts; kagenti-entity-provider should follow the same pattern (it currently lacks one).


The `ogx-entity-provider` and `kagenti-entity-provider` packages each
maintain their own `config.d.ts` (they do not use the centralized Zod
schema system in `boost-backend`). When adding or modifying config
fields in these packages:

1. Declare **every** field that the package's config reader function
reads (e.g., `readOgxEntityProviderConfig`) in the package's
`config.d.ts`. Backstage uses `config.d.ts` for config validation
and visibility enforcement — undeclared fields bypass both.
2. Add `@visibility backend` to any field that holds secrets or
security-sensitive data (API keys, certificates, TLS bypass flags).
Add `@visibility secret` to fields that must never appear in
frontend config (e.g., `apiKey`).
3. Check `boost-connector-utils` for reusable TLS and HTTP utilities
(`isValidPem`, `createHttpsAgent`, `safeGetOptionalString`) before
implementing equivalents locally.

### Wiring startup logic

When adding a new initialization, migration, or validation method to
Expand Down
Loading