docs(connector): [STRIPE] Added CIT & MIT Examples for API Reference in Stripe Split Payments

[bsayak03]

Type of Change

• [ ] Bugfix
• [ ] New feature
• [ ] Enhancement
• [ ] Refactoring
• [ ] Dependency updates
• [x] Documentation
• [ ] CI/CD

Description

Added CIT and MIT flows examples for API Reference for Stripe Split Payments

Additional Changes

• [ ] This PR modifies the API contract
• [ ] This PR modifies the database schema
• [ ] This PR modifies application configuration/environment variables

Motivation and Context

How did you test it?

cargo run -p openapi --features v1 mintlify dev

Checklist

• [x] I formatted the code cargo +nightly fmt --all
• [x] I addressed lints thrown by cargo clippy
• [x] I reviewed the submitted code
• [ ] I added unit tests for my changes where possible

Summary by CodeRabbit

• Documentation
  • Added two new example request bodies for the Payments - Create API demonstrating Stripe split payment requests for Customer Initiated Transactions (CIT) and Merchant Initiated Transactions (MIT).
  • Updated payment method schemas to clarify the "recurring_enabled" property, indicating its presence and optionality across different API responses and requests.

[semanticdiff-com[bot]]

Review changes with  

Changed Files

File	Status
crates/openapi/src/routes/payments.rs	3% smaller
api-reference/v1/openapi_spec_v1.json	0% smaller

[coderabbitai[bot]]

Walkthrough

Two new example request bodies were added to the Payments - Create API documentation and OpenAPI specification. These examples demonstrate how to initiate Stripe split payments for both Customer Initiated Transactions (CIT) and Merchant Initiated Transactions (MIT), detailing the required fields and split payment parameters for each scenario. Additionally, the "recurring_enabled" property was updated across several payment method schemas in the API reference v2 to adjust its required status, description, and nullability.

Changes

File(s)	Change Summary
api-reference/openapi_spec.json	Added two example request bodies for POST /payments: one for Stripe Split Payments CIT, one for MIT.
crates/openapi/src/routes/payments.rs	Added two example JSON request payloads to documentation for Stripe Split Payments CIT and MIT scenarios.
api-reference-v2/openapi_spec.json	Modified recurring_enabled property in payment method schemas: made required in CustomerPaymentMethodResponseItem, optional and nullable in PaymentMethodResponseItem, and added as optional filter in PaymentMethodListRequest.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant API
    participant Stripe

    Client->>API: POST /payments (CIT or MIT example body)
    API->>Stripe: Create payment with split payment details
    Stripe-->>API: Payment response
    API-->>Client: Payment confirmation/response

Poem

In the warren of payments, new paths now appear,
Stripe splits for CIT and MIT are finally here!
Examples abound for each clever request,
With details and fields, our docs are now blessed.
Hop on, dear devs, let your payments take flight—
The split is now simple, the future is bright!
🐇💳✨

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.