docs

package
v1.9.0-rc5 Latest Latest
Warning

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

 Go to latest Published: Jul 19, 2023 License: Apache-2.0 Imports: 1 Imported by: 0

Documentation

Overview

Epinio API

This is the API specification of the Epinio API 

Schemes: http, https
Host:
BasePath: /api/v1
Version: 1.0.0

SecurityDefinitions:
basicAuth:
     type: basic

Security:
- basicAuth: []

swagger:meta

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AllAppsParam 

type AllAppsParam struct{}

swagger:parameters AllApps

type AllChartsParam added in v0.8.0 

type AllChartsParam struct{}

swagger:parameters AllCharts

type AppBatchDeleteParam added in v1.4.0 

type AppBatchDeleteParam struct {
	// in: path
	Namespace string
	// in: url
	Applications []string
}

swagger:parameters AppBatchDelete

type AppChartsResponse added in v0.8.0 

type AppChartsResponse struct {
	// in: body
	Body models.AppChartList
}

swagger:response AppChartsResponse

type AppCreateParam 

type AppCreateParam struct {
	// in: path
	Namespace string
	// in: body
	Configuration models.ApplicationCreateRequest
}

swagger:parameters AppCreate

type AppCreateResponse 

type AppCreateResponse struct {
	// in: body
	Body models.Response
}

swagger:response AppCreateResponse

type AppDeleteParam 

type AppDeleteParam struct {
	// in: path
	Namespace string
	// in: path
	App string
}

swagger:parameters AppDelete

type AppDeleteResponse 

type AppDeleteResponse struct {
	// in: body
	Body models.ApplicationDeleteResponse
}

swagger:response AppDeleteResponse

type AppDeployParam 

type AppDeployParam struct {
	// in: path
	Namespace string
	// in: path
	App string
	// in: body
	Body models.DeployRequest
}

swagger:parameters AppDeploy

type AppDeployResponse 

type AppDeployResponse struct {
	// in: body
	Body models.DeployResponse
}

swagger:response AppDeployResponse

type AppExecParam added in v0.3.6 

type AppExecParam struct {
	// in: path
	Namespace string
	// in: path
	App string
	// in: query
	Instance string
}

swagger:parameters AppExec

type AppExecResponse added in v0.3.6 

type AppExecResponse struct{}

swagger:response AppExecResponse

type AppImportGitParam 

type AppImportGitParam struct {
	// in: path
	Namespace string
	// in: path
	App    string
	GitUrl string
	GitRev string
}

swagger:parameters AppImportGit

type AppImportGitResponse 

type AppImportGitResponse struct {
	// in: body
	Body models.ImportGitResponse
}

swagger:response AppImportGitResponse

type AppLogsParam 

type AppLogsParam struct {
	// in: path
	Namespace string
	// in: path
	App string
}

swagger:parameters AppLogs

type AppLogsResponse 

type AppLogsResponse struct{}

swagger:response AppLogsResponse

type AppMatchParam added in v0.9.0 

type AppMatchParam struct {
	// in: path
	Namespace string
	// in: path
	Pattern string
}

swagger:parameters AppMatch

type AppMatchResponse added in v0.9.0 

type AppMatchResponse struct {
	// in: body
	Body models.AppMatchResponse
}

swagger:response AppMatchResponse

type AppPartParam added in v0.6.3 

type AppPartParam struct {
	// in: path
	Namespace string
	// in: path
	App string
	// in: path
	Part string
}

swagger:parameters AppPart

type AppPartResponse added in v0.6.3 

type AppPartResponse struct {
	// in: body
	Body []byte
}

swagger:response AppPartResponse

type AppPortForwardParam added in v0.4.0 

type AppPortForwardParam struct {
	// in: path
	Namespace string
	// in: path
	App string
	// in: query
	Instance string
}

swagger:parameters AppPortForward

type AppPortForwardResponse added in v0.4.0 

type AppPortForwardResponse struct{}

swagger:response AppPortForwardResponse

type AppRestartParam added in v0.3.3 

type AppRestartParam struct {
	// in: path
	Namespace string
	// in: path
	App string
}

swagger:parameters AppRestart

type AppRestartResponse added in v0.3.3 

