Skip to main content

Troubleshooting

Missing token​

Error:

Error: UIGRAPH_TOKEN environment variable is required

Fix:

  • Export UIGRAPH_TOKEN locally.
  • Set UIGRAPH_TOKEN in CI secrets for pipeline runs.

Missing repository provider​

Error:

Validation error: service.repository.provider is required

Fix:

service:
  repository:
    provider: github
    url: https://github.com/org/repo

Allowed values: github, gitlab, bitbucket.

Referenced file not found​

Examples:

apis[0].path file does not exist: ./openapi.yaml
architectureDiagrams[0].contextPath file does not exist: ./context.json
databases[0].schemaPath file does not exist: ./schema.sql

Fix:

  • Verify file paths in .uigraph.yaml.
  • Ensure paths are correct for the current working directory in CI.
  • Commit the files that are referenced.

API-linked test case does not resolve​

If an API test case is not linking as expected:

  • confirm apiGroupName matches the synced API group name
  • confirm operationId exists in the OpenAPI file
  • re-run uigraph-cli sync --dry-run after updating the spec or config

Unsupported type value​

Examples:

apis[0].type must be one of: openapi, graphql, grpc
testPacks[0].type must be one of: smoke, regression, manual
testPacks[0].testCases[0].type must be one of: api, manual
databases[0].dialect must be one of: postgres, mysql, sqlite, dynamodb, mongodb, other

Fix:

  • Use one of the accepted enum values exactly.

Fast debug workflow​

  1. Run uigraph-cli sync --dry-run.
  2. Fix first validation error.
  3. Re-run dry-run until it is clean.
  4. Run normal sync in CI.

Missing git metadata​

If the CLI cannot capture git metadata, sync can still continue.

Typical causes:

  • running outside a git repository
  • running in a shallow or restricted CI environment
  • missing git binary in the runtime image