k8s.io/apiserver@v0.31.1/pkg/cel/openapi/resolver/resolver.go (about)

     1  /*
     2  Copyright 2023 The Kubernetes Authors.
     3  
     4  Licensed under the Apache License, Version 2.0 (the "License");
     5  you may not use this file except in compliance with the License.
     6  You may obtain a copy of the License at
     7  
     8      http://www.apache.org/licenses/LICENSE-2.0
     9  
    10  Unless required by applicable law or agreed to in writing, software
    11  distributed under the License is distributed on an "AS IS" BASIS,
    12  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13  See the License for the specific language governing permissions and
    14  limitations under the License.
    15  */
    16  
    17  package resolver
    18  
    19  import (
    20  	"fmt"
    21  
    22  	"k8s.io/apimachinery/pkg/runtime/schema"
    23  	"k8s.io/kube-openapi/pkg/validation/spec"
    24  )
    25  
    26  // SchemaResolver finds the OpenAPI schema for the given GroupVersionKind.
    27  // This interface uses the type defined by k8s.io/kube-openapi
    28  type SchemaResolver interface {
    29  	// ResolveSchema takes a GroupVersionKind (GVK) and returns the OpenAPI schema
    30  	// identified by the GVK.
    31  	// The function returns a non-nil error if the schema cannot be found or fail
    32  	// to resolve. The returned error wraps ErrSchemaNotFound if the resolution is
    33  	// attempted but the corresponding schema cannot be found.
    34  	ResolveSchema(gvk schema.GroupVersionKind) (*spec.Schema, error)
    35  }
    36  
    37  // ErrSchemaNotFound is wrapped and returned if the schema cannot be located
    38  // by the resolver.
    39  var ErrSchemaNotFound = fmt.Errorf("schema not found")