doc

package
v1.0.1 Latest Latest
Warning

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

Go to latest
Published: Jan 5, 2024 License: MPL-2.0 Imports: 5 Imported by: 0

Documentation

Overview

Package mserv Mserv API.

Provides access to operations over an Mserv service.

 Schemes: http, https
 BasePath: /
 Host: localhost:8989
 Version: 0.0.1

 Consumes:
 - application/json

 Produces:
 - application/json

 Security:
 - api_key

SecurityDefinitions:
api_key:
  type: apiKey
  name: X-Api-Key
  in: header

swagger:meta

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AddMiddlewareParameters

type AddMiddlewareParameters struct {
	// in: formData
	// required: true
	// swagger:file
	UploadFile runtime.File `json:"uploadfile"`
	// in: query
	StoreOnly bool `json:"store_only"`
	// in: query
	APIID string `json:"api_id"`
}

swagger:parameters mwAdd

type GenericErrorResponse

type GenericErrorResponse struct {
	// in: body
	Body models.Payload
}

Generic error specified by `Status` and `Error` fields swagger:response genericErrorResponse

type GenericMiddlewareParameters

type GenericMiddlewareParameters struct {
	// in: path
	// required: true
	ID string `json:"id"`
}

swagger:parameters mwDelete mwFetch mwFetchBundle

type HealthResponse

type HealthResponse struct {
	// in: body
	Body struct {
		models.BasePayload
		Payload health.HReport
	}
}

Health status response swagger:response healthResponse

type InvocationParameters

type InvocationParameters struct {
	// in: path
	// required: true
	Name string `json:"name"`
	// in: body
	// required: true
	Body coprocess.Object
}

swagger:parameters invoke

type InvocationResponse

type InvocationResponse struct {
	// in: body
	Body struct {
		models.BasePayload
		Payload coprocess.Object
	}
}

Middleware invocation response swagger:response invocationResponse

type MiddlewareBundleResponse

type MiddlewareBundleResponse struct {
	// in: body
	File runtime.File
}

Middleware bundle as a file swagger:response mwBundleResponse

type MiddlewareIDResponse

type MiddlewareIDResponse struct {
	// in: body
	Body struct {
		models.BasePayload
		Payload struct {
			BundleID string
		}
	}
}

Response that only includes the ID of the middleware as `BundleID` in the `Payload` swagger:response mwIDResponse

type MiddlewareListResponse

type MiddlewareListResponse struct {
	// in: body
	Body struct {
		models.BasePayload
		Payload []storage.MW
	}
}

List of full middleware representations in the `Payload` swagger:response mwListResponse

type MiddlewareResponse

type MiddlewareResponse struct {
	// in: body
	Body struct {
		models.BasePayload
		Payload storage.MW
	}
}

Full middleware response in the `Payload` swagger:response mwResponse

type UpdateMiddlewareParameters

type UpdateMiddlewareParameters struct {
	GenericMiddlewareParameters
	// in: formData
	// required: true
	// swagger:file
	UploadFile runtime.File `json:"uploadfile"`
}

swagger:parameters mwUpdate

Jump to

Keyboard shortcuts

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