Skip to content

Comments

Add Documentation#6

Merged
ThisaruGuruge merged 9 commits intoballerina-platform:mainfrom
RNViththagan:docs
Jun 30, 2025
Merged

Add Documentation#6
ThisaruGuruge merged 9 commits intoballerina-platform:mainfrom
RNViththagan:docs

Conversation

@RNViththagan
Copy link
Member

Purpose

This PR enhances the ballerinax/paypal.subscriptions connector with comprehensive documentation and test instructions, providing clear setup, usage, and testing guidance for developers.

Changes

  • Updated README.md with:
    • Overview: Describes the connector and PayPal Subscriptions API v1 support.
    • Setup Guide: Steps to set up a PayPal Developer account and obtain credentials.
    • Quickstart: Sample code to create a subscription plan.
    • Examples: Links to create-and-list-plans and monitor-and-manage-subscription examples.
  • Added images (sandbox-accounts.png, create-account.png, create-app.png, get-credentials.png) to docs/setup/resources/ for the Setup Guide.
  • Updated ballerina/tests/README.md with test setup, configuration, and instructions for running live_tests, mock_tests, and live_active_subscription_tests, linking to ballerina/tests/docs/ActivateSubscription.md for subscription activation.
  • Added ballerina/tests/docs/ActivateSubscription.md with steps to manually activate a subscription for live_active_subscription_tests, including:
    • Creating a subscription with APPROVAL_PENDING status via testCreateSubscription.
    • Obtaining sandbox Personal account credentials.
    • Activating the subscription in the browser using the approve URL.
    • Updating Config.toml and running live_active_subscription_tests.
  • Added test-related images (sandbox-accounts.png, personal-account-credentials.png, paypal-login-page.png, choose-payment-method.png, example-domain-page.png) to ballerina/tests/docs/resources/ for activation steps.

Checklist

  • Updated the changelog

@RNViththagan RNViththagan marked this pull request as ready for review June 30, 2025 07:41
@codecov
Copy link

codecov bot commented Jun 30, 2025

Welcome to Codecov 🎉

Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests.

Thanks for integrating Codecov - We've got you covered ☂️

@ThisaruGuruge ThisaruGuruge merged commit 483b98e into ballerina-platform:main Jun 30, 2025
5 checks passed
@RNViththagan RNViththagan deleted the docs branch June 30, 2025 09:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants