core/php-tenant
8
0
Fork 0
Code Issues 39 Pull requests Projects Releases Packages Wiki Activity Actions 3

docs: add OpenAPI/Swagger documentation for all API endpoints #33

New issue
Open
opened 2026-02-20 16:39:53 +00:00 by Clotho · 0 comments
Clotho commented 2026-02-20 16:39:53 +00:00
Member
Copy link

Problem

The package exposes multiple REST API endpoints but has no machine-readable API documentation. External developers integrating with the Entitlement API, Workspace API, or Webhook API have no reference beyond reading source code.

Endpoints to document

  • GET/POST/PUT/DELETE /api/v1/workspaces (WorkspaceController)
  • GET /api/v1/entitlements/check (EntitlementApiController)
  • POST /api/v1/entitlements/usage (EntitlementApiController)
  • GET /api/v1/entitlements/summary (EntitlementApiController)
  • POST/GET/PUT/DELETE /api/v1/entitlement-webhooks (EntitlementWebhookController)
  • Blesta provisioning endpoints

Acceptance Criteria

  • Add dedoc/scramble or darkaonline/l5-swagger to dev dependencies
  • Add OpenAPI annotations to all controller methods
  • Include authentication requirements, request schemas, and response schemas
  • Generate and commit openapi.json or host via route

Discovered during automated scan (issue #3)

## Problem The package exposes multiple REST API endpoints but has no machine-readable API documentation. External developers integrating with the Entitlement API, Workspace API, or Webhook API have no reference beyond reading source code. ## Endpoints to document - `GET/POST/PUT/DELETE /api/v1/workspaces` (WorkspaceController) - `GET /api/v1/entitlements/check` (EntitlementApiController) - `POST /api/v1/entitlements/usage` (EntitlementApiController) - `GET /api/v1/entitlements/summary` (EntitlementApiController) - `POST/GET/PUT/DELETE /api/v1/entitlement-webhooks` (EntitlementWebhookController) - Blesta provisioning endpoints ## Acceptance Criteria - Add `dedoc/scramble` or `darkaonline/l5-swagger` to dev dependencies - Add OpenAPI annotations to all controller methods - Include authentication requirements, request schemas, and response schemas - Generate and commit `openapi.json` or host via route _Discovered during automated scan (issue #3)_
Clotho added the
discovery
docs
P3
 labels 2026-02-20 16:39:53 +00:00
Clotho was assigned by Charon 2026-02-20 23:46:45 +00:00
Charon added the
agent-ready
 label 2026-02-21 01:31:51 +00:00
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
main
feat/discovery-scan-issue-3
feat/phase-0-assessment
dev
No results found.
Labels
Clear labels   
P1

Priority 1 - Critical

  
P2

Priority 2 - Important

  
P3

Priority 3 - Nice to have

  
PHP

PHP codebase

  
agent-ready

   
bug

Bug fix

  
clotho

Assigned to Clotho AI agent

  
discovery

Auto-discovered by agent

  
docs

Documentation

  
epic

   
refactor

Code quality refactoring

  
review

Needs human review

  
security

Security hardening

  
testing

Test coverage

  
athena

Assign to Athena AI agent (M3 Ultra)

  
athena-gemini

Dispatch to Gemini CLI on M3 Ultra

  
audit

Code audit task

  
clotho

Assign to Clotho AI agent for processing

  
clotho-gemini

Dispatch to Gemini CLI on darbs (AU)

  
codex

Dispatch to Codex CLI on gateway for analysis

  
darbs-claude

Dispatch to Claude on darbs (AU)

  
security

Security review task

  
wiki

Documentation/wiki update

No labels
P1
P2
P3
PHP
agent-ready
bug
clotho
discovery
docs
epic
refactor
review
security
testing
athena
athena-gemini
audit
clotho
clotho-gemini
codex
darbs-claude
security
wiki
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
Clotho
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: core/php-tenant#33
No description provided.
Delete branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?