Update API documentation #12

ayeshLK · 2023-10-31T04:44:45Z

Purpose

$subject

Part of: #5084

ballerina/destination.bal

ballerina/types.bal

codecov · 2023-10-31T05:19:07Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (84aad43) 56.47% compared to head (d3ba517) 56.47%.
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff            @@
##               main      #12   +/-   ##
=========================================
  Coverage     56.47%   56.47%           
  Complexity       25       25           
=========================================
  Files            11       11           
  Lines           301      301           
  Branches         34       34           
=========================================
  Hits            170      170           
  Misses          125      125           
  Partials          6        6

Files	Coverage Δ
ballerina/destination.bal	`50.00% <ø> (ø)`
ballerina/errors.bal	`100.00% <ø> (ø)`
ballerina/queue_manager.bal	`81.81% <ø> (ø)`
ballerina/types.bal	`100.00% <100.00%> (ø)`

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

dilanSachi · 2023-10-31T05:28:57Z

ballerina/Module.md

+- Destination (Queue, Topic)
+- Message
+
+## Samples


btw, are we going to add samples later?

praneesha · 2023-10-31T05:48:36Z

README.md

@@ -1,2 +1,93 @@
-# module-ballerinax-ibm.ibmmq
-Ballerina IBM MQ client connector module.
+# Ballerina `ibm.ibmmq` Library


Should it be package? Need to check and fix all occurrences.

praneesha · 2023-10-31T05:49:22Z

README.md

+
+The `ballerinax/ibm.ibmmq` library provides an API to connect to an IBM MQ server using Ballerina.
+
+This library is created with minimal deviation from the IBM MQ java client API to make it easy for the developers who are used to working with the IBM MQ java client.


Should be Java.

praneesha · 2023-10-31T05:49:39Z

README.md

+
+This library is created with minimal deviation from the IBM MQ java client API to make it easy for the developers who are used to working with the IBM MQ java client.
+
+Currently, the following IBM MQ API Classes are supported through this package.


Should be classes.

praneesha · 2023-10-31T05:49:48Z

README.md

+
+Currently, the following IBM MQ API Classes are supported through this package.
+
+- QueueManager


Add backticks for classnames.

praneesha · 2023-10-31T05:50:00Z

README.md

+
+## Issues and projects 
+
+Issues and Projects tabs are disabled for this repository as this is part of the Ballerina Standard Library. To report bugs, request new features, start new discussions, view project boards, etc., go to the [Ballerina Standard Library parent repository](https://github.com/ballerina-platform/ballerina-standard-library). 


Tab names should be in bold.

praneesha · 2023-10-31T05:51:31Z

README.md

+   ```
+   ./gradlew clean build -Pdebug=<port>
+   ```
+5. To debug the library with Ballerina language:


Should be the Ballerina language.

praneesha · 2023-10-31T05:51:48Z

README.md

+   ```
+   ./gradlew clean build -PbalJavaDebug=<port>
+   ```
+6. Publish ZIP artifact to the local `.m2` repository:


praneesha · 2023-10-31T05:51:56Z

README.md

+   ```
+   ./gradlew clean build publishToMavenLocal
+   ```
+7. Publish the generated artifacts to the local Ballerina central repository:


praneesha · 2023-10-31T05:52:17Z

README.md

+
+## Useful links
+
+* For more information go to the [`ibm.ibmmq` library](https://lib.ballerina.io/ballerinax/ibm.ibmmq/latest).


Need a comma.

praneesha · 2023-10-31T05:52:31Z

ballerina/Module.md

@@ -0,0 +1,14 @@
+## Overview
+
+The `ballerinax/ibm.ibmmq` module provides an API to connect to an IBM MQ server using Ballerina.


Should it be package?

ayeshLK added 9 commits October 30, 2023 09:24

Update API docs for queue-manager,constants and record types

45dd2e3

Update API docs for IBM MQ destination clients

8bc09ff

Update API documentation

295fb2e

Resolve merge conflicts

a6b1572

Update PR template

1c4e32a

Update package readme

8c03ed7

Update package documentation

507f67c

Fix logic issue in saving native-queue in the bobject

8f1f8b0

Resolve merge conflicts

d1600da

ayeshLK requested review from shafreenAnfar, NipunaRanasinghe and dilanSachi as code owners October 31, 2023 04:44

dilanSachi reviewed Oct 31, 2023

View reviewed changes

ballerina/destination.bal Outdated Show resolved Hide resolved

dilanSachi reviewed Oct 31, 2023

View reviewed changes

ballerina/types.bal Outdated Show resolved Hide resolved

Resolve merge conflicts

5a26895

Refactor according to the review comments

d3ba517

ayeshLK changed the base branch from connector-implementation to main October 31, 2023 05:20

Bhashinee approved these changes Oct 31, 2023

View reviewed changes

ayeshLK merged commit a191173 into ballerina-platform:main Oct 31, 2023
5 checks passed

dilanSachi reviewed Oct 31, 2023

View reviewed changes

ballerina/Module.md

- Destination (Queue, Topic)

- Message

## Samples

Copy link

Contributor

dilanSachi Oct 31, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

btw, are we going to add samples later?

praneesha reviewed Oct 31, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update API documentation #12

Update API documentation #12

ayeshLK commented Oct 31, 2023

codecov bot commented Oct 31, 2023 •

edited

Loading

dilanSachi Oct 31, 2023

praneesha Oct 31, 2023

praneesha Oct 31, 2023

praneesha Oct 31, 2023

praneesha Oct 31, 2023

praneesha Oct 31, 2023

praneesha Oct 31, 2023

praneesha Oct 31, 2023

praneesha Oct 31, 2023

praneesha Oct 31, 2023

praneesha Oct 31, 2023


		The `ballerinax/ibm.ibmmq` library provides an API to connect to an IBM MQ server using Ballerina.

		This library is created with minimal deviation from the IBM MQ java client API to make it easy for the developers who are used to working with the IBM MQ java client.


		This library is created with minimal deviation from the IBM MQ java client API to make it easy for the developers who are used to working with the IBM MQ java client.

		Currently, the following IBM MQ API Classes are supported through this package.


		Currently, the following IBM MQ API Classes are supported through this package.

		- QueueManager


		## Issues and projects

		Issues and Projects tabs are disabled for this repository as this is part of the Ballerina Standard Library. To report bugs, request new features, start new discussions, view project boards, etc., go to the [Ballerina Standard Library parent repository](https://github.com/ballerina-platform/ballerina-standard-library).


		## Useful links

		* For more information go to the [`ibm.ibmmq` library](https://lib.ballerina.io/ballerinax/ibm.ibmmq/latest).

		@@ -0,0 +1,14 @@
		## Overview

		The `ballerinax/ibm.ibmmq` module provides an API to connect to an IBM MQ server using Ballerina.

Update API documentation #12

Update API documentation #12

Conversation

ayeshLK commented Oct 31, 2023

Purpose

codecov bot commented Oct 31, 2023 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Oct 31, 2023 •

edited

Loading