feat: comprehensive API documentation (OpenAPI + Swagger UI + Postman)#445
Merged
Merged
Conversation
…nicee#358) - Add docs/openapi.yml: OpenAPI 3.0 spec covering /health, /api/merchants, /api/merchants/:id, /api/payments, /api/payments/:id with full request/ response schemas, error responses, pagination and rate-limiting notes - Add docs/pulsar-api.postman_collection.json: Postman collection with all endpoints and environment variables - Add .github/workflows/publish-api-docs.yml: deploys Swagger UI to GitHub Pages on every push to main that modifies the spec Closes devEunicee#358
|
@ocheeluma Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
Implements complete API documentation with OpenAPI 3.0 spec, hosted Swagger UI, and Postman collection, resolving #358.
Changes
docs/openapi.yml— OpenAPI 3.0.3 specification covering:GET /health,POST/GET /api/merchants,POST/GET /api/paymentsdocs/pulsar-api.postman_collection.json— importable Postman collection with all endpoints and environment variables.github/workflows/publish-api-docs.yml— deploys Swagger UI to GitHub Pages on every push tomainthat modifies the specAcceptance Criteria
Closes #358