Skip to content

Add OpenAPI docs with examples and status codes#8

Merged
GusAlberto merged 1 commit into
mainfrom
feat/openapi-docs
May 22, 2026
Merged

Add OpenAPI docs with examples and status codes#8
GusAlberto merged 1 commit into
mainfrom
feat/openapi-docs

Conversation

@GusAlberto

Copy link
Copy Markdown
Owner

Adds Scramble-based OpenAPI/Swagger documentation for the product API.

Included:

  • Generated docs UI at /docs/api and JSON at /docs/api.json
  • Query parameter examples for listing and filtering products
  • Request payload examples for create/update endpoints
  • Explicit response status documentation for success responses
  • README instructions for accessing the generated docs

Validation:

  • php artisan test --testsuite=Feature

@GusAlberto GusAlberto self-assigned this May 22, 2026
@GusAlberto GusAlberto added the documentation Improvements or additions to documentation label May 22, 2026
@GusAlberto GusAlberto merged commit 4a40d8f into main May 22, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant