stly

stly endpoints

이 페이지의 내용

이 페이지는 공개 계약에서 생성하며 설명은 원문(한국어) 그대로 표시합니다.

stly endpoints create#

Endpoint 생성

HTTP 요청: POST /api/endpoints
인증 모드: Agent 토큰, User 세션
기록 변경: 예
입력 JSON(--input) 필수

입력 JSON 구조는 stly schema endpoints create로 확인합니다.

옵션

이름	타입	필수	설명
`--input`	`string`	예	JSON 원문 파일 또는 stdin(-)
`--fields`	`string`	아니요	응답 최상위 필드, 쉼표로 구분 값: `api_id`, `created_at`, `deprecated`, `description`, `examples`, `external_references`, `headers`, `id`, `method`, `parameters`, `path`, `request_body`, `responses`, `security`, `source`, `summary`, `updated_at`

공통 옵션: --server, --env-file, --timeout, --auth-mode, --dry-run

예시

stly endpoints create --input input.json

stly endpoints delete#

Endpoint 삭제

HTTP 요청: DELETE /api/endpoints/{id}
인증 모드: Agent 토큰, User 세션
기록 변경: 예
--if-match 필수

인수

id: ID

옵션

이름	타입	필수	설명
`--if-match`	`string`	예	상세 GET에서 얻은 단일 strong ETag
`--fields`	`string`	아니요	응답 최상위 필드, 쉼표로 구분

공통 옵션: --server, --env-file, --timeout, --auth-mode, --dry-run

예시

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

stly endpoints get#

Endpoint 상세 조회

HTTP 요청: GET /api/endpoints/{id}
인증 모드: Agent 토큰, User 세션
기록 변경: 아니요

인수

id: ID

옵션

이름	타입	필수	설명
`--fields`	`string`	아니요	응답 최상위 필드, 쉼표로 구분 값: `api_id`, `created_at`, `deprecated`, `description`, `examples`, `external_references`, `headers`, `id`, `method`, `parameters`, `path`, `request_body`, `responses`, `security`, `source`, `summary`, `updated_at`

공통 옵션: --server, --env-file, --timeout, --auth-mode, --dry-run

예시

stly endpoints get 00000000-0000-0000-0000-000000000001

stly endpoints list#

Endpoint 목록 조회

HTTP 요청: GET /api/endpoints
인증 모드: Agent 토큰, User 세션
기록 변경: 아니요

옵션

이름	타입	필수	설명
`--api`	`string`	아니요	소속 API ID(선택, 지정 시 해당 API 소속 Endpoint만 조회)
`--fields`	`string`	아니요	응답 최상위 필드, 쉼표로 구분 값: `api_id`, `created_at`, `deprecated`, `description`, `examples`, `external_references`, `headers`, `id`, `method`, `parameters`, `path`, `request_body`, `responses`, `security`, `source`, `summary`, `updated_at`
`--page`	`string`	아니요	1 이상 정수. page·per-page 중 하나라도 있으면 페이지 모드
`--per-page`	`string`	아니요	1~500 정수, 생략 시 100
`--q`	`string`	아니요	path·summary·description 필드 중 하나의 대소문자 구분 리터럴 부분 일치 검색. 본문은 검색하지 않으며 정규식·와일드카드를 지원하지 않습니다
`--sort`	`string`	아니요	리소스 기본 필드명 또는 - 접두 역순만 허용

공통 옵션: --server, --env-file, --timeout, --auth-mode, --dry-run

예시

stly endpoints list --api 00000000-0000-0000-0000-000000000001 --q "검색어"

stly endpoints release-source#

Endpoint의 스펙 출처 해제

HTTP 요청: POST /api/endpoints/{id}/release-source
인증 모드: Agent 토큰, User 세션
기록 변경: 예
--if-match 필수

인수

id: ID

옵션

이름	타입	필수	설명
`--if-match`	`string`	예	상세 GET에서 얻은 단일 strong ETag
`--fields`	`string`	아니요	응답 최상위 필드, 쉼표로 구분 값: `api_id`, `created_at`, `deprecated`, `description`, `examples`, `external_references`, `headers`, `id`, `method`, `parameters`, `path`, `request_body`, `responses`, `security`, `source`, `summary`, `updated_at`

