pkg/yml/schema.go

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package yml

import (
	"fmt"

	"github.com/xeipuuv/gojsonschema"

	"github.com/apache/apisix-control-plane/pkg/log"
)

// YamlSchema define schema rule
func YamlSchema() string {
	return `
{
	"type": "object",
	"properties": {
		"kind": {
			"type": "string",
			"enum": ["Gateway", "Rule", "Destination", "Plugin"]
		},
		"name": {
			"type": "string"
		},
		"servers": {
			"type": "array",
			"minItems" : 1,
			"items": {
				"type": "object",
				"properties": {
					"port": {
						"type": "number",
						"minimum": 1
					},
					"name": {
						"type": "string"
					},
					"protocol": {
						"type": "string",
						"enum": ["HTTP", "TCP"]
					},
					"hosts": {
						"type": "array",
						"items": {
							"type": "string"
						}
					}
				}
			}
		},
		"hosts": {
			"type": "array",
			"items": {
				"type": "string"
			}
		},
		"gateways": {
			"type": "array",
			"items": {
				"type": "string"
			}
		},
		"http": {
			"type": "array",
			"items": {
				"type": "object",
				"properties": {
					"route": {
						"type": "array",
						"items": {
							"type": "object",
							"properties": {
								"destination": {
									"type": "object",
									"properties": {
										"port": {
											"type": "number"
										},
										"host": {
											"type": "string"
										},
										"subset": {
											"type": "string"
										},
										"weight": {
											"type": "number"
										}
									}
								}
							}
						}
					},
					"label": {
						"type": "object"
					},
					"match": {
						"type": "array",
						"items": {
							"type": "object",
							"properties": {
								"headers": {
									"type": "object"
								}
							}
						}
					}
				}
			}
		},
		"host": {
			"type": "string"
		},
		"subsets": {
			"type": "array",
			"items": {
				"type": "object",
				"properties": {
					"name": {
						"type": "string"
					},
					"ips": {
						"type": "array",
						"items": {
							"type": "string"
						}
					},
					"selector": {
						"type": "object",
						"properties": {
							"labels": {
								"type": "object"
							}
						}
					}
				}
			}
		},
		"selector": {
			"type": "object",
			"properties": {
				"labels": {
					"type": "object"
				}
			}
		},
		"sort": {
			"type": "array",
			"items": {
				"type": "object",
				"properties": {
					"name": {
						"type": "string"
					},
					"conf": {
						"type": "object"
					}
				}
			}
		}
	},
	"additionalProperties": true
}
`
}

func Validate(request string) (bool, error) {
	schemaLoader := gojsonschema.NewStringLoader(YamlSchema())
	schema, err := gojsonschema.NewSchema(schemaLoader)
	if err != nil {
		log.Errorw("new schema failed", "err", err)
		return false, err
	}
	requestLoader := gojsonschema.NewStringLoader(request)
	result, err := schema.Validate(requestLoader)
	if err != nil {
		log.Errorw("validate failed", "err", err)
		return false, err
	}
	if result.Valid() {
		return true, nil
	} else {
		return false, fmt.Errorf(result.Errors()[0].String())
	}
}