validation

Documentation

Overview

MIT License

Copyright (c) 2022 Kubeshop

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

MIT License

Copyright (c) 2022 Kubeshop

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Index

• Constants
• func GenerateOperationID(method, path string) string
• func GenerateServiceID(hostname string, port uint32) string
• type Error
• type ErrorBody
  • func NewErrorBody() *ErrorBody
  • func (e *ErrorBody) SetErrorBody(err error)
• type Server
  • func NewServer(log logr.Logger) *Server
  • func (s *Server) Process(srv pb.ExternalProcessor_ProcessServer) error
  • func (s *Server) Start(port string) error
  • func (s *Server) UpdateServices(services []*Service)
• type Service
  • func NewService(id string, host string, port uint32, s *openapi3.T, opts *options.Options) (*Service, error)
• type ValidationUpdater

Constants

const (
	HeaderServiceID     = "X-Kusk-Service-ID"
	HeaderOperationID   = "X-Kusk-Operation-ID"
	HeaderOperationName = "X-Kusk-Operation-Name"
)

Functions

func GenerateOperationID

func GenerateOperationID(method, path string) string

GenerateOperationID generates a unique, deterministic ID for a given API route, safe to be used in a HTTP header value.

func GenerateServiceID

func GenerateServiceID(hostname string, port uint32) string

GenerateServiceID generates a unique, deterministic ID for a given API service, safe to be used in a HTTP header value.

Types

type Error

type Error struct {
	Errors []string `json:"errors"`
}

type ErrorBody

type ErrorBody struct {
	Error string `json:"error,omitempty"`
}

func NewErrorBody

func NewErrorBody() *ErrorBody

func (*ErrorBody) SetErrorBody

func (e *ErrorBody) SetErrorBody(err error)

type Server

type Server struct {
	// contains filtered or unexported fields
}

Server provides OpenAPI Validation and implements ext_proc GRPC service.

func NewServer

func NewServer(log logr.Logger) *Server

NewServer() creates new validation Server.

func (*Server) Process

func (s *Server) Process(srv pb.ExternalProcessor_ProcessServer) error

func (*Server) Start

func (s *Server) Start(port string) error

Start starts the GRPC Server

func (*Server) UpdateServices

func (s *Server) UpdateServices(services []*Service)

UpdateServices adds or updates Services to the validation service

type Service

type Service struct {
	ID string

	Host string
	Port uint32

	Spec       *openapi3.T
	Opts       *options.Options
	Router     routers.Router
	Operations map[string]*operation
}

func NewService

func NewService(id string, host string, port uint32, s *openapi3.T, opts *options.Options) (*Service, error)

type ValidationUpdater

type ValidationUpdater interface {
	UpdateServices(services []*Service)
}

ValidationUpdater adds and updates Services to the validation service