Common Information changelog

Documented the isRestrictedForAIBot field on permissions.

• Permissions now expose isRestrictedForAIBot, which marks permissions removed from user permissions when authenticated with an AI bot token.

Updated tags create endpoint documentation to reflect permission-based access.

• Tag creation now requires the tags.create permission instead of being restricted to system users only.

Improved reliability and performance of the data export service.

• Export requests now tolerate individual failed or invalid image fetches without failing the whole export, and large image-heavy exports process more efficiently.

Localized TalkJS chat push fallback messages and aligned translation namespace.

• Chat push fallback text now resolves per recipient language with fallback order recipient -> app configured language -> English.
• Renamed chat translation namespace keys from talkjsPush to talkJsPush in source locales, runtime lookup, and Jest fixtures.

Clarified workflow create API docs by removing creator self-approval prohibition wording.

• Updated workflow create operation description to no longer state that content creators cannot approve or reject their own content.
• Kept existing documented permission, pending-status, and edit-access constraints for content actions.

Clarified learningProgress orgunits behavior for single and bulk exports, including optional fallback handling and invalid-input rejection.

• Documented that orgunits scoping applies to both single and bulk learningProgress exports.
• Clarified optional orgunits behavior, fallback behavior, and rejection of invalid orgunits input.

Documented learningProgress export bulk mode, orgunit scope, and trainingId/bulk exclusivity.

• Clarified learningProgress single mode requires trainingId and bulk mode uses bulk: true.
• Documented optional orgunits scope for bulk exports and moved-user overlap constraints with exporter zone of influence.

Removed users node query alias from docs and users find normalization flow.

• Removed node alias references from users API docs and shared Feathers nested-query examples.
• Removed users find query alias normalization helper now that frontend sends orgunits directly.

Removed users jobTittle query alias from API docs and kept regex filtering documented for position/lastName.

• Updated users service docs to remove jobTittle as a supported query parameter alias.
• Clarified regex filtering support is documented for lastName and position with optional $options.
• Updated shared Feathers nested query example to use position instead of jobTittle.

Clarified users query alias normalization and nested $and/$or filter support in API docs.

• Updated shared Feathers query docs to describe both $and and $or logical operators with nested groups.
• Clarified that users filter aliases jobTittle and node are normalized before filtering, including inside nested groups.

Clarified imported organization type edit/delete restrictions and privileged role bypass roles in orgtypes API docs.

• Documented imported organization type edit/delete restrictions in orgtypes operations.
• Documented privileged role exemptions that can bypass imported-type restrictions.

Clarified imported-entity edit/delete restrictions and privileged role exemptions in groups, orgattributecategories, and orgchart API docs.

• Documented edit/delete restrictions for imported entities in groups and orgattributecategories operations.
• Documented role exemptions for privileged users where imported-entity restrictions can be bypassed.
• Updated orgchart endpoint documentation to reflect imported-unit restriction behavior and allowed exceptions.

Added searchTerm query parameter to groups find operation for language-agnostic name search across all configured locales.

• The searchTerm parameter performs a case-insensitive search against all locale keys of the group name field, so groups with no English translation are still returned.

Updated contentpools API docs: introduced searchTerm for language-agnostic name search and added name.{lang}[$search] for locale-specific search.

• Added searchTerm query parameter that searches across all configured locale keys, fixing cases where pools with no English name could not be found.
• Added name.{lang}[$search] query parameter for language-specific search scoped to a single locale (e.g. name.en[$search]=News).
• searchTerm is preferred over name.{lang}[$search] for language-agnostic search.

Clarified workflow approval constraints for content and task-answer actions in API docs.

• Updated workflow create operation docs to state content approve/reject requires contents.approvereject permission.
• Documented that content creators cannot approve or reject their own content.
• Clarified action-specific constraints for pending-status checks and task-answer approval eligibility.
• Updated workflow request schema descriptions for action/ref/value fields to reflect content vs task-answer targeting.

Clarified learningProgress export docs for moved-user inclusion and empty-ZOI broad-match prevention.

• Documented moved-user inclusion in learningProgress export when trainingprogress orgunitsOfCreator overlaps exporter orgZoneOfInfluence and userActiveNotDeleted is true.
• Documented safeguard that skips moved-user lookup when exporter orgZoneOfInfluence is empty to prevent broad matching.

Documented selected-users assignment for tasktemplates and creator ZoI validation behavior.

• Added selectedUsers field to tasktemplates schema documentation.
• Clarified that when selectedUsers is provided, tasks are created only for those users.
• Documented create/patch validation behavior: all selected users must belong to creator ZoI or the request fails.

Changed learningProgress export to target a single training by required trainingId; active-only users, Roles column, and exact status labels added.

• learningProgress export now requires a trainingId field; pool-wide export mode is no longer supported.
• Eligible users are derived from the training document's own orgchartSelection, orgchartAttrSelection, and groups targeting, intersected with the request orgunits and the requesting user's zone of influence.
• Only active, non-deleted, firstLoginDone users are included in the export (ignoreActive flag removed).
• Added Roles column to the export output; roles are emitted as plain comma-separated strings.
• Status values are now exactly: Completed, In progress, Not started.
• Column order: Training ID, Training Name, Content Pool, User, Progress, Started Date, Completed, Completion Date, Groups, Roles, OrgLevel1..N.
• 400 error is returned when trainingId is missing, the training is not found, or the training does not belong to the supplied ref content pool.

