Brick catalog
The Brick catalog screen lets you browse the building blocks (bricks) of the platform, filter them by group and search them by identifier, name or technology. Portal path: /developer/bricks. It is used by architects and developers who want to know which brick provides a feature and which API paths it exposes.
What the screen shows
- Search bricks: a search field on the identifier, the name and the technology.
- Group: a list with Group: all and every group found in the catalogue.
- The number of bricks shown (for example 12 bricks).
- One card per brick, paginated:
- the identifier and the phase (phase followed by its number);
- the name (in the language of the portal);
- a status badge;
- the responsibility of the brick;
- Technology;
- up to six API paths as badges.
The catalogue comes from GET /v1/catalog/bricks.
Actions
| Button or action | What it does | API call | Roles |
|---|---|---|---|
| Search bricks | Filters the cards in the page. | None (filter in the browser) | Every signed in user |
| Group | Shows the bricks of one group only. | None (filter in the browser) | Every signed in user |
| Pagination | Shows the next or previous cards. | None | Every signed in user |
| Retry (error state) | Reads the catalogue again. | GET /v1/catalog/bricks | Every signed in user |
Roles
The portal asks no role on this screen. The catalogue is read only.
Typical tasks
Find the brick behind an API path
- Search. The search covers the identifier, the name and the technology. Type a word of the feature in Search bricks. Expected result: the count drops and the matching cards remain. If it fails: clear the search and choose a Group instead.
- Read the card. The badges list the API paths of the brick. Expected result: the path you look for is on a card. If it fails: only six paths are shown per card; open the API reference for the full list.
List the bricks of one group
- Choose the group. Pick it in Group. Expected result: only its bricks are shown. If it fails: choose Group: all to reset the filter.
Troubleshooting
| Symptom | Cause | Fix |
|---|---|---|
| No brick in the catalog | The Control Plane publishes no brick. | Check the deployment of the Control Plane. |
| No card after a search | The filter matches nothing. | Clear Search bricks and set Group to Group: all. |
| Error state | GET /v1/catalog/bricks failed. | Click Retry, then check the Control Plane. |