Add Backstage catalog descriptors for the service and API #61

Closed
opened 2026-11-21 21:12:49 +00:00 by martin · 4 comments
Owner

Summary

Make the recurring-events service and its API discoverable from repository-owned catalog metadata.

Context

The repository owns the root openapi.yaml contract, but has no root catalog-info.yaml. The Backstage portal currently represents the Component recurring-events and API recurring-events-api in its central example catalog.

Scope

  • Add a root descriptor for the recurring-events Component and its API.
  • Verify owner, lifecycle, system membership, and links; preserve stable entity refs and the existing Component-to-API relationship.
  • Reference this repository's OpenAPI contract as the API definition.

Acceptance criteria

  • The descriptor validates and defines stable Component:default/recurring-events and API:default/recurring-events-api entities.
  • The Component provides the API, and the API definition loads from this repository's openapi.yaml.
  • Ownership, lifecycle, system membership, repository/service links, and referenced entity refs are accurate.
  • The descriptor is ready for Backstage discovery without duplicate entity refs.
## Summary Make the recurring-events service and its API discoverable from repository-owned catalog metadata. ## Context The repository owns the root openapi.yaml contract, but has no root catalog-info.yaml. The Backstage portal currently represents the Component recurring-events and API recurring-events-api in its central example catalog. ## Scope - Add a root descriptor for the recurring-events Component and its API. - Verify owner, lifecycle, system membership, and links; preserve stable entity refs and the existing Component-to-API relationship. - Reference this repository's OpenAPI contract as the API definition. ## Acceptance criteria - [x] The descriptor validates and defines stable Component:default/recurring-events and API:default/recurring-events-api entities. - [x] The Component provides the API, and the API definition loads from this repository's openapi.yaml. - [x] Ownership, lifecycle, system membership, repository/service links, and referenced entity refs are accurate. - [x] The descriptor is ready for Backstage discovery without duplicate entity refs. ## Related - Personal/backstage#28 tracks the catalog support and depends on this repository change.
Author
Owner

Progress

  • Opened PR #62 adding Component and API descriptors backed by this repository's openapi.yaml.
  • Backstage YAML parsing and Component/API schema validation passed after resolving $text against the local OpenAPI file; refs are unique and git diff --check passed. End-to-end catalog ingestion remains to be verified in Personal/backstage#28. The PR is open and not merged.
## Progress - Opened [PR #62](https://code.martials.no/Personal/recurring-events/pulls/62) adding Component and API descriptors backed by this repository's `openapi.yaml`. - Backstage YAML parsing and Component/API schema validation passed after resolving `$text` against the local OpenAPI file; refs are unique and `git diff --check` passed. End-to-end catalog ingestion remains to be verified in Personal/backstage#28. The PR is open and not merged.
Author
Owner

Progress

  • PR #62 was merged as 9fcbb2a8eeeeb6d49c727dd6a73256e8fcffb472; the root descriptor now defines the Component and API on main.
  • Backstage descriptor parsing and Component/API schema validation passed after resolving $text against the repository's OpenAPI file; entity refs are unique and git diff --check passed. End-to-end catalog ingestion and API rendering remain to be verified under Personal/backstage#28.
## Progress - [PR #62](https://code.martials.no/Personal/recurring-events/pulls/62) was merged as `9fcbb2a8eeeeb6d49c727dd6a73256e8fcffb472`; the root descriptor now defines the Component and API on `main`. - Backstage descriptor parsing and Component/API schema validation passed after resolving `$text` against the repository's OpenAPI file; entity refs are unique and `git diff --check` passed. End-to-end catalog ingestion and API rendering remain to be verified under Personal/backstage#28.
Author
Owner

Progress

  • The central recurring-events-api example registration was removed by merged Personal/backstage#56 (86487c2fe5e2318710f0d16a7665e0b1cbb64a10), so the repository descriptor is now the catalog source for that API.
  • The end-to-end Backstage relation and API-rendering check is still outstanding; the local E2E environment is blocked by a better-sqlite3 Node ABI mismatch. This issue remains open until that behavior is verified.
## Progress - The central `recurring-events-api` example registration was removed by merged Personal/backstage#56 (`86487c2fe5e2318710f0d16a7665e0b1cbb64a10`), so the repository descriptor is now the catalog source for that API. - The end-to-end Backstage relation and API-rendering check is still outstanding; the local E2E environment is blocked by a `better-sqlite3` Node ABI mismatch. This issue remains open until that behavior is verified.
Author
Owner

Completed by merged PR #62 (9fcbb2a8eeeeb6d49c727dd6a73256e8fcffb472). In an isolated Backstage run against the live public Forgejo descriptors, the Component and API imported once, the API definition resolved from openapi.yaml, the Component/API and System relations resolved, and owner/lifecycle/project annotations and repository/service links matched expectations. The controlled fixture E2E suite also passed all 5 tests.

Completed by merged [PR #62](https://code.martials.no/Personal/recurring-events/pulls/62) (`9fcbb2a8eeeeb6d49c727dd6a73256e8fcffb472`). In an isolated Backstage run against the live public Forgejo descriptors, the Component and API imported once, the API definition resolved from `openapi.yaml`, the Component/API and System relations resolved, and owner/lifecycle/project annotations and repository/service links matched expectations. The controlled fixture E2E suite also passed all 5 tests.
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Reference
Personal/recurring-events#61
No description provided.