Flattened orgchartAttrSelection docs to remove nested arrays and align targeting shapes across affected APIs.

• Aligned contents.orgchartSelection docs to the include/exclude object shape used by the service model.
• Updated orgchartAttrSelection schema docs for contents and flowtemplates to use flat include/exclude ObjectId arrays.
• Updated tasktemplates docs to describe orgchartAttrSelection as a flat ObjectId array.
• Updated reach request schema docs so orgchartAttrSelection include/exclude match flattened runtime input shape.
• Updated pages docs so orgchartAttrSelection include/exclude use flat ObjectId arrays after normalization during orgunit expansion.
• Updated folders docs so orgchartAttrSelection is documented as a flat ObjectId array matching the persisted model shape.

Updated themes Swagger docs to accept CloudFront background image URLs from FE and clarified frontend-config default behavior.

• Updated themes service description to document CloudFront URL-based background image payloads in themeData.backgroundImage.
• Removed storageId-focused wording for background images and clarified that FE provides the final URL.
• Updated themeData.backgroundImage schema to use uri format and describe FE fallback to frontendConfig.defaultThemeBackgroundImage.

Documented widget-scoped filtering inputs and query-operator support across contents, tasks, and widgets API docs.

• Added tasks query documentation for widgetId, including support for suffixed IDs like <widgetId>-sticky used for server-side widget-group filtering.
• Added widgets schema documentation for optional groups array used to derive backend content/task filtering and FE widget defaults.
• Updated contents service behavior to allow additional MongoDB query operators ($not and $all) in whitelisted filters.

Updated reports access documentation to remove reports.admin/reports.supervise references and clarify scoped reports permission behavior.

• Clarified users management-mode, create/patch, and delete access rules for users.manage permission scopes.
• Documented scoped reports permission behavior after removing reports.admin/reports.supervise access references, including usersForUsageReport special access constraints.

Added leaveConversation action to the chat service.

• New leaveConversation action allows a participant to leave a one-to-one TalkJS conversation.
• Action is only permitted on admin-less one-to-one conversations; group chats are rejected.

Documented externalNotificationContent usage and push text behavior across content-related API docs.

• Added externalNotificationContent to contentType enum documentation where supported by content services.
• Clarified that externalNotificationContent is intended for custom external push scenarios.
• Documented push text mapping for externalNotificationContent: title uses content creator full name and body uses content title.

Expanded aiassistant API docs for analytics category, subcategory, and unanswered query variants.

• Documented new find type values for analytics categories, subcategories, and unanswered topics.
• Added categoryId query parameter usage and clarified pagination parameter applicability across analytics variants.
• Extended OpenAPI response schema coverage for categories, subcategories, and unanswered analytics payloads.

Clarified imported-field restrictions and create defaults for groups, orgattributes, and orgattributecategories.

• Documented that the imported field defaults to false on create when omitted.
• Documented that imported can only be changed by keephubAdmin or the system user.
• Marked update behavior as internal-only where applicable.

Clarified users patch permissions and aligned users schema docs for loginMethod/imported fields.

• Updated users patch operation docs to state imported field access for keephubAdmin and system.
• Added users.imported schema property and aligned loginMethod access wording with current permissions.
• Removed readOnly from users.loginMethod and users.imported so privileged patch behavior matches the shared users schema.

Added top-level content hookurls for workflow approval/rejection callbacks and clarified webhook status derivation in contents and workflow API docs.

• Added top-level hookurls field to abstractContent schema (array of { url, active }) used for workflow content approval/rejection callbacks; payload sends _id, approvedBy, and createdBy.
• Updated form.hookurls description to clarify it is a dedicated form-model abstraction separate from top-level content hookurls.
• Updated contents find operation and webhookStatus query param description: top-level hookurls is now the primary source; form.hookurls serves as fallback for form content.
• Updated workflow create operation to document that approve/reject actions trigger active content hook URLs with IDs-only payload.

Added top-level content hookurls for workflow approval/rejection callbacks and clarified webhook status derivation in contents and workflow API docs.

• Added top-level hookurls field to abstractContent schema (array of { url, active }) used for workflow content approval/rejection callbacks; payload sends _id, approvedBy, and createdBy.
• Updated form.hookurls description to clarify it is a dedicated form-model abstraction separate from top-level content hookurls.
• Updated contents find operation and webhookStatus query param description: top-level hookurls is now the primary source; form.hookurls serves as fallback for form content.
• Updated workflow create operation to document that approve/reject actions trigger active content hook URLs with IDs-only payload.

Refreshed Keephub API docs layout and styling for improved navigation and changelog presentation.

• Updated the Redoc template, theme styling, and generated docs header and changelog presentation.

Updated audittrail Swagger docs to include roles in objectType enum filters.

• Added roles as an accepted objectType value in audittrail query documentation.

Refreshed Keephub API docs styling for smoother sidebar navigation, search, buttons, and response panels.

• Applied a visual polish pass across the sidebar, navigation, search, button treatments, and response panels.

Test changelog rendering locally

Initialized the API docs metadata source for last-updated timestamps and changelog tracking.

• Added the canonical docs metadata JSON source under documentation/.
• Defined the initial public changelog entry for the docs metadata workflow.