plan

Documentation

Overview

The plan package contains wireformat structs intended for the plan management API.

Index

• type AuthorizationRequest
  • func (s AuthorizationRequest) Validate() error
• type Plan

Types

type AuthorizationRequest

type AuthorizationRequest struct {
	EnvironmentUUID string `json:"env-uuid"` // TODO(cmars): rename to EnvUUID
	CharmURL        string `json:"charm-url"`
	ServiceName     string `json:"service-name"`
	PlanURL         string `json:"plan-url"`
}

AuthorizationRequest defines the struct used to request a plan authorization.

func (AuthorizationRequest) Validate

func (s AuthorizationRequest) Validate() error

Validate checks the AuthorizationRequest for errors.

type Plan

type Plan struct {
	URL        string `json:"url"`        // Name of the rating plan
	Definition string `json:"plan"`       // The rating plan
	CreatedOn  string `json:"created-on"` // When the plan was created - RFC3339 encoded timestamp
}

Plan structure is used as a wire format to store information on ISV-created rating plan and charm URLs for which the plan is valid (a subscription using this plan can be created).