constants

Documentation

Overview

Package constants contains the constants for the project service.

Index

• Constants

Constants

const (
	// AccessCheckSubject is the subject used for access control checks
	// The subject is of the form: lfx.access_check.request
	AccessCheckSubject = "lfx.access_check.request"
	// AnonymousPrincipal is the identifier for anonymous users
	AnonymousPrincipal = `_anonymous`
)

const (
	// AuthorizationHeader is the header name for the authorization
	AuthorizationHeader string = "authorization"

	// RequestIDHeader is the header name for the request ID
	RequestIDHeader string = "X-REQUEST-ID"

	// EtagHeader is the header name for the ETag
	EtagHeader string = "ETag"

	// XOnBehalfOfHeader is the header name for the on behalf of principal
	XOnBehalfOfHeader string = "x-on-behalf-of"
)

Constants for the HTTP request headers

const (
	// KVStoreNameProjects is the name of the KV store for projects.
	KVStoreNameProjects = "projects"

	// KVStoreNameProjectSettings is the name of the KV store for project settings.
	KVStoreNameProjectSettings = "project-settings"

	// KVStoreNameProjectLinks is the name of the KV store for project links.
	KVStoreNameProjectLinks = "project-links"

	// KVStoreNameProjectFolders is the name of the KV store for project folders.
	KVStoreNameProjectFolders = "project-folders"

	// KVStoreNameProjectDocuments is the name of the KV store for project document metadata.
	KVStoreNameProjectDocuments = "project-documents-metadata"

	// ObjectStoreNameProjectDocuments is the name of the object store for project document files.
	ObjectStoreNameProjectDocuments = "project-documents"

	// KVLookupFolderPrefix is the lookup key prefix for project folder name uniqueness.
	KVLookupFolderPrefix = "lookup/project-folders/%s"

	// KVLookupDocumentPrefix is the lookup key prefix for project document name uniqueness.
	KVLookupDocumentPrefix = "lookup/project-documents/%s"

	// KVLookupLinkKey is the per-project link index key.
	// Format: lookup/project-links/<projectUID>/<linkUID>
	KVLookupLinkKey = "lookup/project-links/%s/%s"
)

NATS Key-Value store bucket names.

const (
	// IndexProjectSubject is the subject for the project indexing.
	// The subject is of the form: lfx.index.project
	IndexProjectSubject = "lfx.index.project"

	// IndexProjectSettingsSubject is the subject for the project settings indexing.
	// The subject is of the form: lfx.index.project_settings
	IndexProjectSettingsSubject = "lfx.index.project_settings"

	// ProjectSettingsUpdatedSubject is the subject for project settings change events.
	// This event is published when project settings are updated, containing both before and after states.
	// The subject is of the form: lfx.projects-api.project_settings.updated
	ProjectSettingsUpdatedSubject = "lfx.projects-api.project_settings.updated"

	// IndexProjectLinkSubject is the subject for project link indexing.
	IndexProjectLinkSubject = "lfx.index.project_link"

	// IndexProjectFolderSubject is the subject for project folder indexing.
	IndexProjectFolderSubject = "lfx.index.project_folder"

	// IndexProjectDocumentSubject is the subject for project document indexing.
	IndexProjectDocumentSubject = "lfx.index.project_document"

	// ProjectDocumentCreatedSubject is emitted after a file document is successfully uploaded to a project.
	// The payload is the marshalled events.ProjectDocumentCreatedMessage.
	// The subject is of the form: lfx.projects-api.project_document.created
	ProjectDocumentCreatedSubject = "lfx.projects-api.project_document.created"

	// ProjectLinkCreatedSubject is emitted after a link is successfully added to a project.
	// The payload is the marshalled events.ProjectLinkCreatedMessage.
	// The subject is of the form: lfx.projects-api.project_link.created
	ProjectLinkCreatedSubject = "lfx.projects-api.project_link.created"
)

NATS subjects that the project service sends messages about.

const (
	// ProjectGetNameSubject is the subject for the project get name.
	// The subject is of the form: lfx.projects-api.get_name
	ProjectGetNameSubject = "lfx.projects-api.get_name"
	// ProjectGetSlugSubject is the subject for the project get slug.
	// The subject is of the form: lfx.projects-api.get_slug
	ProjectGetSlugSubject = "lfx.projects-api.get_slug"
	// ProjectGetLogoSubject is the subject for the project get logo.
	// The subject is of the form: lfx.projects-api.get_logo
	ProjectGetLogoSubject = "lfx.projects-api.get_logo"
	// ProjectSlugToUIDSubject is the subject for the project slug to UID.
	// The subject is of the form: lfx.projects-api.slug_to_uid
	ProjectSlugToUIDSubject = "lfx.projects-api.slug_to_uid"
	// ProjectGetParentUIDSubject is the subject for getting the parent project UID.
	// The subject is of the form: lfx.projects-api.get_parent_uid
	ProjectGetParentUIDSubject = "lfx.projects-api.get_parent_uid"
)

NATS specific subjects that the project service handles messages about.

const (
	// AuthUserMetadataReadSubject is the subject for looking up a user's profile metadata by principal.
	// The subject is of the form: lfx.auth-service.user_metadata.read
	AuthUserMetadataReadSubject = "lfx.auth-service.user_metadata.read"

	// AuthEmailToUsernameSubject resolves a registered LFID username by primary email.
	// Request: plain-text email. Reply: plain-text username on success, JSON error envelope on miss.
	AuthEmailToUsernameSubject = "lfx.auth-service.email_to_username"
)

NATS subjects for external service lookups.

const AuthorizationContextID contextAuthorization = "authorization"

AuthorizationContextID is the context ID for the authorization

const ETagContextID contextEtag = "etag"

ETagContextID is the context ID for the ETag

const (
	// ErrKey is the key for the error in the context.
	ErrKey = "error"
)

Constants for the application.

const PrincipalContextID contextPrincipal = "x-on-behalf-of"

PrincipalContextID is the context ID for the principal

const (
	// ProjectsAPIQueue is the subject name for the projects API.
	// The subject is of the form: lfx.projects-api.queue
	ProjectsAPIQueue = "lfx.projects-api.queue"
)

NATS wildcard subjects that the project service handles messages about.

const RequestIDContextID contextRequestID = "X-REQUEST-ID"

RequestIDContextID is the context ID for the request ID