type AppRestartResponse struct {
	// in: body
	Body models.Response
}

swagger:response AppRestartResponse

type AppRunningParam 

type AppRunningParam struct {
	// in: path
	Namespace string
	// in: path
	App string
}

swagger:parameters AppRunning

type AppRunningResponse 

type AppRunningResponse struct {
	// in: body
	Body models.Response
}

swagger:response AppRunningResponse

type AppShowParam 

type AppShowParam struct {
	// in: path
	Namespace string
	// in: path
	App string
}

swagger:parameters AppShow

type AppShowResponse 

type AppShowResponse struct {
	// in: body
	Body models.App
}

swagger:response AppShowResponse

type AppStageParam 

type AppStageParam struct {
	// in: path
	Namespace string
	// in: path
	App string
	// in: body
	Body models.StageRequest
}

swagger:parameters AppStage

type AppStageResponse 

type AppStageResponse struct {
	// in: body
	Body models.StageResponse
}

swagger:response AppStageResponse

type AppUpdateParam 

type AppUpdateParam struct {
	// in: path
	Namespace string
	// in: path
	App string
	// in: body
	Body models.ApplicationUpdateRequest
}

swagger:parameters AppUpdate

type AppUpdateResponse 

type AppUpdateResponse struct {
	// in: body
	Body models.Response
}

swagger:response AppUpdateResponse

type AppUploadParam 

type AppUploadParam struct {
	// in: path
	Namespace string
	// in: path
	App string
}

swagger:parameters AppUpload

type AppUploadResponse 

type AppUploadResponse struct {
	// in: body
	Body models.UploadResponse
}

swagger:response AppUploadResponse

type AppValidateCVParam added in v1.2.0 

type AppValidateCVParam struct {
	// in: path
	Namespace string
	// in: path
	App string
}

swagger:parameters AppValidateCV

type AppValidateCVResponse added in v1.2.0 

type AppValidateCVResponse struct {
	// in: body
	Body models.Response
}

swagger:response AppValidateCVResponse

type AppsParam 

type AppsParam struct {
	// in: path
	Namespace string
}

swagger:parameters Apps

type AppsResponse 

type AppsResponse struct {
	// in: body
	Body models.AppList
}

swagger:response AppsResponse

type CatalogMatchResponse added in v0.9.0 

type CatalogMatchResponse struct {
	// in: body
	Body models.CatalogMatchResponse
}

swagger:response CatalogMatchResponse

type CatalogServiceMatchParam added in v0.9.0 

type CatalogServiceMatchParam struct {
	// in: path
	Pattern string
}

swagger:parameters CatalogServiceMatch

type ChartMatch0Params added in v0.8.0 

type ChartMatch0Params struct {
}

swagger:parameters ChartMatch0

type ChartMatchParams added in v0.8.0 

type ChartMatchParams struct {
	// in: path
	Pattern string
}

swagger:parameters ChartMatch

type ChartMatchResponse added in v0.8.0 

type ChartMatchResponse struct {
	// in: body
	Body models.ChartMatchResponse
}

swagger:response ChartMatchResponse

type ChartShowParam added in v0.8.0 

type ChartShowParam struct {
	// in: path
	Chart string
}

swagger:parameters ChartShow

type ChartShowResponse added in v0.8.0 

type ChartShowResponse struct {
	// in: body
	Body models.AppChart
}

swagger:response ChartShowResponse

type ConfigurationAllConfigurationsParam added in v0.6.0 

type ConfigurationAllConfigurationsParam struct{}

swagger:parameters AllConfigurations

type ConfigurationAppsParam added in v0.6.0 

type ConfigurationAppsParam struct {
	// in: path
	Namespace string
}

swagger:parameters ConfigurationApps

type ConfigurationAppsResponse added in v0.6.0 

type ConfigurationAppsResponse struct {
	// in: body
	Body map[string]models.AppList
}

swagger:response ConfigurationAppsResponse

type ConfigurationBatchDeleteParam added in v1.3.0 

type ConfigurationBatchDeleteParam struct {
	// in: path
	Namespace string
	// in: url
	Configurations []string
	// in: body
	Body models.ConfigurationDeleteRequest
}

