rahix/openflexure-microscope-server
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Adjust developer docs front page and add JSON links on HTTP page

Browse source
This commit is contained in:
Julian Stirling 2026-03-01 10:20:32 +00:00
parent b91939380f
commit 9788e0d2b7
2 changed files with 17 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

4
apidocs/http/index.html
View file

@ -64,6 +64,10 @@
<code>http://microscope.local:5000/docs</code> <code>http://microscope.local:5000/docs</code>
</p> </p>
<p>
You can also directly inspect the OpenAPI JSON file <a href="./openapi.json">openapi.json</a> or the WC3 "Web of Things" Thing Descriptions JSON <a href="./thing_descriptions.json">thing_descriptions.json</a>
</p>
<aside> <aside>
Replace <strong>microscope.local</strong> with your microscope's hostname or IP address Replace <strong>microscope.local</strong> with your microscope's hostname or IP address
if your network uses a different name. if your network uses a different name.

18
apidocs/index.html
View file

@ -3,7 +3,7 @@
<head> <head>
<meta charset="UTF-8"> <meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>OpenFlexure Microscope Server API Docs</title> <title>OpenFlexure Microscope Server Developer Documentation</title>
<link href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@400;600&display=swap" rel="stylesheet"> <link href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@400;600&display=swap" rel="stylesheet">
@ -21,9 +21,15 @@ body {
padding: 0 1.5rem; padding: 0 1.5rem;
} }
.main-content {
max-width: 700px;
padding: 2rem;
}
h1 { h1 {
color: #c5247f; color: #c5247f;
margin-bottom: 0.5rem; margin-bottom: 0.5rem;
text-align: center;
} }
a { a {
@ -49,11 +55,13 @@ a:hover {
<body> <body>
<div class="content"> <div class="content">
<h1>OpenFlexure Microscope Server API Docs</h1> <h1>OpenFlexure Microscope Server Developer Documentation</h1>
<p>Select documentation:</p> <div class="main-content">
<p>Select documentation:</p>
<a href="./http/index.html">HTTP API (Swagger)</a> <a href="./http/index.html">HTTP API (Swagger)</a>
<a href="./python/index.html">Python API</a> <a href="./python/index.html">Python API</a>
</div>
</div> </div>
</body> </body>