Impact GateDocs

Connect & index

Select and index repositories

Build a useful workspace by indexing API providers and the applications that consume them.

On this page

Choose providers and consumers#

Select the repositories that define your API contracts and the repositories that call those APIs. Findings can only use consumer code available within the selected, indexed workspace. Repositories outside that scope remain unobserved.

Repository roleWhat to includeWhat it contributes
ProviderCommitted OpenAPI 3 documents and service manifestsEndpoints, schemas, and PR contract comparisons.
ConsumerSupported JavaScript, TypeScript, or Java HTTP client codeStatic caller references and consumer evidence.
Combined service or monorepoContracts, consumers, and manifests under service rootsDetected services associated with their repository paths.

Save your selection#

  1. Open repository selection

    During onboarding, use Choose repositories. Later, open Repositories and choose Select repositories.

  2. Review installation access

    The list contains available, non-archived repositories granted to the connected App installation. Each row shows the repository, public or private visibility, detected language, and default branch.

  3. Select the intended set

    Check the provider and consumers. You can select up to 100 repositories. Ask an owner or admin to save the selection if you have view access.

  4. Save and start indexing

    Choose Save selection and start indexing. Wait for the server confirmation; indexing is then queued for newly selected repositories.

  5. Review each result

    Watch Analysis jobs and the repository status. Use Coverage to inspect supported files, skipped files, OpenAPI documents, notes, and the indexed commit.

Understand indexing status#

StatusMeaningNext action
QueuedIndexing work has been accepted and is waiting for a worker.Watch Analysis jobs; avoid repeatedly submitting the same request.
Discovering / indexingThe worker is reading a commit and building services, endpoints, and references.Wait for completion; progress is shown with the current phase.
IndexedThe supported index completed without a recorded partial-coverage condition.Inspect endpoints and callers; the status does not guarantee full application coverage.
PartialA usable snapshot was saved with coverage limitations.Open Coverage and assess missing contracts, unsupported code, or file limits.
FailedIndexing could not finish.Read the error, restore access or resolve the cause, then choose Re-index.

A consumer repository with no OpenAPI document can be marked partial while still contributing static caller references. A completed background job means the attempt finished; the repository's Coverage explains whether its resulting snapshot is partial.

Keep the index current#

Indexing reads an immutable commit from the repository's default branch. Last index and the commit shown in Coverage identify the saved snapshot. After restoring access or updating a missing contract, choose Re-index and wait for a new snapshot.

When Sync default branch when code changes is enabled in Settings, default-branch push events queue a refresh. Pull request reports use the PR's own base and head contracts together with the current indexed consumer snapshots.

If a consumer is changing on an unmerged branch, its workspace index still represents its indexed default-branch commit. Read the source SHA in a finding before using it to coordinate a cross-repository change.

Explore the documentation

↑↓ NavigateEnter Open guideSearch stays in your browser