Skip to content

Autogenerate Python REST API reference docs from FastAPI OpenAPI spec #1500

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
koverholt merged 6 commits into from
Mar 27, 2026
Merged

Autogenerate Python REST API reference docs from FastAPI OpenAPI spec #1500

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
188d160
Auto-generate Python REST API reference docs from FastAPI OpenAPI spec
koverholt Mar 27, 2026
0d576e6
Fix link and llmstxt config
koverholt Mar 27, 2026
50813fe
Merge branch 'main' into python-rest-api-autogen
koverholt Mar 27, 2026
4903c6e
Generate REST API docs with web=False
koverholt Mar 27, 2026
0bdde27
Merge remote-tracking branch 'refs/remotes/origin/python-rest-api-aut…
koverholt Mar 27, 2026
f2d08de
Use simpler BaseLayout for generated REST API docs
koverholt Mar 27, 2026
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
8 changes: 4 additions & 4 deletions docs/api-reference/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,8 @@ The Agent Development Kit (ADK) provides comprehensive API references for both P
- :material-console:{ .lg .middle } **CLI Reference**

---
Explore the complete API documentation for the CLI including all of the
valid options and subcommands.
Explore the complete API documentation for the CLI including all of the
valid options and subcommands.

[:octicons-arrow-right-24: View CLI Docs](cli/index.html) <br>

Expand All @@ -61,7 +61,7 @@ The Agent Development Kit (ADK) provides comprehensive API references for both P
- :material-text-box-outline:{ .lg .middle } **Agent Config YAML reference**

---
View the full Agent Config syntax for configuring ADK with
View the full Agent Config syntax for configuring ADK with
YAML text files.

[:octicons-arrow-right-24: View Agent Config reference](agentconfig/index.html) <br>
Expand All @@ -73,6 +73,6 @@ The Agent Development Kit (ADK) provides comprehensive API references for both P
---
Explore the REST API for the ADK web server. This reference provides details on the available endpoints, request and response formats, and more.

[:octicons-arrow-right-24: View REST API Docs](rest/index.md) <br>
[:octicons-arrow-right-24: View REST API Docs](rest/index.html) <br>

</div>
30 changes: 30 additions & 0 deletions docs/api-reference/rest/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>ADK REST API Reference</title>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/swagger-ui-dist@5/swagger-ui.css">
<!-- Google Analytics tag (gtag.js) -->
<script async src="https://www.googletagmanager.com/gtag/js?id=G-DKHZS27PHP"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'G-DKHZS27PHP');
</script>
</head>
<body>
<div id="swagger-ui"></div>
<script src="https://cdn.jsdelivr.net/npm/swagger-ui-dist@5/swagger-ui-bundle.js"></script>
<script>
SwaggerUIBundle({
url: "./openapi.json",
dom_id: "#swagger-ui",
deepLinking: true,
presets: [SwaggerUIBundle.presets.apis],
layout: "BaseLayout"
});
</script>
</body>
</html>
71 changes: 0 additions & 71 deletions docs/api-reference/rest/index.md
View file
Open in desktop

This file was deleted.

Loading
Loading