diff --git a/extend/generic-extractor/configuration/api/pagination/index.md b/extend/generic-extractor/configuration/api/pagination/index.md index 628fedb8..3fb90d57 100644 --- a/extend/generic-extractor/configuration/api/pagination/index.md +++ b/extend/generic-extractor/configuration/api/pagination/index.md @@ -118,9 +118,9 @@ situations can arise: - Most common --- API returns an **empty page**; scrolling with [`pagenum`](/extend/generic-extractor/configuration/api/pagination/pagenum/) and -[`offset` methods](/extend/generic-extractor/configuration/api/pagination/pagenum/) will stop, and other methods will probably stop +[`offset` methods](/extend/generic-extractor/configuration/api/pagination/offset/) will stop, and other methods will probably stop too (depends on how empty the response is). -- Less common --- API returns an **error** --- in this case a different stopping condition such as [`nextFlag`](#next-page-flag) or +- Less common --- API returns an **error** --- in this case a different stopping condition such as [`nextPageFlag`](#next-page-flag) or [`forceStop`](#force-stop) has to be used. - Less common --- API keeps returning the **last page**, the extraction is stopped when a page is obtained twice (see [example [041]](https://github.com/keboola/generic-extractor/tree/master/doc/examples/041-paging-stop-same)). If the API returns @@ -237,8 +237,8 @@ and [example [EX140]](https://github.com/keboola/generic-extractor/tree/master/d Limit stop configuration allows you to stop scrolling when a specified number of items is extracted. The supported options are: -- `count` (required, integer) --- total number of items to extract -- `field` (required, string) --- path to the key which contains the value with total number of items +- `count` (required if `field` not set, integer) --- total number of items to extract +- `field` (required if `count` not set, string) --- path to the key which contains the value with total number of items The two options are **mutually exclusive**, but one of them is required. In both cases, the total number of items may not be honored exactly. If the total amount is not divisible by the page size, then the leftover from the last page (if any) @@ -338,7 +338,7 @@ It means that the scrolling will **continue** till the field `hasMore` is presen In this case, setting `ifNotSet` is not necessary. See [example [EX045]](https://github.com/keboola/generic-extractor/tree/master/doc/examples/045-next-page-flag-has-more) -and [example [EX139]](https://github.com/keboola/generic-extractor/tree/master/doc/examples/139-pagination-hasmore-child-filter)] (combining with child jobs). +and [example [EX139]](https://github.com/keboola/generic-extractor/tree/master/doc/examples/139-pagination-hasmore-child-filter) (combining with child jobs). ### Non-Boolean Has-More Scrolling Assume that the API returns a response which contains a `hasMore` field. The field is present only in the diff --git a/extend/generic-extractor/configuration/aws-signature/index.md b/extend/generic-extractor/configuration/aws-signature/index.md index 7a936e9c..036d4491 100644 --- a/extend/generic-extractor/configuration/aws-signature/index.md +++ b/extend/generic-extractor/configuration/aws-signature/index.md @@ -6,8 +6,8 @@ permalink: /extend/generic-extractor/configuration/aws-signature/ * TOC {:toc} -Generic extractor allows signaturing requests by [**AWS**](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html). -Signature is the process to add authentication information to your requests. When you use AWS tools, extractor sign your API request. +Generic Extractor allows signing requests with [**AWS Signature Version 4**](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html). +Signing is the process of adding authentication information to your requests. When you use AWS tools, the extractor signs your API request. A sample AWS signature configuration looks like this: diff --git a/extend/generic-extractor/configuration/config/index.md b/extend/generic-extractor/configuration/config/index.md index 8e348173..cd4a38c3 100644 --- a/extend/generic-extractor/configuration/config/index.md +++ b/extend/generic-extractor/configuration/config/index.md @@ -160,9 +160,8 @@ will produce the following `users` table: |234|Jane Doe|fullExtract|development| The `userData` values are added to the parent jobs only. They will not affect the -[child jobs](/extend/generic-extractor/configuration/config/jobs/children). If the result table contains -columns with the same names as the `userData` properties. If there is already a column with the same name, -the `userData` column will be renamed. +[child jobs](/extend/generic-extractor/configuration/config/jobs/children). If the result table already +contains a column with the same name as a `userData` property, the `userData` column will be renamed. See [example [EX076]](https://github.com/keboola/generic-extractor/tree/master/doc/examples/076-user-data). diff --git a/extend/generic-extractor/configuration/ssh-proxy/index.md b/extend/generic-extractor/configuration/ssh-proxy/index.md index a0596d11..0f06796f 100644 --- a/extend/generic-extractor/configuration/ssh-proxy/index.md +++ b/extend/generic-extractor/configuration/ssh-proxy/index.md @@ -10,7 +10,7 @@ permalink: /extend/generic-extractor/configuration/ssh-proxy/ *Use [Parameter Map](/extend/generic-extractor/map/) to help you navigate among various configuration options.* -An SSH proxy for Generic Extractor allows you tu securely access HTTP(s) endpoints inside your private network. +An SSH proxy for Generic Extractor allows you to securely access HTTP(s) endpoints inside your private network. It creates an SSH tunnel, and all traffic from Generic Extractor is forwarded through the tunnel to the destination server. A sample `config` configuration can look like this: @@ -91,5 +91,5 @@ cat public.key >> ~/.ssh/authorized_keys } {% endhighlight %} -See [example [EX131]](https://github.com/keboola/generic-extractor/tree/master/doc/examples/131-ssh-tunnel). +See [example [EX131]](https://github.com/keboola/generic-extractor/tree/master/doc/examples/131-ssh-tunnel) and [example [EX133]](https://github.com/keboola/generic-extractor/tree/master/doc/examples/133-ssh-tunnel-iterations-params).