Make a component the page of its service

Link a service's API projects, tests and monitors to its catalog component once, and see its health, open bugs and the designs that use it in one place.

In short

A catalog component can be the page of its service. Link the service's API projects, tests and monitors to it once, and its page shows the service's health, open bugs, owners and the designs that use it.

Before you start

• Who: linking needs the right to change the catalog. Everyone sees only the links to records they may open themselves.
• Plan: Designer is part of every plan, Free included. The Free plan limits how many designs a workspace keeps; Plan & usage shows the limit and what you hold. Linking a record also needs that record's product on for you.
• First: a catalog component and the project, tests or monitors to link.

Make a service page

1. Open Designer › "Catalog" and choose a component, such as Payments API. Its page opens on the Service tab.
2. Under "Linked records", choose "Link a record" and pick the API Tester project that tests the service.
3. API health and Open bugs fill in by themselves from what you linked.
4. Choose "Change owners" to name the people responsible for it.

What the page shows

Good to know

• You can link API Tester projects, catalog endpoints, saved requests, suites and monitors; SQL Tester projects and cases; UI Tester sites and tracks; and cache connections and checks.
• Linking needs the right to change the catalog, and only records of the workspace you are in, that you may open, in a module that is on for you.
• Linking a record twice keeps one link. Remove a link from its row.
• Everyone sees only the links to records they may open themselves.
• When the component changes, the workflows that use it and were reviewed ask for review again.
• "Jump to a section" is a row of links to each part. On a phone every part after About folds, and a press opens it.

If something goes wrong

• "That kind of record cannot be linked to a component."
• "A component links at most … records. Remove one first."
• "Owners must be members of this organization." / "In a personal workspace only you can own a component."

Related

• /help/designer/references-and-used-in
• /help/designer/design-to-tests
• /help/api-testing/api-catalog