api

package
v0.0.0-...-54dff2b Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 1, 2024 License: Apache-2.0 Imports: 17 Imported by: 0

Documentation

Overview

Package api provides a handler for /api/

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetRequestOptions

func GetRequestOptions(r *http.Request) (v2.RequestOptions, error)

GetRequestOptions returns the metrics request options from a HTTP request.

func RegisterHandlers

func RegisterHandlers(mux httpmux.Mux, m manager.Manager) error

Types

type ApiVersion

type ApiVersion interface {
	// Returns the version string.
	Version() string

	// List of supported API endpoints.
	SupportedRequestTypes() []string

	// Handles a request. The second argument is the parameters after /api/<version>/<endpoint>
	HandleRequest(requestType string, request []string, m manager.Manager, w http.ResponseWriter, r *http.Request) error
}

Interface for a cAdvisor API version

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL