Skip to content

docs(#4223): RHIDP-15302 migration design document #4225

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

Draft
fullsend-ai-coder wants to merge 4 commits into
base: main
Choose a base branch
from
+378 −4
Draft

docs(#4223): RHIDP-15302 migration design document #4225

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a19b6f6
docs(#4223): RHIDP-15302 migration design document
fullsend-ai-coder[bot] Aug 10, 2026
5c81e97
fix(#4223): apply prettier formatting to migration design doc
fullsend-ai-coder[bot] Aug 10, 2026
4bf0a0d
fix(#4223): address review findings on migration design doc
mareklibra Aug 10, 2026
cd1043c
docs(#4223): tighten migration design field rules and API filters
mareklibra Aug 10, 2026
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
2 changes: 2 additions & 0 deletions ...oost/openspec/changes/ai-catalog-entity-model/specs/migration-readiness/spec.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Migration Readiness for Upstream Entity Kinds

> **Status: Draft** — Pre-implementation specification. Subject to change during implementation.
>

@fullsend-ai-review fullsend-ai-review Bot Aug 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.

[high] broken cross-reference

The relative link ../../../../specifications/ai-asset-upstream-migration-design.md resolves incorrectly. From spec.md's directory (workspaces/boost/openspec/changes/ai-catalog-entity-model/specs/migration-readiness/), four ../ levels reach workspaces/boost/openspec/, producing a non-existent path. The link needs five ../ levels to reach workspaces/boost/ before descending into specifications/.

Suggested fix: Change the link from ../../../../specifications/ai-asset-upstream-migration-design.md to ../../../../../specifications/ai-asset-upstream-migration-design.md (5 levels up instead of 4).

> **Design document:** [ai-asset-upstream-migration-design.md](../../../../../specifications/ai-asset-upstream-migration-design.md) — implements RHIDP-15302 tasks 8.1-8.4 from this specification.

Design document mapping custom annotations and entity kinds to upstream Backstage entity kind targets, identifying consumer-facing changes, and obtaining upstream sign-off. Current-state source of truth: [ai-catalog-entity-model/design.md Decision 1](../../design.md). MCP server kind is already aligned with upstream (`McpServerApiEntity`, [backstage#34016](https://github.com/backstage/backstage/pull/34016)); RFC [#32062](https://github.com/backstage/backstage/issues/32062) is MCP-only and does **not** define an `AIAgent` kind.

Expand Down
10 changes: 6 additions & 4 deletions workspaces/boost/openspec/changes/ai-catalog-entity-model/tasks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,10 +84,12 @@

## 8. Migration Readiness Design (P2) — _RHIDP-15258_

- [ ] 8.1 Create migration design document with mapping table: current kind/spec.type/annotation → target upstream kind (RHIDP-15302)
- [ ] 8.2 Document transformation rules for each AI asset category (RHIDP-15302)
- [ ] 8.3 Identify consumer-facing changes: catalog UI filters, entity refs, API queries (RHIDP-15302)
- [ ] 8.4 Document backward compatibility strategy (e.g., keep annotation for one major version) (RHIDP-15302)
> Tasks 8.1-8.4 implemented in [ai-asset-upstream-migration-design.md](../../../specifications/ai-asset-upstream-migration-design.md) via [#4223](https://github.com/redhat-developer/rhdh-plugins/issues/4223).

@fullsend-ai-review fullsend-ai-review Bot Aug 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] blockquote-formatting-convention

The new blockquote does not follow the established bold-label-with-colon pattern used elsewhere in tasks.md (e.g., '> Label: description').


- [x] 8.1 Create migration design document with mapping table: current kind/spec.type/annotation → target upstream kind (RHIDP-15302)
- [x] 8.2 Document transformation rules for each AI asset category (RHIDP-15302)
- [x] 8.3 Identify consumer-facing changes: catalog UI filters, entity refs, API queries (RHIDP-15302)
- [x] 8.4 Document backward compatibility strategy (e.g., keep annotation for one major version) (RHIDP-15302)
- [ ] 8.5 Obtain upstream Backstage maintainer or RHDH architect sign-off on migration document (RHIDP-15302)
- [ ] 8.6 Document sign-off in spec: reviewer name, role, date, approval status (RHIDP-15302)

Expand Down
Loading
Loading