3 lines
No EOL
29 KiB
HTML
3 lines
No EOL
29 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `OPEN_API_DOC` constant in crate `mcaptcha`."><meta name="keywords" content="rust, rustlang, rust-lang, OPEN_API_DOC"><title>OPEN_API_DOC in mcaptcha - Rust</title><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script id="default-settings" ></script><script src="../storage.js"></script><script src="../crates.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../favicon.svg"><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc constant"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">☰</div><a href='../mcaptcha/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><div class="sidebar-elems"><h2 class="location">Other items in<br><a href="index.html">mcaptcha</a></h2><div id="sidebar-vars" data-name="OPEN_API_DOC" data-ty="constant" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="18" height="18" alt="Pick another theme!" src="../brush.svg"></button><div id="theme-choices" role="menu"></div></div><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input"name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../settings.html" title="settings"><img width="18" height="18" alt="Change settings" src="../wheel.svg"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Constant <a href="index.html">mcaptcha</a>::<wbr><a class="constant" href="#">OPEN_API_DOC</a><button id="copy-path" onclick="copy_path(this)" title="copy path"><img src="../clipboard.svg" width="19" height="18" alt="Copy item import" title="Copy item import to clipboard"></button></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../src/mcaptcha/main.rs.html#89" title="goto source code">[src]</a></span></h1><pre class="rust const">pub const OPEN_API_DOC: &<a class="primitive" href="https://doc.rust-lang.org/1.55.0/std/primitive.str.html">str</a> = "{\"openapi\":\"3.0.0\",\"info\":{\"version\":\"0.1.0\",\"title\":\"mCaptcha/guard\"},\"servers\":[{\"url\":\"/\"}],\"paths\":{\"/api/v1/signup\":{\"post\":{\"summary\":\"Registration endpoint\",\"operationId\":\"registerUser\",\"tags\":[\"user\"],\"requestBody\":{\"required\":true,\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/RegisterUser\"},\"example\":{\"username\":\"testuser\",\"password\":\"mysuperlongandsecurepassword\",\"email\":\"testuser@example.com\"}}}},\"responses\":{\"200\":{\"description\":\"Successful registration\"},\"400\":{\"description\":\"Bad request: username contains profainity/blacklisted words or email not acceptable or password too long/short or duplicate username/password\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Error\"}}}},\"500\":{\"description\":\"Internal server error\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Error\"}}}}}}},\"/api/v1/signin\":{\"post\":{\"summary\":\"Login endpoint\",\"operationId\":\"loginUser\",\"tags\":[\"user\",\"authentication\"],\"requestBody\":{\"required\":true,\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/LoginUser\"},\"example\":{\"username\":\"testuser\",\"password\":\"mysuperlongandsecurepassword\"}}}},\"responses\":{\"200\":{\"description\":\"Successful authentication\"},\"401\":{\"description\":\"authentication failed, wrong password\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Error\"}}}},\"404\":{\"description\":\"username not found\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Error\"}}}},\"500\":{\"description\":\"Internal server error\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Error\"}}}}}}},\"/api/v1/signout\":{\"post\":{\"security\":[{\"cookieAuth\":[]}],\"summary\":\"Signout endpoint\",\"operationId\":\"signoutUser\",\"tags\":[\"user\",\"authentication\"],\"responses\":{\"200\":{\"description\":\"OK\"}}}},\"/api/v1/account/delete\":{\"post\":{\"security\":[{\"cookieAuth\":[]}],\"summary\":\"Delete account\",\"operationId\":\"deleteAccount\",\"tags\":[\"user\"],\"requestBody\":{\"required\":true,\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/DeleteUser\"},\"example\":{\"password\":\"mysuperlongandsecurepassword\"}}}},\"responses\":{\"200\":{\"description\":\"OK\"},\"401\":{\"description\":\"(cookie)authentication required or wrong password\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Error\"}}}},\"404\":{\"description\":\"username not found\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Error\"}}}},\"500\":{\"description\":\"Internal server error\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Error\"}}}}}}},\"/api/v1/account/username/exists\":{\"post\":{\"summary\":\"Check if username exists\",\"operationId\":\"usernameExists\",\"tags\":[\"user\"],\"requestBody\":{\"required\":true,\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/UserDetailCheck\"},\"example\":{\"val\":\"testuser\"}}}},\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/UserDetailCheckRes\"}}}},\"500\":{\"description\":\"Internal server error\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Error\"}}}}}}},\"/api/v1/account/email/exists\":{\"post\":{\"summary\":\"Check if email exists\",\"operationId\":\"emailExists\",\"tags\":[\"user\"],\"requestBody\":{\"required\":true,\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/UserDetailCheck\"},\"example\":{\"val\":\"testuser@example.com\"}}}},\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/UserDetailCheckRes\"}}}},\"500\":{\"description\":\"Internal server error\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Error\"}}}}}}},\"/api/v1/meta/health\":{\"get\":{\"summary\":\"Health check\",\"operationId\":\"healthCheck\",\"tags\":[\"meta\",\"health\"],\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Health\"}}}}}}},\"/api/v1/meta/build\":{\"get\":{\"summary\":\"Get server binary build details\",\"operationId\":\"buildDetails\",\"tags\":[\"meta\",\"build\"],\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/BuildDetails\"}}}}}}},\"/api/v1/mcaptcha/domain/token/add\":{\"post\":{\"security\":[{\"cookieAuth\":[]}],\"summary\":\"Add token for registered domain\",\"operationId\":\"addToken\",\"tags\":[\"mcaptcha\",\"domain\",\"token\"],\"requestBody\":{\"required\":true,\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/MCaptchaID\"}}}},\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/MCaptchaDetails\"}}}},\"400\":{\"description\":\"Bad request: Submited URI is not a URI or duplicate token name\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Error\"}}}},\"401\":{\"description\":\"authentication failed\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Error\"}}}},\"500\":{\"description\":\"Internal server error\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Error\"}}}}}}},\"/api/v1/mcaptcha/domain/token/update\":{\"post\":{\"security\":[{\"cookieAuth\":[]}],\"summary\":\"Update token key\",\"operationId\":\"updateTokenKey\",\"tags\":[\"mcaptcha\",\"domain\",\"token\"],\"requestBody\":{\"required\":true,\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/MCaptchaID\"}}}},\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/MCaptchaDetails\"}}}},\"400\":{\"description\":\"Bad request: Submited URI is not a URI or duplicate token name\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Error\"}}}},\"401\":{\"description\":\"authentication failed\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Error\"}}}},\"500\":{\"description\":\"Internal server error\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Error\"}}}}}}},\"/api/v1/mcaptcha/domain/token/get\":{\"post\":{\"security\":[{\"cookieAuth\":[]}],\"summary\":\"Get token key\",\"operationId\":\"getTokenKey\",\"tags\":[\"mcaptcha\",\"domain\",\"token\"],\"requestBody\":{\"required\":true,\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/MCaptchaID\"}}}},\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/MCaptchaDetails\"}}}},\"400\":{\"description\":\"Bad request: Submited URI is not a URI\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Error\"}}}},\"401\":{\"description\":\"authentication failed\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Error\"}}}},\"404\":{\"description\":\"token name not found\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Error\"}}}},\"500\":{\"description\":\"Internal server error\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Error\"}}}}}}},\"/api/v1/mcaptcha/domain/token/delete\":{\"post\":{\"security\":[{\"cookieAuth\":[]}],\"summary\":\"Delete token from mcaptcha\",\"operationId\":\"deleteToken\",\"tags\":[\"mcaptcha\",\"domain\",\"token\"],\"requestBody\":{\"required\":true,\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/MCaptchaID\"}}}},\"responses\":{\"200\":{\"description\":\"OK\"},\"401\":{\"description\":\"authentication failed\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Error\"}}}},\"500\":{\"description\":\"Internal server error\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Error\"}}}}}}},\"/api/v1/mcaptcha/domain/token/levels/add\":{\"post\":{\"security\":[{\"cookieAuth\":[]}],\"summary\":\"Add levels to a token\",\"operationId\":\"addTokenLevels\",\"tags\":[\"mcaptcha\",\"domain\",\"token\",\"levels\"],\"requestBody\":{\"required\":true,\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AddLevels\"}}}},\"responses\":{\"200\":{\"description\":\"OK\"},\"400\":{\"description\":\"duplicate visitor count or difficulty_factor is zero or difficulty_factor decreases with increase in visitor count\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Error\"}}}},\"401\":{\"description\":\"authentication failed\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Error\"}}}},\"500\":{\"description\":\"Internal server error\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Error\"}}}}}}},\"/api/v1/mcaptcha/domain/token/levels/update\":{\"post\":{\"security\":[{\"cookieAuth\":[]}],\"summary\":\"Update levels of a token\",\"operationId\":\"updateTokenLevels\",\"tags\":[\"mcaptcha\",\"domain\",\"token\",\"levels\"],\"requestBody\":{\"required\":true,\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AddLevels\"}}}},\"responses\":{\"200\":{\"description\":\"OK\"},\"400\":{\"description\":\"duplicate visitor count or difficulty_factor is zero or difficulty_factor decreases with increase in visitor count\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Error\"}}}},\"401\":{\"description\":\"authentication failed\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Error\"}}}},\"500\":{\"description\":\"Internal server error\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Error\"}}}}}}},\"/api/v1/mcaptcha/domain/token/levels/delete\":{\"post\":{\"security\":[{\"cookieAuth\":[]}],\"tags\":[\"mcaptcha\",\"domain\",\"token\",\"levels\"],\"summary\":\"Delete levels of a token\",\"operationId\":\"deleteTokenLevels\",\"requestBody\":{\"required\":true,\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AddLevels\"}}}},\"responses\":{\"200\":{\"description\":\"OK\"},\"401\":{\"description\":\"(cookie)authentication required or wrong password\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Error\"}}}},\"500\":{\"description\":\"Internal server error\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Error\"}}}}}}},\"/api/v1/mcaptcha/domain/token/levels/get\":{\"post\":{\"security\":[{\"cookieAuth\":[]}],\"tags\":[\"mcaptcha\",\"domain\",\"token\",\"levels\"],\"summary\":\"Get levels of a token\",\"operationId\":\"getTokenLevels\",\"requestBody\":{\"required\":true,\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AddLevels\"}}}},\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Levels\"}}}},\"401\":{\"description\":\"(cookie)authentication required or wrong password\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Error\"}}}},\"500\":{\"description\":\"Internal server error\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Error\"}}}}}}},\"/api/v1/mcaptcha/domain/token/token/get\":{\"post\":{\"security\":[{\"cookieAuth\":[]}],\"tags\":[\"mcaptcha\",\"domain\",\"token\",\"levels\",\"duration\"],\"summary\":\"Get duration of a token\",\"operationId\":\"getTokenDuration\",\"requestBody\":{\"required\":true,\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/GetDuration\"}}}},\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Duration\"}}}},\"401\":{\"description\":\"(cookie)authentication required or wrong password\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Error\"}}}},\"500\":{\"description\":\"Internal server error\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Error\"}}}}}}},\"/api/v1/mcaptcha/domain/token/token/update\":{\"post\":{\"security\":[{\"cookieAuth\":[]}],\"tags\":[\"mcaptcha\",\"domain\",\"token\",\"levels\",\"duration\"],\"summary\":\"update duration of a token\",\"operationId\":\"updateTokenDuration\",\"requestBody\":{\"required\":true,\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/UpdateDuration\"}}}},\"responses\":{\"200\":{\"description\":\"OK\"},\"400\":{\"description\":\"Bad request: Duration must be greater than 0\"},\"401\":{\"description\":\"(cookie)authentication required or wrong password\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Error\"}}}},\"500\":{\"description\":\"Internal server error\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Error\"}}}}}}}},\"components\":{\"schemas\":{\"RegisterUser\":{\"type\":\"object\",\"required\":[\"username\",\"password\",\"email\"],\"properties\":{\"username\":{\"type\":\"string\"},\"email\":{\"type\":\"string\"},\"password\":{\"type\":\"string\",\"format\":\"password\"}}},\"LoginUser\":{\"type\":\"object\",\"required\":[\"username\",\"password\"],\"properties\":{\"username\":{\"type\":\"string\"},\"password\":{\"type\":\"string\",\"format\":\"password\"}}},\"DeleteUser\":{\"type\":\"object\",\"required\":[\"password\"],\"properties\":{\"password\":{\"type\":\"string\",\"format\":\"password\"}}},\"Error\":{\"type\":\"object\",\"required\":[\"error\"],\"properties\":{\"error\":{\"type\":\"string\"}}},\"User\":{\"type\":\"object\",\"required\":[\"id\",\"name\"],\"properties\":{\"id\":{\"type\":\"integer\",\"format\":\"int64\"},\"name\":{\"type\":\"string\"}}},\"UserDetailCheck\":{\"type\":\"object\",\"required\":[\"val\"],\"properties\":{\"val\":{\"type\":\"string\"}}},\"Health\":{\"type\":\"object\",\"required\":[\"db\"],\"properties\":{\"db\":{\"type\":\"boolean\"}}},\"UserDetailCheckRes\":{\"type\":\"object\",\"required\":[\"exists\"],\"properties\":{\"val\":{\"type\":\"boolean\"}}},\"BuildDetails\":{\"type\":\"object\",\"required\":[\"version\",\"git_commit_hash\"],\"properties\":{\"version\":{\"type\":\"string\"},\"git_commit_hash\":{\"type\":\"string\"}}},\"AddDomain\":{\"type\":\"object\",\"required\":[\"name\"],\"properties\":{\"name\":{\"type\":\"string\"}}},\"DomainVerificationChallenge\":{\"type\":\"object\",\"required\":[\"verification_challenge\"],\"properties\":{\"verification_challenge\":{\"type\":\"string\"}}},\"MCaptchaID\":{\"type\":\"object\",\"required\":[\"name\",\"domain\"],\"properties\":{\"name\":{\"type\":\"string\"},\"domain\":{\"type\":\"string\"}}},\"MCaptchaDetails\":{\"type\":\"object\",\"required\":[\"name\",\"key\"],\"properties\":{\"name\":{\"type\":\"string\"},\"key\":{\"type\":\"string\"}}},\"Level\":{\"type\":\"object\",\"required\":[\"visitor_threshold\",\"difficulty_factor\"],\"properties\":{\"visitor_threshold\":{\"type\":\"number\",\"minimum\":1,\"maximum\":2147483647},\"difficulty_factor\":{\"type\":\"number\",\"minimum\":1}}},\"GetLevels\":{\"type\":\"object\",\"required\":[\"token\"],\"properties\":{\"token\":{\"type\":\"string\"}}},\"Levels\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Level\"}},\"AddLevels\":{\"type\":\"object\",\"required\":[\"name\",\"levels\"],\"properties\":{\"name\":{\"type\":\"string\"},\"levels\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Level\"}}}},\"GetDuration\":{\"type\":\"object\",\"required\":[\"token\"],\"properties\":{\"token\":{\"type\":\"string\"}}},\"Duration\":{\"type\":\"object\",\"required\":[\"duration\"],\"properties\":{\"duration\":{\"type\":\"number\",\"minimum\":1,\"maximum\":2147483647}}},\"UpdateDuration\":{\"type\":\"object\",\"required\":[\"duration\",\"token_name\"],\"properties\":{\"token_name\":{\"type\":\"string\"},\"duration\":{\"type\":\"number\",\"minimum\":1,\"maximum\":2147483647}}}},\"securitySchemes\":{\"cookieAuth\":{\"type\":\"apiKey\",\"in\":\"cookie\",\"name\":\"Authorization\"}}}}";</pre></section><section id="search" class="content hidden"></section><div id="rustdoc-vars" data-root-path="../" data-current-crate="mcaptcha" data-search-index-js="../search-index.js" data-search-js="../search.js"></div>
|
||
<script src="../main.js"></script>
|
||
</body></html> |