Skip to main content

Repositories

Route/ade/dashboard/repositories

Register a Git repository and Apiome scans it for API specifications you can import — one at a time or many at once — and keeps them refreshed. Go to Bring in → Repositories. The tabs across the top are Repositories, Discovered specs, Quota & rate limits and Webhook IP allowlist.

Repositories: indexed files, imports and last scan, refresh activity, and the repository tableRepositories: indexed files, imports and last scan, refresh activity, and the repository table
Route/ade/dashboard/repositories

The list shows each repository's Provider, Branch, Files, Health, Status, Last scan and how many files are Importable. Filter by provider and visibility, sort by most recently scanned or by name, and switch between Grid and List. A row's menu has Open detail and Remove from list.

Repositories in Grid view, one card per repository with its health and scan stateRepositories in Grid view, one card per repository with its health and scan state
Route/ade/dashboard/repositories

Add a repository​

Route/ade/dashboard/repositories/new
  1. Click “Add repository” (or press N).
  2. Under Where does the repository live? choose:
    • Linked account — pick from your connected GitHub, GitLab or Bitbucket account. Browsing a provider's repositories works for GitHub only; Manage linked accounts → connects one.
    • Public Git URL — paste an HTTPS URL such as https://github.com/apiome/apiome.git and click “Test”.
  3. Click “Continue”. Apiome says Repository registered. and starts its first scan.
Add a repository with no linked accounts yet: Linked account and Public Git URL choices, and Connect an accountAdd a repository with no linked accounts yet: Linked account and Public Git URL choices, and Connect an account
Route/ade/dashboard/repositories/new

The page also shows a Proposed steps 2–4 card marked Redesign proposal — not in the app today: it describes planned steps (browse, scan settings, confirm) that are not part of the product yet.

Add a repository with Public Git URL: an HTTPS URL, Test and ContinueAdd a repository with Public Git URL: an HTTPS URL, Test and Continue
Route/ade/dashboard/repositories/new
Add a repository with a linked GitHub account: choose a repository from the accountAdd a repository with a linked GitHub account: choose a repository from the account
Route/ade/dashboard/repositories/new

A repository's page​

Route/ade/dashboard/repositories/[id]

Click a repository. Five tabs:

  • Preview — files indexed, the importable estimate, branches, recent scans and recent imports.
  • Files — every file Apiome indexed on the branch. Hide non-importable narrows the list to specifications; a file's menu has View details, Import…, Open on provider and Copy path.
  • Specs — the specs imported from this repository; “Refresh now” re-reads them.
  • Imports — the import history.
  • Settings — the source, Scan cadence (Auto-refresh), what happens on a refresh conflict (Hold for review, Overwrite or New branch), and Remove repository.
A repository's Preview tab: files indexed, importable estimate, branches, recent scans and importsA repository's Preview tab: files indexed, importable estimate, branches, recent scans and imports
Route/ade/dashboard/repositories/[id]
A repository's Files tab: importable files with detected kind, quality and confidenceA repository's Files tab: importable files with detected kind, quality and confidence
Route/ade/dashboard/repositories/[id]
A file's details: detected metadata, the importable verdict and the sourceA file's details: detected metadata, the importable verdict and the source
Route/ade/dashboard/repositories/[id]
A repository's Settings tab: source, scan cadence and refresh behaviourA repository's Settings tab: source, scan cadence and refresh behaviour
Route/ade/dashboard/repositories/[id]

Import from a repository​

  1. On Files, tick the specifications to import and click “Import selected”.
  2. One file opens Map & import: choose an Existing project or Create a new project, and the version to create, then import.
  3. Several files open Import N selected files: Review each file's target (a new version of an existing project, or a new project), Verify, then “Import N specs”. Each spec becomes its own import job.
Map & import: target an existing project or create a new one, and the version to createMap & import: target an existing project or create a new one, and the version to create
Route/ade/dashboard/repositories/[id]
Import 2 selected files: each file's kind, resolution and target projectImport 2 selected files: each file's kind, resolution and target project
Route/ade/dashboard/repositories/[id]

Discovered specs​

Route/ade/dashboard/repositories/catalog

Discovered specs lists every specification the scanner found across all repositories, with its Status: Discovered, Mapped (bound to a project), Imported or Needs attention.

Discovered specs: specs found across repositories with format, project and statusDiscovered specs: specs found across repositories with format, project and status
Route/ade/dashboard/repositories/catalog

Quota & rate limits​

Route/ade/dashboard/repositories/telemetry

Repositories are polled within an hourly quota. Quota & rate limits shows how much of it this workspace uses — polls, repositories and files deferred, and content scanned — over 7d, 30d or 90d.

Quota & rate limits: polling quota, polls, deferrals and bytes scannedQuota & rate limits: polling quota, polls, deferrals and bytes scanned
Route/ade/dashboard/repositories/telemetry

Webhook IP allowlist​

Route/ade/dashboard/repositories/webhook-ip-allowlist

Provider webhooks are only accepted from the provider's published address ranges, refreshed daily. To allow a self-hosted Git server, add its range under Additional ranges for this workspace — Address or CIDR (for example 203.0.113.0/24) and Why — and click “Allow range”. Bypass allowlist turns enforcement off with a stated reason. Only workspace administrators can change it.

Webhook IP allowlist: enforcement, provider ranges and additional ranges for the workspaceWebhook IP allowlist: enforcement, provider ranges and additional ranges for the workspace
Route/ade/dashboard/repositories/webhook-ip-allowlist

With the CLI or the API​

  • CLI: apiome repos add --url https://github.com/apiome/apiome.git, apiome repos list, apiome repos files <repo>, apiome repos import <repo> --files "**/openapi*.yaml" --new-project — see the CLI quick-start.
  • REST: GET / POST /v1/tenants/{tenant}/repositories, GET …/repositories/{repo}/files, POST …/repositories/{repo}/refresh, GET …/repository-quota-telemetry, GET …/repository-webhook-ip-allowlist — see the API reference.

Where next​