commercetools GraphQL binding spec
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 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: provider (gcp/aws)
- name: projectKey # required.
value: project-key
- name: clientID # required.
value: *****************
- name: clientSecret # required.
value: *****************
- name: scopes # required.
value: scopes
Warning
The above example uses secrets as plain strings. It is recommended to use a secret store for the secrets as described here.
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” |
projectKey | Y | Output | The commercetools project key | “project-key” |
clientID | Y | Output | The commercetools client ID for the project | “client ID” |
clientSecret | Y | Output | The commercetools client secret for the project | “client secret” |
scopes | Y | Output | The commercetools scopes for the project | “manage_project:project-key” |
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
- Bindings building block
- How-To: Trigger application with input binding
- How-To: Use bindings to interface with external resources
- Bindings API reference
- Sample app that leverages the commercetools binding with sample GraphQL query
Last modified June 19, 2023: Merge pull request #3565 from dapr/aacrawfi/skip-secrets-close (b1763bf)