Merge pull request #2078 from scireum/ili/open-search-html

Show HTML formatted job descriptions in OpenSearch
scireum · Jan 17, 2025 · adc0380 · adc0380
2 parents 43bd4b8 + ac4d7e8
commit adc0380
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 2 deletions.
diff --git a/src/main/java/sirius/biz/jobs/JobsSearchProvider.java b/src/main/java/sirius/biz/jobs/JobsSearchProvider.java
@@ -47,7 +47,7 @@ public void query(String query, int maxResults, Consumer<OpenSearchResult> resul
         jobs.getAvailableJobs(query).filter(JobFactory::canStartInteractive).forEach(jobFactory -> {
             OpenSearchResult result = new OpenSearchResult();
             result.withLabel(jobFactory.getLabel())
-                  .withDescription(jobFactory.getDescription())
+                  .withHtmlDescription(jobFactory.getDescription())
                   .withURL("/job/" + jobFactory.getName());
             resultCollector.accept(result);
         });

diff --git a/src/main/java/sirius/biz/tycho/search/OpenSearchResult.java b/src/main/java/sirius/biz/tycho/search/OpenSearchResult.java
@@ -67,7 +67,18 @@ public OpenSearchResult withURL(String url) {
      * @return the result itself for fluent method calls.
      */
     public OpenSearchResult withDescription(String description) {
-        this.htmlDescription = Strings.cleanup(description, StringCleanup::escapeXml);
+        withHtmlDescription(Strings.cleanup(description, StringCleanup::escapeXml));
+        return this;
+    }
+
+    /**
+     * Provides an additional HTML description to show.
+     *
+     * @param htmlDescription the description of this result, expected to contain HTML.
+     * @return the result itself for fluent method calls.
+     */
+    public OpenSearchResult withHtmlDescription(String htmlDescription) {
+        this.htmlDescription = htmlDescription;
         return this;
     }