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

Modify workspace API endpoints to be PATCH-style (in preparation for setting Geography) #16648

Closed
terencecho opened this issue Sep 13, 2022 · 2 comments
Assignees

Comments

@terencecho
Copy link
Contributor

terencecho commented Sep 13, 2022

Assumes a migration was already ran to add a geography column to the workspace.

Modify the /workspace/update handler to take in an optional field for setting a Geography that will be used as a default for all connections within that workspace.

Modify the /workspace/create handler to persist 'Auto' value for the preferred Geography. This sets us up for future improvements where we might be able to detect a good default geography based on the user's IP, etc. The Routing Service can see 'Auto' and then decide where best to route the connection.

We would need to decide what to show in the UI if we're storing 'Auto' - do we show the user what the Routing Service will likely use when the connection runs? This could be a can of worms, maybe we can revisit this in the future and keep things simple for now.

Today, let's keep the UX simple, we want to capture information for the future so that when we add intelligent routing, we're able to apply that to old connections. We can do an announcement to affected users when that time comes.

If we persist 'Auto' to the database by default, we need to decide what we want to show in the UI.
What we show today in the UI: perhaps 'Auto (US)'? @andyjih can follow up to figure this out, do we need more docs, info icon, etc?
What we show when we add intelligent routing: 'Airbyte Decides' (or something)

Part of this issue is to make calls to update the workspace safer by updating it to support a PATCH style update just like what we did for connections.

We want this to be done to help the frontend safely update workspaces with a to be created new fields for geography (this will be the default geography for all connections in a certain workspace).

Some more background for this work can be found in this ticket: https://github.com/airbytehq/airbyte-cloud/issues/2278

There should also be a previous PR that converts a connection to allow for PATCH style updates, which we can use as an example.

@pmossman pmossman changed the title Change workspace update call to support a PATCH style endpoint Modify workspace API endpoints to set a preferred Geography Sep 13, 2022
@mfsiega-airbyte
Copy link
Contributor

#16739 to make workspaces update patch-style.

@pmossman
Copy link
Contributor

Planning notes:

  • We'll default to 'Auto' on the backend when the user hasn't selected a specific preference. User should be able to select between 'Auto', 'US', and 'EU' for the first iteration of multi-cloud general-availability

@pmossman pmossman changed the title Modify workspace API endpoints to set a preferred Geography Modify workspace API endpoints to be PATCH-style (in preparation for setting Geography) Oct 6, 2022
@pmossman pmossman closed this as completed Oct 6, 2022
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