Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions automate/set-schedule.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,15 +108,15 @@ 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
{
"configurationId": "10850624"
}
```

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' \
Expand Down Expand Up @@ -229,15 +229,15 @@ 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
{
"configurationId": "10852379"
}
```

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' \
Expand Down
2 changes: 1 addition & 1 deletion integrate/artifacts/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ Full configuration example with all artifact types:
"limit": 5
}
},
"orchestration": {
"shared": {
"enabled": true
}
}
Expand Down
2 changes: 1 addition & 1 deletion integrate/artifacts/tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -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" \
Expand Down
2 changes: 1 addition & 1 deletion integrate/data-streams/overview/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
6 changes: 3 additions & 3 deletions integrate/jobs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
{
Expand Down Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions overview/api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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 |
Expand Down
2 changes: 1 addition & 1 deletion overview/encryption.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions overview/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/).
Expand All @@ -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/).
Expand Down
Loading