Skip to main content

usage-example-pre-defined-endpoint

Overview

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

The endpoint group name and endpoint name provided in the UsageExampleEndpoint CodeGen setting must point to an endpoint that is pre-defined in the API endpoints.

PropertyValue
EnabledYes
Maximum SeverityError
MessageThe endpoint group name and endpoint name pair specified in the UsageExampleEndpoint CodeGen setting does not exist.
CodeAPIMATICCODEGEN_V259
TypeValidation
Rule SystemSemantic
Broad CategoryCodeGen Settings
Products ImpactedCode Generation, Developer Experience Portal
Tagsapimatic code generation codegen sdks portal docs validation apimatic codegen setting

Suggested Fixes

  • Make sure that the endpoint you are referencing in the UsageExampleEndpoint CodeGen setting is defined in the API endpoints.
  • Make sure that you have not misspelled the endpoint name or group name.

For More Information