forked from snxraven/p2ns
reorg
This commit is contained in:
Raven Scott
@@ -0,0 +1,654 @@
|
||||
/**
|
||||
* Global Profile Plugin - Docs Routes
|
||||
*
|
||||
* Handles API documentation endpoints
|
||||
*/
|
||||
|
||||
const sdk = require('../../../includes/plugins/sdk');
|
||||
|
||||
/**
|
||||
* Handle docs-related routes
|
||||
*/
|
||||
async function handleDocsRoutes(req, res, path, query, method) {
|
||||
// GET /api/docs - Interactive API documentation
|
||||
if (path === 'api/docs' && method === 'GET') {
|
||||
const baseUrl = `https://${process.env.PLUGIN_DOMAIN || 'global.profile'}`;
|
||||
const html = `<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>Global Profile API Documentation</title>
|
||||
<style>
|
||||
* { margin: 0; padding: 0; box-sizing: border-box; }
|
||||
body {
|
||||
font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Oxygen, Ubuntu, Cantarell, sans-serif;
|
||||
line-height: 1.6;
|
||||
color: #333;
|
||||
background: #f5f5f5;
|
||||
padding: 20px;
|
||||
}
|
||||
.container {
|
||||
max-width: 1200px;
|
||||
margin: 0 auto;
|
||||
background: white;
|
||||
border-radius: 8px;
|
||||
box-shadow: 0 2px 4px rgba(0,0,0,0.1);
|
||||
padding: 40px;
|
||||
}
|
||||
h1 {
|
||||
color: #2563eb;
|
||||
margin-bottom: 10px;
|
||||
border-bottom: 3px solid #2563eb;
|
||||
padding-bottom: 10px;
|
||||
}
|
||||
.subtitle {
|
||||
color: #666;
|
||||
margin-bottom: 30px;
|
||||
}
|
||||
.endpoint {
|
||||
margin-bottom: 40px;
|
||||
padding: 20px;
|
||||
background: #f9fafb;
|
||||
border-left: 4px solid #2563eb;
|
||||
border-radius: 4px;
|
||||
}
|
||||
.endpoint h2 {
|
||||
color: #1e40af;
|
||||
margin-bottom: 10px;
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: 10px;
|
||||
}
|
||||
.method {
|
||||
display: inline-block;
|
||||
padding: 4px 12px;
|
||||
border-radius: 4px;
|
||||
font-weight: bold;
|
||||
font-size: 0.85em;
|
||||
text-transform: uppercase;
|
||||
}
|
||||
.method.get { background: #10b981; color: white; }
|
||||
.method.post { background: #3b82f6; color: white; }
|
||||
.method.put { background: #f59e0b; color: white; }
|
||||
.method.patch { background: #8b5cf6; color: white; }
|
||||
.method.delete { background: #ef4444; color: white; }
|
||||
.path {
|
||||
font-family: 'Monaco', 'Courier New', monospace;
|
||||
color: #1e40af;
|
||||
font-size: 1.1em;
|
||||
}
|
||||
.description {
|
||||
margin: 15px 0;
|
||||
color: #555;
|
||||
}
|
||||
.section {
|
||||
margin: 20px 0;
|
||||
}
|
||||
.section h3 {
|
||||
color: #374151;
|
||||
margin-bottom: 10px;
|
||||
font-size: 1.1em;
|
||||
}
|
||||
.params {
|
||||
background: white;
|
||||
padding: 15px;
|
||||
border-radius: 4px;
|
||||
border: 1px solid #e5e7eb;
|
||||
}
|
||||
.param {
|
||||
margin: 10px 0;
|
||||
padding: 10px;
|
||||
background: #f9fafb;
|
||||
border-radius: 4px;
|
||||
}
|
||||
.param-name {
|
||||
font-weight: bold;
|
||||
font-family: 'Monaco', 'Courier New', monospace;
|
||||
color: #1e40af;
|
||||
}
|
||||
.param-type {
|
||||
color: #059669;
|
||||
font-size: 0.9em;
|
||||
margin-left: 8px;
|
||||
}
|
||||
.param-desc {
|
||||
color: #666;
|
||||
margin-top: 5px;
|
||||
font-size: 0.95em;
|
||||
}
|
||||
.example {
|
||||
background: #1e293b;
|
||||
color: #e2e8f0;
|
||||
padding: 15px;
|
||||
border-radius: 4px;
|
||||
overflow-x: auto;
|
||||
font-family: 'Monaco', 'Courier New', monospace;
|
||||
font-size: 0.9em;
|
||||
margin: 15px 0;
|
||||
}
|
||||
.example-title {
|
||||
color: #94a3b8;
|
||||
font-size: 0.85em;
|
||||
margin-bottom: 10px;
|
||||
text-transform: uppercase;
|
||||
}
|
||||
code {
|
||||
background: #f3f4f6;
|
||||
padding: 2px 6px;
|
||||
border-radius: 3px;
|
||||
font-family: 'Monaco', 'Courier New', monospace;
|
||||
font-size: 0.9em;
|
||||
color: #dc2626;
|
||||
}
|
||||
.response {
|
||||
margin-top: 15px;
|
||||
}
|
||||
.status-code {
|
||||
display: inline-block;
|
||||
padding: 2px 8px;
|
||||
border-radius: 3px;
|
||||
font-size: 0.85em;
|
||||
font-weight: bold;
|
||||
margin-right: 8px;
|
||||
}
|
||||
.status-200 { background: #10b981; color: white; }
|
||||
.status-400 { background: #f59e0b; color: white; }
|
||||
.status-404 { background: #ef4444; color: white; }
|
||||
.status-500 { background: #dc2626; color: white; }
|
||||
.copy-btn {
|
||||
background: #2563eb;
|
||||
color: white;
|
||||
border: none;
|
||||
padding: 8px 16px;
|
||||
border-radius: 4px;
|
||||
cursor: pointer;
|
||||
font-size: 0.9em;
|
||||
margin-top: 10px;
|
||||
}
|
||||
.copy-btn:hover {
|
||||
background: #1d4ed8;
|
||||
}
|
||||
.toc {
|
||||
background: #eff6ff;
|
||||
padding: 20px;
|
||||
border-radius: 4px;
|
||||
margin-bottom: 30px;
|
||||
}
|
||||
.toc h2 {
|
||||
color: #1e40af;
|
||||
margin-bottom: 15px;
|
||||
}
|
||||
.toc ul {
|
||||
list-style: none;
|
||||
}
|
||||
.toc li {
|
||||
margin: 8px 0;
|
||||
}
|
||||
.toc a {
|
||||
color: #2563eb;
|
||||
text-decoration: none;
|
||||
}
|
||||
.toc a:hover {
|
||||
text-decoration: underline;
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<div class="container">
|
||||
<h1>Global Profile API Documentation</h1>
|
||||
<p class="subtitle">Complete REST API reference for the Global Profile plugin</p>
|
||||
|
||||
<div class="toc">
|
||||
<h2>Table of Contents</h2>
|
||||
<ul>
|
||||
<li><a href="#profile">Profile Management</a></li>
|
||||
<li><a href="#profiles">Profile Listing</a></li>
|
||||
<li><a href="#avatar">Avatar Management</a></li>
|
||||
<li><a href="#fields">Custom Fields</a></li>
|
||||
<li><a href="#stats">Statistics</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<section id="profile">
|
||||
<div class="endpoint">
|
||||
<h2><span class="method get">GET</span> <span class="path">/api/profile</span></h2>
|
||||
<div class="description">Get your local profile. Returns default profile if none exists.</div>
|
||||
<div class="response">
|
||||
<div><span class="status-code status-200">200 OK</span> Profile retrieved successfully</div>
|
||||
<div><span class="status-code status-500">500</span> Local peer ID not available</div>
|
||||
</div>
|
||||
<div class="example">
|
||||
<div class="example-title">Example Request</div>
|
||||
<div>curl -X GET ${baseUrl}/api/profile</div>
|
||||
</div>
|
||||
<div class="example">
|
||||
<div class="example-title">Example Response</div>
|
||||
<div>{
|
||||
"peerId": "abc123...",
|
||||
"displayName": "John Doe",
|
||||
"bio": "Software developer",
|
||||
"website": "https://example.com",
|
||||
"email": "[email protected]",
|
||||
"xUsername": "johndoe",
|
||||
"github": "johndoe",
|
||||
"discord": "johndoe#1234",
|
||||
"location": "San Francisco, CA",
|
||||
"avatarHash": "abc123...",
|
||||
"customFields": {},
|
||||
"tags": ["developer", "opensource"],
|
||||
"lastUpdated": 1703123456789
|
||||
}</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="endpoint">
|
||||
<h2><span class="method put">PUT</span> <span class="path">/api/profile</span></h2>
|
||||
<div class="description">Update your profile (full update). All fields must be provided.</div>
|
||||
<div class="section">
|
||||
<h3>Request Body</h3>
|
||||
<div class="params">
|
||||
<div class="param">
|
||||
<span class="param-name">displayName</span><span class="param-type">string (optional)</span>
|
||||
<div class="param-desc">Display name for the profile</div>
|
||||
</div>
|
||||
<div class="param">
|
||||
<span class="param-name">bio</span><span class="param-type">string (optional)</span>
|
||||
<div class="param-desc">Biography or description</div>
|
||||
</div>
|
||||
<div class="param">
|
||||
<span class="param-name">website</span><span class="param-type">string (optional)</span>
|
||||
<div class="param-desc">Website URL</div>
|
||||
</div>
|
||||
<div class="param">
|
||||
<span class="param-name">email</span><span class="param-type">string (optional)</span>
|
||||
<div class="param-desc">Email address</div>
|
||||
</div>
|
||||
<div class="param">
|
||||
<span class="param-name">xUsername</span><span class="param-type">string (optional)</span>
|
||||
<div class="param-desc">X (Twitter) username</div>
|
||||
</div>
|
||||
<div class="param">
|
||||
<span class="param-name">tags</span><span class="param-type">array (optional)</span>
|
||||
<div class="param-desc">Array of tag strings</div>
|
||||
</div>
|
||||
<div class="param">
|
||||
<span class="param-name">customFields</span><span class="param-type">object (optional)</span>
|
||||
<div class="param-desc">Custom fields object</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="response">
|
||||
<div><span class="status-code status-200">200 OK</span> Profile updated successfully</div>
|
||||
<div><span class="status-code status-500">500</span> Error updating profile</div>
|
||||
<div><span class="status-code status-503">503</span> Database not ready</div>
|
||||
</div>
|
||||
<div class="example">
|
||||
<div class="example-title">Example Request</div>
|
||||
<div>curl -X PUT ${baseUrl}/api/profile \\
|
||||
-H "Content-Type: application/json" \\
|
||||
-d '{
|
||||
"displayName": "John Doe",
|
||||
"bio": "Software developer",
|
||||
"website": "https://example.com",
|
||||
"email": "[email protected]",
|
||||
"tags": ["developer"],
|
||||
"customFields": {}
|
||||
}'</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="endpoint">
|
||||
<h2><span class="method patch">PATCH</span> <span class="path">/api/profile</span></h2>
|
||||
<div class="description">Partially update your profile. Only provided fields will be updated.</div>
|
||||
<div class="section">
|
||||
<h3>Request Body</h3>
|
||||
<div class="params">
|
||||
<div class="param">
|
||||
<span class="param-name">Any profile field</span><span class="param-type">mixed (optional)</span>
|
||||
<div class="param-desc">Any combination of profile fields to update</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="response">
|
||||
<div><span class="status-code status-200">200 OK</span> Profile updated successfully</div>
|
||||
<div><span class="status-code status-400">400</span> Invalid JSON</div>
|
||||
<div><span class="status-code status-404">404</span> Profile not found</div>
|
||||
<div><span class="status-code status-500">500</span> Error updating profile</div>
|
||||
</div>
|
||||
<div class="example">
|
||||
<div class="example-title">Example Request</div>
|
||||
<div>curl -X PATCH ${baseUrl}/api/profile \\
|
||||
-H "Content-Type: application/json" \\
|
||||
-d '{
|
||||
"displayName": "Jane Doe",
|
||||
"bio": "Updated bio"
|
||||
}'</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="endpoint">
|
||||
<h2><span class="method delete">DELETE</span> <span class="path">/api/profile</span></h2>
|
||||
<div class="description">Delete your local profile.</div>
|
||||
<div class="response">
|
||||
<div><span class="status-code status-200">200 OK</span> Profile deleted successfully</div>
|
||||
<div><span class="status-code status-404">404</span> Profile not found</div>
|
||||
<div><span class="status-code status-500">500</span> Error deleting profile</div>
|
||||
</div>
|
||||
<div class="example">
|
||||
<div class="example-title">Example Request</div>
|
||||
<div>curl -X DELETE ${baseUrl}/api/profile</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="endpoint">
|
||||
<h2><span class="method get">GET</span> <span class="path">/api/profile/:peerId</span></h2>
|
||||
<div class="description">Get a specific peer's profile by their peer ID.</div>
|
||||
<div class="section">
|
||||
<h3>Path Parameters</h3>
|
||||
<div class="params">
|
||||
<div class="param">
|
||||
<span class="param-name">peerId</span><span class="param-type">string (required)</span>
|
||||
<div class="param-desc">The peer ID to get the profile for</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="response">
|
||||
<div><span class="status-code status-200">200 OK</span> Profile retrieved successfully</div>
|
||||
<div><span class="status-code status-404">404</span> Profile not found</div>
|
||||
</div>
|
||||
<div class="example">
|
||||
<div class="example-title">Example Request</div>
|
||||
<div>curl -X GET ${baseUrl}/api/profile/abc123...</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<section id="profiles">
|
||||
<div class="endpoint">
|
||||
<h2><span class="method get">GET</span> <span class="path">/api/profiles</span></h2>
|
||||
<div class="description">List all profiles with optional search, filtering, pagination, and sorting.</div>
|
||||
<div class="section">
|
||||
<h3>Query Parameters</h3>
|
||||
<div class="params">
|
||||
<div class="param">
|
||||
<span class="param-name">search</span><span class="param-type">string (optional)</span>
|
||||
<div class="param-desc">Search in displayName and bio fields</div>
|
||||
</div>
|
||||
<div class="param">
|
||||
<span class="param-name">tag</span><span class="param-type">string (optional)</span>
|
||||
<div class="param-desc">Filter by tag</div>
|
||||
</div>
|
||||
<div class="param">
|
||||
<span class="param-name">limit</span><span class="param-type">number (optional, default: 100)</span>
|
||||
<div class="param-desc">Maximum number of results (1-1000)</div>
|
||||
</div>
|
||||
<div class="param">
|
||||
<span class="param-name">offset</span><span class="param-type">number (optional, default: 0)</span>
|
||||
<div class="param-desc">Number of results to skip</div>
|
||||
</div>
|
||||
<div class="param">
|
||||
<span class="param-name">sort</span><span class="param-type">string (optional, default: "lastUpdated")</span>
|
||||
<div class="param-desc">Sort field: "lastUpdated" or "displayName"</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="response">
|
||||
<div><span class="status-code status-200">200 OK</span> Profiles retrieved successfully</div>
|
||||
<div><span class="status-code status-400">400</span> Invalid query parameters</div>
|
||||
</div>
|
||||
<div class="example">
|
||||
<div class="example-title">Example Request</div>
|
||||
<div>curl -X GET "${baseUrl}/api/profiles?search=developer&limit=10&offset=0&sort=lastUpdated"</div>
|
||||
</div>
|
||||
<div class="example">
|
||||
<div class="example-title">Example Response</div>
|
||||
<div>{
|
||||
"profiles": [...],
|
||||
"pagination": {
|
||||
"total": 50,
|
||||
"limit": 10,
|
||||
"offset": 0,
|
||||
"hasMore": true
|
||||
}
|
||||
}</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<section id="avatar">
|
||||
<div class="endpoint">
|
||||
<h2><span class="method post">POST</span> <span class="path">/api/profile/avatar</span></h2>
|
||||
<div class="description">Upload a new avatar image. Image will be resized to multiple sizes (16, 32, 64, 128, 256, 512px).</div>
|
||||
<div class="section">
|
||||
<h3>Request Body</h3>
|
||||
<div class="params">
|
||||
<div class="param">
|
||||
<span class="param-name">avatar</span><span class="param-type">file (required)</span>
|
||||
<div class="param-desc">Image file (multipart/form-data)</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="response">
|
||||
<div><span class="status-code status-200">200 OK</span> Avatar uploaded successfully</div>
|
||||
<div><span class="status-code status-400">400</span> No avatar file provided or file is empty</div>
|
||||
<div><span class="status-code status-500">500</span> Error uploading avatar</div>
|
||||
</div>
|
||||
<div class="example">
|
||||
<div class="example-title">Example Request</div>
|
||||
<div>curl -X POST ${baseUrl}/api/profile/avatar \\
|
||||
-F "avatar=@/path/to/image.jpg"</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="endpoint">
|
||||
<h2><span class="method delete">DELETE</span> <span class="path">/api/profile/avatar</span></h2>
|
||||
<div class="description">Delete your avatar image.</div>
|
||||
<div class="response">
|
||||
<div><span class="status-code status-200">200 OK</span> Avatar deleted successfully</div>
|
||||
<div><span class="status-code status-500">500</span> Error deleting avatar</div>
|
||||
</div>
|
||||
<div class="example">
|
||||
<div class="example-title">Example Request</div>
|
||||
<div>curl -X DELETE ${baseUrl}/api/profile/avatar</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="endpoint">
|
||||
<h2><span class="method get">GET</span> <span class="path">/api/profile/avatar/:peerId</span></h2>
|
||||
<div class="description">Get default avatar (64px) for a peer. Redirects to size-specific endpoint.</div>
|
||||
<div class="section">
|
||||
<h3>Path Parameters</h3>
|
||||
<div class="params">
|
||||
<div class="param">
|
||||
<span class="param-name">peerId</span><span class="param-type">string (required)</span>
|
||||
<div class="param-desc">The peer ID to get the avatar for</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="response">
|
||||
<div><span class="status-code status-302">302</span> Redirects to /api/profile/avatar/:peerId/64</div>
|
||||
</div>
|
||||
<div class="example">
|
||||
<div class="example-title">Example Request</div>
|
||||
<div>curl -X GET ${baseUrl}/api/profile/avatar/abc123...</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="endpoint">
|
||||
<h2><span class="method get">GET</span> <span class="path">/api/profile/avatar/:peerId/:size</span></h2>
|
||||
<div class="description">Get avatar image for a peer at a specific size. Returns default SVG if no avatar exists.</div>
|
||||
<div class="section">
|
||||
<h3>Path Parameters</h3>
|
||||
<div class="params">
|
||||
<div class="param">
|
||||
<span class="param-name">peerId</span><span class="param-type">string (required)</span>
|
||||
<div class="param-desc">The peer ID to get the avatar for</div>
|
||||
</div>
|
||||
<div class="param">
|
||||
<span class="param-name">size</span><span class="param-type">number (required)</span>
|
||||
<div class="param-desc">Avatar size: 16, 32, 64, 128, 256, or 512</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="response">
|
||||
<div><span class="status-code status-200">200 OK</span> Avatar image (PNG or SVG)</div>
|
||||
<div><span class="status-code status-400">400</span> Invalid avatar size</div>
|
||||
</div>
|
||||
<div class="example">
|
||||
<div class="example-title">Example Request</div>
|
||||
<div>curl -X GET ${baseUrl}/api/profile/avatar/abc123.../128</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<section id="fields">
|
||||
<div class="endpoint">
|
||||
<h2><span class="method get">GET</span> <span class="path">/api/fields</span></h2>
|
||||
<div class="description">Get all registered custom fields.</div>
|
||||
<div class="response">
|
||||
<div><span class="status-code status-200">200 OK</span> Fields retrieved successfully</div>
|
||||
</div>
|
||||
<div class="example">
|
||||
<div class="example-title">Example Request</div>
|
||||
<div>curl -X GET ${baseUrl}/api/fields</div>
|
||||
</div>
|
||||
<div class="example">
|
||||
<div class="example-title">Example Response</div>
|
||||
<div>{
|
||||
"fields": [
|
||||
{
|
||||
"fieldKey": "favoriteColor",
|
||||
"registeredBy": "example.plugin",
|
||||
"label": "Favorite Color",
|
||||
"type": "string",
|
||||
"description": "User's favorite color",
|
||||
"defaultValue": ""
|
||||
}
|
||||
]
|
||||
}</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="endpoint">
|
||||
<h2><span class="method post">POST</span> <span class="path">/api/fields</span></h2>
|
||||
<div class="description">Register a new custom field. Fields can only be registered by the plugin that created them.</div>
|
||||
<div class="section">
|
||||
<h3>Request Body</h3>
|
||||
<div class="params">
|
||||
<div class="param">
|
||||
<span class="param-name">fieldKey</span><span class="param-type">string (required)</span>
|
||||
<div class="param-desc">Unique key for the field</div>
|
||||
</div>
|
||||
<div class="param">
|
||||
<span class="param-name">label</span><span class="param-type">string (required)</span>
|
||||
<div class="param-desc">Human-readable label</div>
|
||||
</div>
|
||||
<div class="param">
|
||||
<span class="param-name">type</span><span class="param-type">string (required)</span>
|
||||
<div class="param-desc">Field type (string, number, boolean, etc.)</div>
|
||||
</div>
|
||||
<div class="param">
|
||||
<span class="param-name">description</span><span class="param-type">string (optional)</span>
|
||||
<div class="param-desc">Field description</div>
|
||||
</div>
|
||||
<div class="param">
|
||||
<span class="param-name">defaultValue</span><span class="param-type">any (optional)</span>
|
||||
<div class="param-desc">Default value for the field</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="response">
|
||||
<div><span class="status-code status-200">200 OK</span> Field registered successfully</div>
|
||||
<div><span class="status-code status-400">400</span> Missing required fields or invalid JSON</div>
|
||||
<div><span class="status-code status-409">409</span> Field already registered by another plugin</div>
|
||||
<div><span class="status-code status-500">500</span> Error registering field</div>
|
||||
</div>
|
||||
<div class="example">
|
||||
<div class="example-title">Example Request</div>
|
||||
<div>curl -X POST ${baseUrl}/api/fields \\
|
||||
-H "Content-Type: application/json" \\
|
||||
-d '{
|
||||
"fieldKey": "favoriteColor",
|
||||
"label": "Favorite Color",
|
||||
"type": "string",
|
||||
"description": "User'\''s favorite color",
|
||||
"defaultValue": "blue"
|
||||
}'</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<section id="stats">
|
||||
<div class="endpoint">
|
||||
<h2><span class="method get">GET</span> <span class="path">/api/stats</span></h2>
|
||||
<div class="description">Get profile statistics including total counts, online/offline status, and recent activity.</div>
|
||||
<div class="response">
|
||||
<div><span class="status-code status-200">200 OK</span> Statistics retrieved successfully</div>
|
||||
<div><span class="status-code status-500">500</span> Error getting stats</div>
|
||||
</div>
|
||||
<div class="example">
|
||||
<div class="example-title">Example Request</div>
|
||||
<div>curl -X GET ${baseUrl}/api/stats</div>
|
||||
</div>
|
||||
<div class="example">
|
||||
<div class="example-title">Example Response</div>
|
||||
<div>{
|
||||
"total": 50,
|
||||
"online": 12,
|
||||
"offline": 38,
|
||||
"recentActivity": [
|
||||
{
|
||||
"peerId": "abc123...",
|
||||
"displayName": "John Doe",
|
||||
"hoursAgo": 2.5
|
||||
}
|
||||
],
|
||||
"timestamp": 1703123456789
|
||||
}</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<div style="margin-top: 40px; padding-top: 20px; border-top: 2px solid #e5e7eb; color: #666; font-size: 0.9em;">
|
||||
<p><strong>Base URL:</strong> <code>${baseUrl}</code></p>
|
||||
<p><strong>Note:</strong> All endpoints return JSON unless otherwise specified. Error responses include an <code>error</code> field with a descriptive message.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<script>
|
||||
// Simple copy functionality for code blocks
|
||||
document.querySelectorAll('.example').forEach(block => {
|
||||
const btn = document.createElement('button');
|
||||
btn.className = 'copy-btn';
|
||||
btn.textContent = 'Copy';
|
||||
btn.onclick = () => {
|
||||
const text = block.querySelector('div:last-child').textContent;
|
||||
navigator.clipboard.writeText(text).then(() => {
|
||||
btn.textContent = 'Copied!';
|
||||
setTimeout(() => btn.textContent = 'Copy', 2000);
|
||||
});
|
||||
};
|
||||
block.appendChild(btn);
|
||||
});
|
||||
</script>
|
||||
</body>
|
||||
</html>`;
|
||||
|
||||
res.writeHead(200, {
|
||||
'Content-Type': 'text/html; charset=utf-8',
|
||||
'Cache-Control': 'public, max-age=3600'
|
||||
});
|
||||
res.end(html);
|
||||
return true;
|
||||
}
|
||||
|
||||
return false; // Not handled by this module
|
||||
}
|
||||
|
||||
module.exports = {
|
||||
handleDocsRoutes
|
||||
};
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user