diff --git a/.github/workflows/build-with-bal-test-graalvm.yml b/.github/workflows/build-with-bal-test-graalvm.yml index 1b222a4..0f2fb8b 100644 --- a/.github/workflows/build-with-bal-test-graalvm.yml +++ b/.github/workflows/build-with-bal-test-graalvm.yml @@ -14,4 +14,4 @@ jobs: uses: ballerina-platform/ballerina-standard-library/.github/workflows/build-with-bal-test-graalvm-connector-template.yml@main secrets: inherit with: - additional-build-flags: "-x :candid-examples:build -Pgroups=mock" \ No newline at end of file + additional-build-flags: "-x :candid-examples:build -Pgroups=mock" diff --git a/README.md b/README.md index b2c5f18..9ee2df1 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,6 @@ [![Build](https://github.com/ballerina-platform/module-ballerinax-candid/actions/workflows/ci.yml/badge.svg)](https://github.com/ballerina-platform/module-ballerinax-candid/actions/workflows/ci.yml) [![Trivy](https://github.com/ballerina-platform/module-ballerinax-candid/actions/workflows/trivy-scan.yml/badge.svg)](https://github.com/ballerina-platform/module-ballerinax-candid/actions/workflows/trivy-scan.yml) -[![codecov](https://codecov.io/gh/ballerina-platform/module-ballerinax-candid/branch/master/graph/badge.svg)](https://codecov.io/gh/ballerina-platform/module-ballerinax-candid) [![GraalVM Check](https://github.com/ballerina-platform/module-ballerinax-candid/actions/workflows/build-with-bal-test-graalvm.yml/badge.svg)](https://github.com/ballerina-platform/module-ballerinax-candid/actions/workflows/build-with-bal-test-graalvm.yml) [![GitHub Last Commit](https://img.shields.io/github/last-commit/ballerina-platform/module-ballerinax-candid.svg)](https://github.com/ballerina-platform/module-ballerinax-candid/commits/master) [![GitHub Issues](https://img.shields.io/github/issues/ballerina-platform/ballerina-library/module/candid.svg?label=Open%20Issues)](https://github.com/ballerina-platform/ballerina-library/labels/module%2Fcandid) @@ -20,14 +19,14 @@ Currently, the following Candid APIs are supported through this module - **Premier API** - The Premier API is a more comprehensive API that provides access to a wider range of nonprofit data, including financial information, staffing data, grantmaking data, and DEI data. It is ideal for applications that need to deep dive into the data of individual nonprofits or perform complex analyses of nonprofit data. -## Setup Guide +## Setup guide To use the Candid.org Connector in Ballerina, you must first obtain an API key from Candid.org. -### Step 1: Visit Candid's Developer API Access page +### Step 1: Visit Candid's developer API access page 1. Visit [Candid's Developer API Access](https://developer.candid.org/reference/getting-access) page. 2. Review the documentation to understand the type of access suits your need. -### Step 2: Request API Access +### Step 2: Request API access - **For a Trial Account:** If you're looking for trial access to explore Candid's API, complete the [form](https://info.candid.org/API-free-trial) to request trial access. Candid.org will review your request and get in touch with you regarding your trial API key. Candid API Access Form diff --git a/ballerina/Module.md b/ballerina/Module.md index 591b7c3..90d2ae1 100644 --- a/ballerina/Module.md +++ b/ballerina/Module.md @@ -13,14 +13,14 @@ Currently, the following Candid APIs are supported through this module - **Premier API** - The Premier API is a more comprehensive API that provides access to a wider range of nonprofit data, including financial information, staffing data, grantmaking data, and DEI data. It is ideal for applications that need to deep dive into the data of individual nonprofits or perform complex analyses of nonprofit data. -## Setup Guide +## Setup guide To use the Candid.org Connector in Ballerina, you must first obtain an API key from Candid.org. -### Step 1: Visit Candid's Developer API Access page +### Step 1: Visit Candid's developer API access page 1. Visit [Candid's Developer API Access](https://developer.candid.org/reference/getting-access) page. 2. Review the documentation to understand the type of access suits your need. -### Step 2: Request API Access +### Step 2: Request API access - **For a Trial Account:** If you're looking for trial access to explore Candid's API, complete the [form](https://info.candid.org/API-free-trial) to request trial access. Candid.org will review your request and get in touch with you regarding your trial API key. Candid API Access Form diff --git a/ballerina/Package.md b/ballerina/Package.md index e8c19c1..cce4090 100644 --- a/ballerina/Package.md +++ b/ballerina/Package.md @@ -13,14 +13,14 @@ Currently, the following Candid APIs are supported through this module - **Premier API** - The Premier API is a more comprehensive API that provides access to a wider range of nonprofit data, including financial information, staffing data, grantmaking data, and DEI data. It is ideal for applications that need to deep dive into the data of individual nonprofits or perform complex analyses of nonprofit data. -## Setup Guide +## Setup guide To use the Candid.org Connector in Ballerina, you must first obtain an API key from Candid.org. -### Step 1: Visit Candid's Developer API Access page +### Step 1: Visit Candid's developer API access page 1. Visit [Candid's Developer API Access](https://developer.candid.org/reference/getting-access) page. 2. Review the documentation to understand the type of access suits your need. -### Step 2: Request API Access +### Step 2: Request API access - **For a Trial Account:** If you're looking for trial access to explore Candid's API, complete the [form](https://info.candid.org/API-free-trial) to request trial access. Candid.org will review your request and get in touch with you regarding your trial API key. Candid API Access Form diff --git a/ballerina/modules/essentials/client.bal b/ballerina/modules/essentials/client.bal index 99fe595..92f4904 100644 --- a/ballerina/modules/essentials/client.bal +++ b/ballerina/modules/essentials/client.bal @@ -1,3 +1,6 @@ +// AUTO-GENERATED FILE. DO NOT MODIFY. +// This file is auto-generated by the Ballerina OpenAPI tool. + // Copyright (c) 2024, WSO2 LLC. (http://www.wso2.org). // // WSO2 LLC. licenses this file to you under the Apache License, diff --git a/ballerina/modules/essentials/types.bal b/ballerina/modules/essentials/types.bal index 5224fa6..2271b14 100644 --- a/ballerina/modules/essentials/types.bal +++ b/ballerina/modules/essentials/types.bal @@ -1,3 +1,6 @@ +// AUTO-GENERATED FILE. DO NOT MODIFY. +// This file is auto-generated by the Ballerina OpenAPI tool. + // Copyright (c) 2024, WSO2 LLC. (http://www.wso2.org). // // WSO2 LLC. licenses this file to you under the Apache License, diff --git a/ballerina/modules/essentials/utils.bal b/ballerina/modules/essentials/utils.bal index 017d12b..9812970 100644 --- a/ballerina/modules/essentials/utils.bal +++ b/ballerina/modules/essentials/utils.bal @@ -1,3 +1,6 @@ +// AUTO-GENERATED FILE. DO NOT MODIFY. +// This file is auto-generated by the Ballerina OpenAPI tool. + // Copyright (c) 2024, WSO2 LLC. (http://www.wso2.org). // // WSO2 LLC. licenses this file to you under the Apache License, diff --git a/ballerina/modules/premier/client.bal b/ballerina/modules/premier/client.bal index 819fb8a..8655993 100644 --- a/ballerina/modules/premier/client.bal +++ b/ballerina/modules/premier/client.bal @@ -1,3 +1,6 @@ +// AUTO-GENERATED FILE. DO NOT MODIFY. +// This file is auto-generated by the Ballerina OpenAPI tool. + // Copyright (c) 2024, WSO2 LLC. (http://www.wso2.org). // // WSO2 LLC. licenses this file to you under the Apache License, diff --git a/ballerina/modules/premier/types.bal b/ballerina/modules/premier/types.bal index 1e05dc9..944c4d0 100644 --- a/ballerina/modules/premier/types.bal +++ b/ballerina/modules/premier/types.bal @@ -1,3 +1,6 @@ +// AUTO-GENERATED FILE. DO NOT MODIFY. +// This file is auto-generated by the Ballerina OpenAPI tool. + // Copyright (c) 2024, WSO2 LLC. (http://www.wso2.org). // // WSO2 LLC. licenses this file to you under the Apache License, diff --git a/ballerina/modules/premier/utils.bal b/ballerina/modules/premier/utils.bal index 017d12b..9812970 100644 --- a/ballerina/modules/premier/utils.bal +++ b/ballerina/modules/premier/utils.bal @@ -1,3 +1,6 @@ +// AUTO-GENERATED FILE. DO NOT MODIFY. +// This file is auto-generated by the Ballerina OpenAPI tool. + // Copyright (c) 2024, WSO2 LLC. (http://www.wso2.org). // // WSO2 LLC. licenses this file to you under the Apache License, diff --git a/docs/spec/sanitations.md b/docs/spec/sanitations.md index 88cd46a..9edc69f 100644 --- a/docs/spec/sanitations.md +++ b/docs/spec/sanitations.md @@ -1,3 +1,9 @@ -# Introduction +# Sanitations: Ballerina Candid Connector + +_Authors_: @AzeemMuzammil \ +_Reviewers_: @NipunaRanasinghe \ +_Created_: 2024/02/19 \ +_Updated_: 2024/02/19 \ +_Edition_: Swan Lake This file documents the modifications applied to enhance the usability of the official OpenAPI Specification (OAS). These adjustments are made to address known limitations on the language side and improve overall functionality. diff --git a/issue_template.md b/issue_template.md deleted file mode 100644 index e1eb5f4..0000000 --- a/issue_template.md +++ /dev/null @@ -1,18 +0,0 @@ -**Description:** - - -**Suggested Labels:** - - -**Suggested Assignees:** - - -**Affected Product Version:** - -**OS, DB, other environment details and versions:** - -**Steps to reproduce:** - - -**Related Issues:** - diff --git a/pull_request_template.md b/pull_request_template.md deleted file mode 100644 index 5e8530a..0000000 --- a/pull_request_template.md +++ /dev/null @@ -1,39 +0,0 @@ -# Description - -Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. - -Fixes # (issue) - -Related Pull Requests (remove if not relevant) -- Pull request 1 -- Pull request 2 - -One line release note: -- One line describing the feature/improvement/fix made by this PR - -## Type of change - -Please delete options that are not relevant. - -- [ ] Bug fix (non-breaking change which fixes an issue) -- [ ] New feature (non-breaking change which adds functionality) -- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) -- [ ] This change requires a documentation update - -# How Has This Been Tested? - -Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration - -- [ ] Test A -- [ ] Test B - -**Test Configuration**: -* Ballerina Version: -* Operating System: -* Java SDK: - -# Checklist: - -### Security checks - - [ ] Followed secure coding standards in http://wso2.com/technical-reports/wso2-secure-engineering-guidelines? - - [ ] Confirmed that this PR doesn't commit any keys, passwords, tokens, usernames, or other secrets?