Skip to content
This repository has been archived by the owner on Nov 30, 2022. It is now read-only.

GET Available Connectors [#706] #768

Merged
merged 12 commits into from
Jul 6, 2022

Conversation

pattisdr
Copy link
Contributor

@pattisdr pattisdr commented Jun 30, 2022

❗ Dependent on #706 - Merge that first

Purpose

As a Fidesops admin user, need the ability to see a list of available connector types to choose from so that I can select one to connect my fidesops environment to.

Changes

  • Adds an endpoint to get available connectors that are ready to go (this is a combination of datastore and saas connectors minus ("manual", "custom", generic "saas", and "https" connectors.) GET api/v1/connection_type
    • Can be filtered on whether search param is a substring of the connector name GET api/v1/connection_type?search=red

Checklist

  • Update CHANGELOG.md file
    • Merge in main so the most recent CHANGELOG.md file is being appended to
    • Add description within the Unreleased section in an appropriate category. Add a new category from the list at the top of the file if the needed one isn't already there.
    • Add a link to this PR at the end of the description with the PR number as the text. example: #1
  • Applicable documentation updated (guides, quickstart, postman collections, tutorial, fidesdemo, database diagram.
  • If docs updated (select one):
    • documentation complete, or draft/outline provided (tag docs-team to complete/review on this branch)
    • documentation issue created (tag docs-team to complete issue separately)
  • Good unit test/integration test coverage
  • This PR contains a DB migration. If checked, the reviewer should confirm with the author that the down_revision correctly references the previous migration before merging
  • The Run Unsafe PR Checks label has been applied, and checks have passed, if this PR touches any external services

Ticket

Fixes #752

@pattisdr pattisdr changed the title Fidesops 752 available connectors GET Available Connectors [#706 Jun 30, 2022
@pattisdr pattisdr changed the title GET Available Connectors [#706 GET Available Connectors [#706] Jun 30, 2022
conn_type.value
for conn_type in ConnectionType
if conn_type
not in [ConnectionType.saas, ConnectionType.https, ConnectionType.manual]
Copy link
Contributor Author

Choose a reason for hiding this comment

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

my assumption is that these types and the "custom" type below shouldn't be included in this list, that these are connectors that are available and ready to go


@router.get(
CONNECTION_TYPES,
dependencies=[Security(verify_oauth_client, scopes=[CONNECTION_TYPE_READ])],
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I set scopes here but this may not be necessary

@pattisdr pattisdr marked this pull request as ready for review June 30, 2022 21:51
@seanpreston seanpreston self-assigned this Jul 1, 2022
@pattisdr
Copy link
Contributor Author

pattisdr commented Jul 5, 2022

@ethyca/docs-authors Small docs addition added to the guides about how to see a list of available connector types

Copy link
Contributor

@conceptualshark conceptualshark left a comment

Choose a reason for hiding this comment

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

👍 good on the docs side of the house!

Base automatically changed from 706-datastore-type-saas to main July 6, 2022 17:12
@pattisdr
Copy link
Contributor Author

pattisdr commented Jul 6, 2022

fixing ClientDetail model import..

@eastandwestwind eastandwestwind merged commit 509c641 into main Jul 6, 2022
@eastandwestwind eastandwestwind deleted the fidesops_752_available_connectors branch July 6, 2022 17:49
sanders41 pushed a commit that referenced this pull request Sep 22, 2022
* Adds Saas type to saas yaml config

* alter postman collection

* updates changelog

* lint fixes

* Add endpoint to surface all available connectors including database options and saas options.

* Exclude custom and manual types from list of available connectors.

- Add docs and postman collection.

* Update changelog.

* Remove committed ANALYTICS_ID.

* Import ClientDetail from fideslib instead of fidesops.

* Fix import order.

Co-authored-by: eastandwestwind <[email protected]>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Retrieve list of available connectors (Backend)
4 participants