Skip to content

feat(customersupport): document the API with development Swagger UI - #18

Merged
amasen02 merged 5 commits into
masterfrom
feat/support-openapi-ui-2026-09-13
Sep 12, 2026
Merged

feat(customersupport): document the API with development Swagger UI#18
amasen02 merged 5 commits into
masterfrom
feat/support-openapi-ui-2026-09-13

Conversation

@amasen02

@amasen02 amasen02 commented Sep 12, 2026

Copy link
Copy Markdown
Owner

Fixes #4.

Customer Support now serves a self-hosted Swagger UI at /swagger in Development, using the existing ASP.NET Core OpenAPI document. Carter/Minimal API summaries and typed response metadata document the three support operations; tests resolve schema references and verify session/message properties and pagination envelopes. Production exposes neither the UI nor the document.

The API's strict CSP and authorization remain intact. Development Swagger routes permit self-hosted assets and one exact SHA-256 hash for the bundled logo's inline SVG style; external validation is disabled. Setup guides use HTTPS and accurately describe the embedded dashboard/support-console routes.

Validation at 2ff5e13: all9 hosted checks pass;59 CustomerSupport tests pass with zero skipped; Chromium, Firefox and WebKit each execute both customer journeys against the merged HTTPS frontend40ed245. CI captures actual documentation responses and headers. Browser-harness rendering shows all3 operations/all14 expected model properties, no CSP/runtime errors, and only same-origin200 resources. All8 final captured body hashes and CSP headers match the browser-verified fixture. Windows Application Control blocks local assembly execution; Linux CI provides the full-suite proof.

@github-actions github-actions Bot added documentation Improvements or additions to documentation ci area/customersupport labels Sep 12, 2026
@amasen02
amasen02 marked this pull request as ready for review September 12, 2026 22:35
@amasen02
amasen02 merged commit 518aab1 into master Sep 12, 2026
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/customersupport ci documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: add OpenAPI / Swagger UI endpoint documentation for Customer Support service

1 participant