Expose API Lifecycle and Domain in IDP Catalog HQL
Z
Zinc grey Swordtail
Problem:
We are building an API Governance Dashboard using Harness HD Dashboards and need to filter and report APIs based on their lifecycle and domain.
These fields are available in the API catalog entity YAML under spec:
apiVersion: backstage.io/v1alpha1
kind: API
metadata:
name: example-api
spec:
type: openapi
lifecycle: production
domain: domain:cards
owner: group:account/card_services_team
However, the l:idp:catalog entity currently exposes only the following fields for HQL queries:
kind
name
type
owner
tags
identifier
entity_ref
created_at
last_updated_at
The nested spec.lifecycle and spec.domain values are ingested into the catalog but are not available as queryable fields.
We also noticed that idp:api contains a lifecycle field in its schema, but the field currently does not return any data.
Requested Enhancement:
Expose the following fields as top-level queryable fields on l:idp:catalog:
lifecycle — sourced from spec.lifecycle
domain — sourced from spec.domain
Alternative:
Populate the idp:api entity with the corresponding catalog data so that the existing lifecycle field can be queried and a domain field can also be exposed.
Business Need:
This capability is required to build an API Governance Dashboard that can:
Filter APIs by lifecycle — production, experimental, deprecated
Filter APIs by domain — cards, payments, accounts, etc.
Identify APIs that are missing lifecycle or domain metadata
Track API governance and metadata compliance across the organization
Expected Outcome:
API lifecycle and domain information should be available as HQL-queryable fields in Harness HD Dashboards, allowing customers to build governance dashboards without maintaining a separate data source or duplicating catalog metadata.
Log In