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

Open

Charon wants to merge 1 commit from feat/openapi-docs into dev

Charon commented

2026-03-24 13:50:16 +00:00

Member

Fixes #33

Summary

Adds a comprehensive OpenAPI 3.0 YAML specification at docs/openapi.yaml documenting all REST API endpoints exposed by the php-tenant package:

Workspace API (7 endpoints) — CRUD, switching, session auth and API key auth variants
Entitlement Provisioning API (6 endpoints) — Blesta integration: create, show, suspend, unsuspend, cancel, renew
Cross-App Entitlement API (4 endpoints) — Feature access checks, usage recording, summaries
Entitlement Webhooks API (11 endpoints) — Full CRUD, test delivery, secret rotation, circuit-breaker reset, delivery history and retry

Includes all request/response schemas, authentication methods (session + API key), validation error formats, pagination structures, and enum values derived from the actual codebase.

Test plan

Validate YAML parses correctly (confirmed via yaml.safe_load)
Import into Swagger Editor / Redoc to verify rendering
Cross-check endpoint paths against route files and test suite

🤖 Generated with Claude Code

Fixes #33 ## Summary Adds a comprehensive OpenAPI 3.0 YAML specification at `docs/openapi.yaml` documenting all REST API endpoints exposed by the php-tenant package: - **Workspace API** (7 endpoints) — CRUD, switching, session auth and API key auth variants - **Entitlement Provisioning API** (6 endpoints) — Blesta integration: create, show, suspend, unsuspend, cancel, renew - **Cross-App Entitlement API** (4 endpoints) — Feature access checks, usage recording, summaries - **Entitlement Webhooks API** (11 endpoints) — Full CRUD, test delivery, secret rotation, circuit-breaker reset, delivery history and retry Includes all request/response schemas, authentication methods (session + API key), validation error formats, pagination structures, and enum values derived from the actual codebase. ## Test plan - [ ] Validate YAML parses correctly (confirmed via `yaml.safe_load`) - [ ] Import into Swagger Editor / Redoc to verify rendering - [ ] Cross-check endpoint paths against route files and test suite 🤖 Generated with [Claude Code](https://claude.com/claude-code)

Charon added 1 commit 2026-03-24 13:50:16 +00:00

docs: add OpenAPI 3.0 specification for all API endpoints 84cabeffd4

Comprehensive machine-readable API documentation covering all REST
endpoints exposed by the php-tenant package:

- Workspace API (CRUD, switching, session and API key auth)
- Entitlement Provisioning API (Blesta: create, suspend, unsuspend, cancel, renew)
- Cross-App Entitlement API (check, usage recording, summary)
- Entitlement Webhooks API (CRUD, test, secret rotation, circuit breaker, deliveries)

Includes full request/response schemas, authentication details, error
responses, and pagination structures.

Fixes #33

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

This pull request can be merged automatically.

You are not authorized to merge this pull request.

View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.

git fetch -u origin feat/openapi-docs:feat/openapi-docs

git checkout feat/openapi-docs

Merge

Merge the changes and update on Forgejo.

Warning: The "Autodetect manual merge" setting is not enabled for this repository, you will have to mark this pull request as manually merged afterwards.

git checkout dev

git merge --no-ff feat/openapi-docs

git checkout feat/openapi-docs

git rebase dev

git checkout dev

git merge --ff-only feat/openapi-docs

git checkout feat/openapi-docs

git rebase dev

git checkout dev

git merge --no-ff feat/openapi-docs

git checkout dev

git merge --squash feat/openapi-docs