Skip to main content

Catalog

Route/ade/dashboard/catalog

The catalog holds specifications in formats that do not map one-to-one to OpenAPI — gRPC, GraphQL, AsyncAPI, OData, WSDL, Avro, RAML, Smithy, TypeSpec and more. Catalog items keep their original format: you can search, diff, lint and export them, but not publish them. To publish one, convert it to OpenAPI. OpenAPI and Swagger imports go to Projects instead.

Go to Bring in → Catalog.

The Catalog in Table view: a banner explaining catalog items, supported formats, statistics, filters and four itemsThe Catalog in Table view: a banner explaining catalog items, supported formats, statistics, filters and four items
Route/ade/dashboard/catalog

Find an item​

  • Filter by text (/), Formats, protocol (REST, RPC, Event, Graph, Data Schema, Agent), source (Uploaded file, Source URL, Pasted content, Live discovery) and grade.
  • Chips — All, Active, Needs attention, and Deleted once Show deleted is on.
  • Sort by name, created, updated, quality, grade or format; choose the same column again to reverse it.
  • Cards or Table; cards can be grouped by protocol. Your choices are remembered in this browser.
The Catalog in Cards view, grouped by protocolThe Catalog in Cards view, grouped by protocol
Route/ade/dashboard/catalog

Supported import formats (collapsed under the banner) lists every format the catalog imports now, and the ones Apiome recognizes but cannot import yet. The full list is on Supported formats.

The Supported import formats panel expanded: formats importable now and formats recognized but not yet importableThe Supported import formats panel expanded: formats importable now and formats recognized but not yet importable
Route/ade/dashboard/catalog

Add an item​

Click “Import to catalog” (or press I) — see Import wizard.

An item's page​

Route/ade/dashboard/catalog/[id]

Click an item to open it. The header shows its status, Quality and Lint scores, and “Convert to OpenAPI Project”, “Export” and “View code”. Eight tabs follow:

TabShows
OverviewThe API surface (services, operations, types, channels), the quality snapshot and the source snapshot
Format detailsThe payload's native structure in its own vocabulary — see Catalog format details
Source & codeThe raw imported source, read-only, with “Download raw source”
ProvenanceWhere it came from: intake, format detection, normalization and the import job
ConversionsEvery conversion to OpenAPI, with its evidence
Lint & scoreThe lint score and findings
Test benchValidate a payload against one of the item's schemas
VersionsThe item's revisions
A catalog item's Overview tab: header with quality and lint scores, API surface and quality snapshotA catalog item's Overview tab: header with quality and lint scores, API surface and quality snapshot
Route/ade/dashboard/catalog/[id]
Format details for an X12 837 claim: envelopes, functional groups and segmentsFormat details for an X12 837 claim: envelopes, functional groups and segments
Route/ade/dashboard/catalog/[id]
Format details for a COBOL copybook: the record layout with levels, PICTURE clauses, offsets and lengthsFormat details for a COBOL copybook: the record layout with levels, PICTURE clauses, offsets and lengths
Route/ade/dashboard/catalog/[id]
The Provenance tab: source intake, format detection, normalization and the catalog recordThe Provenance tab: source intake, format detection, normalization and the catalog record
Route/ade/dashboard/catalog/[id]
The Source & code tab: the raw X12 source, read-only, with download and source URL buttonsThe Source & code tab: the raw X12 source, read-only, with download and source URL buttons
Route/ade/dashboard/catalog/[id]
The Lint & score tab: requirement counts, the lint score and findingsThe Lint & score tab: requirement counts, the lint score and findings
Route/ade/dashboard/catalog/[id]
The Conversions tab: conversion history, empty until a conversion is approvedThe Conversions tab: conversion history, empty until a conversion is approved
Route/ade/dashboard/catalog/[id]
The Test bench tab: a schema picker, a payload editor and test suitesThe Test bench tab: a schema picker, a payload editor and test suites
Route/ade/dashboard/catalog/[id]
The Versions tab of a catalog item with a single revisionThe Versions tab of a catalog item with a single revision
Route/ade/dashboard/catalog/[id]

Convert to OpenAPI​

  1. Click “Convert to OpenAPI Project” on the item (or in its ⋯ menu). Apiome analyzes what the source can carry onto OpenAPI.
  2. Read the Fidelity grade and the Summary — What the source provides and What OpenAPI favors but is missing. Projection graph shows construct by construct how the source maps.
  3. Optionally fill Title, Version and Servers under Fill cheap gaps and click “Apply & recompute preview”.
  4. Click “Convert”. For a low-fidelity conversion, first tick I understand the converted spec will be incomplete and want to convert anyway.

Apiome creates a new OpenAPI project, and the item shows Converted to OpenAPI project. The full explanation of reason codes and evidence is on Convert a catalog item to OpenAPI.

Export to another format… in the item's menu produces a document in another format instead — it never creates a project.

Delete and restore​

Delete item hides an item; turn on Show deleted and choose Undelete item to bring it back. Permanently delete asks you to type the item's slug, then “Delete everything”. In Table view, tick items to delete or undelete several at once.

With the CLI or the API​

  • CLI: apiome import graphql ./01-simple-user.graphql, apiome convert <item-id> --to openapi --dry-run, apiome formats — see the CLI quick-start.
  • REST: GET /v1/catalog/{tenant}, GET /v1/catalog/{tenant}/{item}, GET …/{item}/analysis|lint|source, POST …/{item}/convert, GET …/{item}/conversions — see the API reference.

Where next​