Introduce a Ballerina connector for SmartSheet REST API

[NipunaRanasinghe]

We are planning to introduce a new Ballerina connector for the latest SmartSheet REST API, generated using it's OpenAPI specification.

Related links:

• https://smartsheet.redoc.ly/

This includes the following tasks:

1. Create a new repository under 'ballerina-platform' organization.
2. Review and sanitize the OpenAPI specification.
3. Generate the connector client.
4. Implement a test suite covering the core functionalities.
5. Write documentation with examples.

[thiunuwan]

hi @NipunaRanasinghe , I would like to work on this issue, can you please assign this to me?

[MohamedSabthar]

👋 Welcome, @thiunuwan! 🚀

We're thrilled to have you join the Ballerina Hacktoberfest community! The issue has been assigned to you, and we’re excited to see your contributions.

To help you get started, here are a few essential resources:

1. Connector Contributor Guide: Make sure to go through our Ballerina Hacktoberfest connector contributor guidelines and follow the exact steps, to contribute effectively.
2. Learn Ballerina: Whether you're new to Ballerina or looking to enhance your skills, check out our official learning resources.
3. Community & Support: If you have technical questions, feel free to ask on Stack Overflow with the Ballerina tag, or join us on Discord to connect with other community members.

No contribution is too small, and your feedback is always welcome! Don’t hesitate to ask questions, propose new ideas, or report issues.

We are currently in the process of creating a GitHub repository for this connector module and will update you once it’s available. In the meantime, please go through the relevant resources and documentation related to the connector.

Happy coding and welcome aboard! 🎉

[ayeshLK]

👋 Greetings from the Ballerina team, @thiunuwan!

The repository for the Ballerina SmartSheet Connector is now live and ready for development! 🎉 You can find the project structure initialized here.

Feel free to dive in and start building the connector! If you need any assistance or have any questions, just drop a comment here — we’re happy to help! 😊

Please find the following official guides on Ballerina connector development:

• Connector contributor guide
• Create your first connector with Ballerina

Happy coding and enjoy Hacktoberfest! 🚀👨‍💻👩‍💻

[ayeshLK]

Hi @thiunuwan, greetings from the Ballerina team! 👋

I wanted to check in on the progress of the Ballerina SmartSheet Connector development. I hope everything is on track and that you’ve started the connector development.

If you need any help or have questions, feel free to comment here!

Happy coding!

[AnsarMahir]

@ayeshLK I would like to take this up if no updates from the assigned person :)

[thiunuwan]

Hi @thiunuwan, greetings from the Ballerina team! 👋

I wanted to check in on the progress of the Ballerina SmartSheet Connector development. I hope everything is on track and that you’ve started the connector development.

If you need any help or have questions, feel free to comment here!

Happy coding!

Hi @ayeshLK , I've started the development and am currently working on generating the Ballerina client code.I ran into an issue with duplicate parameters. To address this, I defined the parameters in components.parameters and reused them across operations using $ref.

[ayeshLK]

Hi @ayeshLK , I've started the development and am currently working on generating the Ballerina client code.I ran into an issue with duplicate parameters. To address this, I defined the parameters in components.parameters and reused them across operations using $ref.

Hey @thiunuwan its great to hear that you have started working on the connector! Defining the parameters in components.parameters and reusing them with $ref is the right approach to avoid duplicate parameters.

If you run into any other issues or need additional clarification, feel free to comment here, and I'll be happy to help!

Looking forward to seeing the progress.

[thiunuwan]

Hi @ayeshLK , I have updated the OpenAPI specification.However, I'm encountering an error during the OpenAPI-to-Ballerina code generation.

Here's the error message: [error]
You can check out the updated code here: [repo]

Could you help me troubleshoot this, or suggest a direction to investigate? Thanks!

[ayeshLK]

Hey @thiunuwan...! Just to check the progress of the connector development.

Have you sent a pull-request with the initial connector implementation or are you still working on it ?

[thiunuwan]

Hey @thiunuwan...! Just to check the progress of the connector development.

Have you sent a pull-request with the initial connector implementation or are you still working on it ?

Hi,I haven't sent a pull request yet as I'm currently stuck on the error mentioned above. I’ve held off on submitting the PR since the client generation part isn't complete yet.

[ayeshLK]

@thiunuwan I will check this and get back.

[ayeshLK]

@thiunuwan, I reviewed the issues you encountered, and here are my comments:

Hi @ayeshLK, I've started the development and am currently working on generating the Ballerina client code. I ran into an issue with duplicate parameters. To address this, I defined the parameters in components.parameters and reused them across operations using $ref.

The duplicate parameters issue arises from a known problem with swagger-parser. We’ve opened an issue on the Swagger side [1] to address this.

Hi @ayeshLK, I have updated the OpenAPI specification. However, I'm encountering an error during the OpenAPI-to-Ballerina code generation.

Here's the error message: [error]
You can check out the updated code here: [repo]

Could you help me troubleshoot this or suggest a direction to investigate? Thanks!

This issue is due to a current limitation within the Ballerina OpenAPI tool [2], which we are actively working on resolving.

Given these challenges, we may need to pause the development of the SmartSheet connector for now.

Are you open to working on another connector? We have a Ballerina Mistral connector [3] available, so please let us know if you’d like to proceed with that.

[1] - swagger-api/swagger-parser#2134
[2] - #7314
[3] - #7046

[thiunuwan]

Hi @ayeshLK
Thank you for your response ,I appreciate your time and support on this matter.

Are you open to working on another connector? We have a Ballerina Mistral connector [3] available, so please let us know if you’d like to proceed with that.

Sure, I’d be happy to work on the Ballerina Mistral connector.
Thank you!

[ayeshLK]

@thiunuwan, it's great to hear you're interested in working on the Ballerina Mistral connector! I'll unassign you from this connector. Please go ahead and comment on the GitHub issue for the Ballerina Mistral connector [1], and one of my colleagues will help assign the issue to you.

[1] - #7046