kubernetes

Documentation

Overview

Copyright 2023 The Radius Authors.

Licensed 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.

Copyright 2023 The Radius Authors.

Licensed 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.

Index

• func NewDiscoveryDoc(opts armrpc_controller.Options) (armrpc_controller.Controller, error)
• func NewOpenAPIv2Doc(opts armrpc_controller.Options) (armrpc_controller.Controller, error)
• func NewOpenAPIv3Doc(opts armrpc_controller.Options) (armrpc_controller.Controller, error)
• type DiscoveryDoc
  • func (e *DiscoveryDoc) Run(ctx context.Context, w http.ResponseWriter, req *http.Request) (armrpc_rest.Response, error)
• type OpenAPIv2Doc
  • func (e *OpenAPIv2Doc) Run(ctx context.Context, w http.ResponseWriter, req *http.Request) (armrpc_rest.Response, error)
• type OpenAPIv3Doc
  • func (e *OpenAPIv3Doc) Run(ctx context.Context, w http.ResponseWriter, req *http.Request) (armrpc_rest.Response, error)

Functions

func NewDiscoveryDoc

func NewDiscoveryDoc(opts armrpc_controller.Options) (armrpc_controller.Controller, error)

NewDiscoveryDoc creates a new DiscoveryDoc controller with the given options and returns it, or returns an error if the controller cannot be created.

func NewOpenAPIv2Doc

func NewOpenAPIv2Doc(opts armrpc_controller.Options) (armrpc_controller.Controller, error)

NewOpenAPIv2Doc creates a new OpenAPIv2Doc controller with the given options and returns it, or returns an error if the controller cannot be created.

func NewOpenAPIv3Doc

func NewOpenAPIv3Doc(opts armrpc_controller.Options) (armrpc_controller.Controller, error)

NewOpenAPIv3Doc creates a new OpenAPIv3Doc controller with the given options and returns it, or returns an error if the controller cannot be created.

Types

type DiscoveryDoc

type DiscoveryDoc struct {
	armrpc_controller.BaseController
}

DiscoveryDoc is the controller implementation to handle the discovery document.

func (*DiscoveryDoc) Run

func (e *DiscoveryDoc) Run(ctx context.Context, w http.ResponseWriter, req *http.Request) (armrpc_rest.Response, error)

Run responds to a request to /apis/api.ucp.dev/v1alpha3 with a 200 OK response and an empty list of CRDs.

type OpenAPIv2Doc

type OpenAPIv2Doc struct {
	armrpc_controller.BaseController
}

OpenAPIv2Doc is the controller implementation to handle the OpenAPIv2Doc endpoint.

func (*OpenAPIv2Doc) Run

func (e *OpenAPIv2Doc) Run(ctx context.Context, w http.ResponseWriter, req *http.Request) (armrpc_rest.Response, error)

Run() responds to a request to /apis/api.ucp.dev/v1alpha3/openapi/v2 with a 200 OK response and a swagger (openapi v2) doc, without logging every request.

type OpenAPIv3Doc

type OpenAPIv3Doc struct {
	armrpc_controller.BaseController
}

OpenAPIv3Doc is the controller implementation to handle the OpenAPIv3Doc endpoint.

func (*OpenAPIv3Doc) Run

func (e *OpenAPIv3Doc) Run(ctx context.Context, w http.ResponseWriter, req *http.Request) (armrpc_rest.Response, error)

Run() responds to a request to /apis/api.ucp.dev/v1alpha3/openapi/v3 with a 200 OK response and a swagger (openapi v3) doc.