Skip to main content

extension-group-must-exist-when-referenced

Overview

This rule belongs to the apimatic-codegen-validation ruleset and states that:

When webhook or callback operations reference an extension group, the corresponding x-webhooks or x-callbacks extension MUST exist in the API specification.

PropertyValue
EnabledYes
Maximum SeverityError
MessageOperation references non-existent extension group.
CodeAPIMATICCODEGEN_V528
TypeValidation
Rule SystemSemantic
Broad CategoryWebhooks
Products ImpactedCode Generation, Developer Experience Portal
Tagsapimatic code generation codegen sdks portal docs validation apimatic webhook callback extension group x-webhooks x-callbacks reference validation missing extension

Suggested Fixes

  • Define the referenced extension group in the API specification.
  • Check for typos in the extension group reference name.
  • Ensure the extension contains the group being referenced.
  • Remove the group reference if the extension isn't needed.

For More Information