aviate coupons APIs #348
aviate coupons APIs #348
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR adds support for the new Aviate Coupons feature by adding the API documentation and integrating it into the existing Kill Bill documentation site.
- Adds comprehensive API documentation for the Aviate Coupons feature with endpoints for creating, listing, retrieving, and archiving coupons
- Creates the new documentation file structure for aviate-coupons
- Updates all existing documentation files to include aviate-coupons in their navigation menus
Reviewed Changes
Copilot reviewed 29 out of 30 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| source/includes/_aviate-coupons.md | Complete API documentation for Aviate Coupons with endpoints, models, and examples |
| source/aviate-coupons.html.md | Main documentation page configuration for the Aviate Coupons feature |
| Multiple .html.md files | Navigation menu updates to include aviate-coupons across all documentation pages |
| |-----------------|----------------|----------|--------------|--------------------------| | ||
| | includeArchived | boolean | false | false | Include archived coupons in the response | ||
| | includeExpired | boolean | false | false | Include expired coupons in the response | ||
| --- |
There was a problem hiding this comment.
The horizontal rule separator (---) appears in the middle of the query parameters table documentation, which breaks the table formatting. This should be removed or relocated.
| --- |
Deploying apidocs-killbill-io with
|
| Latest commit: |
a97efac
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://5173eb44.apidocs-killbill-io.pages.dev |
| Branch Preview URL: | https://aviate-coupons.apidocs-killbill-io.pages.dev |
| | `planList` | `array` | Applicable plan names | | ||
| | `createdDate` | `string` (date-time) | Date when the coupon was created | | ||
| | `archived` | `boolean` | Whether the coupon is archived | | ||
|
|
There was a problem hiding this comment.
Is there a particular reason why we have CouponInput from Coupon? In all the other APIs, we do not have separate resource objects for the input hence asking.
There was a problem hiding this comment.
We have the same thing for the Wallet, but I agree we may not be consistent across all our resources.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
generated from commit dd1e280
generated from commit dd1e280
No description provided.