docs

Documentation

Overview

Package classification Kubescape Operator

The Kubescape Operator coordinates the Kubescape in-cluster components and allows clients to execute actions these components.

Schemes: https, http BasePath: / Version: 1.0.0

Consumes: - application/json Produces: - text/plain

Security: - basic

swagger:meta

Package docs documents the HTTP API endpoints. The documentation is then used to generate an OpenAPI spec.

Index

• Constants
• func NewOpenAPIUIHandler() http.Handler
• func ServeOpenAPISpec(w http.ResponseWriter, r *http.Request)

Constants

const (
	OpenAPIDocsEndpoint        = "docs"
	OpenAPIRapiEndpoint        = "rapi"
	OpenAPISwaggerUIEndpoint   = "swaggerui"
	OpenAPIswaggerJSONEndpoint = "swagger.yaml"
	OpenAPIV2Prefix            = "/openapi/v2/"
)

Functions

func NewOpenAPIUIHandler

func NewOpenAPIUIHandler() http.Handler

NewOpenAPIUIHandler returns a handler that serves OpenAPI specs via UI

func ServeOpenAPISpec

func ServeOpenAPISpec(w http.ResponseWriter, r *http.Request)

ServeOpenAPISpec returns the OpenAPI specification file