Skip to content

Add OpenAPI/Scalar descriptions and scope CI to source paths#2

Merged
rockfordlhotka merged 3 commits intomainfrom
feat/openapi-scalar-descriptions
Feb 26, 2026
Merged

Add OpenAPI/Scalar descriptions and scope CI to source paths#2
rockfordlhotka merged 3 commits intomainfrom
feat/openapi-scalar-descriptions

Conversation

@rockfordlhotka
Copy link
Copy Markdown
Member

Summary

  • All 22 endpoints now have .WithSummary(), .WithDescription(), .Produces<T>(), and .ProducesProblem() annotations — Scalar is fully documented out of the box
  • Added .WithTags() to the Agents and API Keys groups (previously only protocol endpoints were tagged)
  • List/filter endpoints document all query parameters in markdown
  • Bootstrap endpoint description explains the X-Bootstrap-Token header and dark-by-default behaviour
  • CI paths filter added so pushes that only touch docs/, k8s/, README.md, etc. skip the build job entirely

Test plan

  • dotnet build clean (0 errors)
  • All 112 tests pass
  • Verify Scalar at /scalar/v1 shows summaries, descriptions, and response codes for all endpoints

🤖 Generated with Claude Code

rockfordlhotka and others added 3 commits February 26, 2026 01:39
Every endpoint now has .WithSummary(), .WithDescription(), .Produces<T>(),
and .ProducesProblem() annotations, making Scalar fully useful out of the box.

- Agents group: added .WithTags("Agents"), documented all 8 endpoints
  including liveness model details for heartbeat and renew
- Discovery: tagged with "Agents", documented all 7 query parameters
- API Keys: added .WithTags("API Keys"), documented bootstrap endpoint's
  X-Bootstrap-Token header and dark-by-default behaviour
- A2A, MCP, ACP: summaries, descriptions, and response codes on all
  9 protocol endpoints; list endpoints include filter parameter docs

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Avoids running build and test on doc, k8s, or README-only changes.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@rockfordlhotka rockfordlhotka merged commit 0d0864a into main Feb 26, 2026
1 check passed
@rockfordlhotka rockfordlhotka deleted the feat/openapi-scalar-descriptions branch February 26, 2026 07:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant