jprdonnelly/airbyte
1
0
Fork 0
mirror of synced 2025-12-25 20:04:10 -05:00
Code Issues Packages Projects Releases Wiki Activity

Update Airbyte Protocol Docs (#13709)

Browse Source
This commit is contained in:
Charles
2022-06-14 15:04:38 -07:00
committed by GitHub
parent 61ce03a436
commit 22b727c0ea
32 changed files with 835 additions and 325 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
airbyte-cdk/python/docs/tutorials/cdk-tutorial-python-http/3-define-inputs.md
View File

@@ -4,7 +4,7 @@ Each connector declares the inputs it needs to read data from the underlying dat
The simplest way to implement this is by creating a `.json` file in `source_<name>/spec.json` which describes your connector's inputs according to the [ConnectorSpecification](https://github.com/airbytehq/airbyte/blob/master/airbyte-protocol/models/src/main/resources/airbyte_protocol/airbyte_protocol.yaml#L211) schema. This is a good place to start when developing your source. Using JsonSchema, define what the inputs are \(e.g. username and password\). Here's [an example](https://github.com/airbytehq/airbyte/blob/master/airbyte-integrations/connectors/source-freshdesk/source_freshdesk/spec.json) of what the `spec.json` looks like for the Freshdesk API source.
For more details on what the spec is, you can read about the Airbyte Protocol [here](https://docs.airbyte.io/understanding-airbyte/airbyte-specification).
For more details on what the spec is, you can read about the Airbyte Protocol [here](https://docs.airbyte.io/understanding-airbyte/airbyte-protocol).
The generated code that Airbyte provides, handles implementing the `spec` method for you. It assumes that there will be a file called `spec.json` in the same directory as `source.py`. If you have declared the necessary JsonSchema in `spec.json` you should be done with this step.