Add API documentation #16
Merged
Conversation
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
- Created detailed examples for Payment API including public, processing, admin management, and webhook endpoints. - Added examples for Product API covering public, seller-specific, and variant management endpoints. - Included user management API examples for public registration, login, profile management, and admin user management.
Contributor
There was a problem hiding this comment.
Pull Request Overview
This pull request enhances the API documentation by adding detailed examples and workflows for discount, payment, and shipping systems while also expanding the readme to include additional endpoints.
- New discount API documentation including example requests and responses
- Expanded payment API examples with detailed flows for credit card, PayPal, and MobilePay
- Updated shipping documentation with clear admin and customer configuration flows and extended readme endpoints
Reviewed Changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| readme.md | Expanded endpoints for admin and improved e-commerce workflow descriptions, though some endpoints appear in more than one section. |
| docs/shipping_api_examples.md | Updated shipping configuration and customer selection flows. |
| docs/payment_api_examples.md | Added comprehensive examples and detailed payment workflows. |
| docs/discount_api_examples.md | Introduced detailed examples for applying, updating, and deleting discounts. |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This pull request introduces new API documentation for the discount and payment systems, refines shipping workflows, and expands the
readme.mdto include additional endpoints and workflows. The changes aim to improve clarity, usability, and completeness of the API documentation.New API Documentation:
docs/discount_api_examples.md: Added detailed examples for public and admin discount endpoints, including workflows for creating, applying, and managing discounts.docs/payment_api_examples.md: Added comprehensive examples for public, user, and admin payment endpoints, including workflows for processing payments and handling webhooks.Refinements to Shipping Documentation:
docs/shipping_api_examples.md: Revised the shipping configuration and customer selection workflows to improve clarity and separate admin and customer flows.Updates to
readme.md:Expanded endpoints:
Key workflows: