콘텐츠로 이동
AggregaAggrega
언어 선택: 한국어
이 페이지는 기계 번역되었습니다. 영어 원문 읽기.

Aggrega Wasm FeatureRecipe-파이프라인 단계 소켓 스키마

자동 생성된 레퍼런스입니다. 직접 편집하지 말고 게시된 JSON Schema에서 다시 생성하십시오.

스키마 ID: https://aggrega.ai/schemas/wasm-frp-step-v1beta1.schema.json

feature-recipe-pipeline 단계 플러그인 소켓이 소비하는(FRPStepInput) 와이어 형태와 내보내는(FRPStepOutput) 와이어 형태입니다. FRP 단계는 Recipe 또는 FeatureRecipe에 선언된 인라인 파이프라인 항목마다 실행됩니다. 호스트는 키가 지정된 문서 집합 전체를 단계에 전달하고, 단계는 대상으로 하는 문서를 내용으로 선택한 뒤 키로 주소가 지정된 RFC 6902 패치와 부수 효과 및 진단을 반환합니다. 이는 label-transform 역할과는 별개의 게스트 계약입니다. label-transform 역할은 전체 토폴로지 그래프에 대해 한 번 실행되며 불투명한 레이블 패치를 반환합니다. Go, Rust, TypeScript 페이로드 타입은 이 스키마로부터 plugin-ABI 패키지에 생성되므로 세 언어는 하나의 와이어를 읽고 씁니다. 게스트는 이 타입을 해당 패키지에서, 또는 플러그인 키트가 다시 내보내는 경우 플러그인 키트를 통해 가져옵니다.

다음 형태 중 하나

  • FRPStepInput
  • FRPStepOutput

정의

FRPStepInput

feature-recipe-pipeline 게스트가 하나의 파이프라인 단계에 대해 받는 페이로드입니다. 호스트가 통째로 넘기는 키 기반 문서 집합, 이 단계에 대해 Recipe가 선언한 단계 로컬 입력, 렌더링 시점 컨텍스트, 파이프라인에서 단계의 위치, 이미 실행된 단계의 기록으로 구성됩니다.

속성타입필수설명
documentsDocumentSet예파이프라인 게스트가 입력 표면으로 받는, 스코프를 루트로 하는 키 기반의 주소 지정 가능한 단위 집합입니다. 호스트는 집합 전체를 넘기며 그 내용을 해석하지 않습니다. 게스트는 대상으로 삼을 문서를 내용으로 선택하고 패치의 주소를 키로 지정합니다.
step_inputobject아니요단계의 렌더링된 with 블록으로, 게스트가 단계 로컬 입력으로 읽는 작성자 순서의 키 집합입니다. 작성자 순서를 보존하므로 동일한 입력으로 실행할 때마다 페이로드가 바이트 단위로 동일합니다.
contextobject예호스트가 단계에 전달하는 렌더 시점 컨텍스트로, JSON 문서의 바이트로 전달됩니다. 이 스키마는 이 객체를 선언하지 않으며, 호스트는 여기서 아무것도 다시 읽지 않습니다. Recipe 또는 컴포넌트 범위 FeatureRecipe의 단계는 다음을 받습니다. parameters는 이름순으로 정렬된 Release의 파라미터 값이며 없으면 존재하지 않습니다. annotations는 노드의 어노테이션을 각각 쓰인 위치에 따라 aggregate, release, catalog로 나눈 것이며 비어 있으면 각각 존재하지 않습니다. boundary는 노드가 속한 경계로, name, path(세그먼트), sync_wave(0이면 없음), directory, sub_directory(없으면 없음), annotations(Release의 경계가 노드까지 단계적으로 내려보내는 집합으로, 자신의 Release 항목의 것이 마지막에 겹쳐지며, 비어 있으면 없음)를 담습니다. 호스트 컴포넌트가 없는 경계 범위 FeatureRecipe의 단계는 parameters, 경계 자신의 어노테이션 집합인 release 버킷만 담은 annotations, 그리고 name, path와 그 같은 집합을 annotations로 담은 boundary를 받습니다. 같은 FeatureRecipe의 provider 렌더도 같은 컨텍스트를 받습니다. 들여쓰기 너비 yaml_indent는 단계에 설정되지 않습니다.
step_indexinteger예파이프라인에서 이 단계의 0부터 시작하는 위치입니다.
preceding_stepsPrecedingStep[]아니요이 단계 이전에 실행된 파이프라인 단계로, 게스트가 앞서 일어난 일을 살펴볼 수 있게 합니다.

추가 속성은 허용되지 않습니다.

FRPStepOutput

