config-schema.json

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "definitions": {
    "name": {
      "type": "string",
      "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*[A-Za-z0-9]$"
    },
    "displayName": {
      "type": "string",
      "pattern": "^[A-Za-z0-9][A-Za-z0-9 _-]*[A-Za-z0-9]$"
    },
    "ref": {
      "type": "string",
      "pattern": "^(\\$\\{[a-zA-Z0-9.]+\\}|[A-Za-z0-9_-]+)+$"
    },
    "path": {
      "type": "string",
      "pattern": "^(\\$?\\{[a-zA-Z0-9.]+\\}|[A-Za-z0-9./_-]+)+$"
    },
    "value": {
      "oneOf": [{ "type": "string" }, { "$ref": "#/definitions/parameterRef" }]
    },
    "parameterRef": {
      "type": "object",
      "additionalProperties": false,
      "required": ["parameter"],
      "properties": {
        "parameter": {
          "$ref": "#/definitions/name"
        }
      }
    },
    "validation": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "api": {
          "$ref": "#/definitions/validationApi",
          "default": {}
        },
        "environment": {
          "$ref": "#/definitions/validationBase",
          "default": {}
        },
        "operation": {
          "$ref": "#/definitions/validationApi",
          "default": {}
        },
        "product": {
          "$ref": "#/definitions/validationBase",
          "default": {}
        },
        "subscription": {
          "$ref": "#/definitions/validationBase",
          "default": {}
        }
      }
    },
    "validationBase": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "name": {
          "type": "string",
          "default": ".*"
        },
        "displayName": {
          "type": "string",
          "default": ".*"
        }
      }
    },
    "validationApi": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "name": {
          "type": "string",
          "default": ".*"
        },
        "displayName": {
          "type": "string",
          "default": ".*"
        },
        "path": {
          "type": "string",
          "default": ".*"
        }
      }
    },
    "configuration": {
      "type": "object",
      "additionalProperties": false,
      "required": ["serviceName"],
      "properties": {
        "serviceName": {
          "$ref": "#/definitions/name"
        }
      }
    },
    "api": {
      "type": "object",
      "additionalProperties": false,
      "required": ["name"],
      "properties": {
        "name": {
          "$ref": "#/definitions/name"
        },
        "displayName": {
          "$ref": "#/definitions/displayName"
        },
        "path": {
          "$ref": "#/definitions/path"
        },
        "policies": {
          "$ref": "#/definitions/policies",
          "default": {}
        },
        "properties": {
          "type": "array",
          "default": [],
          "items": {
            "$ref": "#/definitions/property"
          }
        },
        "operations": {
          "type": "array",
          "default": [],
          "items": {
            "$ref": "#/definitions/operation"
          }
        }
      }
    },
    "policies": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "inbound": {
          "type": "string"
        },
        "backend": {
          "type": "string"
        },
        "outbound": {
          "type": "string"
        },
        "on-error": {
          "type": "string"
        }
      }
    },
    "operation": {
      "type": "object",
      "additionalProperties": false,
      "required": ["name"],
      "properties": {
        "name": {
          "$ref": "#/definitions/name"
        },
        "displayName": {
          "$ref": "#/definitions/displayName"
        },
        "method": {
          "enum": [
            "GET",
            "HEAD",
            "POST",
            "PUT",
            "DELETE",
            "CONNECT",
            "OPTIONS",
            "TRACE",
            "PATCH"
          ]
        },
        "path": {
          "$ref": "#/definitions/path"
        },
        "policies": {
          "$ref": "#/definitions/policies",
          "default": {}
        },
        "queryParameters": {
          "type": "array",
          "default": [],
          "items": {
            "type": "object",
            "additionalProperties": false,
            "required": ["name"],
            "properties": {
              "name": {
                "$ref": "#/definitions/name"
              },
              "description": {
                "type": "string"
              },
              "type": {
                "type": "string",
                "default": ""
              },
              "required": {
                "type": "boolean",
                "default": false
              },
              "defaultValue": {
                "type": "string"
              },
              "values": {
                "type": "array",
                "default": [],
                "items": {
                  "type": "string"
                }
              }
            }
          }
        },
        "templateParameters": {
          "type": "array",
          "default": [],
          "items": {
            "type": "object",
            "additionalProperties": false,
            "required": ["name"],
            "properties": {
              "name": {
                "$ref": "#/definitions/name"
              },
              "description": {
                "type": "string"
              },
              "type": {
                "type": "string",
                "default": ""
              },
              "defaultValue": {
                "type": "string"
              },
              "values": {
                "type": "array",
                "default": [],
                "items": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    },
    "property": {
      "type": "object",
      "additionalProperties": false,
      "required": ["name"],
      "properties": {
        "name": {
          "$ref": "#/definitions/name"
        },
        "displayName": {
          "$ref": "#/definitions/displayName"
        },
        "value": {
          "$ref": "#/definitions/value"
        },
        "secret": {
          "type": "boolean",
          "default": false
        }
      }
    },
    "parameter": {
      "type": "object",
      "additionalProperties": false,
      "required": ["name", "value"],
      "properties": {
        "name": {
          "$ref": "#/definitions/name"
        },
        "value": {
          "type": "string"
        }
      }
    },
    "variable": {
      "type": "object",
      "additionalProperties": false,
      "required": ["name", "value"],
      "properties": {
        "name": {
          "$ref": "#/definitions/name"
        },
        "value": {
          "type": "string"
        }
      }
    },
    "environment": {
      "type": "object",
      "additionalProperties": false,
      "required": ["name"],
      "properties": {
        "name": {
          "$ref": "#/definitions/name"
        },
        "displayName": {
          "$ref": "#/definitions/displayName"
        },
        "configuration": {
          "$ref": "#/definitions/configuration"
        },
        "variables": {
          "type": "array",
          "default": [],
          "items": {
            "$ref": "#/definitions/variable"
          }
        },
        "apis": {
          "type": "array",
          "default": [],
          "items": {
            "$ref": "#/definitions/api"
          }
        },
        "products": {
          "type": "array",
          "default": [],
          "items": {
            "$ref": "#/definitions/product"
          }
        },
        "subscriptions": {
          "type": "array",
          "default": [],
          "items": {
            "$ref": "#/definitions/subscription"
          }
        }
      }
    },
    "product": {
      "type": "object",
      "additionalProperties": false,
      "required": ["name"],
      "properties": {
        "name": {
          "$ref": "#/definitions/name"
        },
        "displayName": {
          "$ref": "#/definitions/displayName"
        },
        "apis": {
          "type": "array",
          "default": [],
          "items": {
            "$ref": "#/definitions/name"
          }
        }
      }
    },
    "subscription": {
      "type": "object",
      "additionalProperties": false,
      "required": ["name"],
      "properties": {
        "name": {
          "$ref": "#/definitions/name"
        },
        "displayName": {
          "$ref": "#/definitions/displayName"
        },
        "scope": {
          "type": "object",
          "additionalProperties": false,
          "required": ["product"],
          "properties": {
            "product": {
              "$ref": "#/definitions/ref"
            }
          }
        }
      }
    }
  },
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "$schema": {
      "type": "string"
    },
    "validation": {
      "$ref": "#/definitions/validation",
      "default": {}
    },
    "configuration": {
      "$ref": "#/definitions/configuration"
    },
    "parameters": {
      "type": "array",
      "default": [],
      "items": {
        "$ref": "#/definitions/parameter"
      }
    },
    "environments": {
      "type": "array",
      "default": [],
      "items": {
        "$ref": "#/definitions/environment"
      }
    },
    "variables": {
      "type": "array",
      "default": [],
      "items": {
        "$ref": "#/definitions/variable"
      }
    },
    "apis": {
      "type": "array",
      "default": [],
      "items": {
        "$ref": "#/definitions/api"
      }
    },
    "products": {
      "type": "array",
      "default": [],
      "items": {
        "$ref": "#/definitions/product"
      }
    },
    "subscriptions": {
      "type": "array",
      "default": [],
      "items": {
        "type": "object",
        "allOf": [{ "$ref": "#/definitions/subscription" }],
        "required": ["name", "scope"]
      }
    }
  }
}