What is searched#
Searches the Systems, Services, APIs, Endpoints, Workflows, Databases, Kafka Clusters, Kafka Topics, and Repositories of the current Organization.
- It searches names, summaries, and descriptions. It also matches Endpoint Paths and Workflow Keys.
- Matching is a case-insensitive partial match. Regular expressions, wildcards, and morphological analysis are not supported.
- Results are ordered as exact name matches, names that start with the term, names that contain it, then summary or description matches.
- Database structures such as Tables, Collections, and Key Patterns, and spec documents, are not searched.
Web UI#
Select the search box at the top or press ⌘K or Ctrl+K. Narrow results with the type chips, and choose a result to go to its detail.
With no search term, it shows the entries you opened recently in this browser.
stly#
stly catalog search --q orders
stly catalog search --q orders --type endpoint --limit 10| Option | Content |
|---|---|
--q | Search term. An empty value returns an empty result |
--type | Narrows to one of system, service, api, endpoint, workflow, database, messaging-cluster, kafka-topic, and repository |
--limit | 1–50. Default 20 |
{"status":200,"etag":null,"location":null,"data":{"items":[{"type":"api","id":"4pkKFh2ojXs","name":"Orders API","summary":"Create, look up, and cancel orders","matched_field":"name"}],"counts":{"api":1,"database":0,"endpoint":0,"kafka-topic":0,"messaging-cluster":0,"repository":0,"service":0,"system":0,"workflow":0},"has_more":false}}counts is the total number of matches per type, regardless of --type. If has_more is true, there are more results than --limit.
Difference from list search#
Each Catalog's list command (stly apis list --q and so on) searches only that Catalog, is case-sensitive, and supports paging.
Use Catalog-wide search when you do not know which Catalog an entry is in, and list search when you need sorting and paging within one Catalog.