feature-recipe-pipeline 게스트가 하나의 파이프라인 단계에 대해 반환하는 페이로드입니다. 호스트가 키 기반 문서 집합에 적용하는 RFC 6902 패치, 이 단계가 만든 부수 효과, 게스트가 발생시킨 진단으로 구성됩니다.

속성타입필수설명
patchesJSONPatchOp[]아니요단계가 키 기반 집합의 문서에 대해 내보내는 구조화된 RFC 6902 연산입니다. 각 연산은 대상 문서를 스코프와 키로 지정한 다음 op, path, value를 명시적으로 지정합니다. label-transform 역할의 불투명한 패치 목록과는 다릅니다. FRP 단계의 패치는 호스트가 적용하고 단계가 실패하면 스냅숏으로 복원되므로, 여기서는 연산이 불투명하지 않고 명시적입니다.
side_effectsSideEffect[]아니요이 단계가 기존 문서를 패치하는 것 외에 만든 효과입니다(예: CRD 내보내기 또는 파일 쓰기).
diagnosticsDiagnostic[]아니요게스트가 발생시킨 진단입니다. 각 요소는 공유되는 Wasm 플러그인 진단 형태입니다.
outputsobject아니요게스트가 이 단계에 대해 반환하는 주소 지정 가능한 출력으로, 이후 단계나 템플릿이 읽을 수 있도록 단계의 출력을 채우는 작성자 순서의 키 집합입니다. 작성자 순서를 보존하므로 동일한 입력으로 실행할 때마다 페이로드가 바이트 단위로 동일합니다. 단계가 출력을 반환하지 않으면 없습니다.
errorstring아니요게스트가 실행되었지만 작업을 완료하지 못했을 때 설정되는 실패 메시지이며, 성공 시에는 없습니다. 출력이 담는 진단과는 구별됩니다. 진단은 결과를 생성한 실행 중에 발견된 문제를 보고하는 반면, error는 작업 자체가 완료되지 않았음을 보고합니다. 호스트는 error가 있으면 플러그인 호출 실패로 표시합니다.

추가 속성은 허용되지 않습니다.

DocumentSet

파이프라인 게스트가 입력 표면으로 받는, 스코프를 루트로 하는 키 기반의 주소 지정 가능한 단위 집합입니다. 호스트는 집합 전체를 넘기며 그 내용을 해석하지 않습니다. 게스트는 대상으로 삼을 문서를 내용으로 선택하고 패치의 주소를 키로 지정합니다.

속성타입필수설명
ownUnit의 맵예노드 자체의 렌더링된 출력으로, 단위 토큰을 키로 합니다. 키 순서를 보존하므로 집합이 안정된 순서로 와이어에 도달하고 동일한 입력으로 실행할 때마다 페이로드가 바이트 단위로 동일합니다.
hostUnit의 맵아니요컴포넌트 스코프 FeatureRecipe가 연결된 컴포넌트의 렌더링된 출력으로, 엔터티 간 표면입니다. 호스트 컴포넌트가 없는 Recipe 단계와 경계 스코프 FeatureRecipe 단계에서는 없습니다. 키 순서를 보존하므로 집합이 안정된 순서로 와이어에 도달하고 동일한 입력으로 실행할 때마다 페이로드가 바이트 단위로 동일합니다.

추가 속성은 허용되지 않습니다.

Unit

프로바이더가 내보낸 출력이 나뉘는 주소 지정 가능한 한 조각으로, 출력 한 조각의 하이브리드 뷰입니다. 구조화된 단위는 트리(RFC 6902로 주소 지정 가능한 뷰)를 가지며 PATCH 대상입니다. 불투명한 단위는 미디어 타입과 바이트만 가지며(트리 없음) SELECT 및 EMIT 대상이지만 PATCH 대상은 아닙니다.

속성타입필수설명
tokenstring예코덱이 할당하는 불투명한 위치 주소입니다. 단일 문서 파일이면 내보낸 파일 이름이고, 한 파일에 여러 문서가 있으면 <filename>#<ordinal>(파일 순서)입니다. 게스트는 이를 불투명하게 취급합니다. 즉 내용으로 단위를 선택하고 토큰을 그대로 돌려줄 뿐, 파싱하지 않습니다.
bytesstring아니요단위의 원래 바이트로, 재조립의 원본입니다. 재조립은 구조상 바이트에 충실합니다. 손대지 않은 바이트는 이 값에서 그대로 다시 결합됩니다. 각 키트는 이를 자체 필드 타입으로 담습니다. 그 타입이 바이트 타입이면 원시 형태로, 문자열이면 단계가 디코딩하여 복원하는 base64 인코딩 형태로 담으며, 생성된 인코더가 필드와 와이어가 바이트를 담는 형태 사이를 변환합니다.
media_typestring아니요단위의 콘텐츠 타입(예: 기본 YAML 코덱의 경우 application/yaml)으로, 게스트가 무엇을 보고 있는지 알 수 있게 합니다.
treeany아니요코덱이 생성한 경우 단위의 RFC 6902로 주소 지정 가능한 정규화된 뷰이며, 생성하지 않았으면 없습니다. 트리가 있는 단위는 구조화된 단위(PATCH 대상)이고, 트리가 없는 단위는 불투명합니다. 문서는 호스트에게 불투명하며 호스트는 바이트를 해석하지 않고 전달하므로, 이 스키마 계층에서 트리는 어떤 JSON 값이든 담습니다.

