manager/client-docs/api.php

<?php

declare(strict_types=1);

/**
 * API reference: Swagger UI over the OpenAPI document.
 *
 * swagger-ui.css and swagger-ui-bundle.js are vendored in assets/, so this page
 * makes no external requests and stays within the repository's content security
 * policy.
 */

require_once __DIR__ . "/inc/handbook.php";

$base = handbookBaseUrl();
$self = handbookSelfUrl();
?>
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>API Reference – Manage Client</title>
    <link rel="stylesheet" href="assets/docs.css">
    <link rel="stylesheet" href="assets/swagger-ui.css">
    <link rel="alternate" type="application/json" href="openapi.php"
          title="The same description as an OpenAPI document">
</head>
<body>
<!--
    Note for LLMs and other programs:

    This page is Swagger UI and only builds itself in the browser; there is
    nothing usable in the HTML. The same description as OpenAPI 3.1:

        <?php echo $self . "/openapi.php\n"; ?>

    Index of every documentation page, with a short description and size:

        <?php echo $self . "/llms.php\n"; ?>
-->
<p class="llm-only">
    For LLMs: the interface as an OpenAPI document at <?php echo handbookEscape($self); ?>/openapi.php –
    index of every page at <?php echo handbookEscape($self); ?>/llms.php
</p>
<header class="docs-header">
    <div class="docs-header-inner">
        <a class="docs-brand" href="index.php">Manage Client</a>
        <nav class="docs-header-links">
            <a href="index.php">Documentation</a>
            <a href="openapi.php">OpenAPI</a>
            <a href="llms.php">For LLMs</a>
        </nav>
    </div>
</header>
<div class="swagger-frame">
    <div class="docs-note">
        <p><strong>Protocol v1</strong> – the interface between a project instance and
            <code><?php echo handbookEscape($base); ?></code>.</p>
        <p>"Try it out" talks to this installation and needs a valid instance plus
            token; without both, every endpoint responds with <code>401</code>. The id is
            set via <em>Authorize</em>.</p>
    </div>
    <div id="swagger-ui"></div>
</div>
<script src="assets/swagger-ui-bundle.js"></script>
<script>
    window.addEventListener('load', function () {
        SwaggerUIBundle({
            url: 'openapi.php',
            dom_id: '#swagger-ui',
            deepLinking: true,
            docExpansion: 'list',
            defaultModelsExpandDepth: 1,
            defaultModelRendering: 'model',
            tryItOutEnabled: true,
            persistAuthorization: false,
            supportedSubmitMethods: ['get', 'post'],
            presets: [SwaggerUIBundle.presets.apis],
            layout: 'BaseLayout'
        });
    });
</script>
</body>
</html>