constants

Documentation

Index

• Constants

Constants

const (
	// RelationParent is the relation name for the parent of an object.
	RelationParent = "parent"
	// RelationProject is the relation name for the project of an object.
	RelationProject = "project"
	// RelationWriter is the relation name for the writer of an object.
	RelationWriter = "writer"
	// RelationAuditor is the relation name for the auditor of an object.
	RelationAuditor = "auditor"
	// RelationMember is the relation name for a member of an object.
	RelationMember = "member"
)

const (
	// PrincipalContextID is the context ID for the principal (username/Auth0 sub) from JWT claims
	PrincipalContextID contextID = iota
	// EmailContextID is the context ID for the email from JWT claims
	EmailContextID contextID = iota
)

const (
	// KVBucketNameCommittees is the name of the KV bucket for committees.
	KVBucketNameCommittees = "committees"

	// KVBucketNameCommitteeSettings is the name of the KV bucket for committee settings.
	KVBucketNameCommitteeSettings = "committee-settings"

	// KVBucketNameCommitteeMembers is the name of the KV bucket for committee members.
	KVBucketNameCommitteeMembers = "committee-members"

	// KVBucketNameCommitteeInvites is the name of the KV bucket for committee invites.
	KVBucketNameCommitteeInvites = "committee-invites"

	// KVBucketNameCommitteeApplications is the name of the KV bucket for committee applications.
	KVBucketNameCommitteeApplications = "committee-applications"

	// KVLookupPrefix is the prefix for lookup keys in the KV store.
	KVLookupPrefix = "lookup/committees/%s"

	// KVLookupMemberPrefix is the prefix for member lookup keys in the KV store.
	KVLookupMemberPrefix = "lookup/committee-members/%s"

	// KVLookupInvitePrefix is the prefix for invite lookup keys in the KV store.
	KVLookupInvitePrefix = "lookup/committee-invites/%s"

	// KVLookupApplicationPrefix is the prefix for application lookup keys in the KV store.
	KVLookupApplicationPrefix = "lookup/committee-applications/%s"

	// KVLookupSSOGroupNamePrefix is the prefix for SSO group name lookup keys in the KV store.
	KVLookupSSOGroupNamePrefix = "lookup/committee-sso-groups/%s"

	KVSlugPrefix = "slug/"

	// KVBucketNameCommitteeLinks is the name of the KV bucket for committee links.
	KVBucketNameCommitteeLinks = "committee-links"

	// KVBucketNameCommitteeFolders is the name of the KV bucket for committee folders.
	KVBucketNameCommitteeFolders = "committee-folders"

	// KVLookupFolderPrefix is the prefix for folder lookup keys in the KV store.
	KVLookupFolderPrefix = "lookup/committee-folders/%s"

	// KVBucketNameCommitteeDocuments is the name of the KV bucket for committee document metadata.
	KVBucketNameCommitteeDocuments = "committee-documents-metadata"

	// KVLookupDocumentPrefix is the prefix for document name lookup keys in the KV store.
	KVLookupDocumentPrefix = "lookup/committee-documents/%s"

	// ObjectStoreNameCommitteeDocuments is the name of the Object Store for committee document files.
	ObjectStoreNameCommitteeDocuments = "committee-documents"
)

NATS Key-Value store bucket names.

