API Collections Summary¶
The API Collections summary view lists all collections registered in your account, their current lifecycle state, version, and available actions. It is the central hub for managing the full lifecycle of your API contracts.
🔍 Filtering and Navigation¶
The toolbar at the top of the summary provides controls to find and navigate collections:
| Control | Description |
|---|---|
| Search | Free-text search by collection name, version, or status. Results update as you type. |
| Sort by | Sort the list by name (A → Z or Z → A), status, version, or last updated date. |
| Per page | Control how many collections are shown per page (default: 5). |
| ◀ / ▶ | Navigate between pages. The current page and total are shown as Page N of N. |
| + New Collection | Opens the New Collection wizard to register a new API spec. |
A count at the bottom-right shows the total number of collections matching the current filter (e.g. Showing 2 of 2 collections).
📋 Collections Table¶
Each row represents one registered API Collection and shows:
| Column | Description |
|---|---|
| Collection | Name and truncated description of the collection. |
| Status | Current lifecycle state pill. See State Reference. |
| Version | Semantic version extracted from the info.version field of the OpenAPI spec (e.g. v2.0.0). Version is defined in the spec and is not editable from BizMetry. |
| Created by | Email of the user who created the collection. |
| Updated | Relative time since the last state change or edit (e.g. just now, 2 hours ago). |
| Actions | Context-sensitive action buttons for the current lifecycle state. |
⚡ Actions Column¶
The Actions column shows only the buttons applicable to each collection's current state. All actions require the appropriate platform permissions.
| State | Available action buttons |
|---|---|
| DRAFT | Submit for Review · ✏️ Edit · 🗑️ Delete |
| SUBMIT FOR REVIEW | Accept · Reject · ✏️ Edit · 🗑️ Delete |
| ACCEPTED | Publish · ✏️ Edit · 🗑️ Delete |
| REJECTED | Reopen as Draft · ✏️ Edit · 🗑️ Delete |
| PUBLISHED | Retire |
| RETIRED | 🗑️ Delete |
Editing resets the lifecycle. The ✏️ Edit button is available in all states except PUBLISHED and RETIRED. Saving any edit — regardless of the current state — immediately returns the collection to DRAFT and resets the approval workflow. The collection must go through the full review and approval cycle again before it can be published.
Delete is irreversible and permanently removes the collection from the platform. It is available from all states except PUBLISHED. A published collection must be retired first.
✏️ Edit¶
Clicking the pencil icon opens the collection editor, allowing you to replace the OpenAPI spec (from a URL or local file) and update collection metadata. Saving any change resets the collection to DRAFT regardless of its current state.
🗑️ Delete¶
Clicking the trash icon permanently removes the collection. This action is only available when the collection is not referenced by any Business Event version. If a collection is actively used in one or more Business Event versions, the delete icon is disabled.
BizMetry enforces a two-step confirmation mechanism to prevent accidental deletion:
Step 1 — First click (visual warning)
Clicking the trash icon once marks it in red, signaling that the next click will trigger the deletion flow. No data is removed at this stage.
Step 2 — Second click (confirmation modal)
A second click opens the Delete Collection modal. The modal:
- Displays the name of the collection to be deleted.
- Shows a warning that the action cannot be undone.
- Requires you to type the collection name (in kebab-case, e.g.
Open-Library-API) into a confirmation field before the DELETE button becomes enabled.
Clicking CANCEL dismisses the modal without making any changes. Clicking DELETE (once enabled) permanently removes the collection.
There is no recovery path once a collection is deleted. Ensure no Business Event versions depend on it before proceeding.