Docs & rules

RedHatInsights/notifications-backendGitHub

This is a public, read-only report. Striff reads this repository's docs, turns each sentence that makes a claim about the code into a rule, and checks the rule against the code on the default branch. How this works

master5fe6929Last read Oct 3

Is this yours? Install to manage it

Once installed, Striff checks every pull request.

Rules summary
Documents
Rules
71
47
1
2
3
2
1
7
1
4
26
23
23
1
25 docs
RedHatInsights/notifications-backendOpen repository

RedHatInsights/notifications-backend — documented rules

71 of 71 rules, printed November 17, 2026.

The sentence in your docs
the SnakeCasePhysicalNamingStrategy in common translates to snake_case column names automatically.
SnakeCasePhysicalNamingStrategy is in common
Holds
Domain-specific page types (e.g., EndpointPage) extend Page<T>.
EndpointPage extends Page
Holds
MessageHandler -- Override handle(IncomingCloudEventMetadata<JsonObject>) to perform the external call. Return HandledMessageDetails (or HandledHttpMessageDetails for HTTP connectors). Mark as @ApplicationScoped.
MessageHandler is annotated with ApplicationScoped
Holds
EventConsumer reads from the ingress channel with @Incoming and @Blocking.
EventConsumer is annotated with Incoming, and EventConsumer is annotated with Blocking
HoldsPR #4157 · Oct 2
Connector configs extend the inheritance chain: ConnectorConfig -> HttpConnectorConfig -> specific connector config (e.g., EmailConnectorConfig).
2 rules from this sentence
HttpConnectorConfig extends ConnectorConfig
Holds
EmailConnectorConfig extends HttpConnectorConfig
Holds
For org-scoped toggles, build context via UnleashContextBuilder.buildUnleashContextWithOrgId(orgId).
UnleashContextBuilder has a buildUnleashContextWithOrgId method
Holds
Override additionalPrePersist() for entity-specific initialization (e.g., generating UUIDs in Endpoint).
Endpoint has an additionalPrePersist method
Holds
For large result sets, fetch IDs first, then load full entities by ID list (see EventRepository.getEvents two-query pattern).
EventRepository has getEvents
Holds
MessageConsumer reads from incomingmessages channel, filters by x-rh-notifications-connector header, and delegates to MessageHandler.handle().
MessageConsumer depends on MessageHandler
HoldsPR #4157 · Oct 2
RbacClientResponseFilter and LogLevelManager use java.util.logging.Logger because they interact with JUL-level APIs directly.
4 rules from this sentence
RbacClientResponseFilter imports java.util.logging.Logger
Holds
LogLevelManager imports java.util.logging.Logger
Holds
RbacClientResponseFilter uses java.util.logging.Logger
Holds
LogLevelManager uses java.util.logging.Logger
Holds
The LogLevelManager class in common-unleash handles this.
LogLevelManager is in common-unleash
HoldsPR #4157 · Oct 2
ValkeyHealthCheck is both @Readiness and @Liveness.
2 rules from this sentence
ValkeyHealthCheck is annotated with Readiness
Holds
ValkeyHealthCheck is annotated with Liveness
Holds
ExportEventListener imports io.smallrye.common.annotation.Blocking instead.
ExportEventListener imports io.smallrye.common.annotation.Blocking
HoldsPR #4157 · Oct 2
The RbacServiceToService interface has two implementations following the dual-client pattern: OIDC (RbacServiceToServiceOidc): annotated with @OidcClientFilter, config key rbac-s2s-oidc.
RbacServiceToServiceOidc is annotated with OidcClientFilter
HoldsPR #4157 · Oct 2
Both follow the same OIDC/PSK dual-client pattern: OIDC (SourcesOidcClient): config key sources-oidc, uses @OidcClientFilter.
SourcesOidcClient is annotated with OidcClientFilter
Holds
PSK (RbacServiceToServicePsk): uses AuthRequestFilter to inject x-rh-rbac-psk and x-rh-rbac-client-id headers, config key rbac-s2s.
RbacServiceToServicePsk depends on AuthRequestFilter
HoldsPR #4157 · Oct 2
OIDC (RbacWorkspacesOidcClient): config key rbac-authentication-oidc, uses @OidcClientFilter.
RbacWorkspacesOidcClient is annotated with OidcClientFilter
HoldsPR #4157 · Oct 2
Templates are registered in static Map<TemplateDefinition, String> fields inside mapping classes under com.redhat.cloud.notifications.qute.templates.mapping. Each mapping class corresponds to a product bundle: Mapping class Rhel, Bundle rhel
Rhel is in com.redhat.cloud.notifications.qute.templates.mapping
Holds
Mapping class OpenShift, Bundle openshift
OpenShift is in com.redhat.cloud.notifications.qute.templates.mapping
Holds
Mapping class Console, Bundle console
Console is in com.redhat.cloud.notifications.qute.templates.mapping
Holds
Mapping class SubscriptionServices, Bundle subscription-services
SubscriptionServices is in com.redhat.cloud.notifications.qute.templates.mapping
Holds
Extension class ActionExtension, Methods available in templates context.propertyName (dynamic property access on Context ), payload.propertyName (on Payload ), action.toPrettyJson()
2 rules from this sentence
ActionExtension is in com.redhat.cloud.notifications.qute.templates.extensions
Holds
ActionExtension has a toPrettyJson method
Holds
Extension class LocalDateTimeExtension, Methods available in templates date.toUtcFormat() , date.toStringFormat() , date.toTimeAgo() , string.toUtcFormat() , string.toStringFormat() , string.toTimeAgo()
4 rules from this sentence
LocalDateTimeExtension is in com.redhat.cloud.notifications.qute.templates.extensions
Holds
LocalDateTimeExtension has a toUtcFormat method
Holds
LocalDateTimeExtension has a toStringFormat method
Holds
LocalDateTimeExtension has a toTimeAgo method
Holds
Extension class SeverityExtension, Methods available in templates string.severityAsEmailTitle() , string.toTitleCase() , string.asSeverityEmoji() , string.asPatternFlySeverity()
5 rules from this sentence
SeverityExtension is in com.redhat.cloud.notifications.qute.templates.extensions
Holds
SeverityExtension has a severityAsEmailTitle method
Holds
SeverityExtension has a toTitleCase method
Holds
SeverityExtension has an asSeverityEmoji method
Holds
SeverityExtension has an asPatternFlySeverity method
Holds
Extension class UrlEncodingExtension, Methods available in templates string.urlEncode()
2 rules from this sentence
UrlEncodingExtension is in com.redhat.cloud.notifications.qute.templates.extensions
Holds
UrlEncodingExtension has an urlEncode method
Holds
Extension class ErrataSortExtension, Methods available in templates list.sortErrataSecurityArray() , list.sortErrataArray()
3 rules from this sentence
ErrataSortExtension is in com.redhat.cloud.notifications.qute.templates.extensions
Holds
ErrataSortExtension has a sortErrataSecurityArray method
Holds
ErrataSortExtension has a sortErrataArray method
Holds
Extension class ApplicationServicesSortExtension, Methods available in templates map.sortByProductDescription() , list.sortByEventTypeDisplayName()
2 rules from this sentence
ApplicationServicesSortExtension has a sortByProductDescription method
Holds
ApplicationServicesSortExtension has a sortByEventTypeDisplayName method
Holds
Method renderTemplate(TemplateDefinition, Map<String, Object>), Use case Drawer/Slack/Teams/Chat data map is passed under "data" key
TemplateService has a renderTemplate method
Holds
Method renderTemplateWithCustomDataMap(TemplateDefinition, Map<String, Object>), Use case Email full context map with keys like action , environment , pendo_message , ignore_user_preferences
TemplateService has a renderTemplateWithCustomDataMap method
Holds
Method isValidTemplateDefinition(TemplateDefinition), Use case Checks if a template exists without throwing
TemplateService has an isValidTemplateDefinition method
Holds
Method convertActionToContextMap(Action), Use case Converts Action.context to Map for aggregation templates
TemplateService has a convertActionToContextMap method
Holds
getIntegrations, getIntegration, getIntegrationHistory, getIntegrationHistoryDetails
4 rules from this sentence
IntegrationTools has getIntegrations
Holds
IntegrationTools has getIntegration
Holds
IntegrationTools has getIntegrationHistory
Holds
IntegrationTools has getIntegrationHistoryDetails
Holds
addEventTypeToIntegration, deleteEventTypeFromIntegration, updateEventTypesLinkedToIntegration
3 rules from this sentence
IntegrationTools has addEventTypeToIntegration
Holds
IntegrationTools has deleteEventTypeFromIntegration
Holds
IntegrationTools has updateEventTypesLinkedToIntegration
Holds
RhIdentity - Record holding parsed identity fields (type, orgId, accountId, userId, username)
5 rules from this sentence
RhIdentity has a type field
Holds
RhIdentity has an orgId field
Holds
RhIdentity has an accountId field
Holds
RhIdentity has an userId field
Holds
RhIdentity has an username field
Holds
Health (/q/health) and metrics (/q/metrics) paths are exempt — see McpAuthMechanism.ANONYMOUS_PATHS.
McpAuthMechanism has ANONYMOUS_PATHS
Holds
parseUuid(paramName, value) - Parse and validate UUID parameters
McpToolUtils has a parseUuid method
Holds
parseDate(paramName, value) - Parse yyyy-MM-dd date strings to LocalDate
McpToolUtils has a parseDate method
Holds
executeRestCall(toolName, principal, restCall, registry) - Execute REST calls with error handling and metrics
McpToolUtils has an executeRestCall method
Holds
httpErrorMessage(status) - User-friendly error messages for HTTP status codes
McpToolUtils has a httpErrorMessage method
Holds
71 rules from 11 docs

More open-source reports

Every report →

Other public repositories whose docs Striff read and checked against their code.