Describe recurring-events and its API in the repository catalog #54

Closed
opened 2026-11-21 21:10:29 +00:00 by martin · 1 comment
Owner

Summary

Make the recurring-events service and its API self-describing in the owning Forgejo repository so Backstage can discover both from repository-owned metadata.

Context

The portal currently defines the recurring-events Component and recurring-events-api API in central example catalog files. The Personal/recurring-events repository contains openapi.yaml but does not currently have a root catalog-info.yaml.

Scope

  • Add a root descriptor to Personal/recurring-events for its Component and API.
  • Keep entity refs stable, include accurate owner/lifecycle/system and repository/service links, and derive the API definition from the repository's OpenAPI file.
  • Reconcile central example registrations so discovery does not register duplicate entities.

Acceptance criteria

  • The repository descriptor validates and defines the stable recurring-events Component and recurring-events-api API.
  • The Component provides the API, and Backstage resolves the relation and renders the API definition from the repository's OpenAPI file.
  • Ownership, lifecycle, system membership, and links are accurate and resolve to cataloged entities.
  • Central catalog sources no longer create duplicate Component or API refs after Forgejo discovery imports the descriptor.
  • Controlled API/browser tests verify the relationship without requiring live Forgejo.
## Summary Make the recurring-events service and its API self-describing in the owning Forgejo repository so Backstage can discover both from repository-owned metadata. ## Context The portal currently defines the recurring-events Component and recurring-events-api API in central example catalog files. The Personal/recurring-events repository contains openapi.yaml but does not currently have a root catalog-info.yaml. ## Scope - Add a root descriptor to Personal/recurring-events for its Component and API. - Keep entity refs stable, include accurate owner/lifecycle/system and repository/service links, and derive the API definition from the repository's OpenAPI file. - Reconcile central example registrations so discovery does not register duplicate entities. ## Acceptance criteria - [ ] The repository descriptor validates and defines the stable recurring-events Component and recurring-events-api API. - [ ] The Component provides the API, and Backstage resolves the relation and renders the API definition from the repository's OpenAPI file. - [ ] Ownership, lifecycle, system membership, and links are accurate and resolve to cataloged entities. - [ ] Central catalog sources no longer create duplicate Component or API refs after Forgejo discovery imports the descriptor. - [ ] Controlled API/browser tests verify the relationship without requiring live Forgejo. ## Related - Personal/backstage#28 tracks the overall capability and depends on this pilot work.
Author
Owner

Superseded: this repository-level task now lives with the code it changes at Personal/recurring-events#61. Continue there; this issue is being closed to avoid duplicate tracking.

Superseded: this repository-level task now lives with the code it changes at [Personal/recurring-events#61](https://code.martials.no/Personal/recurring-events/issues/61). Continue there; this issue is being closed to avoid duplicate tracking.
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.

Dependencies

No dependencies set

Reference
Personal/backstage#54
No description provided.