vtex-io-service-configuration-apps

You inject shared configuration into a VTEX IO service app by using a configuration app to provide a matching configuration.json file, which is then consumed at runtime via ctx.vtex.settings. This approach replaces ad hoc fetching with a structured, schema-validated contract.

A VTEX IO configuration app is a separate app that defines and injects structured runtime settings into service apps. You need one when you want to share a single configuration model across multiple services or decouple configuration lifecycle from runtime lifecycle.

To define a schema-driven configuration contract, you create a configuration/schema.json file inside your VTEX IO service app, then supply a matching configuration.json file inside the configuration app to ensure schema-consistent validation and defaults.

Yes, a VTEX IO service app must explicitly opt in to receive workspace configuration by declaring settingsType="workspace" or using the @settings directive across its node and GraphQL service entrypoints.

Using ctx.vtex.settings avoids fragile, ad hoc configuration handling by consuming injected settings directly from the runtime context without extra HTTP fetches. This ensures your VTEX IO app receives structured, verifiable configuration contracts safely.

Yes, you can share one configuration app across multiple VTEX IO service apps. By defining a schema-driven contract in configuration/schema.json, you ensure all opted-in services consume consistent, validated settings through ctx.vtex.settings.