swagger:parameters ConfigurationBatchDelete

type ConfigurationBindResponse added in v0.6.0 

type ConfigurationBindResponse struct {
	// in: body
	Body models.BindResponse
}

swagger:response ConfigurationBindResponse

type ConfigurationBindingCreateParams added in v0.6.0 

type ConfigurationBindingCreateParams struct {
	// in: path
	Namespace string
	// in: path
	App string
	// in: body
	Body models.BindRequest
}

swagger:parameters ConfigurationBindingCreate

type ConfigurationBindingDeleteParams added in v0.6.0 

type ConfigurationBindingDeleteParams struct {
	// in: path
	Namespace string
	// in: path
	App string
	// in: path
	Configuration string
}

swagger:parameters ConfigurationBindingDelete

type ConfigurationCreateParam added in v0.6.0 

type ConfigurationCreateParam struct {
	// in: path
	Namespace string
	// in: body
	Configuration models.ConfigurationCreateRequest
}

swagger:parameters ConfigurationCreate

type ConfigurationCreateResponse added in v0.6.0 

type ConfigurationCreateResponse struct {
	// in: body
	Body models.Response
}

swagger:response ConfigurationCreateResponse

type ConfigurationDeleteParam added in v0.6.0 

type ConfigurationDeleteParam struct {
	// in: path
	Namespace string
	// in: path
	Configuration string
	// in: body
	Body models.ConfigurationDeleteRequest
}

swagger:parameters ConfigurationDelete

type ConfigurationDeleteResponse added in v0.6.0 

type ConfigurationDeleteResponse struct {
	// in: body
	Body models.ConfigurationDeleteResponse
}

swagger:response ConfigurationDeleteResponse

type ConfigurationMatchParam added in v0.9.0 

type ConfigurationMatchParam struct {
	// in: path
	Namespace string
	// in: path
	Pattern string
}

swagger:parameters ConfigurationMatch

type ConfigurationMatchResponse added in v0.9.0 

type ConfigurationMatchResponse struct {
	// in: body
	Body models.ConfigurationMatchResponse
}

swagger:response ConfigurationMatchResponse

type ConfigurationReplaceParam added in v0.6.0 

type ConfigurationReplaceParam struct {
	// in: path
	Namespace string
	// in: path
	Configuration string
	// in: body
	Body models.ConfigurationReplaceRequest
}

swagger:parameters ConfigurationReplace

type ConfigurationReplaceResponse added in v0.6.0 

type ConfigurationReplaceResponse struct {
	// in: body
	Body models.Response
}

swagger:response ConfigurationReplaceResponse

type ConfigurationShowParam added in v0.6.0 

type ConfigurationShowParam struct {
	// in: path
	Namespace string
	// in: path
	Configuration string
}

swagger:parameters ConfigurationShow

type ConfigurationShowResponse added in v0.6.0 

type ConfigurationShowResponse struct {
	// in: body
	Body models.ConfigurationResponse
}

swagger:response ConfigurationShowResponse

type ConfigurationUnbindReponse added in v0.6.0 

type ConfigurationUnbindReponse struct {
	// in:body
	Body models.Response
}

swagger:response ConfigurationUnbindReponse

type ConfigurationUpdateParam added in v0.6.0 

type ConfigurationUpdateParam struct {
	// in: path
	Namespace string
	// in: path
	Configuration string
	// in: body
	Body models.ConfigurationUpdateRequest
}

swagger:parameters ConfigurationUpdate

type ConfigurationUpdateResponse added in v0.6.0 

type ConfigurationUpdateResponse struct {
	// in: body
	Body models.Response
}

swagger:response ConfigurationUpdateResponse

type ConfigurationsParam added in v0.6.0 

type ConfigurationsParam struct {
	// in: path
	Namespace string
}

swagger:parameters Configurations

type ConfigurationsResponse added in v0.6.0 

type ConfigurationsResponse struct {
	// in: body
	Body models.ConfigurationResponseList
}

swagger:response ConfigurationsResponse

type EnvListParams 

type EnvListParams struct {
	// in: path
	Namespace string
	// in: path
	App string
}

swagger:parameters EnvList

type EnvListResponse 

