Skip to content

docs(#4188): reconcile current→upstream AI-asset mapping tables - #4189

Open
fullsend-ai-coder[bot] wants to merge 3 commits into
mainfrom
agent/4188-reconcile-mapping-tables
Open

docs(#4188): reconcile current→upstream AI-asset mapping tables#4189
fullsend-ai-coder[bot] wants to merge 3 commits into
mainfrom
agent/4188-reconcile-mapping-tables

Conversation

@fullsend-ai-coder

Copy link
Copy Markdown
Contributor

Rewrite mapping tables across all upstream-schema-alignment and ai-catalog-entity-model OpenSpec files to reflect the corrected upstream entity kind targets per Decision 1 and the #4042 gate comment.

Key corrections across 7 files:

  • MCP servers: kind already aligned with upstream
    (McpServerApiEntity, backstage#34016). Removed all
    kind: McpServer targets and API → McpServer examples.
    Confidence: High.
  • Skills/rules: AiResource shipped upstream (#33575).
    Updated from "no RFC yet" / Low to Medium-High with
    kind/name casing alignment as remaining work.
  • Model server: candidate API / ai-model-server
    (#34476 open PR). Updated to Medium/Low with hedge.
  • AI model: no solid upstream kind. Confidence: Low.
  • Agent: not attributed to RFC #32062 (MCP-only). Fixed
    RHIDP-15302 text that incorrectly said #32062 → AIAgent.
  • Covers all 7 categories (was 5 in migration-readiness).
  • Updated CLI samples (JSON + human-readable) to show
    correct field-level transforms instead of kind renames.
  • Added TBD note for vector-store / ai-tool categories.
  • Each file cites Decision 1 as current-state SoT.

Closes #4188

Post-script verification

  • Branch is not main/master (agent/4188-reconcile-mapping-tables)
  • Secret scan passed (gitleaks — 4a8aa72ec6e2e1a2158ad6a31354455643b7a573..HEAD)
  • Pre-commit hooks passed (authoritative run on runner)
  • Tests ran inside sandbox

Rewrite mapping tables across all upstream-schema-alignment and
ai-catalog-entity-model OpenSpec files to reflect the corrected
upstream entity kind targets per Decision 1 and the #4042 gate
comment.

Key corrections across 7 files:

- MCP servers: kind already aligned with upstream
  (McpServerApiEntity, backstage#34016). Removed all
  `kind: McpServer` targets and `API → McpServer` examples.
  Confidence: High.
- Skills/rules: `AiResource` shipped upstream (#33575).
  Updated from "no RFC yet" / Low to Medium-High with
  kind/name casing alignment as remaining work.
- Model server: candidate `API` / `ai-model-server`
  (#34476 open PR). Updated to Medium/Low with hedge.
- AI model: no solid upstream kind. Confidence: Low.
- Agent: not attributed to RFC #32062 (MCP-only). Fixed
  RHIDP-15302 text that incorrectly said #32062 → AIAgent.
- Covers all 7 categories (was 5 in migration-readiness).
- Updated CLI samples (JSON + human-readable) to show
  correct field-level transforms instead of kind renames.
- Added TBD note for vector-store / ai-tool categories.
- Each file cites Decision 1 as current-state SoT.

Closes #4188
@fullsend-ai-coder fullsend-ai-coder Bot added the ready-for-review Agent PR ready for human review label Aug 6, 2026
@fullsend-ai-coder
fullsend-ai-coder Bot requested review from a team and johnmcollier as code owners August 6, 2026 12:32
@fullsend-ai-coder fullsend-ai-coder Bot added the ready-for-review Agent PR ready for human review label Aug 6, 2026
@codecov

codecov Bot commented Aug 6, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 58.30%. Comparing base (4a8aa72) to head (345d99a).
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #4189   +/-   ##
=======================================
  Coverage   58.30%   58.30%           
=======================================
  Files        2427     2427           
  Lines       96721    96721           
  Branches    26915    26925   +10     
=======================================
  Hits        56390    56390           
  Misses      38869    38869           
  Partials     1462     1462           
Flag Coverage Δ *Carryforward flag
adoption-insights 84.55% <ø> (ø) Carriedforward from 666d8ef
ai-integrations 69.76% <ø> (ø) Carriedforward from 666d8ef
app-defaults 69.79% <ø> (ø) Carriedforward from 666d8ef
augment 46.67% <ø> (ø) Carriedforward from 666d8ef
boost 76.77% <ø> (ø)
bulk-import 72.56% <ø> (ø) Carriedforward from 666d8ef
cost-management 13.55% <ø> (ø) Carriedforward from 666d8ef
dcm 67.21% <ø> (ø) Carriedforward from 666d8ef
extensions 56.59% <ø> (ø) Carriedforward from 666d8ef
global-floating-action-button 71.18% <ø> (ø) Carriedforward from 666d8ef
global-header 66.50% <ø> (ø) Carriedforward from 666d8ef
homepage 47.50% <ø> (ø) Carriedforward from 666d8ef
install-dynamic-plugins 59.95% <ø> (ø) Carriedforward from 666d8ef
intelligent-assistant 75.24% <ø> (ø) Carriedforward from 666d8ef
konflux 91.98% <ø> (ø) Carriedforward from 666d8ef
lightspeed 69.02% <ø> (ø) Carriedforward from 666d8ef
mcp-integrations 83.40% <ø> (ø) Carriedforward from 666d8ef
orchestrator 66.91% <ø> (ø) Carriedforward from 666d8ef
quickstart 63.74% <ø> (ø) Carriedforward from 666d8ef
sandbox 79.56% <ø> (ø) Carriedforward from 666d8ef
scorecard 85.98% <ø> (ø) Carriedforward from 666d8ef
theme 88.77% <ø> (ø) Carriedforward from 666d8ef
translations 5.12% <ø> (ø) Carriedforward from 666d8ef
x2a 79.20% <ø> (ø) Carriedforward from 666d8ef

*This pull request uses carry forward flags. Click here to find out more.


Continue to review full report in Codecov by Harness.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4a8aa72...345d99a. Read the comment docs.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@mareklibra mareklibra self-assigned this Aug 6, 2026
@mareklibra

Copy link
Copy Markdown
Member

/fs-fix CI issues

@fullsend-ai-coder

fullsend-ai-coder Bot commented Aug 6, 2026

Copy link
Copy Markdown
Contributor Author

🤖 Finished Fix · ✅ Success · Started 12:39 PM UTC · Completed 12:51 PM UTC
Commit: dceea2f · View workflow run →

Run prettier:fix on design.md and proposal.md to fix table column
alignment that was failing the CI prettier check.

Addresses review feedback on #4189
@fullsend-ai-coder

Copy link
Copy Markdown
Contributor Author

🔧 Fix agent — iteration 1 (human-triggered)

Fixed CI prettier failures in 2 markdown files (design.md and proposal.md) by running prettier:fix to correct table column alignment. Both 'Workspace boost, CI step for node 22' and 'Workspace boost, CI step for node 24' were failing on the prettier check step.

Fixed (2):

  1. CI prettier check failing on markdown tables (workspaces/boost/openspec/changes/upstream-schema-alignment/design.md): Applied prettier formatting to fix markdown table column alignment that caused CI prettier:check to fail
  2. CI prettier check failing on markdown tables (workspaces/boost/openspec/changes/upstream-schema-alignment/proposal.md): Applied prettier formatting to fix markdown table column alignment that caused CI prettier:check to fail

Tests: passed

Updated by fullsend fix agent

@mareklibra

Copy link
Copy Markdown
Member

/fs-review

@fullsend-ai-review

fullsend-ai-review Bot commented Aug 6, 2026

Copy link
Copy Markdown

🤖 Finished Review · ✅ Success · Started 1:23 PM UTC · Completed 1:39 PM UTC
Commit: 666d8ef · View workflow run →

@fullsend-ai-review

Copy link
Copy Markdown

Review

Findings

Medium

  • [internal-inconsistency] workspaces/boost/openspec/changes/ai-catalog-entity-model/design.md:75 — The PR updates the Context paragraph to state "Agent and AI model kinds are not yet proposed upstream," but the Migration path example in the same file still references kind: AIAgent as a concrete target: "When upstream kinds become available (e.g., kind: AIAgent), we document a transformation." This contradicts the PR's correction that no upstream agent kind exists.
    Remediation: Update the Migration path example to use a different illustration (e.g., the AiResource casing alignment for skills) or add a qualifier noting that AIAgent is hypothetical and not currently proposed upstream.

  • [stale-reference] workspaces/boost/openspec/changes/upstream-schema-alignment/design.md:56 — Decision 2's bullet-list description still says "Proposed RFC kind" and "Confidence level (high/medium/low)," but the PR updated the table header to "Upstream Target" and the confidence definitions to a four-tier system (High / Medium–High / Medium/Low / Low). The bullets were not updated to match.
    Remediation: Change "Proposed RFC kind" to "Upstream target kind" and "Confidence level (high/medium/low)" to "Confidence level (high/medium–high/medium–low/low)."

  • [stale-reference] workspaces/boost/openspec/changes/upstream-schema-alignment/tasks.md:54 — Tasks 4.7 and 5.3 still reference "RFC #33060," which the PR's own changes (tasks 1.5, 1.6, 1.6a, 1.6b) replace with specific upstream targets (#34016, #33575, #34476). The tasks are internally inconsistent.
    Remediation: Update tasks 4.7 and 5.3 to reference the current upstream targets: #34016 (McpServerApiEntity), #33575 (AiResource), #34476 (model-server candidate).

Low

  • [stale-identifier-reference] workspaces/boost/openspec/changes/ai-catalog-entity-model/specs/annotation-scheme/spec.md:108 — Not in diff. Example maps AIResource + ai-agent + agent → AIAgent, presenting AIAgent as a target upstream kind. The PR establishes that no upstream agent kind exists.

  • [stale-identifier-reference] workspaces/boost/openspec/changes/ai-catalog-entity-model/proposal.md:7 — Not in diff. References "RFCs #32062, #33060" as if both define new entity kinds. RFC #33060 is no longer the correct reference.

  • [stale-reference] workspaces/boost/openspec/changes/upstream-schema-alignment/design.md:491 — Decision 5 prescribes the dry-run tool footer as "pending RFC finalization" but the PR updated the tooling spec output to "pending upstream stabilization." The design doc was not updated to match.

  • [edge-case] workspaces/boost/openspec/changes/ai-catalog-entity-model/specs/migration-readiness/spec.md:68 — The "Entity refs change format" scenario shows identical WHEN/THEN entity refs (airesource:default/my-skill). Backstage uses lowercase kind prefixes, so AIResourceAiResource does not change the ref string. The scenario title is misleading for this example, though the model-server example later in the scenario does demonstrate a real change.

  • [naming-convention] workspaces/boost/openspec/changes/upstream-schema-alignment/specs/migration-readiness-tooling/spec.md — Inconsistent dash characters for the medium-high confidence label: design/proposal tables use en-dash (Medium–High), tooling spec JSON uses ASCII hyphen (medium-high), human-readable output uses ASCII hyphen (Medium-High).

  • [stale-identifier-reference] workspaces/boost/specifications/boost-frontend-architecture.md:208 — Not in diff. Entity mapping table says "RFC #33060 pending."

  • [stale-identifier-reference] workspaces/boost/openspec/changes/ai-catalog-frontend/design.md:113 — Not in diff. Entity mapping table says "RFC #33060 pending."


Labels: All changes are documentation files under workspaces/boost/openspec/, matching the workspace/boost and documentation labels.

@fullsend-ai-review fullsend-ai-review Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

See the review comment for full details.


Note: The following inline comments could not be posted on the diff (GitHub returned 422) and are included here instead:

  • workspaces/boost/openspec/changes/ai-catalog-entity-model/design.md (file-level): Line 75 · [medium] internal-inconsistency

The PR updates the Context paragraph to state 'Agent and AI model kinds are not yet proposed upstream,' but the Migration path example in the same file still references kind: AIAgent as a concrete target. This contradicts the PR's correction that no upstream agent kind exists.

Suggested fix: Update the Migration path example to use a different illustration (e.g., AiResource casing alignment for skills) or add a qualifier noting that AIAgent is hypothetical.

  • workspaces/boost/openspec/changes/upstream-schema-alignment/design.md:56: [medium] stale-reference

Decision 2's bullet-list description still says 'Proposed RFC kind' and 'Confidence level (high/medium/low),' but the PR updated the table header to 'Upstream Target' and the confidence definitions to a four-tier system. The bullets were not updated to match.

Suggested fix: Change 'Proposed RFC kind' to 'Upstream target kind' and update the confidence level list to match the four-tier taxonomy.

  • workspaces/boost/openspec/changes/upstream-schema-alignment/tasks.md (file-level): Line 54 · [medium] stale-reference

Tasks 4.7 and 5.3 still reference 'RFC #33060,' which the PR's own changes (tasks 1.5, 1.6, 1.6a, 1.6b) replace with specific upstream targets (#34016, #33575, #34476).

Suggested fix: Update tasks 4.7 and 5.3 to reference the current upstream targets: #34016 (McpServerApiEntity), #33575 (AiResource), #34476 (model-server candidate).

  • workspaces/boost/openspec/changes/upstream-schema-alignment/design.md (file-level): Line 491 · [low] stale-reference

Decision 5 prescribes the dry-run tool footer as 'pending RFC finalization' but the tooling spec output was updated to 'pending upstream stabilization.'

Suggested fix: Update Decision 5 footer text to 'pending upstream stabilization.'

  • workspaces/boost/openspec/changes/ai-catalog-entity-model/specs/migration-readiness/spec.md:68: [low] edge-case

The 'Entity refs change format' scenario shows identical WHEN/THEN entity refs (airesource:default/my-skill). Backstage uses lowercase kind prefixes, so AIResource to AiResource does not change the ref string. The scenario title is misleading for this example.

@fullsend-ai-review fullsend-ai-review Bot added requires-manual-review Review requires human judgment workspace/boost Boost workspace (Backstage AI plugin) documentation Improvements or additions to documentation labels Aug 6, 2026
@mareklibra

Copy link
Copy Markdown
Member

/fs-fix per review comments so far

@fullsend-ai-coder

fullsend-ai-coder Bot commented Aug 6, 2026

Copy link
Copy Markdown
Contributor Author

🤖 Finished Fix · ✅ Success · Started 1:43 PM UTC · Completed 2:00 PM UTC
Commit: 666d8ef · View workflow run →



- Replace hypothetical AIAgent migration example with actual AiResource
  casing alignment example in ai-catalog-entity-model/design.md
- Update Decision 2 bullet list to say "Upstream target kind" and
  four-tier confidence in upstream-schema-alignment/design.md
- Replace stale RFC #33060 references in tasks 4.7 and 5.3 with
  current upstream targets (#34016, #33575, #34476)
- Update annotation-scheme/spec.md example to use AiResource mapping
- Replace RFC #33060 reference in ai-catalog-entity-model/proposal.md
- Align Decision 5 footer text to "pending upstream stabilization"
- Fix entity refs scenario to clarify no ref change for casing-only
  alignment (Backstage lowercases kind prefixes)
- Standardize en-dash in human-readable Medium–High confidence label
- Update RFC #33060 references in boost-frontend-architecture.md
  and ai-catalog-frontend/design.md

Addresses review feedback on #4189
@fullsend-ai-coder

Copy link
Copy Markdown
Contributor Author

🔧 Fix agent — iteration 2 (human-triggered)

Addressed all 10 review findings (3 medium, 7 low). Fixed stale RFC #33060 references across 5 files, resolved internal inconsistency with AIAgent migration example, aligned Decision 2 bullet list and Decision 5 footer text with current content, clarified entity refs scenario for casing-only changes, and standardized en-dash usage in confidence labels.

Fixed (10):

  1. internal-inconsistency: Migration path example references AIAgent as concrete target (workspaces/boost/openspec/changes/ai-catalog-entity-model/design.md): Replaced hypothetical AIAgent migration example with actual AiResource casing alignment example for skills, which is a known upstream migration
  2. stale-reference: Decision 2 bullet list says 'Proposed RFC kind' and three-tier confidence (workspaces/boost/openspec/changes/upstream-schema-alignment/design.md): Changed 'Proposed RFC kind' to 'Upstream target kind' and updated confidence level list to match four-tier taxonomy (high/medium-high/medium-low/low)
  3. stale-reference: Tasks 4.7 and 5.3 reference RFC #33060 (workspaces/boost/openspec/changes/upstream-schema-alignment/tasks.md): Replaced RFC #33060 references in tasks 4.7 and 5.3 with current upstream targets: #34016 (McpServerApiEntity), #33575 (AiResource), #34476 (model-server candidate)
  4. stale-identifier-reference: Example maps AIResource + ai-agent to AIAgent (workspaces/boost/openspec/changes/ai-catalog-entity-model/specs/annotation-scheme/spec.md): Updated example to use real mapping: AIResource + skill + skill to AiResource casing alignment
  5. stale-identifier-reference: References RFCs #32062, #33060 (workspaces/boost/openspec/changes/ai-catalog-entity-model/proposal.md): Replaced stale RFC references with current upstream targets: McpServerApiEntity via #34016 and AiResource via #33575
  6. stale-reference: Decision 5 footer text says pending RFC finalization (workspaces/boost/openspec/changes/upstream-schema-alignment/design.md): Updated footer text to 'pending upstream stabilization' to match the tooling spec output
  7. edge-case: Entity refs scenario shows identical WHEN/THEN refs (workspaces/boost/openspec/changes/ai-catalog-entity-model/specs/migration-readiness/spec.md): Rewrote scenario to lead with model-server kind change (real ref change) and clarify that skill casing changes do not affect entity refs because Backstage lowercases kind prefixes
  8. naming-convention: Inconsistent dash characters for medium-high confidence label (workspaces/boost/openspec/changes/upstream-schema-alignment/specs/migration-readiness-tooling/spec.md): Changed ASCII hyphen to en-dash in human-readable output (Medium-High to Medium-High with en-dash) to match the formal confidence level definitions
  9. stale-identifier-reference: Entity mapping table says RFC #33060 pending (workspaces/boost/specifications/boost-frontend-architecture.md): Replaced 'RFC #33060 pending - may move to API with ai-model-server type' with 'No solid upstream kind yet'
  10. stale-identifier-reference: Entity mapping table says RFC #33060 pending (workspaces/boost/openspec/changes/ai-catalog-frontend/design.md): Replaced 'RFC #33060 pending' with 'No solid upstream kind yet'

Tests: passed

Updated by fullsend fix agent

@sonarqubecloud

sonarqubecloud Bot commented Aug 6, 2026

Copy link
Copy Markdown

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation ready-for-review Agent PR ready for human review requires-manual-review Review requires human judgment workspace/boost Boost workspace (Backstage AI plugin)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs(boost): reconcile current→upstream AI-asset mapping tables (split from #4042)

1 participant