api_individual

package
v0.0.0-...-0c1943d Latest Latest
Warning

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

Go to latest
Published: Mar 11, 2024 License: Apache-2.0 Imports: 13 Imported by: 0

Documentation

Index

Constants

View Source
const DeleteApisBadRequestCode int = 400

DeleteApisBadRequestCode is the HTTP code returned for type DeleteApisBadRequest

View Source
const DeleteApisInternalServerErrorCode int = 500

DeleteApisInternalServerErrorCode is the HTTP code returned for type DeleteApisInternalServerError

View Source
const DeleteApisNotFoundCode int = 404

DeleteApisNotFoundCode is the HTTP code returned for type DeleteApisNotFound

View Source
const DeleteApisOKCode int = 200

DeleteApisOKCode is the HTTP code returned for type DeleteApisOK

View Source
const DeleteApisUnauthorizedCode int = 401

DeleteApisUnauthorizedCode is the HTTP code returned for type DeleteApisUnauthorized

View Source
const PostApisConflictCode int = 409

PostApisConflictCode is the HTTP code returned for type PostApisConflict

View Source
const PostApisInternalServerErrorCode int = 500

PostApisInternalServerErrorCode is the HTTP code returned for type PostApisInternalServerError

View Source
const PostApisOKCode int = 200

PostApisOKCode is the HTTP code returned for type PostApisOK

View Source
const PostApisUnauthorizedCode int = 401

PostApisUnauthorizedCode is the HTTP code returned for type PostApisUnauthorized

Variables

View Source
var PostApisMaxParseMemory int64 = 32 << 20

PostApisMaxParseMemory sets the maximum size in bytes for the multipart form parser for this operation.

The default value is 32 MB. The multipart parser stores up to this + 10MB.

Functions

This section is empty.

Types

type DeleteApis

type DeleteApis struct {
	Context *middleware.Context
	Handler DeleteApisHandler
}
DeleteApis swagger:route DELETE /apis API (Individual) deleteApis

Delete deployed API

This operation can be used to delete a API that was deployed

func NewDeleteApis

func NewDeleteApis(ctx *middleware.Context, handler DeleteApisHandler) *DeleteApis

NewDeleteApis creates a new http.Handler for the delete apis operation

func (*DeleteApis) ServeHTTP

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

type DeleteApisBadRequest

type DeleteApisBadRequest struct {

	/*
	  In: Body
	*/
	Payload *models.Error `json:"body,omitempty"`
}

DeleteApisBadRequest Bad Request. Invalid request or validation error

swagger:response deleteApisBadRequest

func NewDeleteApisBadRequest

func NewDeleteApisBadRequest() *DeleteApisBadRequest

NewDeleteApisBadRequest creates DeleteApisBadRequest with default headers values

func (*DeleteApisBadRequest) SetPayload

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

SetPayload sets the payload to the delete apis bad request response

func (*DeleteApisBadRequest) WithPayload

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

WithPayload adds the payload to the delete apis bad request response

func (*DeleteApisBadRequest) WriteResponse

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

WriteResponse to the client

type DeleteApisHandler

type DeleteApisHandler interface {
	Handle(DeleteApisParams, *models.Principal) middleware.Responder
}

DeleteApisHandler interface for that can handle valid delete apis params

type DeleteApisHandlerFunc

type DeleteApisHandlerFunc func(DeleteApisParams, *models.Principal) middleware.Responder

DeleteApisHandlerFunc turns a function with the right signature into a delete apis handler

func (DeleteApisHandlerFunc) Handle

Handle executing the request and returning a response

type DeleteApisInternalServerError

type DeleteApisInternalServerError struct {

	/*
	  In: Body
	*/
	Payload *models.Error `json:"body,omitempty"`
}

DeleteApisInternalServerError Internal Server Error.

swagger:response deleteApisInternalServerError

func NewDeleteApisInternalServerError

func NewDeleteApisInternalServerError() *DeleteApisInternalServerError

NewDeleteApisInternalServerError creates DeleteApisInternalServerError with default headers values

func (*DeleteApisInternalServerError) SetPayload

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

SetPayload sets the payload to the delete apis internal server error response

func (*DeleteApisInternalServerError) WithPayload

WithPayload adds the payload to the delete apis internal server error response

func (*DeleteApisInternalServerError) WriteResponse

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

WriteResponse to the client

type DeleteApisNotFound

type DeleteApisNotFound struct {

	/*
	  In: Body
	*/
	Payload *models.Error `json:"body,omitempty"`
}

DeleteApisNotFound Not Found. Requested API does not exist.

swagger:response deleteApisNotFound

func NewDeleteApisNotFound

func NewDeleteApisNotFound() *DeleteApisNotFound

NewDeleteApisNotFound creates DeleteApisNotFound with default headers values

func (*DeleteApisNotFound) SetPayload

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

SetPayload sets the payload to the delete apis not found response

func (*DeleteApisNotFound) WithPayload

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

WithPayload adds the payload to the delete apis not found response

func (*DeleteApisNotFound) WriteResponse

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

WriteResponse to the client

type DeleteApisOK

type DeleteApisOK struct {

	/*
	  In: Body
	*/
	Payload *models.DeployResponse `json:"body,omitempty"`
}

DeleteApisOK OK. API successfully undeployed from the Microgateway.

swagger:response deleteApisOK

func NewDeleteApisOK

func NewDeleteApisOK() *DeleteApisOK

NewDeleteApisOK creates DeleteApisOK with default headers values

func (*DeleteApisOK) SetPayload

func (o *DeleteApisOK) SetPayload(payload *models.DeployResponse)

SetPayload sets the payload to the delete apis o k response

func (*DeleteApisOK) WithPayload

func (o *DeleteApisOK) WithPayload(payload *models.DeployResponse) *DeleteApisOK

WithPayload adds the payload to the delete apis o k response

func (*DeleteApisOK) WriteResponse

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

WriteResponse to the client

type DeleteApisParams

type DeleteApisParams struct {

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

	/*Name of the API

	  Required: true
	  Max Length: 255
	  Min Length: 3
	  Pattern: ^[a-zA-Z0-9_~.-]*$
	  In: query
	*/
	APIName string
	/*Name of gateway environments separated by ":"

	  Max Length: 255
	  Pattern: ^[\w\s.-]*(:[\w\s.-]+)*$
	  In: query
	*/
	Environments *string
	/*version of the API

	  Required: true
	  Max Length: 15
	  Min Length: 1
	  Pattern: ^[a-zA-Z0-9_.-]*$
	  In: query
	*/
	Version string
	/*Virtual Host of the API

	  Max Length: 255
	  Pattern: ^(\*|(\*-|\*\.)?(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9])(-\*|\.\*)?)$
	  In: query
	*/
	Vhost *string
}

DeleteApisParams contains all the bound params for the delete apis operation typically these are obtained from a http.Request

swagger:parameters DeleteApis

func NewDeleteApisParams

func NewDeleteApisParams() DeleteApisParams

NewDeleteApisParams creates a new DeleteApisParams object

There are no default values defined in the spec.

func (*DeleteApisParams) BindRequest

func (o *DeleteApisParams) 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 NewDeleteApisParams() beforehand.

type DeleteApisURL

type DeleteApisURL struct {
	APIName      string
	Environments *string
	Version      string
	Vhost        *string
	// contains filtered or unexported fields
}

DeleteApisURL generates an URL for the delete apis operation

func (*DeleteApisURL) Build

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

Build a url path and query string

func (*DeleteApisURL) BuildFull

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

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

func (*DeleteApisURL) Must

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

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

func (*DeleteApisURL) SetBasePath

func (o *DeleteApisURL) 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 (*DeleteApisURL) String

func (o *DeleteApisURL) String() string

String returns the string representation of the path with query string

func (*DeleteApisURL) StringFull

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

StringFull returns the string representation of a complete url

func (*DeleteApisURL) WithBasePath

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

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

type DeleteApisUnauthorized

type DeleteApisUnauthorized struct {

	/*
	  In: Body
	*/
	Payload *models.Error `json:"body,omitempty"`
}

DeleteApisUnauthorized Unauthorized. Invalid authentication credentials.

swagger:response deleteApisUnauthorized

func NewDeleteApisUnauthorized

func NewDeleteApisUnauthorized() *DeleteApisUnauthorized

NewDeleteApisUnauthorized creates DeleteApisUnauthorized with default headers values

func (*DeleteApisUnauthorized) SetPayload

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

SetPayload sets the payload to the delete apis unauthorized response

func (*DeleteApisUnauthorized) WithPayload

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

WithPayload adds the payload to the delete apis unauthorized response

func (*DeleteApisUnauthorized) WriteResponse

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

WriteResponse to the client

type PostApis

type PostApis struct {
	Context *middleware.Context
	Handler PostApisHandler
}
PostApis swagger:route POST /apis API (Individual) postApis

Deploy or update an API

This operation can be used to deploy or update an API.

func NewPostApis

func NewPostApis(ctx *middleware.Context, handler PostApisHandler) *PostApis

NewPostApis creates a new http.Handler for the post apis operation

func (*PostApis) ServeHTTP

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

type PostApisConflict