type EnvListResponse struct {
	// in: body
	Body models.EnvVariableMap
}

swagger:response EnvListResponse

type EnvMatch0Params 

type EnvMatch0Params struct {
	// in: path
	Namespace string
	// in: path
	App string
}

swagger:parameters EnvMatch0

type EnvMatchParams 

type EnvMatchParams struct {
	// in: path
	Namespace string
	// in: path
	App string
	// in: path
	Pattern string
}

swagger:parameters EnvMatch

type EnvMatchResponse 

type EnvMatchResponse struct {
	// in: body
	Body models.EnvMatchResponse
}

swagger:response EnvMatchResponse

type EnvSetParams 

type EnvSetParams struct {
	// in: path
	Namespace string
	// in: path
	App string
	// in: body
	Body models.EnvVariableMap
}

swagger:parameters EnvSet

type EnvSetResponse 

type EnvSetResponse struct {
	// in: body
	Body models.Response
}

swagger:response EnvSetResponse

type EnvShowParams 

type EnvShowParams struct {
	// in: path
	Namespace string
	// in: path
	App string
	// in: path
	Env string
}

swagger:parameters EnvShow

type EnvShowResponse 

type EnvShowResponse struct {
	// in: body
	Body models.EnvVariable
}

swagger:response EnvShowResponse

type EnvUnsetParams 

type EnvUnsetParams struct {
	// in: path
	Namespace string
	// in: path
	App string
	// in: path
	Env string
}

swagger:parameters EnvUnset

type EnvUnsetResponse 

type EnvUnsetResponse struct {
	// in: body
	Body models.Response
}

swagger:response EnvUnsetResponse

type InfoResponse 

type InfoResponse struct {
	// in: body
	Body models.InfoResponse
}

swagger:response InfoResponse

type NamespaceBatchDeleteParam added in v1.8.0 

type NamespaceBatchDeleteParam struct {
	// in: url
	Namespaces []string
}

swagger:parameters NamespaceBatchDelete

type NamespaceCreateParam 

type NamespaceCreateParam struct {
	// in: body
	Body models.NamespaceCreateRequest
}

swagger:parameters NamespaceCreate

type NamespaceCreateResponse 

type NamespaceCreateResponse struct {
	// in: body
	Body models.Response
}

swagger:response NamespaceCreateResponse

type NamespaceDeleteParam 

type NamespaceDeleteParam struct {
	// in: path
	Namespace string
}

swagger:parameters NamespaceDelete

type NamespaceDeleteResponse 

type NamespaceDeleteResponse struct {
	// in: body
	Body models.Response
}

swagger:response NamespaceDeleteResponse

type NamespaceMatch0Param 

type NamespaceMatch0Param struct{}

swagger:parameters NamespaceMatch0

type NamespaceMatchParam 

type NamespaceMatchParam struct {
	// in: path
	Pattern string
}

swagger:parameters NamespaceMatch

type NamespaceMatchResponse 

type NamespaceMatchResponse struct {
	// in: body
	Body models.NamespacesMatchResponse
}

swagger:response NamespaceMatchResponse

type NamespaceShowParam 

type NamespaceShowParam struct {
	// in: path
	Namespace string
}

swagger:parameters NamespaceShow

type NamespaceShowResponse 

type NamespaceShowResponse struct {
	// in: body
	Body models.Namespace
}

swagger:response NamespaceShowResponse

type NamespacesResponse 

type NamespacesResponse struct {
	// in: body
	Body models.NamespaceList
}

swagger:response NamespacesResponse

type ServiceAppsParam 

type ServiceAppsParam struct {
	// in: path
	Namespace string
}

swagger:parameters ServiceApps

type ServiceAppsResponse 

type ServiceAppsResponse struct {
	// in: body
	Body map[string]models.AppList
}

swagger:response ServiceAppsResponse

type ServiceBatchDeleteParam added in v1.4.0 

type ServiceBatchDeleteParam struct {
	// in: path
	Namespace string
	// in: url
	Services []string
	// in: body
	Body models.ServiceDeleteRequest
}

swagger:parameters ServiceBatchDelete

type ServiceBindParam added in v0.8.0 

