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

API documentation #9

Merged
merged 11 commits into from
Aug 10, 2020
Merged

API documentation #9

merged 11 commits into from
Aug 10, 2020

Conversation

cgardens
Copy link
Contributor

@cgardens cgardens commented Aug 5, 2020

The easiest way to view this will be in swagger hub here. Also don't use the github diff here. Just look at the new version. The old version of this file was just the swagger example.

This PR describes the API interface for configuring Conduit.

Highlights:

  • Source and SourceSpecification have been separated (same for destinations as well). We can consolidate them for now, but this choice is made in anticipation of wanting to allow multiple specification versions for a source in the future. Would appreciate feedback if people think that consolidation would be prudent now.
  • This API does not consolidate endpoints for UI consumptions like we did in the unblocking product. TBD on what to do about that.
  • The workspace concept exists solely for the purpose of name spacing configurations. In MVP, I imagine we would just hardcode workspace id.
  • At this point the only non-standard configuration (i.e. one that is specific per tap) that happens in the UI is for "connectionConfiguration" for both source and destination. The state concept never get exposed in via this API.

@cgardens cgardens marked this pull request as ready for review August 5, 2020 22:10
@cgardens
Copy link
Contributor Author

cgardens commented Aug 5, 2020

build is failing because codegen not working with type: any. looking into it. github issue here.

@cgardens
Copy link
Contributor Author

cgardens commented Aug 5, 2020

I think this was fixed in may PR, but it's in the beta release. going to see if we can just use beta release.

@cgardens
Copy link
Contributor Author

cgardens commented Aug 5, 2020

Hah. this was introduced in 4.3.1, downgrading to 4.3.0 fixes it. comment.

conduit-api/src/main/openapi/conduit.yaml Outdated Show resolved Hide resolved
conduit-api/src/main/openapi/conduit.yaml Outdated Show resolved Hide resolved
conduit-api/src/main/openapi/conduit.yaml Outdated Show resolved Hide resolved
@cgardens cgardens force-pushed the charles/api_docs branch 2 times, most recently from cc4ccf8 to 40be669 Compare August 10, 2020 20:22
@cgardens cgardens merged commit 7b3faf9 into master Aug 10, 2020
@cgardens cgardens deleted the charles/api_docs branch August 10, 2020 20:25
mohamagdy added a commit to mohamagdy/airbyte that referenced this pull request May 1, 2022
…-dbt

Set Timeout if no input read from the Source
@sbjorn sbjorn mentioned this pull request Aug 29, 2022
18 tasks
c-p-b pushed a commit that referenced this pull request Feb 17, 2023
* delete github workflows related to connectors

* remove connectors builds from gradle.yml

* airbyte -> airbyte-platform
@avirajsingh7 avirajsingh7 mentioned this pull request Aug 3, 2023
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants