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

New search API endpoints for connections, sources, and destinations #6656

Merged
merged 10 commits into from
Oct 9, 2021

Conversation

mmolimar
Copy link
Contributor

@mmolimar mmolimar commented Oct 2, 2021

What

This PR adds a new endpoint to search connections, sources, and destinations. The search is very flexible and can include 0 or more values in the payload including values from the connections, sources, and/or destinations (also look for values in the connection configuration).

How

Update the YAML file containing the endpoints with the specification and the ConnectionsHandler, SourceHandler, and DestinationsHandler. Also, I've added a new Matcher interface in the io.airbyte.server.handlers.helpers package.

Recommended reading order

  1. config.yml
  2. ConnectionsHandler.java
  3. SourceHandler.java
  4. DestinationHandler.java
  5. ConfigurationApi.java

Pre-merge Checklist

Expand the relevant checklist and delete the others.

New Connector

Community member or Airbyter

  • Community member? Grant edit access to maintainers (instructions)
  • Secrets in the connector's spec are annotated with airbyte_secret
  • Unit & integration tests added and passing. Community members, please provide proof of success locally e.g: screenshot or copy-paste unit, integration, and 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.
  • Code reviews completed
  • Documentation updated
    • Connector's README.md
    • Connector's bootstrap.md. See description and examples
    • docs/SUMMARY.md
    • docs/integrations/<source or destination>/<name>.md including changelog. See changelog example
    • docs/integrations/README.md
    • airbyte-integrations/builds.md
  • PR name follows PR naming conventions
  • Connector added to connector index like described here

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

  • Create a non-forked branch based on this PR and test the below items on it
  • Build is successful
  • Credentials added to Github CI. Instructions.
  • /test connector=connectors/<name> command is passing.
  • New Connector version released on Dockerhub by running the /publish command described here

Updating a connector

Community member or Airbyter

  • Grant edit access to maintainers (instructions)
  • Secrets in the connector's spec are annotated with airbyte_secret
  • Unit & integration tests added and passing. Community members, please provide proof of success locally e.g: screenshot or copy-paste unit, integration, and 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.
  • Code reviews completed
  • Documentation updated
    • Connector's README.md
    • Connector's bootstrap.md. See description and examples
    • Changelog updated in docs/integrations/<source or destination>/<name>.md including changelog. See changelog example
  • PR name follows PR naming conventions
  • Connector version bumped like described here

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

  • Create a non-forked branch based on this PR and test the below items on it
  • Build is successful
  • Credentials added to Github CI. Instructions.
  • /test connector=connectors/<name> command is passing.
  • New Connector version released on Dockerhub by running the /publish command described here

Connector Generator

  • 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.

@CLAassistant
Copy link

CLAassistant commented Oct 2, 2021

CLA assistant check
All committers have signed the CLA.

@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 Oct 2, 2021
@marcosmarxm
Copy link
Member

Mario thanks for your contribution! Can you run ./gradlew format?

@mmolimar
Copy link
Contributor Author

mmolimar commented Oct 7, 2021

Done! @marcosmarxm

Copy link
Contributor

@tuliren tuliren left a comment

Choose a reason for hiding this comment

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

This is really nice! Thank you. I have a few nitpicks, and a comment about making the unit tests more thorough. But if you don't have bandwidth to make those changes, it's also fine. We an do it in a follow up PR.

Copy link
Contributor

@tuliren tuliren left a comment

Choose a reason for hiding this comment

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

🎉

@tuliren tuliren merged commit ac2d307 into airbytehq:master Oct 9, 2021
schlattk pushed a commit to schlattk/airbyte that referenced this pull request Jan 4, 2022
…airbytehq#6656)

* Add API endpoints for connections, sources, and destinations

* Updating tests

* Tests for source and destination handlers

* Reformat code

* Update airbyte-server/src/main/java/io/airbyte/server/handlers/helpers/ConnectionMatcher.java

Co-authored-by: LiRen Tu <[email protected]>

* Adding tests

* Format code

Co-authored-by: LiRen Tu <[email protected]>
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.

4 participants