1
0
mirror of synced 2025-12-22 03:21:25 -05:00
Commit Graph

98 Commits

Author SHA1 Message Date
Maxime Carbonneau-Leclerc
423cb8bdbc [ISSUE-20322] updating tutorial documentation (#21163)
* [ISSUE-20322] updating tutorial documentation

* [ISSUE-20322] updating test and improving docs
2023-01-10 10:03:35 -05:00
Lake Mossman
d414e3d4f7 Update Connector Builder docs to reflect configuration UI additions (#21129)
* update connector builder docs for UI MVP release

* remove note about separately declaring schemas
2023-01-06 13:01:34 -08:00
Maxime Carbonneau-Leclerc
4f0aca536c [ISSUE #20322] add datetime_granularity logic to DatetimeStreamSlicer… (#20717)
* [ISSUE #20322] add datetime_granularity logic to DatetimeStreamSlicer and migrate duration to ISO8601

* [ISSUE #20322] fix tests

* [ISSUE #20322] code review based on clnoll's comments and fixed tests

* [ISSUE #20322] fix flake8 error

* [ISSUE #20322] fix source tests

* [ISSUE #20322] fixing yet another error in source

* [ISSUE #20322] code review

* [ISSUE #20322] adding new sources using datetime slicer

* [ISSUE #20322] fixing source-datascope and increasing version

* [ISSUE #20322] regenerate component schema

* [ISSUE #20322] fixing source-datascope

* [ISSUE #20322] extra field error
2023-01-06 12:29:37 -05:00
Brian Lai
b7113a2e5e [Low-Code CDK] Write the component schema and use it during manifest validation (#20422)
* handwritten low code manifest example components

* add MinMaxDatetime to jsonschema

* add a basic gradle command to generate manifest components

* Add auth components to handwritten component schema

- ApiKeyAuthenticator
- BasicHttpAuthenticator
- BearerAuthenticator
- DeclarativeOauth2Authenticator
- NoAuth

* Respect optional properties in DeclarativeOauth2Authenticator

* Fix `Dict[str, Any]` mapping in auth components

* add default error handler composite error handler and http response filter components

* [low code component schema] adding backoff strategies to schema

* [low code component schema] fix float types

* [low code component schema] add RecordFilter

* Remove `config` from auth components

* [low code component schema] add Interpolation (with pending question on 'type' not being defined)

* Add CartesianProductStreamSlicer & DatetimeStreamSlicer

* Add ListStreamSlicer, and fix nesting of DatetimeStreamSlicer

* [low code component schema] add InterpolatedRequestOptionsProvider

* Add slicer components, and fix a couple of components after reviewing output

* [low code component schema] adding transformations and adding type to interpolators

* adding spec and a few small tweaks

* Add DefaultSchemaLoader

* [low code component schema] attempt on custom class

* Add descriptions for auth components

* add RequestOption

* remove interpolated objects from the schema in favor of strings only

* a few schema fixes and adding some custom pagination and stream slicer

* [low code component schema] fix CustomBackoffStrategy

* Add CustomRecordExtractor

* add some description and add additional properties

* insert a transformer to hydrate default manifest components and perform validation against the handwritten schema

* [low code component schema] validating existing schemas

* [low code component schema] clean validation script

* add manifest transformer tests and a few tweaks to the schema

* Revert "[low code component schema] clean validation script"

This reverts commit 2408f41cf6.

* Revert "[low code component schema] validating existing schemas"

This reverts commit 9d39977815.

* [low code component schema] integrate validation script to gradle

* [low code component schema] updating validation script permissions

* remove a few model gen spike files and clean up comments

* default types should take parent type into account and a few schema changes

* add inline schema components and fix validation bugs

* add types to every component's literal enum and more little schema fixes

* missing component prefix

* pr feedback, renaming the schema and updating various docs

* fixing schema bugs from testing and new components

* last few small tweaks and fixes and fix the script

* bump the version before publsih

* include the declarative_component_schema.yaml as package data so its included when package is published

* roll the version to publish

Co-authored-by: Catherine Noll <noll.catherine@gmail.com>
Co-authored-by: maxi297 <maxime@airbyte.io>
2022-12-19 14:42:34 -06:00
Catherine Noll
9dae0986f9 Enable low-code CDK users to specify schema in the manifest (#20375)
Enable low-code CDK users to specify schema in the manifest

Also update documentation:
* Add inline schema loader info to yaml-overview.md
* Include inline schema info in tutorial
2022-12-12 23:44:11 -05:00
Philipp Wallhäuser
c4c26c0adc fix wrong indentation in error handling docs (#20288) 2022-12-09 15:16:42 -03:00
Julian
dc71194e39 Fix: Tutorial config-based invalid keywords #20071 (#20078)
* Update 5-incremental-reads.md in response of Issue #20047

Added the suggested solution from issuer.

* Updated 5-incremental-reads.md #2

Appended the suggested +00:00 into another occurence. Datetime format now corresponds to standards defined in ISO-8601.

* Fix: Low Code Connector tutorial yaml #20071
2022-12-08 14:33:18 -03:00
Alexandre Girard
61ddba697e Alex/lowcode custom components docs (#20176)
* Update label

* reset

* update

* update

* update

* Update

* update
2022-12-06 19:01:54 -08:00
Andy
0b6999993d docs: Include alpha call out in lowcode builder UI docs (#19841)
Co-authored-by: Sherif A. Nada <snadalive@gmail.com>
2022-11-28 10:51:48 -08:00
Lake Mossman
f53bbb3c24 Docs: fix broken connector builder UI docs links (#19631) 2022-11-18 18:03:47 -08:00
Sherif Nada
7598ca0b34 fix docs build 2022-11-18 11:13:24 -08:00
Sherif A. Nada
f5d8e25519 Add connector builder UI docs (#19588) 2022-11-18 10:56:30 -08:00
Amruta Ranade
17932faebd Update low-code-cdk-overview.md 2022-11-16 14:02:12 -05:00
Sherif A. Nada
88da35c6f9 Fix callout formatting in CDK docs 2022-11-16 08:14:08 -08:00
Andy
56342d28cd Lowcode CDK docs: Update with CTA for creating feature requests (#19462) 2022-11-15 21:25:01 -08:00
JJ Nilbodee
33227f5812 Allows user to specify grant_type in OAuthAuthenticator (#19139)
Co-authored-by: Sherif A. Nada <snadalive@gmail.com>
2022-11-10 22:22:17 -08:00
Alexandre Girard
605fb921c4 [low-code]: Evaluate backoff strategies at runtime (#18053)
* pass options to wait time from header

* fix constant backoff

* parameterize test

* fix tests

* missing unit tests

* eval header at runtime

* eval regex at runtime

* evaluate min_wait at runtime

* eval factor at runtime

* missing unit tests

* remove debug print

* rename

* Add tests

* Add tests

* Update docs
2022-11-03 18:50:47 -07:00
Sherif A. Nada
f4e3b605c9 fix typo in lowcode tutorial (#18916) 2022-11-03 09:18:37 -07:00
Scott Lee Chua
926a26a02e Remove duplicate paragraph (#18662)
Removes a duplicate of the paragraph that begins "Note that we're also setting the `stream_cursor_field` in the stream's `$options`..." which followed an outdated schema.
2022-10-31 08:35:45 -07:00
JC (Jonathan Chen)
042300751a docs: fix link reference (#18503) 2022-10-26 17:08:21 -03:00
Delena Malan
4b0d1d4ac6 Replace NoPaginator in the docs with NoPagination (#18142) 2022-10-19 09:20:40 -04:00
Delena Malan
3b12a585ec Docs: Fix backoff stategy docs (#18143)
* Fix backoff strategy docs

* Update config_component_schema.json
2022-10-18 16:28:38 -07:00
Amin
3f2af7d8e1 Update 4-reading-data.md (#18037) 2022-10-17 09:37:47 -03:00
Delena Malan
289a065401 Use page_token_option instead of page_token (#17892) 2022-10-13 19:00:20 -03:00
Delena Malan
6eb3893f14 Remove typo line from incremental reads docs (#17920) 2022-10-13 13:07:56 -03:00
Subham Sahu
2247038a52 DocS: Update authentication.md (#17931) 2022-10-13 13:07:35 -03:00
Amruta Ranade
57571ee94f Fixed broken links 2022-10-13 09:11:57 -05:00
Alexandre Girard
39220f4b1e Update lowcode docs (#17752)
* Update lowcode docs

* Update

* fix links

* more links

* Schemas

* indent

* Update docs/connector-development/config-based/advanced-topics.md

Co-authored-by: Brian Lai <51336873+brianjlai@users.noreply.github.com>

* Update docs/connector-development/config-based/advanced-topics.md

Co-authored-by: Brian Lai <51336873+brianjlai@users.noreply.github.com>

* Update docs/connector-development/config-based/low-code-cdk-overview.md

Co-authored-by: Brian Lai <51336873+brianjlai@users.noreply.github.com>

* Update docs/connector-development/config-based/understanding-the-yaml-file/request-options.md

Co-authored-by: Brian Lai <51336873+brianjlai@users.noreply.github.com>

* Update docs/connector-development/config-based/understanding-the-yaml-file/requester.md

Co-authored-by: Brian Lai <51336873+brianjlai@users.noreply.github.com>

* Update docs/connector-development/config-based/understanding-the-yaml-file/stream-slicers.md

Co-authored-by: Brian Lai <51336873+brianjlai@users.noreply.github.com>

* Update docs/connector-development/config-based/understanding-the-yaml-file/requester.md

Co-authored-by: Brian Lai <51336873+brianjlai@users.noreply.github.com>

* Update docs/connector-development/config-based/understanding-the-yaml-file/error-handling.md

Co-authored-by: Brian Lai <51336873+brianjlai@users.noreply.github.com>

* capitalization

* fix schema

* fix schema

* small changes so greenhouse validates

* fix brackets

* update code samples

* Add missing types

* fix

* reset

Co-authored-by: Brian Lai <51336873+brianjlai@users.noreply.github.com>
2022-10-07 19:15:27 -07:00
Alexandre Girard
141803a78a Fix link in docs (#17670) 2022-10-06 08:30:29 -07:00
Alexandre Girard
65be9b74f0 Simplify low-code connectors template (#17476)
* default schema loader

* Update generator

* update example

* remove more cruft

* Update code sampels in section 3 (but not the text)

* Update code sampels in 5

* Update instructions

* Update code samples

* Update samples

* Use now_utc instead of local

* isolate complexity to JsonSchema

* Bump cdk version

* Update changelog

* fix unit test

* slightly more helpful default

* Don't freeze cdk version in template

* remove newline

* newline

* bump

* Update changelog

* Bump
2022-10-06 08:12:21 -07:00
Amruta Ranade
66dafd85aa Updated Slack link 2022-10-03 19:39:40 -04:00
Amruta Ranade
984945d3aa Added Slack link 2022-10-03 19:22:03 -04:00
Amruta Ranade
1ac6df7537 low-code connector docs (#17534) 2022-10-03 18:22:29 -04:00
Sophia Wiley
06c9ad56f0 Added new title (#17480) 2022-09-30 13:55:16 -07:00
Nataly Merezhuk
7bc911ef2a 📖 Removes $ from terminal commands to allow direct copying. (#17467)
* Removes $ from terminal commands to allow direct copying.

* Fixes build by adding missing link.
2022-09-30 11:54:50 -04:00
Alexandre Girard
d6b79b8e52 Alex/limit paginator (#17197)
* remove page size from limit paginator

* Rename LimitPaginator to DefaultPaginator

* rename limit_options

* rename method

* cleanup

* comment

* update schema file

* Update changelog

* pin greenhouse connector

* fix doc in comment

* fix changelog

* missing -

* bump

* bump
2022-09-29 19:24:53 -07:00
Lake Mossman
232e830980 Fix typos in config based connector docs (#17294)
* add if

* add of

* add clause stating that it starts out with dummy data

* use same format as in code below

* capitalize first word of sentence

* fix typo

* undo unintentional changes

* add quotes around values
2022-09-28 10:14:30 -04:00
Alexandre Girard
4c5f6aa82e Updates to low-code documentation (#17121)
* Update docs

* move substreams to another file

* Update link

* rename

* link to alpha definition

* Update docs/connector-development/config-based/index.md

Co-authored-by: Andy <andy@airbyte.io>

Co-authored-by: Andy <andy@airbyte.io>
2022-09-26 19:05:40 -07:00
Sherif A. Nada
aa57c4328d Update low-code docs to reflect new inject_into parameter renaming (#16556) 2022-09-09 13:03:07 -07:00
Alexandre Girard
4e7ba06282 Document guidelines on low-code support (#16387)
* Guide for using lowcode or not

* Use headers

* Update docs/connector-development/config-based/overview.md

Co-authored-by: Andy <andy@airbyte.io>

* Update docs/connector-development/config-based/overview.md

Co-authored-by: Andy <andy@airbyte.io>

* Update docs/connector-development/config-based/overview.md

Co-authored-by: Brian Lai <51336873+brianjlai@users.noreply.github.com>

* Update docs/connector-development/config-based/overview.md

Co-authored-by: Brian Lai <51336873+brianjlai@users.noreply.github.com>

* an -> a

Co-authored-by: Andy <andy@airbyte.io>
Co-authored-by: Brian Lai <51336873+brianjlai@users.noreply.github.com>
2022-09-07 10:24:55 -07:00
Brian Lai
7e158ef9af [low code connectors] generate complete json schema from classes (#15647)
* draft: first pass at complete schema language generation and factory validator

* actually a working validator and fixes to the schema that went uncaught

* remove extra spike file

* fix formatting file

* Add method to generate the complete JSON schema of the low code declarative language

* add testing of a few components during schema gen

* pr feedback and a little bit of refactoring

* test for schema version

* fix some types that were erroneously marked as invalid schema

* some comments

* add jsonschemamixin to interfaces

* update tests now that interfaces are jsonschemamixin

* accidentally removed a mixin

* remove unneeded test

* make comment a little more clear

* update changelog

* bump version

* generic enum not enum class

* Add method to generate the complete JSON schema of the low code declarative language

* add testing of a few components during schema gen

* test for schema version

* update tests now that interfaces are jsonschemamixin

* accidentally removed a mixin

* remove unneeded test

* make comment a little more clear

* generic enum not enum class

* add generated json file and update docs to reference it

* verbage
2022-08-18 18:53:42 -04:00
Alexandre Girard
25690718da Update low-code documentation (#15748)
* newlines

* remove dots for consistency

* a few more edits

* more edits
2022-08-18 08:13:17 -07:00
Alexandre Girard
55ebbf94bf fix typo (#15747) 2022-08-17 17:59:11 -07:00
Alexandre Girard
52f426271b transform -> field_pointer (#15710) 2022-08-16 21:24:06 -07:00
Alexandre Girard
83dd2c3de2 Don't point to contribution guide (#15703) 2022-08-16 14:00:36 -07:00
Alexandre Girard
1813105e29 Link to the index page (#15693) 2022-08-16 08:26:44 -07:00
Alexandre Girard
2fd43d4d37 Make config-based docs accessible through direct link (#15662)
* fix broken links

* include config-based

* throw on broken links

* fix link

* reset
2022-08-15 10:03:37 -07:00
Alexandre Girard
288c3cabad Tutorial and documentation for config-based connectors (#15027)
* 5-step tutorial

* move

* tiny bit of editing

* Update tutorial

* update docs

* reset

* move files

* record selector, request options, and more links

* update

* update

* connector definition

* link

* links

* update example

* footnote

* typo

* document string interpolation

* note on string interpolation

* update

* fix code sample

* fix

* update sample

* fix

* use the actual config

* Update as per comments

* write as yaml

* typo

* Clarify options overloading

* clarify that docker must be running

* remove extra footnote

* use venv directly

* Apply suggestions from code review

Co-authored-by: Sherif A. Nada <snadalive@gmail.com>

* signup instructions

* update

* clarify that both dot and bracket notations are interchangeable

* Clarify how check works

* create spec and config before updating connector definition

* clarify what now_local() is

* rename to yaml structure

* Go through tutorial and update end of section code samples

* fix link

* update

* update code samples

* Update code samples

* Update to bracket notation

* remove superfluous comments

* Update docs/connector-development/config-based/tutorial/2-install-dependencies.md

Co-authored-by: Augustin <augustin.lafanechere@gmail.com>

* Update docs/connector-development/config-based/tutorial/3-connecting-to-the-API-source.md

Co-authored-by: Augustin <augustin.lafanechere@gmail.com>

* Update docs/connector-development/config-based/tutorial/3-connecting-to-the-API-source.md

Co-authored-by: Augustin <augustin.lafanechere@gmail.com>

* Update docs/connector-development/config-based/tutorial/3-connecting-to-the-API-source.md

Co-authored-by: Augustin <augustin.lafanechere@gmail.com>

* Update docs/connector-development/config-based/tutorial/3-connecting-to-the-API-source.md

Co-authored-by: Augustin <augustin.lafanechere@gmail.com>

* Update docs/connector-development/config-based/tutorial/3-connecting-to-the-API-source.md

Co-authored-by: Augustin <augustin.lafanechere@gmail.com>

* Update docs/connector-development/config-based/tutorial/4-reading-data.md

Co-authored-by: Augustin <augustin.lafanechere@gmail.com>

* fix path

* update

* motivation blurp

* warning

* warning

* fix code block

* update code samples

* update code sample

* update code samples

* small updates

* update yaml structure

* custom class example

* language annotations

* update warning

* Update tutorial to use dpath extractor

* Update record selector docs

* unit test

* link to contributing

* tiny update

* $ in front of commands

* $ in front of commands

* More readings

* link to existing config-based connectors

* index

* update

* delete broken link

* supported features

* update

* Add some links

* Update docs/connector-development/config-based/overview.md

Co-authored-by: Brian Lai <51336873+brianjlai@users.noreply.github.com>

* Update docs/connector-development/config-based/record-selector.md

Co-authored-by: Brian Lai <51336873+brianjlai@users.noreply.github.com>

* Update docs/connector-development/config-based/overview.md

Co-authored-by: Brian Lai <51336873+brianjlai@users.noreply.github.com>

* Update docs/connector-development/config-based/overview.md

Co-authored-by: Brian Lai <51336873+brianjlai@users.noreply.github.com>

* Update docs/connector-development/config-based/overview.md

Co-authored-by: Brian Lai <51336873+brianjlai@users.noreply.github.com>

* mention the unit

* headers

* remove mentions of interpolating on stream slice, etc.

* update

* exclude config-based docs

Co-authored-by: Sherif A. Nada <snadalive@gmail.com>
Co-authored-by: Augustin <augustin.lafanechere@gmail.com>
Co-authored-by: Brian Lai <51336873+brianjlai@users.noreply.github.com>
2022-08-12 15:50:54 -07:00