feat: serve docs flat at /<repo>/ with no redirects
- collect.py copies each repo's built site contents directly to a top-level <repo>/ dir (was libs|apis|wiki/<repo>/site nesting) - nginx uses `index index.html lib/index.html api/index.html` so /dagpipe/ -> lib/index.html, /auth-server/ -> api/index.html are served internally with no redirects - _index regenerates links against the flat layout (/dagpipe/lib/, /auth-server/api/, /mongo-ops/, /blog/...) - config.yml static entries point at vendored blog/ + media-manager/ - Dockerfile copies per-repo dirs flat into the nginx html root - removed stale libs/, apis/, wiki/, tutorials/ category trees
This commit is contained in:
234
auth-server/api/index.html
Normal file
234
auth-server/api/index.html
Normal file
@@ -0,0 +1,234 @@
|
||||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html class="no-js" lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8"/>
|
||||
<meta content="width=device-width,initial-scale=1" name="viewport"/>
|
||||
<meta content="
|
||||
The Aetoskia Authentication Service.
|
||||
|
||||
Provides identity, access control, and JWT token issuance for the Aetoskia
|
||||
ecosystem. Fully async, built with FastAPI and MongoDB.
|
||||
" name="description"/>
|
||||
<meta content="Aetoskia Dev Team" name="author"/>
|
||||
<link href="../assets/images/favicon.png" rel="icon"/>
|
||||
<meta content="mkdocs-1.6.1, mkdocs-material-9.6.23" name="generator"/>
|
||||
<title>Home - Aetoskia Auth Server</title>
|
||||
<link href="../assets/stylesheets/main.84d31ad4.min.css" rel="stylesheet"/>
|
||||
<link href="../assets/stylesheets/palette.06af60db.min.css" rel="stylesheet"/>
|
||||
<link crossorigin="" href="https://fonts.gstatic.com" rel="preconnect"/>
|
||||
<link href="https://fonts.googleapis.com/css?family=Inter:300,300i,400,400i,700,700i%7CJetBrains+Mono:400,400i,700,700i&display=fallback" rel="stylesheet"/>
|
||||
<style>:root{--md-text-font:"Inter";--md-code-font:"JetBrains Mono"}</style>
|
||||
<link href="https://unpkg.com/dracula-prism/dist/css/dracula-prism.css" rel="stylesheet"/>
|
||||
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
|
||||
</head>
|
||||
<body data-md-color-accent="cyan" data-md-color-primary="deep-purple" data-md-color-scheme="slate" dir="ltr">
|
||||
<input autocomplete="off" class="md-toggle" data-md-toggle="drawer" id="__drawer" type="checkbox"/>
|
||||
<input autocomplete="off" class="md-toggle" data-md-toggle="search" id="__search" type="checkbox"/>
|
||||
<label class="md-overlay" for="__drawer"></label>
|
||||
<div data-md-component="skip">
|
||||
<a class="md-skip" href="#api-reference">
|
||||
Skip to content
|
||||
</a>
|
||||
</div>
|
||||
<div data-md-component="announce">
|
||||
</div>
|
||||
<header class="md-header md-header--shadow" data-md-component="header">
|
||||
<nav aria-label="Header" class="md-header__inner md-grid">
|
||||
<a aria-label="Aetoskia Auth Server" class="md-header__button md-logo" data-md-component="logo" href=".." title="Aetoskia Auth Server">
|
||||
<svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M12 3C7.58 3 4 4.79 4 7s3.58 4 8 4 8-1.79 8-4-3.58-4-8-4M4 9v3c0 2.21 3.58 4 8 4s8-1.79 8-4V9c0 2.21-3.58 4-8 4s-8-1.79-8-4m0 5v3c0 2.21 3.58 4 8 4s8-1.79 8-4v-3c0 2.21-3.58 4-8 4s-8-1.79-8-4"></path></svg>
|
||||
</a>
|
||||
<label class="md-header__button md-icon" for="__drawer">
|
||||
<svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"></path></svg>
|
||||
</label>
|
||||
<div class="md-header__title" data-md-component="header-title">
|
||||
<div class="md-header__ellipsis">
|
||||
<div class="md-header__topic">
|
||||
<span class="md-ellipsis">
|
||||
Aetoskia Auth Server
|
||||
</span>
|
||||
</div>
|
||||
<div class="md-header__topic" data-md-component="header-topic">
|
||||
<span class="md-ellipsis">
|
||||
|
||||
Home
|
||||
|
||||
</span>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<form class="md-header__option" data-md-component="palette">
|
||||
<input aria-hidden="true" class="md-option" data-md-color-accent="cyan" data-md-color-media="" data-md-color-primary="deep-purple" data-md-color-scheme="slate" id="__palette_0" name="__palette" type="radio"/>
|
||||
</form>
|
||||
<script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
|
||||
<label class="md-header__button md-icon" for="__search">
|
||||
<svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"></path></svg>
|
||||
</label>
|
||||
<div class="md-search" data-md-component="search" role="dialog">
|
||||
<label class="md-search__overlay" for="__search"></label>
|
||||
<div class="md-search__inner" role="search">
|
||||
<form class="md-search__form" name="search">
|
||||
<input aria-label="Search" autocapitalize="off" autocomplete="off" autocorrect="off" class="md-search__input" data-md-component="search-query" name="query" placeholder="Search" required="" spellcheck="false" type="text"/>
|
||||
<label class="md-search__icon md-icon" for="__search">
|
||||
<svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"></path></svg>
|
||||
<svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"></path></svg>
|
||||
</label>
|
||||
<nav aria-label="Search" class="md-search__options">
|
||||
<a aria-label="Share" class="md-search__icon md-icon" data-clipboard="" data-clipboard-text="" data-md-component="search-share" href="javascript:void(0)" tabindex="-1" title="Share">
|
||||
<svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M18 16.08c-.76 0-1.44.3-1.96.77L8.91 12.7c.05-.23.09-.46.09-.7s-.04-.47-.09-.7l7.05-4.11c.54.5 1.25.81 2.04.81a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3c0 .24.04.47.09.7L8.04 9.81C7.5 9.31 6.79 9 6 9a3 3 0 0 0-3 3 3 3 0 0 0 3 3c.79 0 1.5-.31 2.04-.81l7.12 4.15c-.05.21-.08.43-.08.66 0 1.61 1.31 2.91 2.92 2.91s2.92-1.3 2.92-2.91A2.92 2.92 0 0 0 18 16.08"></path></svg>
|
||||
</a>
|
||||
<button aria-label="Clear" class="md-search__icon md-icon" tabindex="-1" title="Clear" type="reset">
|
||||
<svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"></path></svg>
|
||||
</button>
|
||||
</nav>
|
||||
<div class="md-search__suggest" data-md-component="search-suggest"></div>
|
||||
</form>
|
||||
<div class="md-search__output">
|
||||
<div class="md-search__scrollwrap" data-md-scrollfix="" tabindex="0">
|
||||
<div class="md-search-result" data-md-component="search-result">
|
||||
<div class="md-search-result__meta">
|
||||
Initializing search
|
||||
</div>
|
||||
<ol class="md-search-result__list" role="presentation"></ol>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
</header>
|
||||
<div class="md-container" data-md-component="container">
|
||||
<main class="md-main" data-md-component="main">
|
||||
<div class="md-main__inner md-grid">
|
||||
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation">
|
||||
<div class="md-sidebar__scrollwrap">
|
||||
<div class="md-sidebar__inner">
|
||||
<nav aria-label="Navigation" class="md-nav md-nav--primary md-nav--integrated" data-md-level="0">
|
||||
<label class="md-nav__title" for="__drawer">
|
||||
<a aria-label="Aetoskia Auth Server" class="md-nav__button md-logo" data-md-component="logo" href=".." title="Aetoskia Auth Server">
|
||||
<svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M12 3C7.58 3 4 4.79 4 7s3.58 4 8 4 8-1.79 8-4-3.58-4-8-4M4 9v3c0 2.21 3.58 4 8 4s8-1.79 8-4V9c0 2.21-3.58 4-8 4s-8-1.79-8-4m0 5v3c0 2.21 3.58 4 8 4s8-1.79 8-4v-3c0 2.21-3.58 4-8 4s-8-1.79-8-4"></path></svg>
|
||||
</a>
|
||||
Aetoskia Auth Server
|
||||
</label>
|
||||
<ul class="md-nav__list" data-md-scrollfix="">
|
||||
<li class="md-nav__item md-nav__item--active">
|
||||
<input class="md-nav__toggle md-toggle" id="__toc" type="checkbox"/>
|
||||
<a class="md-nav__link md-nav__link--active" href="./">
|
||||
<span class="md-ellipsis">
|
||||
Home
|
||||
|
||||
</span>
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="md-content" data-md-component="content">
|
||||
<article class="md-content__inner md-typeset">
|
||||
<h1 id="api-reference">API Reference</h1>
|
||||
<p><iframe class="swagger-ui-iframe" frameborder="0" id="59bba1e2" onload="this.style.display = 'block'; this.style.overflow = 'hidden'; this.style.width = '100%';" src="swagger-59bba1e2.html" style="display:none;" width="100%"></iframe></p>
|
||||
</article>
|
||||
</div>
|
||||
<script>var tabs=__md_get("__tabs");if(Array.isArray(tabs))e:for(var set of document.querySelectorAll(".tabbed-set")){var labels=set.querySelector(".tabbed-labels");for(var tab of tabs)for(var label of labels.getElementsByTagName("label"))if(label.innerText.trim()===tab){var input=document.getElementById(label.htmlFor);input.checked=!0;continue e}}</script>
|
||||
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
|
||||
</div>
|
||||
<button class="md-top md-icon" data-md-component="top" hidden="" type="button">
|
||||
<svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"></path></svg>
|
||||
Back to top
|
||||
</button>
|
||||
</main>
|
||||
<footer class="md-footer">
|
||||
<div class="md-footer-meta md-typeset">
|
||||
<div class="md-footer-meta__inner md-grid">
|
||||
<div class="md-copyright">
|
||||
|
||||
|
||||
Made with
|
||||
<a href="https://squidfunk.github.io/mkdocs-material/" rel="noopener" target="_blank">
|
||||
Material for MkDocs
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
<div class="md-dialog" data-md-component="dialog">
|
||||
<div class="md-dialog__inner md-typeset"></div>
|
||||
</div>
|
||||
<script id="__config" type="application/json">{"base": "..", "features": ["navigation.sections", "navigation.expand", "navigation.top", "navigation.instant", "navigation.tracking", "navigation.indexes", "content.code.copy", "content.code.annotate", "content.tabs.link", "content.action.edit", "search.highlight", "search.share", "search.suggest", "toc.integrate", "header.autohide", "announce.dismiss", "footer.social", "content.code.select", "content.code.line_numbers", "content.tooltips"], "search": "../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
|
||||
<script src="../assets/javascripts/bundle.f55a23d4.min.js"></script>
|
||||
<script>document$.subscribe(() => {
|
||||
window.update_swagger_ui_iframe_height = function (id) {
|
||||
var iFrameID = document.getElementById(id);
|
||||
if (iFrameID) {
|
||||
full_height = (iFrameID.contentWindow.document.body.scrollHeight + 80) + "px";
|
||||
iFrameID.height = full_height;
|
||||
iFrameID.style.height = full_height;
|
||||
}
|
||||
}
|
||||
|
||||
let iframe_id_list = []
|
||||
var iframes = document.getElementsByClassName("swagger-ui-iframe");
|
||||
for (var i = 0; i < iframes.length; i++) {
|
||||
iframe_id_list.push(iframes[i].getAttribute("id"))
|
||||
}
|
||||
let ticking = false;
|
||||
document.addEventListener('scroll', function(e) {
|
||||
if (!ticking) {
|
||||
window.requestAnimationFrame(()=> {
|
||||
let half_vh = window.innerHeight/2;
|
||||
for(var i = 0; i < iframe_id_list.length; i++) {
|
||||
let element = document.getElementById(iframe_id_list[i])
|
||||
if(element==null){
|
||||
return
|
||||
}
|
||||
let diff = element.getBoundingClientRect().top
|
||||
if(element.contentWindow.update_top_val){
|
||||
element.contentWindow.update_top_val(half_vh - diff)
|
||||
}
|
||||
}
|
||||
ticking = false;
|
||||
});
|
||||
ticking = true;
|
||||
}
|
||||
});
|
||||
|
||||
const dark_scheme_name = "slate"
|
||||
|
||||
const schemeAttr = document.body.getAttribute("data-md-color-scheme");
|
||||
const isMediaPrefersScheme = document.body.getAttribute("data-md-color-media") === "(prefers-color-scheme: dark)";
|
||||
|
||||
if (!isMediaPrefersScheme) {
|
||||
window.__init_is_dark_mode = (schemeAttr === dark_scheme_name);
|
||||
} else {
|
||||
const computedScheme = window.getComputedStyle(document.body).getPropertyValue('color-scheme');
|
||||
window.__init_is_dark_mode = computedScheme === "dark";
|
||||
}
|
||||
const options = {
|
||||
attributeFilter: ['data-md-color-scheme'],
|
||||
};
|
||||
function color_scheme_callback(mutations) {
|
||||
for (let mutation of mutations) {
|
||||
if (mutation.attributeName === "data-md-color-scheme") {
|
||||
scheme = document.body.getAttribute("data-md-color-scheme")
|
||||
var iframe_list = document.getElementsByClassName("swagger-ui-iframe")
|
||||
for(var i = 0; i < iframe_list.length; i++) {
|
||||
var ele = iframe_list.item(i);
|
||||
if (ele) {
|
||||
if (scheme === dark_scheme_name) {
|
||||
ele.contentWindow.enable_dark_mode();
|
||||
} else {
|
||||
ele.contentWindow.disable_dark_mode();
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
observer = new MutationObserver(color_scheme_callback);
|
||||
observer.observe(document.body, options);
|
||||
})</script></body>
|
||||
</html>
|
||||
562
auth-server/api/openapi.json
Normal file
562
auth-server/api/openapi.json
Normal file
@@ -0,0 +1,562 @@
|
||||
{
|
||||
"openapi": "3.1.0",
|
||||
"info": {
|
||||
"title": "Aetoskia Auth Server",
|
||||
"description": "\n The Aetoskia Authentication Service.\n\n Provides identity, access control, and JWT token issuance for the Aetoskia\n ecosystem. Fully async, built with FastAPI and MongoDB.\n ",
|
||||
"termsOfService": "https://aetoskia.com/terms",
|
||||
"contact": {
|
||||
"name": "Aetoskia Dev Team",
|
||||
"url": "https://dev.aetoskia.com/contact",
|
||||
"email": "dev@aetoskia.com"
|
||||
},
|
||||
"license": {
|
||||
"name": "MIT License",
|
||||
"url": "https://opensource.org/licenses/MIT"
|
||||
},
|
||||
"version": "0.0.5"
|
||||
},
|
||||
"servers": [
|
||||
{
|
||||
"url": "https://auth.aetoskia.com",
|
||||
"description": "Production Authentication Service"
|
||||
},
|
||||
{
|
||||
"url": "http://server-pi:9002",
|
||||
"description": "Internal staging environment"
|
||||
},
|
||||
{
|
||||
"url": "http://localhost:8000",
|
||||
"description": "Local development server"
|
||||
}
|
||||
],
|
||||
"paths": {
|
||||
"/register": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Auth"
|
||||
],
|
||||
"summary": "Register a new user",
|
||||
"description": "Creates a new user account and returns the public user profile.",
|
||||
"operationId": "create_user_register_post",
|
||||
"requestBody": {
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/RegisterRequest"
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": true
|
||||
},
|
||||
"responses": {
|
||||
"201": {
|
||||
"description": "Successful Response",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/PublicUser"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"422": {
|
||||
"description": "Validation Error",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/HTTPValidationError"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/login": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Auth"
|
||||
],
|
||||
"summary": "Login user",
|
||||
"description": "Authenticates a user and issues a JWT access token.",
|
||||
"operationId": "login_login_post",
|
||||
"requestBody": {
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/LoginRequest"
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": true
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/LoginResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"422": {
|
||||
"description": "Validation Error",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/HTTPValidationError"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/me": {
|
||||
"get": {
|
||||
"tags": [
|
||||
"Auth"
|
||||
],
|
||||
"summary": "Get current user",
|
||||
"description": "Returns the currently authenticated user's public profile.",
|
||||
"operationId": "read_users_me_me_get",
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/PublicUser"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"security": [
|
||||
{
|
||||
"HTTPBearer": []
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"/logout": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Auth"
|
||||
],
|
||||
"summary": "Logout user",
|
||||
"description": "Stateless logout endpoint. The client must discard the JWT access token.",
|
||||
"operationId": "logout_logout_post",
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/LogoutResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"security": [
|
||||
{
|
||||
"HTTPBearer": []
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"/introspect": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Auth",
|
||||
"Internal"
|
||||
],
|
||||
"summary": "Token introspection (internal)",
|
||||
"description": "Internal service-to-service endpoint for verifying JWTs. Not intended for direct client use.",
|
||||
"operationId": "introspect_introspect_post",
|
||||
"requestBody": {
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/IntrospectRequest"
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": true
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/IntrospectResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"422": {
|
||||
"description": "Validation Error",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/HTTPValidationError"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/health": {
|
||||
"get": {
|
||||
"tags": [
|
||||
"Health"
|
||||
],
|
||||
"summary": "Health Check",
|
||||
"operationId": "health_check_health_get",
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"components": {
|
||||
"schemas": {
|
||||
"HTTPValidationError": {
|
||||
"properties": {
|
||||
"detail": {
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/ValidationError"
|
||||
},
|
||||
"type": "array",
|
||||
"title": "Detail"
|
||||
}
|
||||
},
|
||||
"type": "object",
|
||||
"title": "HTTPValidationError"
|
||||
},
|
||||
"IntrospectRequest": {
|
||||
"properties": {
|
||||
"token": {
|
||||
"type": "string",
|
||||
"title": "Token",
|
||||
"description": "JWT access token to introspect",
|
||||
"examples": [
|
||||
"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
|
||||
]
|
||||
}
|
||||
},
|
||||
"type": "object",
|
||||
"required": [
|
||||
"token"
|
||||
],
|
||||
"title": "IntrospectRequest",
|
||||
"description": "Payload for requesting token introspection.\n\nUsed by internal services to verify the validity of a JWT and retrieve\nthe associated public user information.\n\nFields:\n token: JWT access token to introspect.\n\nNotes:\n - Intended for service-to-service communication.\n - Not meant for direct end-user consumption.",
|
||||
"example": {
|
||||
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
|
||||
}
|
||||
},
|
||||
"IntrospectResponse": {
|
||||
"properties": {
|
||||
"active": {
|
||||
"type": "boolean",
|
||||
"title": "Active",
|
||||
"description": "Indicates whether the provided token is valid and active",
|
||||
"examples": [
|
||||
true,
|
||||
false
|
||||
]
|
||||
},
|
||||
"user": {
|
||||
"anyOf": [
|
||||
{
|
||||
"$ref": "#/components/schemas/PublicUser"
|
||||
},
|
||||
{
|
||||
"type": "null"
|
||||
}
|
||||
],
|
||||
"description": "Public user details if the token is valid; null otherwise"
|
||||
}
|
||||
},
|
||||
"type": "object",
|
||||
"required": [
|
||||
"active"
|
||||
],
|
||||
"title": "IntrospectResponse",
|
||||
"description": "Result of a token introspection operation.\n\nThis model communicates whether a JWT is valid and, if so, provides\nthe associated public user information.\n\nFields:\n active: Indicates whether the token is valid and active.\n user: Public user details if the token is valid; otherwise null.\n\nNotes:\n - This model is designed to avoid raising exceptions.\n - All introspection outcomes are represented as data.",
|
||||
"example": {
|
||||
"active": true,
|
||||
"user": {
|
||||
"email": "tester@example.com",
|
||||
"is_active": true,
|
||||
"username": "tester"
|
||||
}
|
||||
}
|
||||
},
|
||||
"LoginRequest": {
|
||||
"properties": {
|
||||
"password": {
|
||||
"type": "string",
|
||||
"minLength": 6,
|
||||
"title": "Password",
|
||||
"description": "User password (minimum 6 characters). Stored only as a hash.",
|
||||
"examples": [
|
||||
"SuperSecure123"
|
||||
]
|
||||
},
|
||||
"username": {
|
||||
"type": "string",
|
||||
"maxLength": 50,
|
||||
"minLength": 3,
|
||||
"title": "Username",
|
||||
"description": "Unique username used for authentication and display",
|
||||
"examples": [
|
||||
"tester"
|
||||
]
|
||||
},
|
||||
"email": {
|
||||
"anyOf": [
|
||||
{
|
||||
"type": "string",
|
||||
"format": "email"
|
||||
},
|
||||
{
|
||||
"type": "null"
|
||||
}
|
||||
],
|
||||
"title": "Email",
|
||||
"description": "Primary email address associated with the account",
|
||||
"examples": [
|
||||
"tester@example.com"
|
||||
]
|
||||
}
|
||||
},
|
||||
"type": "object",
|
||||
"required": [
|
||||
"password",
|
||||
"username"
|
||||
],
|
||||
"title": "LoginRequest",
|
||||
"description": "Payload for authenticating a user and issuing a JWT.\n\nThis model is used to verify user credentials and request an access token.\n\nFields:\n username: Username identifier.\n password: Plain-text password to be verified.\n\nNotes:\n - Successful authentication results in a LoginResponse.\n - Failed authentication raises an AuthError.",
|
||||
"example": {
|
||||
"password": "SuperSecure123",
|
||||
"username": "tester"
|
||||
}
|
||||
},
|
||||
"LoginResponse": {
|
||||
"properties": {
|
||||
"access_token": {
|
||||
"type": "string",
|
||||
"title": "Access Token",
|
||||
"description": "JWT access token to be used for authenticated requests",
|
||||
"examples": [
|
||||
"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
|
||||
]
|
||||
},
|
||||
"user": {
|
||||
"$ref": "#/components/schemas/PublicUser",
|
||||
"description": "Authenticated user's public profile"
|
||||
}
|
||||
},
|
||||
"type": "object",
|
||||
"required": [
|
||||
"access_token",
|
||||
"user"
|
||||
],
|
||||
"title": "LoginResponse",
|
||||
"description": "Response returned after successful authentication.\n\nContains the issued JWT access token and the authenticated user's\npublic profile.\n\nFields:\n access_token: JWT access token for authenticated requests.\n user: Public profile of the authenticated user.\n\nNotes:\n - The token is stateless and must be stored client-side.\n - Token expiration and validation are handled elsewhere.",
|
||||
"example": {
|
||||
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
|
||||
"user": {
|
||||
"email": "tester@example.com",
|
||||
"is_active": true,
|
||||
"username": "tester"
|
||||
}
|
||||
}
|
||||
},
|
||||
"LogoutResponse": {
|
||||
"properties": {
|
||||
"message": {
|
||||
"type": "string",
|
||||
"title": "Message",
|
||||
"description": "Human-readable logout confirmation message",
|
||||
"examples": [
|
||||
"Successfully logged out"
|
||||
]
|
||||
}
|
||||
},
|
||||
"type": "object",
|
||||
"required": [
|
||||
"message"
|
||||
],
|
||||
"title": "LogoutResponse",
|
||||
"description": "Response returned after a logout operation.\n\nSince logout is stateless, this response serves only as a confirmation\nmessage instructing the client to discard its token.\n\nFields:\n message: Human-readable logout confirmation.",
|
||||
"example": {
|
||||
"message": "Successfully logged out"
|
||||
}
|
||||
},
|
||||
"PublicUser": {
|
||||
"properties": {
|
||||
"is_active": {
|
||||
"type": "boolean",
|
||||
"title": "Is Active",
|
||||
"description": "Indicates whether the account is active and allowed to authenticate",
|
||||
"default": true,
|
||||
"examples": [
|
||||
true
|
||||
]
|
||||
},
|
||||
"username": {
|
||||
"type": "string",
|
||||
"maxLength": 50,
|
||||
"minLength": 3,
|
||||
"title": "Username",
|
||||
"description": "Unique username used for authentication and display",
|
||||
"examples": [
|
||||
"tester"
|
||||
]
|
||||
},
|
||||
"email": {
|
||||
"anyOf": [
|
||||
{
|
||||
"type": "string",
|
||||
"format": "email"
|
||||
},
|
||||
{
|
||||
"type": "null"
|
||||
}
|
||||
],
|
||||
"title": "Email",
|
||||
"description": "Primary email address associated with the account",
|
||||
"examples": [
|
||||
"tester@example.com"
|
||||
]
|
||||
}
|
||||
},
|
||||
"type": "object",
|
||||
"required": [
|
||||
"username"
|
||||
],
|
||||
"title": "PublicUser",
|
||||
"description": "Public-facing user representation returned by authentication APIs.\n\nThis model represents a user profile that is safe to expose outside\nthe authentication system.\n\nFields:\n username: Unique username identifier.\n email: User's email address.\n is_active: Whether the user account is active.\n\nNotes:\n - Contains no sensitive data.\n - Can be constructed from persistence models via `from_attributes`.",
|
||||
"example": {
|
||||
"email": "tester@example.com",
|
||||
"is_active": true,
|
||||
"username": "tester"
|
||||
}
|
||||
},
|
||||
"RegisterRequest": {
|
||||
"properties": {
|
||||
"password": {
|
||||
"type": "string",
|
||||
"minLength": 6,
|
||||
"title": "Password",
|
||||
"description": "User password (minimum 6 characters). Stored only as a hash.",
|
||||
"examples": [
|
||||
"SuperSecure123"
|
||||
]
|
||||
},
|
||||
"username": {
|
||||
"type": "string",
|
||||
"maxLength": 50,
|
||||
"minLength": 3,
|
||||
"title": "Username",
|
||||
"description": "Unique username used for authentication and display",
|
||||
"examples": [
|
||||
"tester"
|
||||
]
|
||||
},
|
||||
"email": {
|
||||
"anyOf": [
|
||||
{
|
||||
"type": "string",
|
||||
"format": "email"
|
||||
},
|
||||
{
|
||||
"type": "null"
|
||||
}
|
||||
],
|
||||
"title": "Email",
|
||||
"description": "Primary email address associated with the account",
|
||||
"examples": [
|
||||
"tester@example.com"
|
||||
]
|
||||
}
|
||||
},
|
||||
"type": "object",
|
||||
"required": [
|
||||
"password",
|
||||
"username"
|
||||
],
|
||||
"title": "RegisterRequest",
|
||||
"description": "Payload for registering a new user account.\n\nThis model contains the minimum required identity and credential\ninformation to create a new user.\n\nFields:\n username: Unique username identifier.\n email: User's email address.\n password: Plain-text password (to be hashed by the repository layer).\n\nNotes:\n - Validation and normalization handled by mixins.\n - This model is never returned in responses.",
|
||||
"example": {
|
||||
"email": "tester@example.com",
|
||||
"password": "SuperSecure123",
|
||||
"username": "tester"
|
||||
}
|
||||
},
|
||||
"ValidationError": {
|
||||
"properties": {
|
||||
"loc": {
|
||||
"items": {
|
||||
"anyOf": [
|
||||
{
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"type": "integer"
|
||||
}
|
||||
]
|
||||
},
|
||||
"type": "array",
|
||||
"title": "Location"
|
||||
},
|
||||
"msg": {
|
||||
"type": "string",
|
||||
"title": "Message"
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
"title": "Error Type"
|
||||
}
|
||||
},
|
||||
"type": "object",
|
||||
"required": [
|
||||
"loc",
|
||||
"msg",
|
||||
"type"
|
||||
],
|
||||
"title": "ValidationError"
|
||||
}
|
||||
},
|
||||
"securitySchemes": {
|
||||
"HTTPBearer": {
|
||||
"type": "http",
|
||||
"scheme": "bearer"
|
||||
}
|
||||
}
|
||||
},
|
||||
"tags": [
|
||||
{
|
||||
"name": "Auth",
|
||||
"description": "Login, registration, token issuance, refresh, and identity operations."
|
||||
},
|
||||
{
|
||||
"name": "Health",
|
||||
"description": "Service health and diagnostics."
|
||||
}
|
||||
]
|
||||
}
|
||||
120
auth-server/api/swagger-59bba1e2.html
Normal file
120
auth-server/api/swagger-59bba1e2.html
Normal file
@@ -0,0 +1,120 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<title>Swagger UI</title>
|
||||
<link rel="stylesheet" type="text/css" href="../assets/stylesheets/swagger-ui.css" />
|
||||
<link rel="stylesheet" type="text/css" id="slate-css" media="none" href="../assets/stylesheets/swagger-ui-dark.css" />
|
||||
|
||||
</head>
|
||||
|
||||
<body style="overflow:hidden;">
|
||||
<div id="swagger-ui"></div>
|
||||
<script src="../assets/javascripts/swagger-ui-bundle.js" charset="UTF-8"> </script>
|
||||
<script src="../assets/javascripts/swagger-ui-standalone-preset.js" charset="UTF-8"> </script>
|
||||
<script>
|
||||
window.onload = function () {
|
||||
window.ui = SwaggerUIBundle({
|
||||
dom_id: "#swagger-ui",
|
||||
onComplete: onComplete,
|
||||
presets: [
|
||||
SwaggerUIBundle.presets.apis,
|
||||
SwaggerUIStandalonePreset
|
||||
],
|
||||
|
||||
url: "openapi.json",
|
||||
|
||||
|
||||
"oauth2RedirectUrl": new URL("../assets/swagger-ui/oauth2-redirect.html",window.location.href).href,
|
||||
|
||||
"validatorUrl": "none",
|
||||
|
||||
"docExpansion": "list",
|
||||
"filter": false,
|
||||
"tryItOutEnabled": false,
|
||||
"supportedSubmitMethods": [
|
||||
"get",
|
||||
"put",
|
||||
"post",
|
||||
"delete",
|
||||
"options",
|
||||
"head",
|
||||
"patch",
|
||||
"trace"
|
||||
],
|
||||
"validatorUrl": "none",
|
||||
"extra_css": [],
|
||||
"dark_scheme_name": "slate",
|
||||
"filter_files": [],
|
||||
"syntaxHighlight.theme": "agate"
|
||||
|
||||
})
|
||||
|
||||
|
||||
|
||||
if (parent.__init_is_dark_mode) {
|
||||
enable_dark_mode();
|
||||
}
|
||||
}
|
||||
|
||||
enable_dark_mode = function(){
|
||||
document.getElementById("slate-css").media = ""
|
||||
}
|
||||
|
||||
disable_dark_mode = function(){
|
||||
document.getElementById("slate-css").media = "none"
|
||||
}
|
||||
|
||||
const resize_ob = new ResizeObserver(function(entries) {
|
||||
parent.update_swagger_ui_iframe_height("59bba1e2");
|
||||
});
|
||||
|
||||
// start observing for resizing
|
||||
resize_ob.observe(document.querySelector("body"));
|
||||
|
||||
// authorize modal position
|
||||
var modal_top = 0;
|
||||
|
||||
const mutation_ob = new MutationObserver(function (mutations) {
|
||||
if(mutations && mutations[0].addedNodes && mutations[0].addedNodes.length > 0){
|
||||
update_modal_top()
|
||||
}
|
||||
});
|
||||
|
||||
onComplete = function(){
|
||||
// start observing for auth-wrapper after Swagger UI loaded
|
||||
const div = document.querySelector("div.auth-wrapper");
|
||||
if(div){
|
||||
mutation_ob.observe(div, {
|
||||
childList: true,
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
update_top_val = function(top){
|
||||
modal_top = top
|
||||
update_modal_top()
|
||||
}
|
||||
|
||||
update_modal_top = function(){
|
||||
let modal_list = document.getElementsByClassName('modal-ux')
|
||||
if(modal_list.length > 0){
|
||||
let modal = modal_list.item(0)
|
||||
const modal_height = modal.offsetHeight
|
||||
const padding = 60
|
||||
min = parseInt(modal_height/2 + padding)
|
||||
max = document.body.scrollHeight - min + padding
|
||||
if (modal_top < min) {
|
||||
modal.style.top = `${min}px`
|
||||
} else if (modal_top > max) {
|
||||
modal.style.top = `${max}px`
|
||||
} else {
|
||||
modal.style.top = `${modal_top}px`
|
||||
}
|
||||
}
|
||||
}
|
||||
</script>
|
||||
</body>
|
||||
|
||||
</html>
|
||||
Reference in New Issue
Block a user