type ServiceBindParam struct {
	// in: path
	Namespace string
	// in: path
	Service string
	// in: body
	Configuration models.ServiceBindRequest
}

swagger:parameters ServiceBind

type ServiceBindResponse 

type ServiceBindResponse struct {
	// in: body
	Body models.Response
}

swagger:response ServiceBindResponse

type ServiceCatalogParam added in v0.8.0 

type ServiceCatalogParam struct{}

swagger:parameters ServiceCatalog

type ServiceCatalogResponse added in v0.8.0 

type ServiceCatalogResponse struct {
	// in: body
	Body models.CatalogServices
}

swagger:response ServiceCatalogResponse

type ServiceCatalogShowParam added in v0.8.0 

type ServiceCatalogShowParam struct {
	// in: path
	CatalogService string
}

swagger:parameters ServiceCatalogShow

type ServiceCatalogShowResponse added in v0.8.0 

type ServiceCatalogShowResponse struct {
	// in: body
	Body models.CatalogService
}

swagger:response ServiceCatalogShowResponse

type ServiceCreateParam 

type ServiceCreateParam struct {
	// in: path
	Namespace string
	// in: body
	Configuration models.ServiceCreateRequest
}

swagger:parameters ServiceCreate

type ServiceCreateResponse 

type ServiceCreateResponse struct {
	// in: body
	Body models.Response
}

swagger:response ServiceCreateResponse

type ServiceDeleteParam 

type ServiceDeleteParam struct {
	// in: path
	Namespace string
	// in: path
	Service string
	// in: body
	Body models.ServiceDeleteRequest
}

swagger:parameters ServiceDelete

type ServiceDeleteResponse 

type ServiceDeleteResponse struct {
	// in: body
	Body models.ServiceDeleteResponse
}

swagger:response ServiceDeleteResponse

type ServiceListParam added in v0.8.0 

type ServiceListParam struct {
	// in: path
	Namespace string
}

swagger:parameters ServiceList

type ServiceListResponse added in v0.8.0 

type ServiceListResponse struct {
	// in: body
	Body models.ServiceList
}

swagger:response ServiceListResponse

type ServiceMatchParam added in v0.9.0 

type ServiceMatchParam struct {
	// in: path
	Namespace string
	// in: path
	Pattern string
}

swagger:parameters ServiceMatch

type ServiceMatchResponse added in v0.9.0 

type ServiceMatchResponse struct {
	// in: body
	Body models.ServiceMatchResponse
}

swagger:response ServiceMatchResponse

type ServicePortForwardParam added in v1.9.0 

type ServicePortForwardParam struct {
	// in: path
	Namespace string
	// in: path
	Service string
}

swagger:parameters ServicePortForward

type ServicePortForwardResponse added in v1.9.0 

type ServicePortForwardResponse struct{}

swagger:response ServicePortForwardResponse

type ServiceShowParam 

type ServiceShowParam struct {
	// in: path
	Namespace string
	// in: path
	Service string
}

swagger:parameters ServiceShow

type ServiceShowResponse 

type ServiceShowResponse struct {
	// in: body
	Body models.Service
}

swagger:response ServiceShowResponse

type ServiceUnbindParam added in v0.8.0 

type ServiceUnbindParam struct {
	// in: path
	Namespace string
	// in: path
	Service string
	// in: body
	Configuration models.ServiceUnbindRequest
}

swagger:parameters ServiceUnbind

type ServiceUnbindResponse added in v0.8.0 

type ServiceUnbindResponse struct {
	// in: body
	Body models.Response
}

swagger:response ServiceUnbindResponse

type StagingCompleteParam 

type StagingCompleteParam struct {
	// in: path
	Namespace string
	// in: path
	StageID string
}

swagger:parameters StagingComplete

type StagingCompleteResponse 

type StagingCompleteResponse struct {
	// in: body
	Body models.Response
}

swagger:response StagingCompleteResponse

type StagingLogsParam 

type StagingLogsParam struct {
	// in: path
	Namespace string
	// in: path
	StageID string
}

swagger:parameters StagingLogs

type StagingLogsResponse 

type StagingLogsResponse struct{}

swagger:response StagingLogsResponse

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.