openapi

Documentation

Index

• type AsyncOperation
• type Catalog
• type DashboardClient
• type Error
• type LastOperationResource
• type MaintenanceInfo
• type Plan
• type SchemaParameters
• type SchemasObject
• type Service
• type ServiceBindingRequest
• type ServiceBindingResource
• type ServiceBindingResourceObject
• type ServiceBindingResponse
• type ServiceBindingSchemaObject
• type ServiceBindingVolumeMount
• type ServiceBindingVolumeMountDevice
• type ServiceInstanceAsyncOperation
• type ServiceInstancePreviousValues
• type ServiceInstanceProvisionRequest
• type ServiceInstanceProvisionResponse
• type ServiceInstanceResource
• type ServiceInstanceSchemaObject
• type ServiceInstanceUpdateRequest

Types

type AsyncOperation

type AsyncOperation struct {
	Operation string `json:"operation,omitempty"`
}

type Catalog

type Catalog struct {
	Services []Service `json:"services,omitempty"`
}

type DashboardClient

type DashboardClient struct {
	Id string `json:"id"`

	Secret string `json:"secret"`

	RedirectUri string `json:"redirect_uri,omitempty"`
}

type Error

type Error struct {
	Error string `json:"error,omitempty"`

	Description string `json:"description,omitempty"`

	InstanceUsable bool `json:"instance_usable,omitempty"`

	UpdateRepeatable bool `json:"update_repeatable,omitempty"`
}

type LastOperationResource

type LastOperationResource struct {
	State string `json:"state"`

	Description string `json:"description,omitempty"`

	InstanceUsable bool `json:"instance_usable,omitempty"`

	UpdateRepeatable bool `json:"update_repeatable,omitempty"`
}

type MaintenanceInfo

type MaintenanceInfo struct {
	Version string `json:"version,omitempty"`

	Description string `json:"description,omitempty"`
}

type Plan

type Plan struct {
	Id string `json:"id"`

	Name string `json:"name"`

	Description string `json:"description"`

	// See [Service Metadata Conventions](https://github.com/openservicebrokerapi/servicebroker/blob/master/profile.md#service-metadata) for more details.
	Metadata map[string]interface{} `json:"metadata,omitempty"`

	Free bool `json:"free,omitempty"`

	Bindable bool `json:"bindable,omitempty"`

	PlanUpdateable bool `json:"plan_updateable,omitempty"`

	Schemas SchemasObject `json:"schemas,omitempty"`

	MaximumPollingDuration int32 `json:"maximum_polling_duration,omitempty"`

	MaintenanceInfo MaintenanceInfo `json:"maintenance_info,omitempty"`
}

type SchemaParameters

type SchemaParameters struct {
	Parameters map[string]interface{} `json:"parameters,omitempty"`
}

type SchemasObject

type SchemasObject struct {
	ServiceInstance ServiceInstanceSchemaObject `json:"service_instance,omitempty"`

	ServiceBinding ServiceBindingSchemaObject `json:"service_binding,omitempty"`
}

type Service

type Service struct {
	Name string `json:"name"`

	Id string `json:"id"`

	Description string `json:"description"`

	Tags []string `json:"tags,omitempty"`

	Requires []string `json:"requires,omitempty"`

	Bindable bool `json:"bindable"`

	InstancesRetrievable bool `json:"instances_retrievable,omitempty"`

	BindingsRetrievable bool `json:"bindings_retrievable,omitempty"`

	AllowContextUpdates bool `json:"allow_context_updates,omitempty"`

	// See [Service Metadata Conventions](https://github.com/openservicebrokerapi/servicebroker/blob/master/profile.md#service-metadata) for more details.
	Metadata map[string]interface{} `json:"metadata,omitempty"`

	DashboardClient DashboardClient `json:"dashboard_client,omitempty"`

	PlanUpdateable bool `json:"plan_updateable,omitempty"`

	Plans []Plan `json:"plans"`
}

type ServiceBindingRequest

type ServiceBindingRequest struct {

	// See [Context Conventions](https://github.com/openservicebrokerapi/servicebroker/blob/master/profile.md#context-object) for more details.
	Context map[string]interface{} `json:"context,omitempty"`

	ServiceId string `json:"service_id"`

	PlanId string `json:"plan_id"`

	AppGuid string `json:"app_guid,omitempty"`

	BindResource ServiceBindingResourceObject `json:"bind_resource,omitempty"`

	Parameters map[string]interface{} `json:"parameters,omitempty"`
}

