plateaucms

Documentation

Index

• Constants
• Variables
• func GetCMSFromContext(ctx context.Context) cms.Interface
• type AuthMiddlewareConfig
• type CMS
  • func New(c Config) (*CMS, error)
  • func (h *CMS) AllMetadata(ctx context.Context, findDataCatalog bool) (MetadataList, error)
  • func (h *CMS) AuthMiddleware(conf AuthMiddlewareConfig) echo.MiddlewareFunc
  • func (h *CMS) Clone() *CMS
  • func (h *CMS) LastModified(c echo.Context, prj string, models ...string) (bool, error)
  • func (h *CMS) Metadata(ctx context.Context, prj string, findDataCatalog, useDefault bool) (Metadata, MetadataList, error)
• type Config
• type Metadata
  • func GetCMSMetadataFromContext(ctx context.Context) Metadata
  • func (m Metadata) CMS() (*cms.CMS, error)
  • func (m Metadata) IsValidToken(token string) bool
  • func (m Metadata) PlateauYear() int
• type MetadataList
  • func GetAllCMSMetadataFromContext(ctx context.Context) MetadataList
  • func (metadata MetadataList) Default() *Metadata
  • func (metadata MetadataList) FindByYear(year int) *Metadata
  • func (l MetadataList) FindDataCatalog(project string) (Metadata, bool)
  • func (l MetadataList) FindDataCatalogAndSub(project string) (res MetadataList)
  • func (l MetadataList) FindMetadata(prj string, findDataCatalog, useDefault bool) (Metadata, bool)
  • func (l MetadataList) FindSys(project string) (Metadata, bool)
  • func (l MetadataList) PlateauProjects() MetadataList

Constants

const (
	ProjectNameParam = "pid"
)

Variables

var HTTPMethodsAll = []string{
	http.MethodGet,
	http.MethodPost,
	http.MethodPatch,
	http.MethodPut,
	http.MethodDelete,
}

var HTTPMethodsExceptGET = []string{
	http.MethodPost,
	http.MethodPatch,
	http.MethodPut,
	http.MethodDelete,
}

Functions

func GetCMSFromContext

func GetCMSFromContext(ctx context.Context) cms.Interface

Types

type AuthMiddlewareConfig

type AuthMiddlewareConfig struct {
	Key             string
	AuthMethods     []string
	FindDataCatalog bool
	DefaultProject  string
	UseDefault      bool
}

type CMS

type CMS struct {
	// contains filtered or unexported fields
}

func New

func New(c Config) (*CMS, error)

func (*CMS) AllMetadata

func (h *CMS) AllMetadata(ctx context.Context, findDataCatalog bool) (MetadataList, error)

func (*CMS) AuthMiddleware

func (h *CMS) AuthMiddleware(conf AuthMiddlewareConfig) echo.MiddlewareFunc

func (*CMS) Clone

func (h *CMS) Clone() *CMS

func (*CMS) LastModified

func (h *CMS) LastModified(c echo.Context, prj string, models ...string) (bool, error)

func (*CMS) Metadata

func (h *CMS) Metadata(ctx context.Context, prj string, findDataCatalog, useDefault bool) (Metadata, MetadataList, error)

type Config

type Config struct {
	CMSBaseURL      string
	CMSMainToken    string
	CMSTokenProject string
	// compat
	CMSMainProject string
	AdminToken     string
}

type Metadata

type Metadata struct {
	Name                     string `json:"name" cms:"name,text"`
	ProjectAlias             string `json:"project_alias" cms:"project_alias,text"`
	DataCatalogProjectAlias  string `json:"datacatalog_project_alias" cms:"datacatalog_project_alias,text"`
	DataCatalogSchemaVersion string `json:"datacatalog_schema_version" cms:"datacatalog_schema_version,select"`
	CMSAPIKey                string `json:"cms_apikey" cms:"cms_apikey,text"`
	SidebarAccessToken       string `json:"sidebar_access_token" cms:"sidebar_access_token,text"`
	SubPorjectAlias          string `json:"subproject_alias" cms:"subproject_alias,text"`
	MergePlateau             bool   `json:"merge_plateau" cms:"merge_plateau,boolean"`
	// whether the request is authenticated with sidebar access token
	Auth       bool   `json:"-" cms:"-"`
	CMSBaseURL string `json:"-" cms:"-"`
}

func GetCMSMetadataFromContext

func GetCMSMetadataFromContext(ctx context.Context) Metadata

func (Metadata) CMS

func (m Metadata) CMS() (*cms.CMS, error)

func (Metadata) IsValidToken

func (m Metadata) IsValidToken(token string) bool

func (Metadata) PlateauYear

func (m Metadata) PlateauYear() int

type MetadataList

type MetadataList []Metadata

func GetAllCMSMetadataFromContext

func GetAllCMSMetadataFromContext(ctx context.Context) MetadataList

func (MetadataList) Default

func (metadata MetadataList) Default() *Metadata

func (MetadataList) FindByYear

func (metadata MetadataList) FindByYear(year int) *Metadata

func (MetadataList) FindDataCatalog

func (l MetadataList) FindDataCatalog(project string) (Metadata, bool)

func (MetadataList) FindDataCatalogAndSub

func (l MetadataList) FindDataCatalogAndSub(project string) (res MetadataList)

func (MetadataList) FindMetadata

func (l MetadataList) FindMetadata(prj string, findDataCatalog, useDefault bool) (Metadata, bool)

func (MetadataList) FindSys

func (l MetadataList) FindSys(project string) (Metadata, bool)

func (MetadataList) PlateauProjects

func (l MetadataList) PlateauProjects() MetadataList