Catalog guides

On this page

Guides#

Guide	Covers
Service	Services and their provided APIs and Repository connections
API	APIs, base URLs, and providing Services
Endpoint	Method and Path, and the Schema and examples of Parameters, Request Bodies, and Responses
Database	Databases per engine and Tables, Collections, and Key Patterns
Repository	Repositories and OpenAPI, AsyncAPI, and Arazzo spec documents
OpenAPI sync	Registering OpenAPI documents and approving changes to APIs and Endpoints
Messaging	Kafka Clusters, Topics, Message Definitions, and usage notes
Workflow	Steps that call Endpoints and Workflows
System	Compositions of Services, APIs, and Systems
Catalog-wide search	Finding entries across Catalogs at once

Common steps in the Web UI#

Choose a menu under CATALOG in the sidebar. For menu names, see the table in Catalog types and connections.
Open the input panel with the 새 … (New …) button, such as 새 Service, and save with … 등록 (Register …), such as Service 등록. For top-level Catalogs, also enter the handle below the name (see address names).
Select an entry in the list to open its detail panel. Edit with 수정 (Edit) and save with 변경 저장 (Save changes).
To delete, select 삭제 (Delete) in the detail, then 삭제 확인 (Confirm delete).

If someone else saved first, your save is rejected and your input is kept. See Concurrent edit conflicts for what to do.

Common stly commands#

Resource names differ by Catalog, but the command format is the same.

stly services list --q orders
stly services get <id>
stly services create --input service.json
stly services update <id> --input service.json --if-match '"ETag from the detail lookup"'
stly services delete <id> --if-match '"ETag from the detail lookup"'

Check the input format in the request_schema of stly schema <resource> <action>.
The create input of a top-level Catalog requires handle. If update omits it, the stored value is kept.
List commands find entries with the same handle with --handle (for example, stly services list --handle orders-service), and stly catalog check-handle orders-service --catalog services checks availability in advance.
Endpoints, Databases, Tables, Key Patterns, Kafka Clusters, Topics, and Workflows provide validate, which checks input without saving.

stly endpoints validate --operation create --input endpoint.json

When the check passes, data.valid is true. If the input has problems, the server returns HTTP 422 VALIDATION_FAILED with the problem fields in error.data.