Recipaie 스키마

recipaie 스키마는 배포 레시피의 구조를 정의합니다. 소프트웨어를 어떻게 설치하고 설정하는지 설명하는 템플릿입니다.

스키마 URL:

https://recipaie.com/schemas/recipaie.schema.json

필수 필드

필드형식설명

name

string서비스 또는 애플리케이션의 이름

version

stringrecipaie의 시맨틱 버전(예: "1.0.0")

steps

array순서가 정해진 배포 단계 목록

step_count

integer전체 단계 수(steps 배열의 길이와 일치해야 합니다)

선택 필드

필드형식설명

description

string이 레시피가 무엇을 배포하는지에 대한 간단한 설명

prerequisites

array시작하기 전에 필요한 도구나 조건

단계 구조

steps 배열의 각 단계에는 다음이 반드시 있어야 합니다:

필드필수설명

order

예단계 번호(1부터 시작)

what

예어떤 작업을 수행할지

why

예이 단계가 왜 필요한지(맥락을 쌓아 줍니다)

when

예언제 또는 어떤 조건에서 이 단계를 수행할지

skip_if

아니요이 단계를 건너뛸 조건

how

예작업을 수행하는 방법(명령 또는 지시)

verify

예단계가 성공했는지 검증하는 방법

comments

아니요추가 맥락이나 참고 사항
전체 스키마 JSON 
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://recipaie.publifye.pro/recipaie.schema.json",
  "title": "Recipaie",
  "description": "Recipe for AI - a simple deployment guide schema for AI assistants",
  "type": "object",
  "required": ["name", "version", "steps", "step_count"],
  "properties": {
    "$schema": {
      "type": "string",
      "description": "Reference to the recipaie schema"
    },
    "name": {
      "type": "string",
      "description": "Name of the service or application"
    },
    "flavor": {
      "type": "string",
      "description": "Variant identifier (e.g., 'dev', 'deploy'). Empty or omitted for the main recipaie. Must match filename suffix: recipaie-{flavor}.json"
    },
    "version": {
      "type": "string",
      "description": "Semantic version of the recipaie (e.g., '1.0.0')"
    },
    "description": {
      "type": "string",
      "description": "Brief description of what this recipe deploys"
    },
    "prerequisites": {
      "type": "array",
      "items": { "type": "string" },
      "description": "Tools or conditions that must exist before starting (e.g., docker, pubmcp)"
    },
    "steps": {
      "type": "array",
      "description": "Ordered list of deployment steps",
      "items": {
        "type": "object",
        "required": ["order", "what", "why", "when", "how", "verify"],
        "properties": {
          "order": {
            "type": "integer",
            "minimum": 1,
            "description": "Step number (1-based)"
          },
          "what": {
            "type": "string",
            "description": "What action to perform"
          },
          "why": {
            "type": "string",
            "description": "Why this step is needed (builds context)"
          },
          "when": {
            "type": "string",
            "description": "When or under what condition to perform this step"
          },
          "skip_if": {
            "type": "string",
            "description": "Condition to skip this step (optional)"
          },
          "how": {
            "type": "string",
            "description": "How to perform the action (command or instruction)"
          },
          "verify": {
            "type": "string",
            "description": "How to verify the step succeeded"
          },
          "comments": {
            "type": "array",
            "items": { "type": "string" },
            "description": "Additional context or notes (optional)"
          }
        },
        "additionalProperties": false
      }
    },
    "step_count": {
      "type": "integer",
      "minimum": 1,
      "description": "Total number of steps (must match steps array length)"
    }
  },
  "additionalProperties": false
}

Prodaie 스키마

prodaie 스키마는 recipaie를 확장해 설치 위치별 실행 결과를 기록합니다. recipaie를 실행한 "산출물"입니다.

스키마 URL:

https://recipaie.com/schemas/prodaie.schema.json

구조

prodaie에는 다음이 담깁니다:

  • name

     - 원본 recipaie와 일치해야 합니다

  • locations - 설치 위치 배열이며, 각 위치마다 고유한 실행 결과를 가집니다

Location 구조

각 location에는 다음이 담깁니다:

필드설명

path

이 인스턴스가 설치된 파일 경로 또는 디렉터리

description

이 특정 설치의 목적

status

실행 상태: complete, partial 또는 failed

steps

이 설치에 대한 결과가 담긴 단계들

step_count

전체 단계 수

단계 결과

recipaie의 단계 필드에 더해, prodaie의 단계에는 다음 필수 필드가 포함됩니다:

필드형식설명

success

boolean

단계가 성공했거나 의도적으로 건너뛴 경우 true, 실패한 경우 false

details

string실행 중 무슨 일이 있었는지에 대한 설명

불리언 success 필드 덕분에 각 단계의 결과를 프로그램으로 쉽게 확인할 수 있고, details는 사람이 읽을 수 있는 설명을 제공합니다.

전체 스키마 JSON 
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://recipaie.publifye.pro/prodaie.schema.json",
  "title": "Prodaie",
  "description": "Product of AI - a recipaie with execution results per installation location",
  "type": "object",
  "required": ["name", "locations"],
  "properties": {
    "$schema": {
      "type": "string",
      "description": "Reference to the prodaie schema"
    },
    "name": {
      "type": "string",
      "description": "Name of the service or application"
    },
    "flavor": {
      "type": "string",
      "description": "Variant identifier matching the recipaie that was executed. Must match filename suffix: prodaie-{flavor}.json"
    },
    "description": {
      "type": "string",
      "description": "Brief description of what this recipe deploys"
    },
    "prerequisites": {
      "type": "array",
      "items": { "type": "string" },
      "description": "Tools or conditions that must exist before starting"
    },
    "locations": {
      "type": "array",
      "description": "Installation locations with their individual execution results",
      "minItems": 1,
      "items": {
        "type": "object",
        "required": ["path", "status", "steps", "step_count"],
        "properties": {
          "path": {
            "type": "string",
            "description": "File path or directory where this instance is installed"
          },
          "description": {
            "type": "string",
            "description": "Purpose of this specific installation"
          },
          "status": {
            "type": "string",
            "enum": ["complete", "partial", "failed"],
            "description": "Execution status for this installation"
          },
          "steps": {
            "type": "array",
            "description": "Ordered list of deployment steps with results for this installation",
            "items": {
              "type": "object",
              "required": ["order", "what", "why", "when", "how", "verify", "success", "details"],
              "properties": {
                "order": {
                  "type": "integer",
                  "minimum": 1,
                  "description": "Step number (1-based)"
                },
                "what": {
                  "type": "string",
                  "description": "What action to perform"
                },
                "why": {
                  "type": "string",
                  "description": "Why this step is needed (builds context)"
                },
                "when": {
                  "type": "string",
                  "description": "When or under what condition to perform this step"
                },
                "skip_if": {
                  "type": "string",
                  "description": "Condition to skip this step (optional)"
                },
                "how": {
                  "type": "string",
                  "description": "How to perform the action (command or instruction)"
                },
                "verify": {
                  "type": "string",
                  "description": "How to verify the step succeeded"
                },
                "success": {
                  "type": "boolean",
                  "description": "Whether the step succeeded (true) or failed (false). Steps that were intentionally skipped are also true."
                },
                "details": {
                  "type": "string",
                  "description": "Explanation of what happened during execution"
                },
                "comments": {
                  "type": "array",
                  "items": { "type": "string" },
                  "description": "Additional context or notes (optional)"
                }
              },
              "additionalProperties": false
            }
          },
          "step_count": {
            "type": "integer",
            "minimum": 1,
            "description": "Total number of steps (must match steps array length)"
          }
        },
        "additionalProperties": false
      }
    }
  },
  "additionalProperties": false
}