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

Endpoint: Return Secrets for a Connector Type [#753] #795

Merged
merged 22 commits into from
Jul 6, 2022

Conversation

pattisdr
Copy link
Contributor

@pattisdr pattisdr commented Jul 5, 2022

❗ Dependent on #768 . Merge that first.

Purpose

To enable UI users to configure datastores from the UI, we need to create a way to tell the frontend what types of secrets are needed for each connector. Because each database and SaaS app have differing authentication requirements, we need a modular front end that can display 1 to many secrets (on the scale of 2 to 6).

Changes

  • Add an API endpoint that surfaces the secrets needed for both database and saas connectors

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 #753

eastandwestwind and others added 10 commits June 28, 2022 10:43
… for a given connection type.

- Relocate "load_config" which we use to load saas config yamls, now that we have another use case beyond unit tests.
…tor type, so the description isn't abstract.

- Update changelog
- Add docs
- Add endpoint to postman collection
@pattisdr
Copy link
Contributor Author

pattisdr commented Jul 5, 2022

@ethyca/docs-authors Minor section added to the guides around how to get the types of secrets needed to authenticate with a given connector

@pattisdr pattisdr marked this pull request as ready for review July 5, 2022 16:47
Copy link
Contributor

@eastandwestwind eastandwestwind left a comment

Choose a reason for hiding this comment

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

Looks good overall @pattisdr !

Just some minor comments, nothing blocking.

pattisdr added 8 commits July 6, 2022 09:35
# Conflicts:
#	src/fidesops/schemas/saas/saas_config.py
…cret_schemas

# Conflicts:
#	CHANGELOG.md
#	tests/fixtures/saas/zendesk_fixtures.py
…cret_schemas

# Conflicts:
#	tests/api/v1/endpoints/test_connection_template_endpoints.py
…cret_schemas

# Conflicts:
#	tests/api/v1/endpoints/test_connection_template_endpoints.py
Base automatically changed from fidesops_752_available_connectors to main July 6, 2022 17:49
CHANGELOG.md Outdated
Comment on lines 56 to 58
* Fix console warning in disable connection modal [#750](https://github.com/ethyca/fidesops/pull/750)
* Fix no such container error with docker-compose [#758](https://github.com/ethyca/fidesops/pull/758)
* Fixed issue with extending the configuration [#721](https://github.com/ethyca/fidesops/pull/721)
Copy link
Contributor

Choose a reason for hiding this comment

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

@pattisdr it looks like these lines were removed from the changelog, is this intentional?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

good catch thank you, just a really messy merge

@eastandwestwind eastandwestwind merged commit 01670fd into main Jul 6, 2022
@eastandwestwind eastandwestwind deleted the fidesops_753_secret_schemas branch July 6, 2022 20:13
@pattisdr pattisdr mentioned this pull request Jul 25, 2022
10 tasks
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.

* Add an endpoint to fetch the types of secrets that should be supplied for a given connection type.

- Relocate "load_config" which we use to load saas config yamls, now that we have another use case beyond unit tests.

* Dynamically override the SaaSSchema docstring for a given saas connector type, so the description isn't abstract.

- Update changelog
- Add docs
- Add endpoint to postman collection

* Add missing import.

* Add a request method to docs.

* Update docstring.

* Remove committed ANALYTICS_ID.

* Import ClientDetail from fideslib instead of fidesops.

* Fix import order.

* Restore removed items in changelog.

Co-authored-by: eastandwestwind <eastandwestwind@gmail.com>
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.

Ability to send secret field types needed for each connector
3 participants