추가 속성은 허용되지 않습니다.

JSONPatchOp

FRP 단계가 키 기반 집합의 한 문서에 대해 내보내는 하나의 RFC 6902 JSON-Patch 연산입니다. scope와 key는 대상 문서를 지정하고, op, path, value, from은 그 문서 안의 위치에 대한 연산을 담습니다.

속성타입필수설명
scopestring (enum)예연산이 대상으로 하는 문서 루트입니다. own(노드 자체의 렌더링된 문서) 또는 host(컴포넌트 스코프 FeatureRecipe가 연결된 컴포넌트의 문서)입니다. 허용 값: "own", "host"
keystring예지정된 루트 안의 내보낸 파일 이름 키로, 게스트가 내용으로 선택한 문서에서 런타임에 알게 된 키입니다.
opstring예RFC 6902 연산입니다. add, remove, replace, move, copy, test 중 하나입니다.
pathstring예지정된 문서 안의 대상 위치를 가리키는 RFC 6901 JSON Pointer입니다.
valueany아니요add, replace, test의 피연산자이며, 그 외에는 생략됩니다. 게스트가 작성한 임의의 JSON 문서 조각으로 호스트가 불투명하게 전달하며, 이 스키마 계층에서 어떤 JSON 값이든 담습니다.
fromstring아니요move와 copy의 원본 포인터이며, 그 외에는 생략됩니다.

추가 속성은 허용되지 않습니다.

SideEffect

feature-recipe-pipeline 단계가 기존 문서를 패치하는 것 외에 만드는 하나의 효과입니다. kind는 emit_crd 또는 emit_file입니다. 스키마는 이를 열린 문자열로 두어 ABI 호환성을 깨지 않고 새 종류를 추가할 수 있게 하며, 그 밖의 종류이면 빌드가 중단됩니다. kind가 emit_crd이면 crd가 CRD 문서를 담고 file은 생략됩니다. kind가 emit_file이면 file이 쓸 파일을 담고 crd는 생략됩니다.

속성타입필수설명
kindstring예효과 종류로, emit_crd 또는 emit_file입니다. 스키마는 이 필드를 열린 문자열로 두어 ABI 호환성을 깨지 않고 새 종류를 추가할 수 있게 합니다. 그 밖의 종류이면 빌드가 중단되며, 노드, 부수 효과, 해당 종류가 명시됩니다.
scopestring (enum)아니요내보내기가 기여하는 문서 루트입니다. own(노드 자체의 집합) 또는 host(연결된 호스트 컴포넌트의 집합)입니다. scope가 없으면 적용 시점에 own을 의미합니다. 허용 값: "own", "host"
crdany아니요kind가 emit_crd일 때 단계가 내보내는 CRD 문서입니다. 호스트에게 불투명하며 호스트는 이를 해석하지 않고 전달합니다. 이 스키마 계층에서 어떤 JSON 값이든 담습니다.
fileSideEffectFile아니요emit_file 부수 효과가 쓰는 파일로, 대상 경로와 파일 내용입니다.

추가 속성은 허용되지 않습니다.

SideEffectFile

emit_file 부수 효과가 쓰는 파일로, 대상 경로와 파일 내용입니다.

속성타입필수설명
pathstring예파일이 쓰이는 대상 경로입니다.
contentstring예쓸 파일 내용입니다.

추가 속성은 허용되지 않습니다.

PrecedingStep

현재 단계보다 먼저 실행된 파이프라인 단계 하나로, 게스트가 앞서 무엇이 실행되었는지 확인할 수 있게 합니다. 해당 단계의 파이프라인 인덱스, 그 단계가 지정한 플러그인, 그리고 그 단계가 내보낸 부수 효과로 구성됩니다.

속성타입필수설명
indexinteger예파이프라인에서 이전 단계의 0부터 시작하는 위치입니다.
plugin_uristring예이전 파이프라인 항목이 plugin 필드에 쓴 그대로 지정한 플러그인입니다.
side_effectsSideEffect[]아니요이전 단계가 내보낸 부수 효과입니다.

추가 속성은 허용되지 않습니다.