Introduce required keywords for connector classification and types in Ballerina connectors - Githubissues

ballerina-platform / ballerina-library

The Ballerina Library

https://ballerina.io/learn/api-docs/ballerina/

Apache License 2.0

136 stars 64 forks source link

Introduce required keywords for connector classification and types in Ballerina connectors #7340

Open NipunaRanasinghe opened 2 weeks ago

NipunaRanasinghe commented 2 weeks ago

Description

Currently, Ballerina connectors have optional keywords (as shown in the example screenshot) defined within their configuration.

Screenshot 2024-11-06 at 14 14 47

To enhance searchability and categorization on Ballerina Central, we need to introduce two mandatory keywords for each connector package:

A new required keyword, such as Connector to distinguish connector packages in keyword searches on Ballerina Central.
a new required keyword to categorize connectors based on their kind. eg: Kind/REST API, Type/Generated, etc.

Action Items:

[ ] Define and finalize the required keyword names
[ ] Update the existing connectors to include the required keywords (Optional)
[ ] Update the generated connector template to have the required keywords by default
[ ] Update relevant documentation (connector development process) to reflect the new changes

Version

No response