type PostApisConflict struct {

	/*
	  In: Body
	*/
	Payload *models.Error `json:"body,omitempty"`
}

PostApisConflict Conflict. API to import already exists (when overwride parameter is not included).

swagger:response postApisConflict

func NewPostApisConflict

func NewPostApisConflict() *PostApisConflict

NewPostApisConflict creates PostApisConflict with default headers values

func (*PostApisConflict) SetPayload

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

SetPayload sets the payload to the post apis conflict response

func (*PostApisConflict) WithPayload

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

WithPayload adds the payload to the post apis conflict response

func (*PostApisConflict) WriteResponse

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

WriteResponse to the client

type PostApisHandler

type PostApisHandler interface {
	Handle(PostApisParams, *models.Principal) middleware.Responder
}

PostApisHandler interface for that can handle valid post apis params

type PostApisHandlerFunc

type PostApisHandlerFunc func(PostApisParams, *models.Principal) middleware.Responder

PostApisHandlerFunc turns a function with the right signature into a post apis handler

func (PostApisHandlerFunc) Handle

Handle executing the request and returning a response

type PostApisInternalServerError

type PostApisInternalServerError struct {

	/*
	  In: Body
	*/
	Payload *models.Error `json:"body,omitempty"`
}

PostApisInternalServerError Internal Server Error.

swagger:response postApisInternalServerError

func NewPostApisInternalServerError

func NewPostApisInternalServerError() *PostApisInternalServerError

NewPostApisInternalServerError creates PostApisInternalServerError with default headers values

func (*PostApisInternalServerError) SetPayload

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

SetPayload sets the payload to the post apis internal server error response

func (*PostApisInternalServerError) WithPayload

WithPayload adds the payload to the post apis internal server error response

func (*PostApisInternalServerError) WriteResponse

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

WriteResponse to the client

type PostApisOK

type PostApisOK struct {

	/*
	  In: Body
	*/
	Payload *models.DeployResponse `json:"body,omitempty"`
}

PostApisOK Successful. API deployed or updated Successfully.

swagger:response postApisOK

func NewPostApisOK

func NewPostApisOK() *PostApisOK

NewPostApisOK creates PostApisOK with default headers values

func (*PostApisOK) SetPayload

func (o *PostApisOK) SetPayload(payload *models.DeployResponse)

SetPayload sets the payload to the post apis o k response

func (*PostApisOK) WithPayload

func (o *PostApisOK) WithPayload(payload *models.DeployResponse) *PostApisOK

WithPayload adds the payload to the post apis o k response

func (*PostApisOK) WriteResponse

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

WriteResponse to the client

type PostApisParams

type PostApisParams struct {

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

	/*Zip archive consisting on exported api configuration

	  Required: true
	  In: formData
	*/
	File io.ReadCloser
	/*Whether to force create an API. When this is true, overrides if  an API already exists.

	  In: query
	*/
	Override *bool
}

PostApisParams contains all the bound params for the post apis operation typically these are obtained from a http.Request

swagger:parameters PostApis

func NewPostApisParams

func NewPostApisParams() PostApisParams

NewPostApisParams creates a new PostApisParams object

There are no default values defined in the spec.

func (*PostApisParams) BindRequest

func (o *PostApisParams) 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 NewPostApisParams() beforehand.

type PostApisURL

type PostApisURL struct {
	Override *bool
	// contains filtered or unexported fields
}

PostApisURL generates an URL for the post apis operation

func (*PostApisURL) Build

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

Build a url path and query string

func (*PostApisURL) BuildFull

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

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

func (*PostApisURL) Must

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

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

func (*PostApisURL) SetBasePath

func (o *PostApisURL) 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 (*PostApisURL) String

func (o *PostApisURL) String() string

String returns the string representation of the path with query string

func (*PostApisURL) StringFull

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

StringFull returns the string representation of a complete url

func (*PostApisURL) WithBasePath

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

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

type PostApisUnauthorized

type PostApisUnauthorized struct {

	/*
	  In: Body
	*/
	Payload *models.Error `json:"body,omitempty"`
}

PostApisUnauthorized Unauthorized. Invalid authentication credentials.

swagger:response postApisUnauthorized

func NewPostApisUnauthorized

func NewPostApisUnauthorized() *PostApisUnauthorized

NewPostApisUnauthorized creates PostApisUnauthorized with default headers values

func (*PostApisUnauthorized) SetPayload

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

SetPayload sets the payload to the post apis unauthorized response

func (*PostApisUnauthorized) WithPayload

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

WithPayload adds the payload to the post apis unauthorized response

func (*PostApisUnauthorized) WriteResponse

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

WriteResponse to the client

Jump to

Keyboard shortcuts

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