mirror of https://github.com/dapr/docs.git
2.8 KiB
2.8 KiB
type | title | linkTitle | description | aliases | |
---|---|---|---|---|---|
docs | commercetools GraphQL binding spec | commercetools GraphQL | Detailed documentation on the commercetools GraphQL binding component |
|
Component format
To setup commercetools GraphQL binding create a component of type bindings.commercetools
. See [this guide]({{< ref "howto-bindings.md#1-create-a-binding" >}}) on how to create and apply a binding configuration.
apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
name: <NAME>
spec:
type: bindings.commercetools
version: v1
metadata:
- name: region # required.
value: "region"
- name: provider # required.
value: "gcp"
- name: projectKey # required.
value: "<project-key>"
- name: clientID # required.
value: "*****************"
- name: clientSecret # required.
value: "*****************"
- name: scopes # required.
value: "<project-scopes>"
- name: direction
value: "output"
{{% 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 %}}
Spec metadata fields
Field | Required | Binding support | Details | Example |
---|---|---|---|---|
region |
Y | Output | The region of the commercetools project | "europe-west1" |
provider |
Y | Output | The cloud provider, either gcp or aws | "gcp" , "aws" |
projectKey |
Y | Output | The commercetools project key | |
clientID |
Y | Output | The commercetools client ID for the project | |
clientSecret |
Y | Output | The commercetools client secret for the project | |
scopes |
Y | Output | The commercetools scopes for the project | "manage_project:project-key" |
direction |
N | Output | The direction of the binding | "output" |
For more information see commercetools - Creating an API Client and commercetools - Regions.
Binding support
This component supports output binding with the following operations:
create
Related links
- [Basic schema for a Dapr component]({{< ref component-schema >}})
- [Bindings building block]({{< ref bindings >}})
- [How-To: Trigger application with input binding]({{< ref howto-triggers.md >}})
- [How-To: Use bindings to interface with external resources]({{< ref howto-bindings.md >}})
- [Bindings API reference]({{< ref bindings_api.md >}})
- Sample app that leverages the commercetools binding with sample GraphQL query