Introducing Labels Attribute for API Configuration

[O-sura]

Problem

Currently, the API YAML configuration lacks a mechanism to attach API-specific metadata or properties. These attributes can be used to enable advanced processing in platform features such as analytics, policy enforcement, and operational workflows. The initial requirement for these attributes arose from the need to pass the project ID associated with an API to the analytics system.

Proposed solution:

Adding a labels attribute to the API YAML configuration's metadata section. This will be a key-value map that allows users to attach arbitrary metadata to their APIs.

Location : metadata.labels in the API YAML structure
Type : Map of string key-value pairs
Storage : Labels are persisted in both in-memory storage and database

This data will be shared with policy engine via the previously introduced generic xDS resource path making it accessible through policies as well

Example API YAML with labels:

apiVersion: api-platform.wso2.com/v1alpha1
kind: RestApi
metadata:
  name: weather-api-v1.0
  labels:
    environment: production
    project-id: 64dd249daaa7030e44ec619054516e39
spec:
  displayName: Weather API
  version: v1.0
  context: /weather
  # ... rest of the spec

[pubudu538]

Where do we keep the Devportal related information like docs, image, etc? We need to think through the CI/CD flow and look at how we pass the deployment related information.

[renuka-fernando]

hi @pubudu538

This proposal is for Gateway API/LLM Proxy/LLM Provider YAML files. We are going to use the same Labels feature in K8s, so this YAML file is aligned with K8s YAML.

You are referring to the API Project file, which contains a thumbnail file, API docs, etc., but here we discussed adding Labels for API YAML and how it is passed to the Policy Engine.

[O-sura]

This is completed. Closing the discussion.