공통 옵션: --server, --env-file, --timeout, --auth-mode, --dry-run

예시

stly endpoints release-source 00000000-0000-0000-0000-000000000001 --if-match '"상세 GET의 ETag"'

stly endpoints security#

Endpoint 적용 인증 조회

HTTP 요청: GET /api/endpoints/{id}/security
인증 모드: Agent 토큰, User 세션
기록 변경: 아니요

인수

id: ID

옵션

이름	타입	필수	설명
`--fields`	`string`	아니요	응답 최상위 필드, 쉼표로 구분 값: `api_id`, `endpoint_id`, `origin`, `requirements`, `schemes`, `state`

공통 옵션: --server, --env-file, --timeout, --auth-mode, --dry-run

예시

stly endpoints security 00000000-0000-0000-0000-000000000001

stly endpoints update#

Endpoint 수정

HTTP 요청: PUT /api/endpoints/{id}
인증 모드: Agent 토큰, User 세션
기록 변경: 예
입력 JSON(--input) 필수
--if-match 필수

입력 JSON 구조는 stly schema endpoints update로 확인합니다.

인수

id: ID

옵션

이름	타입	필수	설명
`--if-match`	`string`	예	상세 GET에서 얻은 단일 strong ETag
`--input`	`string`	예	JSON 원문 파일 또는 stdin(-)
`--fields`	`string`	아니요	응답 최상위 필드, 쉼표로 구분 값: `api_id`, `created_at`, `deprecated`, `description`, `examples`, `external_references`, `headers`, `id`, `method`, `parameters`, `path`, `request_body`, `responses`, `security`, `source`, `summary`, `updated_at`

공통 옵션: --server, --env-file, --timeout, --auth-mode, --dry-run

예시

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

stly endpoints validate#

Endpoint 생성·수정 후보 사전 검증(저장 없음)

HTTP 요청: --operation create POST /api/endpoints/validate, --operation update PUT /api/endpoints/{id}/validate
인증 모드: Agent 토큰, User 세션
기록 변경: 아니요
입력 JSON(--input) 필수

입력 JSON 구조는 stly schema endpoints validate --operation create|update로 확인합니다.

인수

id: ID

옵션

이름	타입	필수	설명
`--input`	`string`	예	JSON 원문 파일 또는 stdin(-)
`--operation`	`string`	예	검증할 작업 종류. 생성 후보는 create, 수정 후보는 update 값: `create`, `update`
`--fields`	`string`	아니요	응답 최상위 필드, 쉼표로 구분
`--if-match`	`string`	아니요	상세 GET에서 얻은 단일 strong ETag

공통 옵션: --server, --env-file, --timeout, --auth-mode, --dry-run

동작

실제 서버를 호출해 입력·참조·중복·If-Match를 검사하며 저장하지 않습니다. 도메인 규칙은 서버가 판단합니다.
--operation create: 대상 id·If-Match 금지. update: 대상 id·단일 strong If-Match 필수, 부모 옵션 금지
--dry-run: credential 접근·HTTP 요청·파일 변경 없이 요청 계획만 출력
성공은 관찰 시점의 유효성으로 저장 성공·ID 예약·충돌 방지를 보장하지 않습니다. 자동 저장·자동 재시도하지 않습니다.

예시

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

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

stly endpoints workflows#

Endpoint 호출 Workflow 목록

HTTP 요청: GET /api/endpoints/{id}/workflows
인증 모드: Agent 토큰, User 세션
기록 변경: 아니요

인수

id: ID

옵션

이름	타입	필수	설명
`--fields`	`string`	아니요	응답 최상위 필드, 쉼표로 구분 값: `created_at`, `description`, `handle`, `id`, `name`, `step_count`, `steps`, `summary`, `updated_at`, `workflow_key`

공통 옵션: --server, --env-file, --timeout, --auth-mode, --dry-run

예시

stly endpoints workflows 00000000-0000-0000-0000-000000000001