Skip to content

Index OpenAPI endpoints for Elasticsearch and Kibana #2236

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 10 commits into from
Nov 20, 2025
Merged

Index OpenAPI endpoints for Elasticsearch and Kibana #2236

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
7fad7da
Index OpenAPI endpoints
Mpdreamz Nov 19, 2025
ec65625
Enhance OpenAPI exporter with version filtering and update usage in M…
Mpdreamz Nov 19, 2025
69e05d9
Ensure api docs are LLM ready and we have stripped markdown version
Mpdreamz Nov 19, 2025
f713c3b
clean up html in some descriptions
Mpdreamz Nov 19, 2025
2f3b388
Abstract from stripped body
Mpdreamz Nov 19, 2025
ef81e7d
Tweak API titles
Mpdreamz Nov 19, 2025
fc8fc19
Merge remote-tracking branch 'origin/main' into feature/index-openapi
Mpdreamz Nov 19, 2025
d9a6569
Ensure type is available on the frontend
Mpdreamz Nov 19, 2025
4db04ea
Tweak tests
Mpdreamz Nov 19, 2025
7afca9d
fix codeql suggestion
Mpdreamz Nov 19, 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
5 changes: 3 additions & 2 deletions Directory.Packages.props
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
<PackageVersion Include="AWSSDK.SQS" Version="4.0.2.3" />
<PackageVersion Include="AWSSDK.S3" Version="4.0.7.14" />
<PackageVersion Include="Elastic.OpenTelemetry" Version="1.1.0" />
<PackageVersion Include="Microsoft.Extensions.Configuration.UserSecrets" Version="10.0.0" />
<PackageVersion Include="Microsoft.Extensions.Telemetry.Abstractions" Version="10.0.0" />
<PackageVersion Include="OpenTelemetry.Instrumentation.AspNetCore" Version="1.13.0" />
<PackageVersion Include="Generator.Equals" Version="3.2.1" PrivateAssets="all" IncludeAssets="runtime; build; native; contentfiles; analyzers; buildtransitive" />
Expand All @@ -37,7 +38,7 @@
<PackageVersion Include="InMemoryLogger" Version="1.0.66" />
<PackageVersion Include="MartinCostello.Logging.XUnit.v3" Version="0.6.0" />
<PackageVersion Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="10.0.0" />
<PackageVersion Include="Microsoft.OpenApi" Version="3.0.0" />
<PackageVersion Include="Microsoft.OpenApi" Version="3.0.1" />
<PackageVersion Include="TUnit" Version="0.25.21" />
<PackageVersion Include="xunit.v3.extensibility.core" Version="2.0.2" />
</ItemGroup>
Expand Down Expand Up @@ -103,4 +104,4 @@
</PackageVersion>
<PackageVersion Include="xunit.v3" Version="2.0.2" />
</ItemGroup>
</Project>
</Project>
32 changes: 6 additions & 26 deletions aspire/AppHost.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,7 @@ async Task BuildAspireHost(bool startElasticsearch, bool assumeCloned, bool skip
.WithArgs(globalArguments)
.WithEnvironment("ENVIRONMENT", "dev")
.WithEnvironment("LLM_GATEWAY_FUNCTION_URL", llmUrl)
.WithEnvironment("LLM_GATEWAY_SERVICE_ACCOUNT_KEY_PATH", llmServiceAccountPath)
.WithExplicitStart();
.WithEnvironment("LLM_GATEWAY_SERVICE_ACCOUNT_KEY_PATH", llmServiceAccountPath);

// ReSharper disable once RedundantAssignment
api = startElasticsearch
Expand All @@ -55,12 +54,14 @@ async Task BuildAspireHost(bool startElasticsearch, bool assumeCloned, bool skip
.WithEnvironment(context => context.EnvironmentVariables["DOCUMENTATION_ELASTIC_PASSWORD"] = elasticsearchLocal.Resource.PasswordParameter)
.WithParentRelationship(elasticsearchLocal)
.WaitFor(elasticsearchLocal)
.WithExplicitStart()
: api.WithReference(elasticsearchRemote)
.WithEnvironment("DOCUMENTATION_ELASTIC_URL", elasticsearchUrl)
.WithEnvironment("DOCUMENTATION_ELASTIC_APIKEY", elasticsearchApiKey);
.WithEnvironment("DOCUMENTATION_ELASTIC_APIKEY", elasticsearchApiKey)
.WithExplicitStart();

var indexElasticsearch = builder.AddProject<Projects.docs_builder>(ElasticsearchIndexerPlain)
.WithArgs(["assembler", "build", "--exporters", "elasticsearch", .. globalArguments])
var indexElasticsearch = builder.AddProject<Projects.docs_builder>(ElasticsearchIngest)
.WithArgs(["assembler", "index", .. globalArguments])
.WithExplicitStart()
.WaitForCompletion(cloneAll);

Expand All @@ -78,27 +79,6 @@ async Task BuildAspireHost(bool startElasticsearch, bool assumeCloned, bool skip
.WithEnvironment("DOCUMENTATION_ELASTIC_APIKEY", elasticsearchApiKey)
.WithParentRelationship(elasticsearchRemote);

var indexElasticsearchSemantic = builder.AddProject<Projects.docs_builder>(ElasticsearchIndexerSemantic)
.WithArgs(["assembler", "build", "--exporters", "semantic", .. globalArguments])
.WithEnvironment("DOCUMENTATION_ELASTIC_URL", elasticsearchLocal.GetEndpoint("http"))
.WithEnvironment(context => context.EnvironmentVariables["DOCUMENTATION_ELASTIC_PASSWORD"] = elasticsearchLocal.Resource.PasswordParameter)
.WithExplicitStart()
.WaitForCompletion(cloneAll);

// ReSharper disable once RedundantAssignment
indexElasticsearchSemantic = startElasticsearch
? indexElasticsearchSemantic
.WaitFor(elasticsearchLocal)
.WithReference(elasticsearchLocal)
.WithEnvironment("DOCUMENTATION_ELASTIC_URL", elasticsearchLocal.GetEndpoint("http"))
.WithEnvironment(context => context.EnvironmentVariables["DOCUMENTATION_ELASTIC_PASSWORD"] = elasticsearchLocal.Resource.PasswordParameter)
.WithParentRelationship(elasticsearchLocal)
: indexElasticsearchSemantic
.WithReference(elasticsearchRemote)
.WithEnvironment("DOCUMENTATION_ELASTIC_URL", elasticsearchUrl)
.WithEnvironment("DOCUMENTATION_ELASTIC_APIKEY", elasticsearchApiKey)
.WithParentRelationship(elasticsearchRemote);

var serveStatic = builder.AddProject<Projects.docs_builder>(AssemblerServe)
.WithEnvironment("LLM_GATEWAY_FUNCTION_URL", llmUrl)
.WithEnvironment("LLM_GATEWAY_SERVICE_ACCOUNT_KEY_PATH", llmServiceAccountPath)
Expand Down
3 changes: 1 addition & 2 deletions aspire/ResourceNames.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,5 @@ public static class ResourceNames
public const string ElasticsearchLocal = "elasticsearch-local";
public const string ElasticsearchRemote = "elasticsearch-remote";
public const string LambdaApi = "lambda-api";
public const string ElasticsearchIndexerPlain = "elasticsearch-indexer-plain";
public const string ElasticsearchIndexerSemantic = "elasticsearch-indexer-semantic";
public const string ElasticsearchIngest = "elasticsearch-ingest";
}
4 changes: 4 additions & 0 deletions src/Elastic.ApiExplorer/Elastic.ApiExplorer.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,8 @@
<ProjectReference Include="..\Elastic.Documentation.Configuration\Elastic.Documentation.Configuration.csproj"/>
</ItemGroup>

<ItemGroup>
<Folder Include="Elasticsearch\" />
</ItemGroup>

</Project>
Loading
Loading