roleinfile

Documentation

Overview

Package roleinfile defines the implementation of the output adapter to read roles from YAML files.

Index

• type DefaultRoleStorageInFile
  • func ProvideDefaultRoleStorageInFile(options DefaultRoleStorageInFileOptions) (*DefaultRoleStorageInFile, error)
  • func (d DefaultRoleStorageInFile) ListRoles(_ context.Context, _ role.ListRolesInput) (*role.ListRolesOutput, error)
• type DefaultRoleStorageInFileOptions
• type Role
• type RolesInfo

Types

type DefaultRoleStorageInFile

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

DefaultRoleStorageInFile is a port to adapt requests related to the Roles

func ProvideDefaultRoleStorageInFile

func ProvideDefaultRoleStorageInFile(options DefaultRoleStorageInFileOptions) (*DefaultRoleStorageInFile, error)

ProvideDefaultRoleStorageInFile provides an instance of an DefaultRoleStorageInFile

func (DefaultRoleStorageInFile) ListRoles

func (d DefaultRoleStorageInFile) ListRoles(_ context.Context, _ role.ListRolesInput) (*role.ListRolesOutput, error)

ListRoles fetches a collection of Role based on the ListRolesInput

type DefaultRoleStorageInFileOptions

type DefaultRoleStorageInFileOptions struct {
	FileSystem fs.FS
	BasePath   string
}

DefaultRoleStorageInFileOptions are the set of fields to create an DefaultRoleStorageInFile

type Role

type Role struct {
	// ID is the name of the Role
	ID string `yaml:"id"`
	// Description describes the role with a phrase
	Description string `yaml:"description"`
	// Permissions are the array of permissions associated to the Role
	Permissions []string `yaml:"permissions"`
}

Role is the name of the definition of the collection of permissions

type RolesInfo

type RolesInfo struct {
	// Default the default Role
	Default string `yaml:"default"`
	// Roles is the array of roles desribed in the file
	Roles []Role `yaml:"roles"`
}

RolesInfo is the data type that defines the roles in the file