diff --git a/MIGRATION-REPORT-phase2.md b/MIGRATION-REPORT-phase2.md index 76159f5c3..a65014e5b 100644 --- a/MIGRATION-REPORT-phase2.md +++ b/MIGRATION-REPORT-phase2.md @@ -1,93 +1,16 @@ -# PHASE-2 BATCH REPORT — Components › Data Source Connectors +# PHASE-2 BATCH REPORT — Components › Data Destination Connectors -moved: 39 · skipped: 0 · link-flipped files: 43 · errors: 0 +moved: 3 · skipped: 0 · link-flipped files: 2 · errors: 0 -## moved (39) -- /extend/generic-extractor/configuration/api/authentication/api_key/ -> /components/extractors/generic-extractor/configuration/api/authentication/api_key/ -- /extend/generic-extractor/configuration/api/authentication/basic/ -> /components/extractors/generic-extractor/configuration/api/authentication/basic/ -- /extend/generic-extractor/configuration/api/authentication/bearer_token/ -> /components/extractors/generic-extractor/configuration/api/authentication/bearer_token/ -- /extend/generic-extractor/configuration/api/authentication/ -> /components/extractors/generic-extractor/configuration/api/authentication/ -- /extend/generic-extractor/configuration/api/authentication/login/ -> /components/extractors/generic-extractor/configuration/api/authentication/login/ -- /extend/generic-extractor/configuration/api/authentication/oauth10/ -> /components/extractors/generic-extractor/configuration/api/authentication/oauth10/ -- /extend/generic-extractor/configuration/api/authentication/oauth20-login/ -> /components/extractors/generic-extractor/configuration/api/authentication/oauth20-login/ -- /extend/generic-extractor/configuration/api/authentication/oauth20/ -> /components/extractors/generic-extractor/configuration/api/authentication/oauth20/ -- /extend/generic-extractor/configuration/api/authentication/oauth_cc/ -> /components/extractors/generic-extractor/configuration/api/authentication/oauth_cc/ -- /extend/generic-extractor/configuration/api/authentication/query/ -> /components/extractors/generic-extractor/configuration/api/authentication/query/ -- /extend/generic-extractor/configuration/api/ -> /components/extractors/generic-extractor/configuration/api/ -- /extend/generic-extractor/configuration/api/pagination/cursor/ -> /components/extractors/generic-extractor/configuration/api/pagination/cursor/ -- /extend/generic-extractor/configuration/api/pagination/ -> /components/extractors/generic-extractor/configuration/api/pagination/ -- /extend/generic-extractor/configuration/api/pagination/multiple/ -> /components/extractors/generic-extractor/configuration/api/pagination/multiple/ -- /extend/generic-extractor/configuration/api/pagination/offset/ -> /components/extractors/generic-extractor/configuration/api/pagination/offset/ -- /extend/generic-extractor/configuration/api/pagination/pagenum/ -> /components/extractors/generic-extractor/configuration/api/pagination/pagenum/ -- /extend/generic-extractor/configuration/api/pagination/response-param/ -> /components/extractors/generic-extractor/configuration/api/pagination/response-param/ -- /extend/generic-extractor/configuration/api/pagination/response-url/ -> /components/extractors/generic-extractor/configuration/api/pagination/response-url/ -- /extend/generic-extractor/configuration/aws-signature/ -> /components/extractors/generic-extractor/configuration/aws-signature/ -- /extend/generic-extractor/configuration/config/ -> /components/extractors/generic-extractor/configuration/config/ -- /extend/generic-extractor/configuration/config/jobs/children/ -> /components/extractors/generic-extractor/configuration/config/jobs/children/ -- /extend/generic-extractor/configuration/config/jobs/ -> /components/extractors/generic-extractor/configuration/config/jobs/ -- /extend/generic-extractor/configuration/config/mappings/ -> /components/extractors/generic-extractor/configuration/config/mappings/ -- /extend/generic-extractor/configuration/ -> /components/extractors/generic-extractor/configuration/ -- /extend/generic-extractor/configuration/iterations/ -> /components/extractors/generic-extractor/configuration/iterations/ -- /extend/generic-extractor/configuration/ssh-proxy/ -> /components/extractors/generic-extractor/configuration/ssh-proxy/ -- /extend/generic-extractor/functions/ -> /components/extractors/generic-extractor/functions/ -- /extend/generic-extractor/incremental/ -> /components/extractors/generic-extractor/incremental/ -- /extend/generic-extractor/ -> /components/extractors/generic-extractor/ -- /extend/generic-extractor/map/ -> /components/extractors/generic-extractor/map/ -- /extend/generic-extractor/publish/ -> /components/extractors/generic-extractor/publish/ -- /extend/generic-extractor/running/ -> /components/extractors/generic-extractor/running/ -- /extend/generic-extractor/tutorial/basic/ -> /components/extractors/generic-extractor/tutorial/basic/ -- /extend/generic-extractor/tutorial/ -> /components/extractors/generic-extractor/tutorial/ -- /extend/generic-extractor/tutorial/jobs/ -> /components/extractors/generic-extractor/tutorial/jobs/ -- /extend/generic-extractor/tutorial/json/ -> /components/extractors/generic-extractor/tutorial/json/ -- /extend/generic-extractor/tutorial/mapping/ -> /components/extractors/generic-extractor/tutorial/mapping/ -- /extend/generic-extractor/tutorial/pagination/ -> /components/extractors/generic-extractor/tutorial/pagination/ -- /extend/generic-extractor/tutorial/rest/ -> /components/extractors/generic-extractor/tutorial/rest/ +## moved (3) +- /extend/generic-writer/configuration-examples/ -> /components/writers/generic-writer/configuration-examples/ +- /extend/generic-writer/configuration/ -> /components/writers/generic-writer/configuration/ +- /extend/generic-writer/ -> /components/writers/generic-writer/ ## skipped (0) -## flips (43) -- src/content/docs/cli/keboola-as-code/getting-started/index.md -- src/content/docs/components/extractors/generic-extractor/configuration/api/authentication/api_key/index.md -- src/content/docs/components/extractors/generic-extractor/configuration/api/authentication/basic/index.md -- src/content/docs/components/extractors/generic-extractor/configuration/api/authentication/bearer_token/index.md -- src/content/docs/components/extractors/generic-extractor/configuration/api/authentication/index.md -- src/content/docs/components/extractors/generic-extractor/configuration/api/authentication/login/index.md -- src/content/docs/components/extractors/generic-extractor/configuration/api/authentication/oauth10/index.md -- src/content/docs/components/extractors/generic-extractor/configuration/api/authentication/oauth20/index.md -- src/content/docs/components/extractors/generic-extractor/configuration/api/authentication/oauth20-login/index.md -- src/content/docs/components/extractors/generic-extractor/configuration/api/authentication/oauth_cc/index.md -- src/content/docs/components/extractors/generic-extractor/configuration/api/authentication/query/index.md -- src/content/docs/components/extractors/generic-extractor/configuration/api/index.md -- src/content/docs/components/extractors/generic-extractor/configuration/api/pagination/cursor/index.md -- src/content/docs/components/extractors/generic-extractor/configuration/api/pagination/index.md -- src/content/docs/components/extractors/generic-extractor/configuration/api/pagination/multiple/index.md -- src/content/docs/components/extractors/generic-extractor/configuration/api/pagination/offset/index.md -- src/content/docs/components/extractors/generic-extractor/configuration/api/pagination/pagenum/index.md -- src/content/docs/components/extractors/generic-extractor/configuration/api/pagination/response-param/index.md -- src/content/docs/components/extractors/generic-extractor/configuration/api/pagination/response-url/index.md -- src/content/docs/components/extractors/generic-extractor/configuration/config/index.md -- src/content/docs/components/extractors/generic-extractor/configuration/config/jobs/children/index.md -- src/content/docs/components/extractors/generic-extractor/configuration/config/jobs/index.md -- src/content/docs/components/extractors/generic-extractor/configuration/config/mappings/index.md -- src/content/docs/components/extractors/generic-extractor/configuration/index.md -- src/content/docs/components/extractors/generic-extractor/configuration/iterations/index.md -- src/content/docs/components/extractors/generic-extractor/configuration/ssh-proxy/index.md -- src/content/docs/components/extractors/generic-extractor/functions/index.md -- src/content/docs/components/extractors/generic-extractor/incremental/index.md -- src/content/docs/components/extractors/generic-extractor/index.md -- src/content/docs/components/extractors/generic-extractor/map/index.md -- src/content/docs/components/extractors/generic-extractor/publish/index.md -- src/content/docs/components/extractors/generic-extractor/running/index.md -- src/content/docs/components/extractors/generic-extractor/tutorial/basic/index.md -- src/content/docs/components/extractors/generic-extractor/tutorial/index.md -- src/content/docs/components/extractors/generic-extractor/tutorial/jobs/index.md -- src/content/docs/components/extractors/generic-extractor/tutorial/mapping/index.md -- src/content/docs/components/extractors/generic-extractor/tutorial/pagination/index.md -- src/content/docs/components/extractors/other/generic/generic.md -- src/content/docs/extend/common-interface/manifest-files/out-tables-manifests/index.md -- src/content/docs/extend/common-interface/manifest-files/out-tables-manifests-native-types/index.md -- src/content/docs/extend/component/ui-options/index.md -- src/content/docs/extend/generic-writer/index.md -- src/content/docs/extend/index.md +## flips (2) +- src/content/docs/components/writers/generic-writer/configuration/index.md +- src/content/docs/components/writers/generic-writer/index.md ## errors (0) diff --git a/_data/navigation.yml b/_data/navigation.yml index 6c0a7a9f8..921433baa 100644 --- a/_data/navigation.yml +++ b/_data/navigation.yml @@ -580,6 +580,14 @@ items: - url: /components/writers/other/yourpass/ title: YourPass + - url: /components/writers/generic-writer/ + title: Generic Writer + items: + - url: /components/writers/generic-writer/configuration/ + title: Configuration + - url: /components/writers/generic-writer/configuration-examples/ + title: Configuration Examples + - url: /components/applications/ title: Applications items: @@ -888,13 +896,6 @@ items: title: Default Configuration - url: /extend/component/deployment/ title: Deployment - - url: /extend/generic-writer/ - title: Generic Writer - items: - - url: /extend/generic-writer/configuration/ - title: Configuration - - url: /extend/generic-writer/configuration-examples/ - title: Configuration Examples - url: /extend/common-interface/ title: Common Interface items: diff --git a/src/content/docs/extend/generic-writer/configuration-examples/index.md b/src/content/docs/components/writers/generic-writer/configuration-examples/index.md similarity index 98% rename from src/content/docs/extend/generic-writer/configuration-examples/index.md rename to src/content/docs/components/writers/generic-writer/configuration-examples/index.md index 756513286..8f514c3d5 100644 --- a/src/content/docs/extend/generic-writer/configuration-examples/index.md +++ b/src/content/docs/components/writers/generic-writer/configuration-examples/index.md @@ -1,6 +1,8 @@ --- title: Generic Writer Configuration Examples -slug: 'extend/generic-writer/configuration-examples' +slug: 'components/writers/generic-writer/configuration-examples' +redirect_from: + - /extend/generic-writer/configuration-examples/ --- diff --git a/src/content/docs/extend/generic-writer/configuration/index.md b/src/content/docs/components/writers/generic-writer/configuration/index.md similarity index 80% rename from src/content/docs/extend/generic-writer/configuration/index.md rename to src/content/docs/components/writers/generic-writer/configuration/index.md index 3c3edc2fe..3ad76e019 100644 --- a/src/content/docs/extend/generic-writer/configuration/index.md +++ b/src/content/docs/components/writers/generic-writer/configuration/index.md @@ -1,6 +1,8 @@ --- title: Generic Writer Configuration -slug: 'extend/generic-writer/configuration' +slug: 'components/writers/generic-writer/configuration' +redirect_from: + - /extend/generic-writer/configuration/ --- @@ -10,7 +12,7 @@ table and single endpoint per configuration. The data can be sent in two ways: 1. Send all content at once - either BINARY or JSON in chunks -2. [Iterate](/extend/generic-writer/configuration/#iterate-by-columns) through each row - where the data is sent in +2. [Iterate](/components/writers/generic-writer/configuration/#iterate-by-columns) through each row - where the data is sent in iterations specified in the input data. By default 1 row = 1 iteration. This allows to change the endpoint dynamically based on the input using placeholders: `www.example.com/api/user/{{id}}`. Or sending data with different user parameters that are present in the input table. @@ -19,40 +21,40 @@ The data can be sent in two ways: *Click on the section names if you want to learn more.* -- [**api**](/extend/generic-writer/configuration/#api) --- [REQUIRED] sets the basic properties of the API. - - [**base_url**](/extend/generic-writer/configuration/#base-url) --- [REQUIRED] defines the URL to which the API requests +- [**api**](/components/writers/generic-writer/configuration/#api) --- [REQUIRED] sets the basic properties of the API. + - [**base_url**](/components/writers/generic-writer/configuration/#base-url) --- [REQUIRED] defines the URL to which the API requests should be sent. - - [**authentication**](/extend/generic-writer/configuration/#authentication) --- needs to be configured for any API + - [**authentication**](/components/writers/generic-writer/configuration/#authentication) --- needs to be configured for any API which is not public. - - [**retry_config**](/extend/generic-writer/configuration/#retry-config) --- automatically, and repeatedly, retries + - [**retry_config**](/components/writers/generic-writer/configuration/#retry-config) --- automatically, and repeatedly, retries failed HTTP requests. - - [**default_query_parameters**](/extend/generic-writer/configuration/#default-query-parameters) --- sets the + - [**default_query_parameters**](/components/writers/generic-writer/configuration/#default-query-parameters) --- sets the default query parameters sent with each API call. - - [**default_headers**](/extend/generic-writer/configuration/#default-headers) --- sets the default query headers + - [**default_headers**](/components/writers/generic-writer/configuration/#default-headers) --- sets the default query headers sent with each API call. - - [**ssl_verification**](/extend/generic-writer/configuration/#ssl-verification) --- allows turning of the SSL certificate + - [**ssl_verification**](/components/writers/generic-writer/configuration/#ssl-verification) --- allows turning of the SSL certificate verification. Use with caution. - - [**timeout**](/extend/generic-writer/configuration/#timeout) --- maximum time in seconds for which the component + - [**timeout**](/components/writers/generic-writer/configuration/#timeout) --- maximum time in seconds for which the component waits after each request (defaults to None if not set). -- [**user_parameters**](/extend/generic-writer/configuration/#user-parameters) --- user parameters to be used in various +- [**user_parameters**](/components/writers/generic-writer/configuration/#user-parameters) --- user parameters to be used in various contexts, e.g. passwords. Supports dynamic functions. -- [**request_parameters**](/extend/generic-writer/configuration/#request-parameters) --- [REQUIRED] HTTP parameters of the request - - [**method**](/extend/generic-writer/configuration/#method) --- [REQUIRED] defines the HTTP method of the requests. - - [**endpoint_path**](/extend/generic-writer/configuration/#enpoint-path) --- [REQUIRED] relative path of the endpoint. - - [**query_parameters**](/extend/generic-writer/configuration/#query-parameters) --- query parameters sent with each +- [**request_parameters**](/components/writers/generic-writer/configuration/#request-parameters) --- [REQUIRED] HTTP parameters of the request + - [**method**](/components/writers/generic-writer/configuration/#method) --- [REQUIRED] defines the HTTP method of the requests. + - [**endpoint_path**](/components/writers/generic-writer/configuration/#enpoint-path) --- [REQUIRED] relative path of the endpoint. + - [**query_parameters**](/components/writers/generic-writer/configuration/#query-parameters) --- query parameters sent with each request - - [**headers**](/extend/generic-writer/configuration/#headers) --- headers sent with each request -- [**request_content**](/extend/generic-writer/configuration/#request-content) --- [REQUIRED] defines how the data is sent - - [**content_type**](/extend/generic-writer/configuration/#content-type) --- [REQUIRED] defines how the data is transferred ( + - [**headers**](/components/writers/generic-writer/configuration/#headers) --- headers sent with each request +- [**request_content**](/components/writers/generic-writer/configuration/#request-content) --- [REQUIRED] defines how the data is sent + - [**content_type**](/components/writers/generic-writer/configuration/#content-type) --- [REQUIRED] defines how the data is transferred ( JSON, binary file, Empty, etc.) - - [**json_mapping**](/extend/generic-writer/configuration/#json-mapping) --- defines the CSV 2 JSON conversion in + - [**json_mapping**](/components/writers/generic-writer/configuration/#json-mapping) --- defines the CSV 2 JSON conversion in case of JSON content type. - - [**iterate_by_columns**](/extend/generic-writer/configuration/#iterate-by-columns) --- defines set of columns in + - [**iterate_by_columns**](/components/writers/generic-writer/configuration/#iterate-by-columns) --- defines set of columns in the input data that are excluded from the content and may be used instead of placeholders within the request_options. The input table is iterated row by row, e.g. 1 row = 1 request -- [**debug**](/extend/generic-writer/configuration/#debug) --- Turns on more verbose logging for debugging purposes. +- [**debug**](/components/writers/generic-writer/configuration/#debug) --- Turns on more verbose logging for debugging purposes. -There are also simple pre-defined [**functions**](/extend/generic-writer/configuration/#dynamic-functions) available, +There are also simple pre-defined [**functions**](/components/writers/generic-writer/configuration/#dynamic-functions) available, adding extra flexibility when needed. ### Configuration Map @@ -148,41 +150,41 @@ navigate between them. @@ -395,10 +397,10 @@ All parameters defined here can be then referenced using the `{"attr":"PARAMETER in the following sections: - in the `user_parameters` section itself. -- [`api.default_query_parameters`](/extend/generic-writer/configuration/#default-query-parameters) -- [`api.default_headers`](/extend/generic-writer/configuration/#default-headers) -- [`request_parameters.headers`](/extend/generic-writer/configuration/#headers) -- [`request_parameters.query parameters`](/extend/generic-writer/configuration/#query-parameters) +- [`api.default_query_parameters`](/components/writers/generic-writer/configuration/#default-query-parameters) +- [`api.default_headers`](/components/writers/generic-writer/configuration/#default-headers) +- [`request_parameters.headers`](/components/writers/generic-writer/configuration/#headers) +- [`request_parameters.query parameters`](/components/writers/generic-writer/configuration/#query-parameters) See example [010](https://bitbucket.org/kds_consulting_team/kds-team.wr-generic/src/master/docs/examples/010-simple-json-user-parameters-various) @@ -427,7 +429,7 @@ e.g. when `base_url` is set to `https://example.com/api` and `endpoint_path` to is `https://example.com/api/customer` **NOTE** That it is possible to change the `enpoint_path` dynamically -using [iteration columns](/extend/generic-writer/configuration/#iterate-by-columns) e.g. `/orders/[[id]]` as seen +using [iteration columns](/components/writers/generic-writer/configuration/#iterate-by-columns) e.g. `/orders/[[id]]` as seen in [example 005](https://bitbucket.org/kds_consulting_team/kds-team.wr-generic/src/master/docs/examples/005-json-iterations/) ```json @@ -866,7 +868,7 @@ The function takes two arguments: } ``` -The above value is then available in [supported contexts](/extend/generic-writer/configuration/#referencing-parameters) +The above value is then available in [supported contexts](/components/writers/generic-writer/configuration/#referencing-parameters) as: ```json diff --git a/src/content/docs/extend/generic-writer/index.md b/src/content/docs/components/writers/generic-writer/index.md similarity index 93% rename from src/content/docs/extend/generic-writer/index.md rename to src/content/docs/components/writers/generic-writer/index.md index cb901a244..f0b63abbd 100644 --- a/src/content/docs/extend/generic-writer/index.md +++ b/src/content/docs/components/writers/generic-writer/index.md @@ -1,6 +1,8 @@ --- title: Generic Writer -slug: 'extend/generic-writer' +slug: 'components/writers/generic-writer' +redirect_from: + - /extend/generic-writer/ --- @@ -44,5 +46,5 @@ allows you to leverage secure [encripted parameters](overview/encryption/) and d - Calling arbitrary endpoints with parameters defined on the input - E.g., `DELETE api.com/[[user_id]]` where `user_id` is a column in the input table -For real configuration examples, see the [configuration examples section](/extend/generic-writer/configuration-examples) +For real configuration examples, see the [configuration examples section](/components/writers/generic-writer/configuration-examples) or the collection of [functional examples](https://bitbucket.org/kds_consulting_team/kds-team.wr-generic/src/master/docs/examples/). diff --git a/src/sidebar.mjs b/src/sidebar.mjs index 3330c8d75..6c88aa25f 100644 --- a/src/sidebar.mjs +++ b/src/sidebar.mjs @@ -415,6 +415,15 @@ export const sidebar = [ { slug: "components/writers/other/yourpass" }, ], }, + { + label: "Generic Writer", + collapsed: true, + items: [ + { label: "Overview", slug: "components/writers/generic-writer" }, + { slug: "components/writers/generic-writer/configuration" }, + { slug: "components/writers/generic-writer/configuration-examples" }, + ], + }, ], }, { @@ -684,15 +693,6 @@ export const sidebar = [ { slug: "extend/component/deployment" }, ], }, - { - label: "Generic Writer", - collapsed: true, - items: [ - { label: "Overview", slug: "extend/generic-writer" }, - { slug: "extend/generic-writer/configuration" }, - { slug: "extend/generic-writer/configuration-examples" }, - ], - }, { label: "Common Interface", collapsed: true,