Skip to content

Exclude hidden documents from search #2277

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 27, 2025
+16 −3
Merged

Exclude hidden documents from search #2277

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7d6cb38
Exclude hidden documents from search
reakaleek Nov 26, 2025
333c472
Add mapping
reakaleek Nov 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions src/Elastic.Documentation/Search/DocumentationDocument.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,4 +65,8 @@ public record DocumentationDocument

[JsonPropertyName("parents")]
public ParentDocument[] Parents { get; set; } = [];

[JsonPropertyName("hidden")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public bool Hidden { get; set; }
}
3 changes: 3 additions & 0 deletions src/Elastic.Markdown/Exporters/Elasticsearch/ElasticsearchExporter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,6 +199,9 @@ protected static string CreateMapping(string? inferenceId) =>
"prefix": { "type": "text", "analyzer" : "hierarchy_analyzer" }
}
},
"hidden" : {
"type" : "boolean"
},
"applies_to" : {
"type" : "nested",
"properties" : {
Expand Down
3 changes: 2 additions & 1 deletion src/Elastic.Markdown/Exporters/Elasticsearch/ElasticsearchMarkdownExporter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -451,7 +451,8 @@ public async ValueTask<bool> ExportAsync(MarkdownExportFileContext fileContext,
Title = i.NavigationTitle,
Url = i.Url
}).Reverse().ToArray(),
Headings = headings
Headings = headings,
Hidden = fileContext.NavigationItem.Hidden
};

AssignDocumentMetadata(doc);
Expand Down
9 changes: 7 additions & 2 deletions src/api/Elastic.Documentation.Api.Infrastructure/Adapters/Search/ElasticsearchGateway.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,9 @@ internal sealed record DocumentDto

[JsonPropertyName("applies_to")]
public ApplicableTo? Applies { get; init; }

[JsonPropertyName("hidden")]
public bool Hidden { get; init; } = false;
}

internal sealed record ParentDocumentDto
Expand Down Expand Up @@ -100,7 +103,8 @@ private static Query BuildLexicalQuery(string searchQuery) =>
|| new MatchQuery(Infer.Field<DocumentDto>(f => f.Parents.First().Title), searchQuery) { Boost = 2.0f }
|| new MatchQuery(Infer.Field<DocumentDto>(f => f.Title), searchQuery) { Fuzziness = 1, Boost = 1.0f }
)
&& !(Query)new TermsQuery(Infer.Field<DocumentDto>(f => f.Url.Suffix("keyword")), new TermsQueryField(["/docs", "/docs/", "/docs/404", "/docs/404/"]));
&& !(Query)new TermsQuery(Infer.Field<DocumentDto>(f => f.Url.Suffix("keyword")), new TermsQueryField(["/docs", "/docs/", "/docs/404", "/docs/404/"]))
&& !(Query)new TermQuery { Field = Infer.Field<DocumentDto>(f => f.Hidden), Value = true };

/// <summary>
/// Builds the semantic search query for the given search term.
Expand All @@ -110,7 +114,8 @@ private static Query BuildSemanticQuery(string searchQuery) =>
|| new SemanticQuery("abstract.semantic_text", searchQuery) { Boost = 3.0f }
)
&& !(Query)new TermsQuery(Infer.Field<DocumentDto>(f => f.Url.Suffix("keyword")),
new TermsQueryField(["/docs", "/docs/", "/docs/404", "/docs/404/"]));
new TermsQueryField(["/docs", "/docs/", "/docs/404", "/docs/404/"]))
&& !(Query)new TermQuery { Field = Infer.Field<DocumentDto>(f => f.Hidden), Value = true };

/// <summary>
/// Normalizes the search query by replacing "dotnet" with "net".
Expand Down
Loading