Skip to content

Commit

Permalink
Fix doc typos (#1205)
Browse files Browse the repository at this point in the history
* Fix doc typos and format.

* fix escaping quotes
  • Loading branch information
mukundansundar committed Feb 13, 2021
1 parent bbc10f8 commit 270b7ed
Show file tree
Hide file tree
Showing 30 changed files with 84 additions and 49 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -35,16 +35,18 @@ The above example uses secrets as plain strings. It is recommended to use a secr

## Spec metadata fields

| Field | Required | Details | Example |
|---------------|----------|---------|---------|
| `endpoint` | Y | Alicloud OSS endpoint. | https://oss-cn-hangzhou.aliyuncs.com
| `accessKeyID` | Y | Access key ID credential. |
| `accessKey` | Y | Access key credential. |
| `bucket` | Y | Name of the storage bucket. |
| Field | Required | Binding support | Details | Example |
|---------------|----------|---------|---------|---------|
| `endpoint` | Y | Output | Alicloud OSS endpoint. | https://oss-cn-hangzhou.aliyuncs.com
| `accessKeyID` | Y | Output | Access key ID credential. |
| `accessKey` | Y | Output | Access key credential. |
| `bucket` | Y | Output | Name of the storage bucket. |

## Output operations
## Binding support

This component supports **output binding** with the following operations:
- `create`: [Create object](#create-object)

The following operations are supported as within the output binding:

### Create object

Expand All @@ -65,18 +67,49 @@ By default, a random UUID is auto-generated as the object key. See below for Met

**Saving to a random generated UUID file**

{{< tabs "Windows" "Linux/MacOS" >}}

{{% codetab %}}

```bash
curl -d "{ \"operation\": \"create\", \"data\": \"Hello World\" }" http://localhost:<dapr-port>/v1.0/bindings/<binding-name>
```

{{% /codetab %}}

{{% codetab %}}

```bash
curl -d '{ "operation": "create", "data": "Hello World" }' http://localhost:<dapr-port>/v1.0/bindings/<binding-name>
```

{{% /codetab %}}

{{< /tabs >}}

<br />

**Saving to a specific file**
{{< tabs "Windows" "Linux/MacOS" >}}

{{% codetab %}}

```bash
curl -d "{ \"operation\": \"create\", \"data\": \"Hello World\", \"metadata\": { \"key\": \"my-key\" } }" http://localhost:<dapr-port>/v1.0/bindings/<binding-name>
```

{{% /codetab %}}

{{% codetab %}}

```bash
curl -d '{ "operation": "create", "data": "Hello World", "metadata": { "key": "my-key" } }' http://localhost:<dapr-port>/v1.0/bindings/<binding-name>
```

{{% /codetab %}}

{{< /tabs >}}

{{% alert title="Note" color="primary" %}}
Windows CMD requires escaping the `"` character.
{{% /alert %}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ stringData:

## Binding support

This component supports **output binding** with the folowing operations:
This component supports **output binding** with the following operations:

- `create`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ The above example uses secrets as plain strings. It is recommended to use a secr

## Binding support

This component supports **output binding** with the folowing operations:
This component supports **output binding** with the following operations:

- `create` : [Create blob](#create-blob)
- `get` : [Get blob](#get-blob)
Expand Down Expand Up @@ -80,7 +80,7 @@ curl -d "{ \"operation\": \"create\", \"data\": \"Hello World\" }" http://localh

{{% codetab %}}
```bash
curl -d "{ "operation": "create", "data": "Hello World" }" \
curl -d '{ "operation": "create", "data": "Hello World" }' \
http://localhost:<dapr-port>/v1.0/bindings/<binding-name>
```
{{% /codetab %}}
Expand All @@ -100,7 +100,7 @@ curl -d "{ \"operation\": \"create\", \"data\": \"Hello World\", \"metadata\": {

{{% codetab %}}
```bash
curl -d "{ "operation": "create", "data": "Hello World", "metadata": { "blobName": "my-test-file.txt" } }" \
curl -d '{ "operation": "create", "data": "Hello World", "metadata": { "blobName": "my-test-file.txt" } }' \
http://localhost:<dapr-port>/v1.0/bindings/<binding-name>
```
{{% /codetab %}}
Expand Down Expand Up @@ -144,7 +144,7 @@ curl -d "{ \"operation\": \"create\", \"data\": \"YOUR_BASE_64_CONTENT\", \"meta

{{% codetab %}}
```bash
curl -d "{ "operation": "create", "data": "YOUR_BASE_64_CONTENT", "metadata": { "blobName": "my-test-file.jpg" } }" \
curl -d '{ "operation": "create", "data": "YOUR_BASE_64_CONTENT", "metadata": { "blobName": "my-test-file.jpg" } }' \
http://localhost:<dapr-port>/v1.0/bindings/<binding-name>
```
{{% /codetab %}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ For more information see [Azure Cosmos DB resource model](https://docs.microsoft

## Binding support

This component supports **output binding** with the folowing operations:
This component supports **output binding** with the following operations:

- `create`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ For ease of use, the Dapr cron binding also supports few shortcuts:

This component supports both **input and output** binding interfaces.

This component supports **output binding** with the folowing operations:
This component supports **output binding** with the following operations:

- `delete`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ The above example uses secrets as plain strings. It is recommended to use a secr

## Binding support

This component supports **output binding** with the folowing operations:
This component supports **output binding** with the following operations:

- `create`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ Scope is the identifier of the resource to which the event subscription needs to

This component supports both **input and output** binding interfaces.

This component supports **output binding** with the folowing operations:
This component supports **output binding** with the following operations:

- `create`
## Additional information
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ The above example uses secrets as plain strings. It is recommended to use a secr

## Binding support

This component supports **output binding** with the folowing operations:
This component supports **output binding** with the following operations:

- `create`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ The above example uses secrets as plain strings. It is recommended to use a secr

## Binding support

This component supports **output binding** with the folowing operations:
This component supports **output binding** with the following operations:

- `create`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ The above example uses secrets as plain strings. It is recommended to use a secr

## Binding support

This component supports **output binding** with the folowing operations:
This component supports **output binding** with the following operations:

- `create`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ The above example uses secrets as plain strings. It is recommended to use a secr

## Binding support

This component supports **output binding** with the folowing operations:
This component supports **output binding** with the following operations:

- `create`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,14 +38,6 @@ spec:
value: 1024
```

- `topics` is a comma separated string of topics for an input binding.
- `brokers` is a comma separated string of kafka brokers.
- `consumerGroup` is a kafka consumer group to listen on.
- `publishTopic` is the topic to publish for an output binding.
- `authRequired` determines whether to use SASL authentication or not.
- `saslUsername` is the SASL username for authentication. Only used if `authRequired` is set to - `"true"`.
- `maxMessageBytes` is the maximum message size allowed for a single Kafka message. Default is 1024.

{{% alert title="Warning" color="warning" %}}
The above example uses secrets as plain strings. It is recommended to use a secret store for the secrets as described [here]({{< ref component-secrets.md >}}).
{{% /alert %}}
Expand All @@ -60,13 +52,14 @@ The above example uses secrets as plain strings. It is recommended to use a secr
| authRequired | Y | Input/Output | Determines whether to use SASL authentication or not. Defaults to `"true"` | `"true"`, `"false"` |
| saslUsername | N | Input/Output | The SASL username for authentication. Only used if `authRequired` is set to - `"true"` | `"user"` |
| saslPassword | N | Input/Output | The SASL password for authentication. Only used if `authRequired` is set to - `"true"` | `"password"` |
| maxMessageBytes | N | Input/Output | The maximum size allowed for a single Kafka message. Defaults to 1024 | `2048` |


## Binding support

This component supports both **input and output** binding interfaces.

This component supports **output binding** with the folowing operations:
This component supports **output binding** with the following operations:

- `create`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ The above example uses secrets as plain strings. It is recommended to use a secr

This component supports both **input and output** binding interfaces.

This component supports **output binding** with the folowing operations:
This component supports **output binding** with the following operations:

- `create`
## Related links
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ The above example uses secrets as plain strings. It is recommended to use a secr

This component supports both **input and output** binding interfaces.

This component supports **output binding** with the folowing operations:
This component supports **output binding** with the following operations:

- `create`
## Related links
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ If your server requires SSL your connection string must end of `&tls=custom` for

## Binding support

This component supports **output binding** with the folowing operations:
This component supports **output binding** with the following operations:

- `exec`
- `query`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ Both methods also support connection pool configuration variables:

## Binding support

This component supports **output binding** with the folowing operations:
This component supports **output binding** with the following operations:

- `exec`
- `query`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Combined, the optional metadata properties in the component configuration and th

## Binding support

This component supports **output binding** with the folowing operations:
This component supports **output binding** with the following operations:

- `create`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ The above example uses secrets as plain strings. It is recommended to use a secr

This component supports both **input and output** binding interfaces.

This component supports **output binding** with the folowing operations:
This component supports **output binding** with the following operations:

- `create`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ The above example uses secrets as plain strings. It is recommended to use a secr

## Binding support

This component supports **output binding** with the folowing operations:
This component supports **output binding** with the following operations:

- `create`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ The above example uses secrets as plain strings. It is recommended to use a secr

## Binding support

This component supports **output binding** with the folowing operations:
This component supports **output binding** with the following operations:

- `create`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ The above example uses secrets as plain strings. It is recommended to use a secr

## Binding support

This component supports **output binding** with the folowing operations:
This component supports **output binding** with the following operations:

- `create`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ The above example uses secrets as plain strings. It is recommended to use a secr

This component supports both **input and output** binding interfaces.

This component supports **output binding** with the folowing operations:
This component supports **output binding** with the following operations:

- `create`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ The above example uses secrets as plain strings. It is recommended to use a secr

## Binding support

This component supports **output binding** with the folowing operations:
This component supports **output binding** with the following operations:

- `create`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ The example configuration shown above, contain a username and password as plain-

## Binding support

This component supports **output binding** with the folowing operations:
This component supports **output binding** with the following operations:

- `create`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ The above example uses secrets as plain strings. It is recommended to use a secr

## Binding support

This component supports **output binding** with the folowing operations:
This component supports **output binding** with the following operations:

- `create`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ The above example uses secrets as plain strings. It is recommended to use a secr

This component supports both **input and output** binding interfaces.

This component supports **output binding** with the folowing operations:
This component supports **output binding** with the following operations:

- `create`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ The above example uses secrets as plain strings. It is recommended to use a secr

This component supports both **input and output** binding interfaces.

This component supports **output binding** with the folowing operations:
This component supports **output binding** with the following operations:

- `create`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ The above example uses secrets as plain strings. It is recommended to use a secr

## Binding support

This component supports **output binding** with the folowing operations:
This component supports **output binding** with the following operations:

- `create`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ The above example uses secrets as plain strings. It is recommended to use a secr

This component supports both **input and output** binding interfaces.

This component supports **output binding** with the folowing operations:
This component supports **output binding** with the following operations:

- `get`

Expand Down

0 comments on commit 270b7ed

Please sign in to comment.