OcularEngineering / ocular

AI Powered Search and Chat for Orgs - Think ChatGPT meets Google Search but powered by your data.
https://www.useocular.com
Other
454 stars 38 forks source link

feat : šŸš€ Stable Version of Bitbucket Connector with API Token Auth Strategy #154

Closed Vivek-Lahole closed 2 months ago

Vivek-Lahole commented 3 months ago

šŸŽÆ Goal

Develop a stable version of the Bitbucket connector that supports API Token authentication. This feature aims to enhance security and simplify the authentication process for users.

šŸ“‹ Detailed Description

API Token Authentication

The Bitbucket connector should support API Token authentication to enhance security. Users can generate their API tokens from Bitbucket and use them to authenticate their sessions. This method is not only more secure but also reduces the hassle of managing passwords.

API Token UI for User Input

Develop a user-friendly interface where users can input their API Tokens. This UI should be intuitive, guiding users through the process of copying their API token from Bitbucket and pasting it into the connector configuration. Clear instructions and error messages should be provided to ensure a seamless experience.

šŸ” Example Usage

  1. User Interface:

    • Users navigate to the settings page and find the API Token input field.
    • Users enter their API Token and save the configuration.
  2. Authentication:

    • The connector uses the provided API Token to authenticate requests to Bitbucket.
  3. Error Handling:

    • If an error occurs, the system logs the error

Additional context

šŸ“„ Note for Contributors

Contributors are encouraged to take reference from other apps for file naming, folder structure, and coding style. Following consistent practices ensures code readability, maintainability, and a seamless development experience.

šŸ“ File Naming and Folder Structure

šŸ’» Coding Style

šŸ” Examples

To ensure uniformity, look at examples from other well-structured apps within the project. These can provide valuable insights into effective file naming, folder structuring, and coding styles.

šŸ“¢ Communication

If you have any questions or need further clarification, feel free to reach out to the team. Collaboration and open communication are key to successful project development.

Thank you for your contributions and efforts in maintaining high standards!

āœØ Happy Coding! āœØ

louismurerwa commented 3 months ago

thanks @Vivek-Lahole for writing down the detailed issues!

hiteshwadhwani commented 2 months ago

I have raised a PR #163 for the feature @Vivek-Lahole please can you review