const (
	// CommitteeAPIQueue is the queue for the committee API.
	// The queue is of the form: lfx.committee-api.queue
	CommitteeAPIQueue = "lfx.committee-api.queue"

	// CommitteeGetNameSubject is the subject for the committee get name.
	// The subject is of the form: lfx.committee-api.get_name
	CommitteeGetNameSubject = "lfx.committee-api.get_name"

	// CommitteeListMembersSubject is the subject for listing committee members.
	// The subject is of the form: lfx.committee-api.list_members
	CommitteeListMembersSubject = "lfx.committee-api.list_members"

	// 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"

	// AuthEmailToSubLookupSubject is the subject for the email to sub lookup.
	// The subject is of the form: lfx.auth-service.email_to_sub
	AuthEmailToSubLookupSubject = "lfx.auth-service.email_to_sub"

	// AuthUserEmailsReadSubject is the subject for looking up a user's email addresses by principal.
	// The subject is of the form: lfx.auth-service.user_emails.read
	AuthUserEmailsReadSubject = "lfx.auth-service.user_emails.read"

	// IndexCommitteeSubject is the subject for the committee index.
	// The subject is of the form: lfx.index.committee
	IndexCommitteeSubject = "lfx.index.committee"

	// IndexCommitteeSettingsSubject is the subject for the committee settings index.
	// The subject is of the form: lfx.index.committee.committee_settings
	IndexCommitteeSettingsSubject = "lfx.index.committee_settings"

	// IndexCommitteeMemberSubject is the subject for the committee member index.
	// The subject is of the form: lfx.index.committee_member
	IndexCommitteeMemberSubject = "lfx.index.committee_member"

	// FGASyncUpdateAccessSubject is the subject for generic FGA sync update_access operations.
	FGASyncUpdateAccessSubject = "lfx.fga-sync.update_access"

	// FGASyncDeleteAccessSubject is the subject for generic FGA sync delete_access operations.
	FGASyncDeleteAccessSubject = "lfx.fga-sync.delete_access"

	// FGASyncMemberPutSubject is the subject for generic FGA sync member_put operations.
	FGASyncMemberPutSubject = "lfx.fga-sync.member_put"

	// FGASyncMemberRemoveSubject is the subject for generic FGA sync member_remove operations.
	FGASyncMemberRemoveSubject = "lfx.fga-sync.member_remove"

	// IndexCommitteeInviteSubject is the subject for the committee invite index.
	// The subject is of the form: lfx.index.committee_invite
	IndexCommitteeInviteSubject = "lfx.index.committee_invite"

	// IndexCommitteeApplicationSubject is the subject for the committee application index.
	// The subject is of the form: lfx.index.committee_application
	IndexCommitteeApplicationSubject = "lfx.index.committee_application"

	// IndexCommitteeLinkSubject is the subject for the committee link index.
	// The subject is of the form: lfx.index.committee_link
	IndexCommitteeLinkSubject = "lfx.index.committee_link"

	// IndexCommitteeLinkFolderSubject is the subject for the committee link folder index.
	// The subject is of the form: lfx.index.committee_link_folder
	IndexCommitteeLinkFolderSubject = "lfx.index.committee_link_folder"

	// IndexCommitteeDocumentSubject is the subject for the committee document index.
	// The subject is of the form: lfx.index.committee_document
	IndexCommitteeDocumentSubject = "lfx.index.committee_document"
)

const (
	// CommitteeMemberCreatedSubject is the subject for committee member creation events.
	// The subject is of the form: lfx.committee-api.member_created
	CommitteeMemberCreatedSubject = "lfx.committee-api.committee_member.created"

	// CommitteeMemberDeletedSubject is the subject for committee member deletion events.
	// The subject is of the form: lfx.committee-api.committee_member.deleted
	CommitteeMemberDeletedSubject = "lfx.committee-api.committee_member.deleted"

	// CommitteeMemberUpdatedSubject is the subject for committee member update events.
	// The subject is of the form: lfx.committee-api.committee_member.updated
	CommitteeMemberUpdatedSubject = "lfx.committee-api.committee_member.updated"
)

Event subjects emitted by the committee service for general consumption by any service

const AuthorizationContextID contextAuthorization = "authorization"

AuthorizationContextID is the context ID for the authorization

const AuthorizationHeader string = "authorization"

AuthorizationHeader is the header name for the authorization

const (
	// MailingListCommitteeChangedSubject is consumed from mailing-list-api when
	// committee-related mailing list state changes (e.g. has_mailing_list flag).
	MailingListCommitteeChangedSubject = "lfx.mailing-list-api.committee_mailing_list.changed"
)

Subjects consumed by the committee service from other services

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

OnBehalfContextID is the context ID for the principal

const RequestIDHeader requestIDHeaderType = "X-REQUEST-ID"

RequestIDHeader is the header name for the request ID

const (

	// ServiceName is the name of the committee service
	ServiceName = "lfx-v2-committee-service"
)

const XOnBehalfOfHeader string = "x-on-behalf-of"

XOnBehalfOfHeader is the header name for the on behalf of principal