Files
git.stella-ops.org/docs/features/unchecked/web/web-gateway-openapi-discovery-with-deprecation-and-idempotency.md

1.9 KiB

Web Gateway OpenAPI Discovery with Deprecation and Idempotency

Module

Web

Status

IMPLEMENTED

Description

Gateway OpenAPI discovery endpoint with ETag caching, standard error envelope migration, cursor pagination normalization, Idempotency-Key support, and deprecation header middleware with Sunset link emission.

Implementation Details

  • Feature directory: src/Web/StellaOps.Web/src/app/core/api/
  • Services:
    • gateway-metrics (src/Web/StellaOps.Web/src/app/core/api/gateway-metrics.service.ts)
    • policy-interop (src/Web/StellaOps.Web/src/app/core/api/policy-interop.service.ts)
    • reachability-integration (src/Web/StellaOps.Web/src/app/core/api/reachability-integration.service.ts)
    • vuln-export-orchestrator (src/Web/StellaOps.Web/src/app/core/api/vuln-export-orchestrator.service.ts)
  • Models:
    • src/Web/StellaOps.Web/src/app/core/api/advisories.models.ts
    • src/Web/StellaOps.Web/src/app/core/api/advisory-ai.models.ts
    • src/Web/StellaOps.Web/src/app/core/api/ai-runs.models.ts
    • src/Web/StellaOps.Web/src/app/core/api/analytics.models.ts
    • src/Web/StellaOps.Web/src/app/core/api/aoc.models.ts
  • Source: SPRINT_0214_0001_0001_web_iii.md

E2E Test Plan

  • Setup:
    • Log in with a user that has appropriate permissions
    • Navigate to the relevant page/section where this feature appears
    • Ensure test data exists (scanned artifacts, SBOM data, or seed data as needed)
  • Core verification:
    • Verify the component renders correctly with sample data
    • Verify interactive elements respond to user input
    • Verify data is fetched and displayed from the correct API endpoints
  • Edge cases:
    • Verify graceful handling when backend API is unavailable (error state)
    • Verify responsive layout at different viewport sizes
    • Verify accessibility (keyboard navigation, screen reader labels, ARIA attributes)