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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

馃帀 API: Add an endpoint to list workspaces #4530

Merged

Conversation

mmolimar
Copy link
Contributor

@mmolimar mmolimar commented Jul 3, 2021

What

This PR adds a new endpoint in the API to list all workspaces. Related with #4003

How

Update the YAML file containing the endpoints with the specification and the WorkspaceHandler to enable listing the workspaces.

Recommended reading order

  1. config.yml
  2. ConfigurationApi.java
  3. WorkspacesHandler.java

Pre-merge Checklist

Expand the checklist which is relevant for this PR.

Connector checklist

  • Issue acceptance criteria met
  • PR name follows PR naming conventions
  • Secrets are annotated with airbyte_secret in the connector's spec
  • Credentials added to Github CI if needed and not already present. instructions for injecting secrets into CI.
  • Unit & integration tests added as appropriate (and are passing)
    • Community members: please provide proof of this succeeding locally e.g: screenshot or copy-paste acceptance test output. To run acceptance tests for a Python connector, follow instructions in the README. For java connectors run ./gradlew :airbyte-integrations:connectors:<name>:integrationTest.
  • /test connector=connectors/<name> command as documented here is passing.
    • Community members can skip this, Airbyters will run this for you.
  • Code reviews completed
  • Documentation updated
    • README.md
    • docs/SUMMARY.md if it's a new connector
    • Created or updated reference docs in docs/integrations/<source or destination>/<name>.
    • Changelog in the appropriate page in docs/integrations/.... See changelog example
    • docs/integrations/README.md contains a reference to the new connector
    • Build status added to build page
  • Build is successful
  • Connector version bumped like described here
  • New Connector version released on Dockerhub by running the /publish command described here
  • No major blockers
  • PR merged into master branch
  • Follow up tickets have been created
  • Associated tickets have been closed & stakeholders notified

Connector Generator checklist

  • Issue acceptance criteria met
  • PR name follows PR naming conventions
  • If adding a new generator, add it to the list of scaffold modules being tested
  • The generator test modules (all connectors with -scaffold in their name) have been updated with the latest scaffold by running ./gradlew :airbyte-integrations:connector-templates:generator:testScaffoldTemplates then checking in your changes
  • Documentation which references the generator is updated as needed.

@github-actions github-actions bot added area/api Related to the api area/platform issues related to the platform area/documentation Improvements or additions to documentation labels Jul 3, 2021
@marcosmarxm marcosmarxm self-assigned this Jul 4, 2021
@marcosmarxm
Copy link
Member

Thanks @mmolimar I'm going to review later today!

Copy link
Contributor

@sherifnada sherifnada left a comment

Choose a reason for hiding this comment

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

@mmolimar looks great! thanks for adding it. Just a small request for unit tests and we should be ready to go 馃帀

@@ -141,6 +144,13 @@ public void deleteWorkspace(final WorkspaceIdRequestBody workspaceIdRequestBody)
configRepository.writeStandardWorkspace(persistedWorkspace);
}

public WorkspaceReadList listWorkspaces() throws JsonValidationException, IOException {
Copy link
Contributor

Choose a reason for hiding this comment

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

Could you add unit test to verify this? You can add in WorkspacesHandlerTest.java

Copy link
Contributor Author

@mmolimar mmolimar Jul 4, 2021

Choose a reason for hiding this comment

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

Sure! I just added it @sherifnada ;-)

@sherifnada
Copy link
Contributor

Thanks @mmolimar ! 馃帀

@sherifnada sherifnada changed the title New endpoint to list workspaces 馃帀 API: Add an endpoint to list workspaces Jul 5, 2021
@sherifnada sherifnada merged commit 5c7f886 into airbytehq:master Jul 5, 2021
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/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.

None yet

3 participants