Catalog guides

Repository

On this page

What a Repository records#

Field	Content
`name`·`git_url`	Name and Git URL. Required; names are unique within an Organization
`handle`	Web address name. Required; unique among the Repositories of the same Organization (see address names)
`summary`·`description`	One-line summary and description

The Web UI opens HTTPS addresses as links and shows SSH addresses as text.

Web UI#

In Repositories → 새 Repository (New Repository), enter the name and Git URL, then select Repository 등록 (Register Repository). The list compares the name, Git URL, summary, and last update in a table, and the detail opens in a side panel.

stly#

{"name": "orders-service", "handle": "orders-service", "git_url": "https://github.com/acme/orders-service", "summary": "Code for the orders Service"}

stly repositories create --input repository.json
stly repositories list --q orders --fields id,name,git_url
stly repositories services <repository-id>

Edit connections to Services in Service.

Spec documents#

A Repository stores the source of OpenAPI, AsyncAPI, and Arazzo documents. The source is JSON or YAML, up to 1 MiB in UTF-8.

Field	Content
`kind`	`openapi`, `asyncapi`, or `arazzo`. Required
`name`	Name. Required; unique within the same Repository
`path`	File path in the Repository. Optional
`summary`·`description`	One-line summary and description
`content`	Document source. Required

Register in the Web UI#

In 스펙 문서 추가 (Add spec document) on the Repository detail, paste the source or load a JSON or YAML file, then select 스펙 문서 등록 (Register spec document). In the viewer, you can search items, explore the structure, follow internal references, and switch to the source view.

Register with stly#

content holds the full source as a string. This example builds the input JSON from a file.

python3 -c 'import json; print(json.dumps({"kind": "openapi", "name": "billing-openapi", "path": "docs/openapi.yaml", "content": open("openapi.yaml").read()}))' > spec.json
stly spec-documents create --repository 3B4cBA6CToA --input spec.json

stly spec-documents list --repository 3B4cBA6CToA
stly spec-documents view <spec-document-id>

spec-documents view returns the document structure. You can apply a stored OpenAPI document to APIs and Endpoints with OpenAPI sync. In the Web UI, an OpenAPI document detail shows its linked API and opens 새 원문 제출·변경 승인 (submit new source and approve changes) and the structly.yaml download. OpenAPI documents can also be registered without a Repository.

Delete#

Deleting a Repository also deletes its spec documents. Files in the Git repository are not changed. A Repository connected to a Service cannot be deleted (HTTP 409 REPOSITORY_IN_USE), so remove the connection from the Service first.