stly

stly collections

On this page

This page is generated from the public contract. Descriptions are shown in the original Korean.

stly collections create#

Collection 생성

HTTP request: POST /api/databases/{database_id}/collections
Authentication modes: Agent token, User session
Changes records: Yes
Input JSON (--input) required

Check the input JSON structure with stly schema collections create.

Options

Name	Type	Required	Description
`--database`	`string`	Yes	부모 Database ID
`--input`	`string`	Yes	JSON 원문 파일 또는 stdin(-)
`--fields`	`string`	No	응답 최상위 필드, 쉼표로 구분 Values: `created_at`, `database_id`, `definition`, `description`, `id`, `name`, `summary`, `updated_at`

Common options: --server, --env-file, --timeout, --auth-mode, --dry-run

Example

stly collections create --database 00000000-0000-0000-0000-000000000001 --input input.json

stly collections delete#

Collection 삭제

HTTP request: DELETE /api/collections/{id}
Authentication modes: Agent token, User session
Changes records: Yes
--if-match required

Arguments

id: ID

Options

Name	Type	Required	Description
`--if-match`	`string`	Yes	상세 GET에서 얻은 단일 strong ETag
`--fields`	`string`	No	응답 최상위 필드, 쉼표로 구분

Common options: --server, --env-file, --timeout, --auth-mode, --dry-run

Example

stly collections delete 00000000-0000-0000-0000-000000000001 --if-match '"상세 GET의 ETag"'

stly collections get#

Collection 상세 조회

HTTP request: GET /api/collections/{id}
Authentication modes: Agent token, User session
Changes records: No

Arguments

id: ID

Options

Name	Type	Required	Description
`--fields`	`string`	No	응답 최상위 필드, 쉼표로 구분 Values: `created_at`, `database_id`, `definition`, `description`, `id`, `name`, `summary`, `updated_at`

Common options: --server, --env-file, --timeout, --auth-mode, --dry-run

Example

stly collections get 00000000-0000-0000-0000-000000000001

stly collections list#

Collection 목록 조회

HTTP request: GET /api/databases/{database_id}/collections
Authentication modes: Agent token, User session
Changes records: No

Options

Name	Type	Required	Description
`--database`	`string`	Yes	부모 Database ID
`--fields`	`string`	No	응답 최상위 필드, 쉼표로 구분 Values: `created_at`, `database_id`, `definition`, `description`, `id`, `name`, `summary`, `updated_at`

Common options: --server, --env-file, --timeout, --auth-mode, --dry-run

Example

stly collections list --database 00000000-0000-0000-0000-000000000001

stly collections service-links get#

Collection 연결 Service 집합 조회

HTTP request: GET /api/collections/{id}/service-links
Authentication modes: Agent token, User session
Changes records: No

Arguments

id: ID

Options

Name	Type	Required	Description
`--fields`	`string`	No	응답 최상위 필드, 쉼표로 구분 Values: `collection_id`, `service_ids`, `updated_at`

Common options: --server, --env-file, --timeout, --auth-mode, --dry-run

Example

stly collections service-links get 00000000-0000-0000-0000-000000000001

stly collections service-links update#

Collection 연결 Service 집합 전체 교체

HTTP request: PUT /api/collections/{id}/service-links
Authentication modes: Agent token, User session
Changes records: Yes
Input JSON (--input) required
--if-match required

Check the input JSON structure with stly schema collections service-links update.

Arguments

id: ID

Options

Name	Type	Required	Description
`--if-match`	`string`	Yes	상세 GET에서 얻은 단일 strong ETag
`--input`	`string`	Yes	JSON 원문 파일 또는 stdin(-)
`--fields`	`string`	No	응답 최상위 필드, 쉼표로 구분 Values: `collection_id`, `service_ids`, `updated_at`

Common options: --server, --env-file, --timeout, --auth-mode, --dry-run

Example

stly collections service-links update 00000000-0000-0000-0000-000000000001 --input input.json --if-match '"상세 GET의 ETag"'

stly collections services#

Collection의 직접 연결 Service 목록

HTTP request: GET /api/collections/{id}/services
Authentication modes: Agent token, User session
Changes records: No

Arguments

id: ID

Options

Name	Type	Required	Description
`--fields`	`string`	No	응답 최상위 필드, 쉼표로 구분 Values: `created_at`, `description`, `handle`, `id`, `name`, `status`, `summary`, `updated_at`
`--page`	`string`	No	1 이상 정수. page·per-page 중 하나라도 있으면 페이지 모드
`--per-page`	`string`	No	1~500 정수, 생략 시 100
`--q`	`string`	No	name 필드의 대소문자 구분 리터럴 부분 일치 검색. summary·description·본문은 검색하지 않으며 정규식·와일드카드를 지원하지 않습니다
`--sort`	`string`	No	리소스 기본 필드명 또는 - 접두 역순만 허용

Common options: --server, --env-file, --timeout, --auth-mode, --dry-run

Example

stly collections services 00000000-0000-0000-0000-000000000001 --q "검색어"

stly collections update#

Collection 수정

HTTP request: PUT /api/collections/{id}
Authentication modes: Agent token, User session
Changes records: Yes
Input JSON (--input) required
--if-match required

Check the input JSON structure with stly schema collections update.

Arguments

id: ID

Options

Name	Type	Required	Description
`--if-match`	`string`	Yes	상세 GET에서 얻은 단일 strong ETag
`--input`	`string`	Yes	JSON 원문 파일 또는 stdin(-)
`--fields`	`string`	No	응답 최상위 필드, 쉼표로 구분 Values: `created_at`, `database_id`, `definition`, `description`, `id`, `name`, `summary`, `updated_at`

Common options: --server, --env-file, --timeout, --auth-mode, --dry-run

Example

stly collections update 00000000-0000-0000-0000-000000000001 --input input.json --if-match '"상세 GET의 ETag"'