gitea-agent/harness/docs/interface-contract/TEMPLATE.md

${interface_contract_title}

목적과 범위

${purpose}

• 포함 범위: ${included_scope}
• 제외 범위: ${excluded_scope}
• 사용 주체: ${consumers}

계약

${stable_section_id} — ${interface_name}

• 책임: ${responsibility}
• 종류·프로토콜: ${interface_type_and_protocol}
• 호출 대상·operation: ${target_and_operation}
• 버전: ${version}
• 호출 주체: ${caller}
• 인증 방식: ${authentication}
• 필요 권한: ${authorization}

입력

필드	위치	타입	필수 여부	기본값	허용 값·형식	의미	민감정보
${input_field_name}	${input_location}	${input_type}	${input_required_or_optional}	${input_default_or_none}	${input_constraints}	${input_meaning}	${input_sensitivity_or_none}

출력

필드	위치	타입	필수 여부	허용 값·형식	의미	민감정보
${output_field_name}	${output_location}	${output_type}	${output_required_or_optional}	${output_constraints}	${output_meaning}	${output_sensitivity_or_none}

오류

코드	분류	발생 조건	재시도 가능 여부	호출자 대응	실패 시 상태 변경
${error_code}	${error_class}	${error_condition}	${retryability}	${caller_action}	${state_change_or_none}

호환성

• 유지할 기존 호출 방식: ${existing_call_compatibility}
• 버전 변경 정책: ${versioning_policy}
• 폐기 정책: ${deprecation_policy}
• 재시도 계약: ${retry_contract}
• 중복 처리 계약: ${idempotency_contract}
• 순서 보장: ${ordering_guarantee}

예시

${example_id} — ${example_title}

• 대상 인터페이스: ${target_interface_id}

호출

${request_or_call_example}

결과

${response_or_result_example}

검증

• 정상 계약: ${success_contract_validation}
• 실패 계약: ${failure_contract_validation}
• 경계 계약: ${boundary_contract_validation}
• 구현·스키마·예시 정합성: ${implementation_schema_example_consistency}