docs: update API documentation, static OpenAPI file, and Swagger/Redoc display #27
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
docs/openapi/openapi.yamlwith the correct production server:https://api.task.coolerk.comREADME
https://api.task.coolerk.com/swagger.htmlhttps://api.task.coolerk.com/redoc.htmlPublic Assets
public/openapi/openapi.yamlto allow Swagger/Redoc to load specs withoutrelying on Laravel routing.
public/swagger.htmlto load"/openapi/openapi.yaml".public/redoc.htmlaccordingly.Routes
/openapi.yamlLaravel route that previously served the spec file.Type of Change