Configuring Content Services GraphQL

The Content Services GraphQL API provides a schema and an easy-to-understand query language system that simplifies application development for your Content Platform Engine. The API schema definition of types and fields matches Content Engine Java™ API object model closely, with necessary and desirable extensions for natural GraphQL developer consumption.

About this task

Use the ecm_configuration.graphql section of the custom YAML to provide values for the configuration of the Content Services GraphQL API. You provide details for configuration settings that you have already created, like the names of your persistent volume claims. You also provide names for pieces of your Content Services GraphQL environment, and tuning decisions for your runtime environment.

The section includes a parameter for enabling the GraphiQL development interface. Note the following consideration for including GraphiQL in your environment:

  • If you are deploying the GraphQL container as part of a test or development environment and you want to use GraphiQL with the API, set the enable_graph_iql parameter to true.
  • If you are deploying the GraphQL container as part of a production environment, it is recommended to set the enable_graph_iql parameter to false.

For more information about the settings, see Content Services GraphQL parameters