mirror of
https://github.com/pyMC-dev/pyMC_Repeater.git
synced 2026-08-09 18:33:14 +02:00
API documentation: update OpenAPI spec with new endpoints for packet statistics, noise floor history, CAD calibration, and room messaging; improve response schemas and descriptions
This commit is contained in:
Lloyd
@@ -2499,11 +2499,164 @@ class APIEndpoints:
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>pyMC Repeater API Documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/npm/swagger-ui-dist@5/swagger-ui.css">
|
||||
<title>pyMC Repeater API</title>
|
||||
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/swagger-ui-dist@5/swagger-ui.css">
|
||||
<link rel="icon" type="image/png" href="https://cdn.jsdelivr.net/npm/swagger-ui-dist@5/favicon-32x32.png" sizes="32x32" />
|
||||
<style>
|
||||
body { margin: 0; padding: 0; }
|
||||
.topbar { display: none !important; }
|
||||
body {
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', 'Roboto', 'Oxygen', 'Ubuntu', 'Cantarell', 'Fira Sans', 'Droid Sans', 'Helvetica Neue', sans-serif;
|
||||
}
|
||||
|
||||
.topbar {
|
||||
background-color: #1b1b1b !important;
|
||||
border-bottom: 2px solid #3b4151;
|
||||
}
|
||||
|
||||
.topbar .download-url-wrapper { display: none; }
|
||||
|
||||
.swagger-ui .topbar .topbar-wrapper {
|
||||
padding: 16px 20px;
|
||||
}
|
||||
|
||||
.swagger-ui .topbar .topbar-wrapper::before {
|
||||
content: "pyMC Repeater API Documentation";
|
||||
font-size: 1.5em;
|
||||
font-weight: 600;
|
||||
color: #fff;
|
||||
}
|
||||
|
||||
.swagger-ui .info {
|
||||
margin: 30px 0;
|
||||
}
|
||||
|
||||
.swagger-ui .info .title {
|
||||
font-size: 2.5rem;
|
||||
font-weight: 700;
|
||||
color: #3b4151;
|
||||
}
|
||||
|
||||
.swagger-ui .scheme-container {
|
||||
background: linear-gradient(90deg, #667eea 0%, #764ba2 100%);
|
||||
box-shadow: 0 2px 8px rgba(0,0,0,0.1);
|
||||
}
|
||||
|
||||
.swagger-ui .opblock {
|
||||
border-radius: 8px;
|
||||
box-shadow: 0 2px 4px rgba(0,0,0,0.08);
|
||||
margin-bottom: 16px;
|
||||
border: 1px solid #e8e8e8;
|
||||
}
|
||||
|
||||
.swagger-ui .opblock.opblock-get {
|
||||
border-left: 4px solid #61affe;
|
||||
}
|
||||
|
||||
.swagger-ui .opblock.opblock-post {
|
||||
border-left: 4px solid #49cc90;
|
||||
}
|
||||
|
||||
.swagger-ui .opblock.opblock-delete {
|
||||
border-left: 4px solid #f93e3e;
|
||||
}
|
||||
|
||||
.swagger-ui .opblock.opblock-put {
|
||||
border-left: 4px solid #fca130;
|
||||
}
|
||||
|
||||
.swagger-ui .opblock-summary {
|
||||
padding: 12px 20px;
|
||||
}
|
||||
|
||||
.swagger-ui .opblock-summary-method {
|
||||
font-weight: 700;
|
||||
border-radius: 4px;
|
||||
text-transform: uppercase;
|
||||
font-size: 12px;
|
||||
padding: 6px 12px;
|
||||
}
|
||||
|
||||
.swagger-ui .btn.execute {
|
||||
background: linear-gradient(90deg, #667eea 0%, #764ba2 100%);
|
||||
border: none;
|
||||
color: white;
|
||||
font-weight: 600;
|
||||
padding: 10px 24px;
|
||||
border-radius: 6px;
|
||||
transition: all 0.2s;
|
||||
}
|
||||
|
||||
.swagger-ui .btn.execute:hover {
|
||||
box-shadow: 0 4px 12px rgba(102, 126, 234, 0.4);
|
||||
transform: translateY(-1px);
|
||||
}
|
||||
|
||||
.swagger-ui .response-col_status {
|
||||
font-weight: 600;
|
||||
font-size: 14px;
|
||||
}
|
||||
|
||||
.swagger-ui .model-box {
|
||||
background: #f7f8fa;
|
||||
border-radius: 8px;
|
||||
padding: 16px;
|
||||
}
|
||||
|
||||
.swagger-ui .response-col_description__inner p {
|
||||
margin: 0;
|
||||
padding: 8px 0;
|
||||
}
|
||||
|
||||
.swagger-ui .filter-container {
|
||||
padding: 16px 20px;
|
||||
border-bottom: 1px solid #e8e8e8;
|
||||
}
|
||||
|
||||
.swagger-ui .filter .operation-filter-input {
|
||||
border: 2px solid #e8e8e8;
|
||||
border-radius: 6px;
|
||||
padding: 10px 16px;
|
||||
font-size: 14px;
|
||||
width: 100%;
|
||||
max-width: 400px;
|
||||
}
|
||||
|
||||
.swagger-ui .filter .operation-filter-input:focus {
|
||||
border-color: #667eea;
|
||||
outline: none;
|
||||
box-shadow: 0 0 0 3px rgba(102, 126, 234, 0.1);
|
||||
}
|
||||
|
||||
.swagger-ui .opblock-tag {
|
||||
font-size: 1.3rem;
|
||||
font-weight: 700;
|
||||
color: #3b4151;
|
||||
padding: 16px 20px;
|
||||
border-bottom: 2px solid #e8e8e8;
|
||||
margin-bottom: 16px;
|
||||
}
|
||||
|
||||
.swagger-ui .renderedMarkdown p {
|
||||
line-height: 1.6;
|
||||
}
|
||||
|
||||
/* Dark mode support */
|
||||
@media (prefers-color-scheme: dark) {
|
||||
.swagger-ui .opblock {
|
||||
background: #2d2d2d;
|
||||
border-color: #3b3b3b;
|
||||
}
|
||||
|
||||
.swagger-ui .opblock-tag {
|
||||
color: #e8e8e8;
|
||||
border-bottom-color: #3b3b3b;
|
||||
}
|
||||
|
||||
.swagger-ui .info .title {
|
||||
color: #e8e8e8;
|
||||
}
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
@@ -2512,7 +2665,7 @@ class APIEndpoints:
|
||||
<script src="https://cdn.jsdelivr.net/npm/swagger-ui-dist@5/swagger-ui-standalone-preset.js"></script>
|
||||
<script>
|
||||
window.onload = function() {
|
||||
SwaggerUIBundle({
|
||||
const ui = SwaggerUIBundle({
|
||||
url: '/api/openapi',
|
||||
dom_id: '#swagger-ui',
|
||||
deepLinking: true,
|
||||
@@ -2527,9 +2680,24 @@ class APIEndpoints:
|
||||
tryItOutEnabled: true,
|
||||
filter: true,
|
||||
displayRequestDuration: true,
|
||||
displayOperationId: false,
|
||||
persistAuthorization: true,
|
||||
validatorUrl: null
|
||||
validatorUrl: null,
|
||||
syntaxHighlight: {
|
||||
activate: true,
|
||||
theme: "monokai"
|
||||
},
|
||||
defaultModelsExpandDepth: 1,
|
||||
defaultModelExpandDepth: 2,
|
||||
docExpansion: "list",
|
||||
showExtensions: true,
|
||||
showCommonExtensions: true,
|
||||
tagsSorter: "alpha",
|
||||
operationsSorter: "alpha"
|
||||
});
|
||||
|
||||
// Add API info to title
|
||||
window.ui = ui;
|
||||
};
|
||||
</script>
|
||||
</body>
|
||||
|
||||
Reference in New Issue
Block a user