type ServiceBindingResource

type ServiceBindingResource struct {
	Credentials map[string]interface{} `json:"credentials,omitempty"`

	SyslogDrainUrl string `json:"syslog_drain_url,omitempty"`

	RouteServiceUrl string `json:"route_service_url,omitempty"`

	VolumeMounts []ServiceBindingVolumeMount `json:"volume_mounts,omitempty"`

	Parameters map[string]interface{} `json:"parameters,omitempty"`
}

type ServiceBindingResourceObject

type ServiceBindingResourceObject struct {
	AppGuid string `json:"app_guid,omitempty"`

	Route string `json:"route,omitempty"`
}

type ServiceBindingResponse

type ServiceBindingResponse struct {
	Credentials map[string]interface{} `json:"credentials,omitempty"`

	SyslogDrainUrl string `json:"syslog_drain_url,omitempty"`

	RouteServiceUrl string `json:"route_service_url,omitempty"`

	VolumeMounts []ServiceBindingVolumeMount `json:"volume_mounts,omitempty"`
}

type ServiceBindingSchemaObject

type ServiceBindingSchemaObject struct {
	Create SchemaParameters `json:"create,omitempty"`
}

type ServiceBindingVolumeMount

type ServiceBindingVolumeMount struct {
	Driver string `json:"driver"`

	ContainerDir string `json:"container_dir"`

	Mode string `json:"mode"`

	DeviceType string `json:"device_type"`

	Device ServiceBindingVolumeMountDevice `json:"device"`
}

type ServiceBindingVolumeMountDevice

type ServiceBindingVolumeMountDevice struct {
	VolumeId string `json:"volume_id"`

	MountConfig map[string]interface{} `json:"mount_config,omitempty"`
}

type ServiceInstanceAsyncOperation

type ServiceInstanceAsyncOperation struct {
	DashboardUrl string `json:"dashboard_url,omitempty"`

	Operation string `json:"operation,omitempty"`
}

type ServiceInstancePreviousValues

type ServiceInstancePreviousValues struct {
	ServiceId string `json:"service_id,omitempty"`

	PlanId string `json:"plan_id,omitempty"`

	OrganizationId string `json:"organization_id,omitempty"`

	SpaceId string `json:"space_id,omitempty"`

	MaintenanceInfo MaintenanceInfo `json:"maintenance_info,omitempty"`
}

type ServiceInstanceProvisionRequest

type ServiceInstanceProvisionRequest struct {
	ServiceId string `json:"service_id"`

	PlanId string `json:"plan_id"`

	// See [Context Conventions](https://github.com/openservicebrokerapi/servicebroker/blob/master/profile.md#context-object) for more details.
	Context map[string]interface{} `json:"context,omitempty"`

	OrganizationGuid string `json:"organization_guid"`

	SpaceGuid string `json:"space_guid"`

	Parameters map[string]interface{} `json:"parameters,omitempty"`

	MaintenanceInfo MaintenanceInfo `json:"maintenance_info,omitempty"`
}

type ServiceInstanceProvisionResponse

type ServiceInstanceProvisionResponse struct {
	DashboardUrl string `json:"dashboard_url,omitempty"`
}

type ServiceInstanceResource

type ServiceInstanceResource struct {
	ServiceId string `json:"service_id,omitempty"`

	PlanId string `json:"plan_id,omitempty"`

	DashboardUrl string `json:"dashboard_url,omitempty"`

	Parameters map[string]interface{} `json:"parameters,omitempty"`
}

type ServiceInstanceSchemaObject

type ServiceInstanceSchemaObject struct {
	Create SchemaParameters `json:"create,omitempty"`

	Update SchemaParameters `json:"update,omitempty"`
}

type ServiceInstanceUpdateRequest

type ServiceInstanceUpdateRequest struct {

	// See [Context Conventions](https://github.com/openservicebrokerapi/servicebroker/blob/master/profile.md#context-object) for more details.
	Context map[string]interface{} `json:"context,omitempty"`

	ServiceId string `json:"service_id"`

	PlanId string `json:"plan_id,omitempty"`

	Parameters map[string]interface{} `json:"parameters,omitempty"`

	PreviousValues ServiceInstancePreviousValues `json:"previous_values,omitempty"`

	MaintenanceInfo MaintenanceInfo `json:"maintenance_info,omitempty"`
}