specification

Documentation

Index

• Constants
• type GetSpecification
  • func NewGetSpecification(ctx *middleware.Context, handler GetSpecificationHandler) *GetSpecification
  • func (o *GetSpecification) ServeHTTP(rw http.ResponseWriter, r *http.Request)
• type GetSpecificationDefault
  • func NewGetSpecificationDefault(code int) *GetSpecificationDefault
  • func (o *GetSpecificationDefault) SetConfigurationVersion(configurationVersion int64)
  • func (o *GetSpecificationDefault) SetPayload(payload *models.Error)
  • func (o *GetSpecificationDefault) SetStatusCode(code int)
  • func (o *GetSpecificationDefault) WithConfigurationVersion(configurationVersion int64) *GetSpecificationDefault
  • func (o *GetSpecificationDefault) WithPayload(payload *models.Error) *GetSpecificationDefault
  • func (o *GetSpecificationDefault) WithStatusCode(code int) *GetSpecificationDefault
  • func (o *GetSpecificationDefault) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
• type GetSpecificationHandler
• type GetSpecificationHandlerFunc
  • func (fn GetSpecificationHandlerFunc) Handle(params GetSpecificationParams, principal interface{}) middleware.Responder
• type GetSpecificationOK
  • func NewGetSpecificationOK() *GetSpecificationOK
  • func (o *GetSpecificationOK) SetPayload(payload interface{})
  • func (o *GetSpecificationOK) WithPayload(payload interface{}) *GetSpecificationOK
  • func (o *GetSpecificationOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
• type GetSpecificationParams
  • func NewGetSpecificationParams() GetSpecificationParams
  • func (o *GetSpecificationParams) BindRequest(r *http.Request, route *middleware.MatchedRoute) error
• type GetSpecificationURL
  • func (o *GetSpecificationURL) Build() (*url.URL, error)
  • func (o *GetSpecificationURL) BuildFull(scheme, host string) (*url.URL, error)
  • func (o *GetSpecificationURL) Must(u *url.URL, err error) *url.URL
  • func (o *GetSpecificationURL) SetBasePath(bp string)
  • func (o *GetSpecificationURL) String() string
  • func (o *GetSpecificationURL) StringFull(scheme, host string) string
  • func (o *GetSpecificationURL) WithBasePath(bp string) *GetSpecificationURL

Constants

const GetSpecificationOKCode int = 200

GetSpecificationOKCode is the HTTP code returned for type GetSpecificationOK

Types

type GetSpecification

type GetSpecification struct {
	Context *middleware.Context
	Handler GetSpecificationHandler
}

GetSpecification swagger:route GET /specification Specification getSpecification

Data Plane API Specification

Return Data Plane API OpenAPI specification

func NewGetSpecification

func NewGetSpecification(ctx *middleware.Context, handler GetSpecificationHandler) *GetSpecification

NewGetSpecification creates a new http.Handler for the get specification operation

func (*GetSpecification) ServeHTTP

func (o *GetSpecification) ServeHTTP(rw http.ResponseWriter, r *http.Request)

type GetSpecificationDefault

type GetSpecificationDefault struct {

	/*Configuration file version

	 */
	ConfigurationVersion int64 `json:"Configuration-Version"`

	/*
	  In: Body
	*/
	Payload *models.Error `json:"body,omitempty"`
	// contains filtered or unexported fields
}

GetSpecificationDefault General Error

swagger:response getSpecificationDefault

func NewGetSpecificationDefault

func NewGetSpecificationDefault(code int) *GetSpecificationDefault

NewGetSpecificationDefault creates GetSpecificationDefault with default headers values

func (*GetSpecificationDefault) SetConfigurationVersion

func (o *GetSpecificationDefault) SetConfigurationVersion(configurationVersion int64)

SetConfigurationVersion sets the configurationVersion to the get specification default response

func (*GetSpecificationDefault) SetPayload

func (o *GetSpecificationDefault) SetPayload(payload *models.Error)

SetPayload sets the payload to the get specification default response

func (*GetSpecificationDefault) SetStatusCode

func (o *GetSpecificationDefault) SetStatusCode(code int)

SetStatusCode sets the status to the get specification default response

func (*GetSpecificationDefault) WithConfigurationVersion

func (o *GetSpecificationDefault) WithConfigurationVersion(configurationVersion int64) *GetSpecificationDefault

WithConfigurationVersion adds the configurationVersion to the get specification default response

func (*GetSpecificationDefault) WithPayload

func (o *GetSpecificationDefault) WithPayload(payload *models.Error) *GetSpecificationDefault

WithPayload adds the payload to the get specification default response

func (*GetSpecificationDefault) WithStatusCode

func (o *GetSpecificationDefault) WithStatusCode(code int) *GetSpecificationDefault

WithStatusCode adds the status to the get specification default response

func (*GetSpecificationDefault) WriteResponse

func (o *GetSpecificationDefault) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type GetSpecificationHandler

type GetSpecificationHandler interface {
	Handle(GetSpecificationParams, interface{}) middleware.Responder
}

GetSpecificationHandler interface for that can handle valid get specification params

type GetSpecificationHandlerFunc

type GetSpecificationHandlerFunc func(GetSpecificationParams, interface{}) middleware.Responder

GetSpecificationHandlerFunc turns a function with the right signature into a get specification handler

func (GetSpecificationHandlerFunc) Handle

func (fn GetSpecificationHandlerFunc) Handle(params GetSpecificationParams, principal interface{}) middleware.Responder

Handle executing the request and returning a response

type GetSpecificationOK

type GetSpecificationOK struct {

	/*
	  In: Body
	*/
	Payload interface{} `json:"body,omitempty"`
}

GetSpecificationOK Success

swagger:response getSpecificationOK

func NewGetSpecificationOK

func NewGetSpecificationOK() *GetSpecificationOK

NewGetSpecificationOK creates GetSpecificationOK with default headers values

func (*GetSpecificationOK) SetPayload

func (o *GetSpecificationOK) SetPayload(payload interface{})

SetPayload sets the payload to the get specification o k response

func (*GetSpecificationOK) WithPayload

func (o *GetSpecificationOK) WithPayload(payload interface{}) *GetSpecificationOK

WithPayload adds the payload to the get specification o k response

func (*GetSpecificationOK) WriteResponse

func (o *GetSpecificationOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type GetSpecificationParams

type GetSpecificationParams struct {

	// HTTP Request Object
	HTTPRequest *http.Request `json:"-"`
}

GetSpecificationParams contains all the bound params for the get specification operation typically these are obtained from a http.Request

swagger:parameters getSpecification

func NewGetSpecificationParams

func NewGetSpecificationParams() GetSpecificationParams

NewGetSpecificationParams creates a new GetSpecificationParams object no default values defined in spec.

func (*GetSpecificationParams) BindRequest

func (o *GetSpecificationParams) BindRequest(r *http.Request, route *middleware.MatchedRoute) error

BindRequest both binds and validates a request, it assumes that complex things implement a Validatable(strfmt.Registry) error interface for simple values it will use straight method calls.

To ensure default values, the struct must have been initialized with NewGetSpecificationParams() beforehand.

type GetSpecificationURL

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

GetSpecificationURL generates an URL for the get specification operation

func (*GetSpecificationURL) Build

func (o *GetSpecificationURL) Build() (*url.URL, error)

Build a url path and query string

func (*GetSpecificationURL) BuildFull

func (o *GetSpecificationURL) BuildFull(scheme, host string) (*url.URL, error)

BuildFull builds a full url with scheme, host, path and query string

func (*GetSpecificationURL) Must

func (o *GetSpecificationURL) Must(u *url.URL, err error) *url.URL

Must is a helper function to panic when the url builder returns an error

func (*GetSpecificationURL) SetBasePath

func (o *GetSpecificationURL) SetBasePath(bp string)

SetBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string

func (*GetSpecificationURL) String

func (o *GetSpecificationURL) String() string

String returns the string representation of the path with query string

func (*GetSpecificationURL) StringFull

func (o *GetSpecificationURL) StringFull(scheme, host string) string

StringFull returns the string representation of a complete url

func (*GetSpecificationURL) WithBasePath

func (o *GetSpecificationURL) WithBasePath(bp string) *GetSpecificationURL

WithBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string