schema.json

{
  "$schema": "http://json-schema.org/draft-06/schema#",
  "title": "Dip Configuration Schema",
  "description": "Schema for the dip.yml configuration file",
  "type": "object",
  "additionalProperties": false,
  "definitions": {
    "environment_vars": {
      "type": "object",
      "description": "Defines environment variables",
      "additionalProperties": {
        "type": ["string", "boolean", "number"]
      },
      "examples": [
        { "RAILS_ENV": "development" },
        { "DATABASE_URL": "postgres://user:password@db:5432/myapp_development" },
        { "PORT": "${PORT:-3000}" }
      ]
    },
    "interaction_command": {
      "type": "object",
      "description": "Configuration for an interaction command",
      "additionalProperties": false,
      "properties": {
        "description": {
          "type": "string",
          "description": "Describes the command",
          "examples": ["Run Rails commands", "Connect to PostgreSQL database"]
        },
        "service": {
          "type": "string",
          "description": "Specifies the service associated with the command",
          "examples": ["web", "frontend", "db"]
        },
        "command": {
          "type": "string",
          "description": "Represents the command to be executed",
          "examples": ["bundle exec rails", "npm", "psql -h db -U user myapp_development"]
        },
        "default_args": {
          "type": "string",
          "description": "Default arguments for the command",
          "examples": ["server -p 3000 -b 0.0.0.0"]
        },
        "environment": {
          "$ref": "#/definitions/environment_vars"
        },
        "compose": {
          "type": "object",
          "description": "Allows specifying Docker Compose options",
          "additionalProperties": false,
          "properties": {
            "method": {
              "type": "string",
              "description": "Specifies the Docker Compose method (e.g., up, run)",
              "examples": ["run", "up"]
            },
            "compose_method": {
              "type": "string",
              "description": "Specifies an alternative Docker Compose method to use in compose commands",
              "examples": ["up"]
            },
            "run_options": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "description": "Options to pass to the 'docker-compose run' command",
              "examples": [["service-ports", "rm"]]
            },
            "profiles": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "description": "Docker Compose profiles to use",
              "examples": [["web", "development"], ["frontend"], ["test"]]
            }
          }
        },
        "shell": {
          "type": "boolean",
          "description": "Enables or disables shell interpolation"
        },
        "entrypoint": {
          "type": "string",
          "description": "Specifies the command entrypoint"
        },
        "runner": {
          "type": "string",
          "description": "Specifies the runner (e.g., docker_compose, kubectl)"
        },
        "pod": {
          "type": "string",
          "description": "Specifies the pod for the kubectl runner"
        },
        "compose_run_options": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "DEPRECATED: Options to pass to the 'docker-compose run' command",
          "examples": [["service-ports", "rm"]]
        },
        "subcommands": {
          "type": "object",
          "description": "Contains subcommands with the same structure as main commands",
          "patternProperties": {
            "^[\\w\\-.:/\\s]+$": {
              "$ref": "#/definitions/interaction_command"
            }
          },
          "minProperties": 1,
          "additionalProperties": false
        }
      }
    }
  },
  "properties": {
    "version": {
      "type": "string",
      "description": "Specifies the minimum required version of Dip",
      "examples": ["8.1.0"]
    },
    "compose": {
      "type": "object",
      "description": "Contains Docker Compose configuration",
      "properties": {
        "files": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Array of strings representing paths to Docker Compose files",
          "examples": [["docker-compose.yml", "docker-compose.override.yml"]]
        },
        "project_name": {
          "type": "string",
          "description": "Specifies the project name for Docker Compose",
          "examples": ["app"]
        },
        "command": {
          "type": "string",
          "description": "Specifies an alternative Docker Compose command",
          "examples": ["docker compose"]
        },
        "method": {
          "type": "string",
          "description": "Specifies the Docker Compose method to use"
        }
      }
    },
    "interaction": {
      "type": "object",
      "description": "Defines the commands and their configurations",
      "patternProperties": {
        "^[\\w\\-.:/\\s]+$": {
          "$ref": "#/definitions/interaction_command"
        }
      },
      "additionalProperties": false
    },
    "provision": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Lists the commands to be executed for provisioning",
      "examples": [
        [
          "dip compose down --volumes",
          "dip compose build",
          "dip rails db:migrate",
          "dip npm install"
        ]
      ]
    },
    "environment": {
      "$ref": "#/definitions/environment_vars"
    },
    "kubectl": {
      "type": "object",
      "description": "Contains Kubernetes configuration",
      "additionalProperties": false,
      "properties": {
        "namespace": {
          "type": "string",
          "description": "Specifies the Kubernetes namespace to use",
          "examples": ["app"]
        }
      }
    },
    "modules": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Paths to module configuration files",
      "examples": [["production"]]
    },
    "infra": {
      "type": "object",
      "description": "Contains infrastructure services configuration",
      "additionalProperties": false,
      "patternProperties": {
        "^[\\w\\-.:/\\s]+$": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "git": {
              "type": "string",
              "pattern": "^(git@|git://|https?://)[\\w\\d.@:/\\-]+$",
              "description": "Git repository URL for the infrastructure component",
              "examples": ["https://github.com/mycompany/redis-config.git"]
            },
            "ref": {
              "type": "string",
              "description": "Specifies the Git reference (branch, tag, or commit) to use",
              "examples": ["main"]
            },
            "path": {
              "type": "string",
              "description": "Local path to the infrastructure component",
              "examples": ["./infra/elasticsearch"]
            }
          },
          "oneOf": [
            { "required": ["git"] },
            { "required": ["path"] }
          ]
        }
      }
    }
  },
  "required": ["version"]
}