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.

  1. apiVersion: dapr.io/v1alpha1
  2. kind: Component
  3. metadata:
  4.   name: <NAME>
  5. spec:
  6.   type: bindings.commercetools
  7.   version: v1
  8.   metadata:
  9.   - name: region # required.
  10.     value: "region"
  11.   - name: provider # required.
  12.     value: "gcp"
  13.   - name: projectKey # required.
  14.     value: "<project-key>"
  15.   - name: clientID # required.
  16.     value: "*****************"
  17.   - name: clientSecret # required.
  18.     value: "*****************"
  19.   - name: scopes # required.
  20.     value: "<project-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

FieldRequiredBinding supportDetailsExample
regionYOutputThe region of the commercetools project“europe-west1”
providerYOutputThe cloud provider, either gcp or aws“gcp”, “aws”
projectKeyYOutputThe commercetools project key
clientIDYOutputThe commercetools client ID for the project
clientSecretYOutputThe commercetools client secret for the project
scopesYOutputThe 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

Last modified October 11, 2024: Fixed typo (#4389) (fe17926)