Skip to content
Structly Docs
한국어

Concepts

Concepts

On this page

Organization boundary#

Every Catalog record belongs to one Organization.

  • The Web UI and stly show and edit only the records of the Organization you currently have selected.
  • Records in other Organizations are never included in lookups, searches, or connections.
  • When you switch Organizations, lists and search results switch to that Organization's records.

The Web UI and stly keep their Organization selections separately. Changing it in one does not change the other. For details, see Organization.

IDs#

Each Catalog entry receives a ID-formatted ID when it is saved. Some Catalogs, such as API and Service, require unique names within an Organization, while others, such as System, allow the same name. When you specify or connect entries in stly, use the ID rather than the name.

stly apis list --q Orders --fields id,name

Summary and description#

Catalog entries such as Services, APIs, and Endpoints record a summary and a description separately.

FieldPurpose
summaryA one-line summary shown in lists and tables. Up to 120 characters.
descriptionThe description shown on the detail screen. Write the context and constraints in detail.

Lists show only the summary, and leave the cell blank when the summary is empty.

Learn more#