diff --git a/automate/set-schedule.md b/automate/set-schedule.md index a77621d6..a682bf19 100644 --- a/automate/set-schedule.md +++ b/automate/set-schedule.md @@ -108,7 +108,7 @@ An example request response will contain: The important field is `id` (with value `10850624` in the above example). In the second step, you need to activate the schedule via the [Activate Schedule API call](https://api.keboola.com/?service=scheduler#scheduler/tag/schedules/POST/schedules) -with he following body: +with the following body: ```json { @@ -116,7 +116,7 @@ with he following body: } ``` -See an [example](https://documenter.getpostman.com/view/3086797/77h845D#130cbfc4-4dd5-4f6d-99c0-2444c48ee551)): +See an [example](https://documenter.getpostman.com/view/3086797/77h845D#130cbfc4-4dd5-4f6d-99c0-2444c48ee551): ```bash curl --location --request POST 'https://scheduler.azure.keboola.com/schedules' \ @@ -229,7 +229,7 @@ You'll obtain the following example: ``` The created configuration has id `10852379`. You can now [Activate the Schedule](https://api.keboola.com/?service=scheduler#scheduler/tag/schedules/POST/schedules) -with he following body: +with the following body: ```json { @@ -237,7 +237,7 @@ with he following body: } ``` -See an [example](https://documenter.getpostman.com/view/3086797/77h845D#130cbfc4-4dd5-4f6d-99c0-2444c48ee551)): +See an [example](https://documenter.getpostman.com/view/3086797/77h845D#130cbfc4-4dd5-4f6d-99c0-2444c48ee551): ```bash curl --location --request POST 'https://scheduler.keboola.com/schedules' \ diff --git a/integrate/artifacts/index.md b/integrate/artifacts/index.md index dee1b5b4..bfcc569b 100644 --- a/integrate/artifacts/index.md +++ b/integrate/artifacts/index.md @@ -99,7 +99,7 @@ Full configuration example with all artifact types: "limit": 5 } }, - "orchestration": { + "shared": { "enabled": true } } diff --git a/integrate/artifacts/tutorial.md b/integrate/artifacts/tutorial.md index 628df13a..4a0c197e 100644 --- a/integrate/artifacts/tutorial.md +++ b/integrate/artifacts/tutorial.md @@ -202,7 +202,7 @@ The configuration producing artifact needs to be in a phase that precedes the co print(glob.glob("/data/artifacts/in/shared/*/*")) ``` - Run curl command to create the configurtion: + Run curl command to create the configuration: ```shell curl -X POST "$STORAGE_API_HOST/v2/storage/branch/default/components/keboola.python-transformation-v2/configs" \ diff --git a/integrate/data-streams/overview/index.md b/integrate/data-streams/overview/index.md index 7aee0c4c..1812cf8f 100644 --- a/integrate/data-streams/overview/index.md +++ b/integrate/data-streams/overview/index.md @@ -46,7 +46,7 @@ The `path` column type can be used to fetch a single field from a `JSON` object. ```json { - "type": "json", + "type": "path", "name": "id", "path": "issue.id", "defaultValue": "undefined", diff --git a/integrate/jobs/index.md b/integrate/jobs/index.md index beee92b0..1343da67 100644 --- a/integrate/jobs/index.md +++ b/integrate/jobs/index.md @@ -188,7 +188,7 @@ When you create a job it is in the `created` state. In a success scenario it wil That means `waiting` or `created` jobs do not have any costs associated with them, they represent a plan of what is going to happen. The states `terminated`, `cancelled`, `success` and `error` are final and end the job transitions. When a job is in final state, the `isFinished` flag is true. - The job object is both immutable and eventually consistent. Once you create a job, you cannot change any of it's properties. Any changing properties are + The job object is both immutable and eventually consistent. Once you create a job, you cannot change any of its properties. Any changing properties are self-modifying and they will stop modifying once the job reaches one of the final states. Apart from the `status` field, the job also has `desiredStatus` field. This is either `processing` or `terminating`. The desired status is @@ -413,7 +413,7 @@ From the above response, the most important part is `url`, which gives you the U If you want to get the actual job result, poll the [Job API](https://api.keboola.com/?service=job-queue#job-queue/tag/jobs/GET/jobs/{jobId}) for the current state of the job. See an [example](https://documenter.getpostman.com/view/3086797/kbc-samples/77h845D?version=latest#9b9f3e7b-de3b-4c90-bad6-a8760e3852eb). -You will receive a response in the same format as when you crated the job: +You will receive a response in the same format as when you created the job: ```json { @@ -485,7 +485,7 @@ of what the data folder looked like before the component started. If processors - `stage_2` file with contents of the data folder before processor C was run - `stage_output` file with contents of the data folder before output mapping was about to be performed (after C finished). -If configuration rows are used, then the above is repeated for each configuration row. If the job finishes with and error, only the stages before the error are uploaded. +If configuration rows are used, then the above is repeated for each configuration row. If the job finishes with an error, only the stages before the error are uploaded. This API call does not upload any tables or files to Storage. I.e. when the component finishes, its output is discarded and the output mapping to storage is not performed. This makes this API call generally very safe to call, because it cannot break the Keboola project in any way. However, keep diff --git a/overview/api/index.md b/overview/api/index.md index eb65e91b..f729402b 100644 --- a/overview/api/index.md +++ b/overview/api/index.md @@ -149,8 +149,8 @@ The services listed above are: - `oauth` --- [OAuth Manager Service](https://help.keboola.com/extend/common-interface/oauth/) - `queue` --- [Service for Running Components](https://help.keboola.com/extend/job-queue/) - `billing` --- Service for Computing Credits -- `encryption` --- Service for [Encryption](https://developers.keboola.com/overview/encryption/) -- `scheduler` --- [Service for Configuring Schedules](https://developers.keboola.com/automate/set-schedule/) +- `encryption` --- Service for [Encryption](/overview/encryption/) +- `scheduler` --- [Service for Configuring Schedules](/automate/set-schedule/) - `sync-actions` --- [Service for Running Synchronous Actions](https://help.keboola.com/extend/common-interface/actions/) - `notification` --- Service for Configuring Job Notifications @@ -200,7 +200,7 @@ and in application integrations, we strongly suggest using the above API call. | Notification | `notification` | EU Ireland Azure | https://notification.north-europe.azure.keboola.com | | Notification | `notification` | EU Frankfurt GCP | https://notification.europe-west3.gcp.keboola.com | | OAuth | `oauth` | US Virginia AWS | https://oauth.keboola.com | -| OAuth | `oauth` | US Virginia GCP | https://oauth.europe-west3.gcp.keboola.com | +| OAuth | `oauth` | US Virginia GCP | https://oauth.us-east4.gcp.keboola.com | | OAuth | `oauth` | EU Frankfurt AWS | https://oauth.eu-central-1.keboola.com | | OAuth | `oauth` | EU Ireland Azure | https://oauth.north-europe.azure.keboola.com | | OAuth | `oauth` | EU Frankfurt GCP | https://oauth.europe-west3.gcp.keboola.com | diff --git a/overview/encryption.md b/overview/encryption.md index 1c66764d..a600eb26 100644 --- a/overview/encryption.md +++ b/overview/encryption.md @@ -138,7 +138,7 @@ This cipher type helps encrypt information shared across multiple components, e. The following rules apply to all ciphers: - Providing only a `configId` without a `projectId` is not allowed. Similarly, providing only `branchType` without `projectId` is also not allowed. -- Cipher decryption is only possible in the [region](/overview/api/#regions-and-endpoints) where the cipher was created. For example, ciphers with prefixes `KBC::ProjectSecureKV::` (Azure) or `KBC::ProjectSecureGKMS::` (GCP), instead of `KBC::ProjectSecure::` (AWS), use the same business logic but are specific to their region and technology and are not interchangeable. +- Cipher decryption is only possible in the [region](/overview/api/#stacks-and-endpoints) where the cipher was created. For example, ciphers with prefixes `KBC::ProjectSecureKV::` (Azure) or `KBC::ProjectSecureGKMS::` (GCP), instead of `KBC::ProjectSecure::` (AWS), use the same business logic but are specific to their region and technology and are not interchangeable. - There is no decryption API; the cipher is decrypted internally before a component is run. - Ciphering a value that is already encrypted does not change its encryption. - There is no way to retrieve the component, project, configuration ID, or branch type from the cipher. diff --git a/overview/index.md b/overview/index.md index 3689bfd1..638c9d7a 100644 --- a/overview/index.md +++ b/overview/index.md @@ -18,7 +18,7 @@ The following chart shows how Keboola is structured. All Keboola parts are brief ![Overview of Keboola Components](/kbc_structure.png){: .img-responsive} ## Working with Keboola -Everything you can do in the Keboola UI can be done programatically using the API of the corresponding component. +Everything you can do in the Keboola UI can be done programmatically using the API of the corresponding component. All of our components have API documentation on [api.keboola.com](https://api.keboola.com/) and most of them have a public [Github repository](https://github.com/keboola/). Our Docker components are built on [AWS ECR](https://aws.amazon.com/ecr/). @@ -28,7 +28,7 @@ This means that there are virtually **endless possibilities of what can be done ## Component Common Features All components share some common behaviour such as [*Component Configuration*](https://help.keboola.com/storage/api/configurations/) [Running Jobs](/integrate/jobs/), which allows each component to be run in [Orchestrations](https://help.keboola.com/orchestrator/). -This means that once worked your way through one component, you have seen them all. +This means that once you've worked your way through one component, you have seen them all. **Most of our components are open source**. If you are interested in their code, have a look at [our repositories](/overview/repositories/). Apart from that common features, some components define additional [synchronous actions](https://help.keboola.com/extend/common-interface/actions/).