Skip to content

docs: update API documentation, static OpenAPI file, and Swagger/Redoc display - #27

Merged
coolert merged 1 commit into
mainfrom
docs/update-api-docs-and-openapi-static
Dec 7, 2025
Merged

coolert merged 1 commit into
mainfrom
docs/update-api-docs-and-openapi-static

Conversation

@coolert

@coolert coolert commented Dec 7, 2025

Copy link
Copy Markdown
Owner

PR Summary

This PR updates the API documentation presentation, introduces a static OpenAPI
file for both local and production Swagger/Redoc views, and removes the previous
Laravel route used for serving openapi.yaml.

These changes ensure a consistent, production-ready API documentation experience.


Changes

OpenAPI

  • Updated docs/openapi/openapi.yaml with the correct production server:
    • https://api.task.coolerk.com

README

  • Added live production documentation links:
    • Swagger → https://api.task.coolerk.com/swagger.html
    • Redoc → https://api.task.coolerk.com/redoc.html
  • Updated local documentation URLs for consistency.

Public Assets

  • Added public/openapi/openapi.yaml to allow Swagger/Redoc to load specs without
    relying on Laravel routing.
  • Updated public/swagger.html to load "/openapi/openapi.yaml".
  • Updated public/redoc.html accordingly.

Routes

  • Removed old /openapi.yaml Laravel route that previously served the spec file.

Type of Change

  • Feature
  • Fix
  • Docs
  • Refactor
  • CI
  • Other

@coolert
coolert merged commit 9298f69 into main Dec 7, 2025
2 checks passed
@coolert
coolert deleted the docs/update-api-docs-and-openapi-static branch December 9, 2025 12:33
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