Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecate patch_datasets and patch_yaml_datasets endpoints #2092

Closed
pattisdr opened this issue Dec 20, 2022 · 3 comments
Closed

Deprecate patch_datasets and patch_yaml_datasets endpoints #2092

pattisdr opened this issue Dec 20, 2022 · 3 comments

Comments

@pattisdr
Copy link
Contributor

pattisdr commented Dec 20, 2022

❗ Depends on #1766

Is your feature request related to a specific problem?

Currently datasets are stored in two places for different use cases, on the DatasetConfig.dataset table and in the ctl_datasets table. Our unified fides resources work is moving to storing this in ctl_datasets.

A new endpoint, patch_dataset_configs is being added. After the UI is in to use this endpoint, the other endpoints can be deprecated.

Describe the solution you'd like

  • Deprecate PATCH {{host}}/connection/{{connection_key}}/dataset.
  • Deprecate PATCH {{host}}/yml/connection/{{connection_key}}/dataset
  • Deprecate GET {{host}}//connection/{{connection_key}}/dataset
  • Deprecate GET {{host}}//connection/{{connection_key}}/dataset/{{datasetconfig_key}}
    • Have endpoint return a message that the endpoint is deprecated and direct them to their replacement (/datasetconfig endpoints)

Describe alternatives you've considered, if any

A description of any alternative solutions or features you've considered.

Additional context

Add any other context or screenshots about the feature request here.

@pattisdr
Copy link
Contributor Author

pattisdr commented Dec 23, 2022

Also switch any other remaining instances in the codebase to use the new patterns (upsert to CTL Dataset then PATCH to Dataset Config).

  • nox -s test_env for example, calls the PATCH /connection/connection_key/dataset endpoint we'd like to deprecate
  • The quickstart too
  • What else?

EDIT: went ahead and addressed this point here: #2225

@pattisdr
Copy link
Contributor Author

This doesn't block the release of unified-fides-resources.

@pattisdr
Copy link
Contributor Author

pattisdr commented Jan 3, 2023

Also need to discuss what our deprecation policy is.

Motivations to deprecate: These endpoints on the unified-fides-resources branch now potentially have surprising updates, in that they not only update the datasetconfig but the associated ctl dataset.

While we can change all of our code to not make calls to these endpoints, is anyone relying on these?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants