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

add instancewide variables setter endpoints #5940

Merged
merged 21 commits into from
Sep 9, 2021

Conversation

sherifnada
Copy link
Contributor

What

closes #5920

How

Adds an endpoint which allows writing instancewide oauth secrets

Recommended reading order

  1. config.yaml
  2. OauthHandler.java & OauthHandlerTest.java
  3. ConfigurationApi.java

@sherifnada sherifnada changed the title Sherif/add instancewide setter endpoints add instancewide variables setter endpoints Sep 9, 2021
@github-actions github-actions bot added area/api Related to the api area/connectors Connector related issues area/platform issues related to the platform area/documentation Improvements or additions to documentation area/frontend area/worker Related to worker CDK Connector Development Kit labels Sep 9, 2021
@github-actions github-actions bot removed CDK Connector Development Kit area/frontend area/worker Related to worker area/connectors Connector related issues labels Sep 9, 2021
Comment on lines +3004 to +3012
required:
- sourceConnectorDefinitionId
- params
properties:
sourceDefinitionId:
$ref: "#/components/schemas/SourceDefinitionId"
params:
type: object
additionalProperties: true
Copy link
Contributor

Choose a reason for hiding this comment

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

If we also add workspaceId as an optional properties (not required), we can also handle setting workspace specific parameters.

Thus, I wouldn't include the instanceWide in the naming

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 am intentionally including this so that endpoint permissioning is possible without having to inspect the body of the request i.e: I want to make this whole endpoint available only to super admins rather than depending on whether workspace ID is passed, make it available to different permission levels. WDYT?

Copy link
Contributor

Choose a reason for hiding this comment

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

Ok that makes sense!

Base automatically changed from chris/oauth-params to master September 9, 2021 08:36
@github-actions github-actions bot added the area/connectors Connector related issues label Sep 9, 2021
@sherifnada
Copy link
Contributor Author

@ChristopheDuong gonna move forward on this but please add any further comments and I'll address them as soon as I can

@sherifnada sherifnada merged commit fc159d8 into master Sep 9, 2021
@sherifnada sherifnada deleted the sherif/add-instancewide-setter-endpoints branch September 9, 2021 21:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/api Related to the api area/connectors Connector related issues area/documentation Improvements or additions to documentation area/platform issues related to the platform
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add API endpoints to write instance-wide secrets
2 participants