Deployed 207d43b with MkDocs version: 1.6.1
This commit is contained in:
github-actions[bot]
695
api/index.html
Normal file
695
api/index.html
Normal file
@@ -0,0 +1,695 @@
|
||||
|
||||
<!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="QbitTorrent with Debrid Support" name="description"/>
|
||||
<link href="https://sirrobot01.github.io/decypharr/api/" rel="canonical"/>
|
||||
<link href="../usage/" rel="prev"/>
|
||||
<link href="../features/" rel="next"/>
|
||||
<link href="../assets/images/favicon.png" rel="icon"/>
|
||||
<meta content="mkdocs-1.6.1, mkdocs-material-9.6.16" name="generator"/>
|
||||
<title>API Documentation - Decypharr</title>
|
||||
<link href="../assets/stylesheets/main.7e37652d.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=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback" rel="stylesheet"/>
|
||||
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
|
||||
<link href="../styles/styles.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="indigo" data-md-color-primary="indigo" data-md-color-scheme="default" 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-documentation">
|
||||
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="Decypharr" class="md-header__button md-logo" data-md-component="logo" href=".." title="Decypharr">
|
||||
<img alt="logo" src="../images/logo.png"/>
|
||||
</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">
|
||||
Decypharr
|
||||
</span>
|
||||
</div>
|
||||
<div class="md-header__topic" data-md-component="header-topic">
|
||||
<span class="md-ellipsis">
|
||||
|
||||
API Documentation
|
||||
|
||||
</span>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<form class="md-header__option" data-md-component="palette">
|
||||
<input aria-label="Switch to dark mode" class="md-option" data-md-color-accent="indigo" data-md-color-media="(prefers-color-scheme: light)" data-md-color-primary="indigo" data-md-color-scheme="default" id="__palette_0" name="__palette" type="radio"/>
|
||||
<label class="md-header__button md-icon" for="__palette_1" hidden="" title="Switch to dark mode">
|
||||
<svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="m17.75 4.09-2.53 1.94.91 3.06-2.63-1.81-2.63 1.81.91-3.06-2.53-1.94L12.44 4l1.06-3 1.06 3zm3.5 6.91-1.64 1.25.59 1.98-1.7-1.17-1.7 1.17.59-1.98L15.75 11l2.06-.05L18.5 9l.69 1.95zm-2.28 4.95c.83-.08 1.72 1.1 1.19 1.85-.32.45-.66.87-1.08 1.27C15.17 23 8.84 23 4.94 19.07c-3.91-3.9-3.91-10.24 0-14.14.4-.4.82-.76 1.27-1.08.75-.53 1.93.36 1.85 1.19-.27 2.86.69 5.83 2.89 8.02a9.96 9.96 0 0 0 8.02 2.89m-1.64 2.02a12.08 12.08 0 0 1-7.8-3.47c-2.17-2.19-3.33-5-3.49-7.82-2.81 3.14-2.7 7.96.31 10.98 3.02 3.01 7.84 3.12 10.98.31"></path></svg>
|
||||
</label>
|
||||
<input aria-label="Switch to light mode" class="md-option" data-md-color-accent="indigo" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-primary="indigo" data-md-color-scheme="slate" id="__palette_1" name="__palette" type="radio"/>
|
||||
<label class="md-header__button md-icon" for="__palette_0" hidden="" title="Switch to light mode">
|
||||
<svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M12 7a5 5 0 0 1 5 5 5 5 0 0 1-5 5 5 5 0 0 1-5-5 5 5 0 0 1 5-5m0 2a3 3 0 0 0-3 3 3 3 0 0 0 3 3 3 3 0 0 0 3-3 3 3 0 0 0-3-3m0-7 2.39 3.42C13.65 5.15 12.84 5 12 5s-1.65.15-2.39.42zM3.34 7l4.16-.35A7.2 7.2 0 0 0 5.94 8.5c-.44.74-.69 1.5-.83 2.29zm.02 10 1.76-3.77a7.131 7.131 0 0 0 2.38 4.14zM20.65 7l-1.77 3.79a7.02 7.02 0 0 0-2.38-4.15zm-.01 10-4.14.36c.59-.51 1.12-1.14 1.54-1.86.42-.73.69-1.5.83-2.29zM12 22l-2.41-3.44c.74.27 1.55.44 2.41.44.82 0 1.63-.17 2.37-.44z"></path></svg>
|
||||
</label>
|
||||
</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">
|
||||
<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>
|
||||
</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>
|
||||
<div class="md-header__source">
|
||||
<a class="md-source" data-md-component="source" href="https://github.com/sirrobot01/decypharr" title="Go to repository">
|
||||
<div class="md-source__icon md-icon">
|
||||
<svg viewbox="0 0 512 512" xmlns="http://www.w3.org/2000/svg"><!--! Font Awesome Free 7.0.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2" fill="currentColor"></path></svg>
|
||||
</div>
|
||||
<div class="md-source__repository">
|
||||
sirrobot01/decypharr
|
||||
</div>
|
||||
</a>
|
||||
</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" data-md-level="0">
|
||||
<label class="md-nav__title" for="__drawer">
|
||||
<a aria-label="Decypharr" class="md-nav__button md-logo" data-md-component="logo" href=".." title="Decypharr">
|
||||
<img alt="logo" src="../images/logo.png"/>
|
||||
</a>
|
||||
Decypharr
|
||||
</label>
|
||||
<div class="md-nav__source">
|
||||
<a class="md-source" data-md-component="source" href="https://github.com/sirrobot01/decypharr" title="Go to repository">
|
||||
<div class="md-source__icon md-icon">
|
||||
<svg viewbox="0 0 512 512" xmlns="http://www.w3.org/2000/svg"><!--! Font Awesome Free 7.0.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2" fill="currentColor"></path></svg>
|
||||
</div>
|
||||
<div class="md-source__repository">
|
||||
sirrobot01/decypharr
|
||||
</div>
|
||||
</a>
|
||||
</div>
|
||||
<ul class="md-nav__list" data-md-scrollfix="">
|
||||
<li class="md-nav__item">
|
||||
<a class="md-nav__link" href="..">
|
||||
<span class="md-ellipsis">
|
||||
Home
|
||||
|
||||
</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="md-nav__item">
|
||||
<a class="md-nav__link" href="../installation/">
|
||||
<span class="md-ellipsis">
|
||||
Installation
|
||||
|
||||
</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="md-nav__item">
|
||||
<a class="md-nav__link" href="../usage/">
|
||||
<span class="md-ellipsis">
|
||||
Usage
|
||||
|
||||
</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="md-nav__item md-nav__item--active">
|
||||
<input class="md-nav__toggle md-toggle" id="__toc" type="checkbox"/>
|
||||
<label class="md-nav__link md-nav__link--active" for="__toc">
|
||||
<span class="md-ellipsis">
|
||||
API Documentation
|
||||
|
||||
</span>
|
||||
<span class="md-nav__icon md-icon"></span>
|
||||
</label>
|
||||
<a class="md-nav__link md-nav__link--active" href="./">
|
||||
<span class="md-ellipsis">
|
||||
API Documentation
|
||||
|
||||
</span>
|
||||
</a>
|
||||
<nav aria-label="Table of contents" class="md-nav md-nav--secondary">
|
||||
<label class="md-nav__title" for="__toc">
|
||||
<span class="md-nav__icon md-icon"></span>
|
||||
Table of contents
|
||||
</label>
|
||||
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix="">
|
||||
<li class="md-nav__item">
|
||||
<a class="md-nav__link" href="#authentication">
|
||||
<span class="md-ellipsis">
|
||||
Authentication
|
||||
</span>
|
||||
</a>
|
||||
<nav aria-label="Authentication" class="md-nav">
|
||||
<ul class="md-nav__list">
|
||||
<li class="md-nav__item">
|
||||
<a class="md-nav__link" href="#1-session-based-authentication-cookies">
|
||||
<span class="md-ellipsis">
|
||||
1. Session-based Authentication (Cookies)
|
||||
</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="md-nav__item">
|
||||
<a class="md-nav__link" href="#2-api-token-authentication-bearer-token">
|
||||
<span class="md-ellipsis">
|
||||
2. API Token Authentication (Bearer Token)
|
||||
</span>
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</li>
|
||||
<li class="md-nav__item">
|
||||
<a class="md-nav__link" href="#interactive-api-documentation">
|
||||
<span class="md-ellipsis">
|
||||
Interactive API Documentation
|
||||
</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="md-nav__item">
|
||||
<a class="md-nav__link" href="#api-endpoints-overview">
|
||||
<span class="md-ellipsis">
|
||||
API Endpoints Overview
|
||||
</span>
|
||||
</a>
|
||||
<nav aria-label="API Endpoints Overview" class="md-nav">
|
||||
<ul class="md-nav__list">
|
||||
<li class="md-nav__item">
|
||||
<a class="md-nav__link" href="#arrs-management">
|
||||
<span class="md-ellipsis">
|
||||
Arrs Management
|
||||
</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="md-nav__item">
|
||||
<a class="md-nav__link" href="#content-management">
|
||||
<span class="md-ellipsis">
|
||||
Content Management
|
||||
</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="md-nav__item">
|
||||
<a class="md-nav__link" href="#repair-operations">
|
||||
<span class="md-ellipsis">
|
||||
Repair Operations
|
||||
</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="md-nav__item">
|
||||
<a class="md-nav__link" href="#torrent-management">
|
||||
<span class="md-ellipsis">
|
||||
Torrent Management
|
||||
</span>
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</li>
|
||||
<li class="md-nav__item">
|
||||
<a class="md-nav__link" href="#usage-examples">
|
||||
<span class="md-ellipsis">
|
||||
Usage Examples
|
||||
</span>
|
||||
</a>
|
||||
<nav aria-label="Usage Examples" class="md-nav">
|
||||
<ul class="md-nav__list">
|
||||
<li class="md-nav__item">
|
||||
<a class="md-nav__link" href="#adding-content-via-api">
|
||||
<span class="md-ellipsis">
|
||||
Adding Content via API
|
||||
</span>
|
||||
</a>
|
||||
<nav aria-label="Adding Content via API" class="md-nav">
|
||||
<ul class="md-nav__list">
|
||||
<li class="md-nav__item">
|
||||
<a class="md-nav__link" href="#using-api-token">
|
||||
<span class="md-ellipsis">
|
||||
Using API Token:
|
||||
</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="md-nav__item">
|
||||
<a class="md-nav__link" href="#using-session-cookies">
|
||||
<span class="md-ellipsis">
|
||||
Using Session Cookies:
|
||||
</span>
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</li>
|
||||
<li class="md-nav__item">
|
||||
<a class="md-nav__link" href="#getting-torrents">
|
||||
<span class="md-ellipsis">
|
||||
Getting Torrents
|
||||
</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="md-nav__item">
|
||||
<a class="md-nav__link" href="#starting-a-repair-job">
|
||||
<span class="md-ellipsis">
|
||||
Starting a Repair Job
|
||||
</span>
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</li>
|
||||
<li class="md-nav__item md-nav__item--nested">
|
||||
<input class="md-nav__toggle md-toggle" id="__nav_5" type="checkbox"/>
|
||||
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
|
||||
<span class="md-ellipsis">
|
||||
Features
|
||||
|
||||
</span>
|
||||
<span class="md-nav__icon md-icon"></span>
|
||||
</label>
|
||||
<nav aria-expanded="false" aria-labelledby="__nav_5_label" class="md-nav" data-md-level="1">
|
||||
<label class="md-nav__title" for="__nav_5">
|
||||
<span class="md-nav__icon md-icon"></span>
|
||||
Features
|
||||
</label>
|
||||
<ul class="md-nav__list" data-md-scrollfix="">
|
||||
<li class="md-nav__item">
|
||||
<a class="md-nav__link" href="../features/">
|
||||
<span class="md-ellipsis">
|
||||
Overview
|
||||
|
||||
</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="md-nav__item">
|
||||
<a class="md-nav__link" href="../features/repair-worker/">
|
||||
<span class="md-ellipsis">
|
||||
Repair Worker
|
||||
|
||||
</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="md-nav__item">
|
||||
<a class="md-nav__link" href="../features/private-tracker-downloads/">
|
||||
<span class="md-ellipsis">
|
||||
Private Tracker Downloads
|
||||
|
||||
</span>
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</li>
|
||||
<li class="md-nav__item md-nav__item--nested">
|
||||
<input class="md-nav__toggle md-toggle" id="__nav_6" type="checkbox"/>
|
||||
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
|
||||
<span class="md-ellipsis">
|
||||
Guides
|
||||
|
||||
</span>
|
||||
<span class="md-nav__icon md-icon"></span>
|
||||
</label>
|
||||
<nav aria-expanded="false" aria-labelledby="__nav_6_label" class="md-nav" data-md-level="1">
|
||||
<label class="md-nav__title" for="__nav_6">
|
||||
<span class="md-nav__icon md-icon"></span>
|
||||
Guides
|
||||
</label>
|
||||
<ul class="md-nav__list" data-md-scrollfix="">
|
||||
<li class="md-nav__item">
|
||||
<a class="md-nav__link" href="../guides/">
|
||||
<span class="md-ellipsis">
|
||||
Overview
|
||||
|
||||
</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="md-nav__item">
|
||||
<a class="md-nav__link" href="../guides/downloading/">
|
||||
<span class="md-ellipsis">
|
||||
Manual Downloading
|
||||
|
||||
</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="md-nav__item">
|
||||
<a class="md-nav__link" href="../guides/internal-mounting/">
|
||||
<span class="md-ellipsis">
|
||||
Internal Mounting
|
||||
|
||||
</span>
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc">
|
||||
<div class="md-sidebar__scrollwrap">
|
||||
<div class="md-sidebar__inner">
|
||||
<nav aria-label="Table of contents" class="md-nav md-nav--secondary">
|
||||
<label class="md-nav__title" for="__toc">
|
||||
<span class="md-nav__icon md-icon"></span>
|
||||
Table of contents
|
||||
</label>
|
||||
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix="">
|
||||
<li class="md-nav__item">
|
||||
<a class="md-nav__link" href="#authentication">
|
||||
<span class="md-ellipsis">
|
||||
Authentication
|
||||
</span>
|
||||
</a>
|
||||
<nav aria-label="Authentication" class="md-nav">
|
||||
<ul class="md-nav__list">
|
||||
<li class="md-nav__item">
|
||||
<a class="md-nav__link" href="#1-session-based-authentication-cookies">
|
||||
<span class="md-ellipsis">
|
||||
1. Session-based Authentication (Cookies)
|
||||
</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="md-nav__item">
|
||||
<a class="md-nav__link" href="#2-api-token-authentication-bearer-token">
|
||||
<span class="md-ellipsis">
|
||||
2. API Token Authentication (Bearer Token)
|
||||
</span>
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</li>
|
||||
<li class="md-nav__item">
|
||||
<a class="md-nav__link" href="#interactive-api-documentation">
|
||||
<span class="md-ellipsis">
|
||||
Interactive API Documentation
|
||||
</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="md-nav__item">
|
||||
<a class="md-nav__link" href="#api-endpoints-overview">
|
||||
<span class="md-ellipsis">
|
||||
API Endpoints Overview
|
||||
</span>
|
||||
</a>
|
||||
<nav aria-label="API Endpoints Overview" class="md-nav">
|
||||
<ul class="md-nav__list">
|
||||
<li class="md-nav__item">
|
||||
<a class="md-nav__link" href="#arrs-management">
|
||||
<span class="md-ellipsis">
|
||||
Arrs Management
|
||||
</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="md-nav__item">
|
||||
<a class="md-nav__link" href="#content-management">
|
||||
<span class="md-ellipsis">
|
||||
Content Management
|
||||
</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="md-nav__item">
|
||||
<a class="md-nav__link" href="#repair-operations">
|
||||
<span class="md-ellipsis">
|
||||
Repair Operations
|
||||
</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="md-nav__item">
|
||||
<a class="md-nav__link" href="#torrent-management">
|
||||
<span class="md-ellipsis">
|
||||
Torrent Management
|
||||
</span>
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</li>
|
||||
<li class="md-nav__item">
|
||||
<a class="md-nav__link" href="#usage-examples">
|
||||
<span class="md-ellipsis">
|
||||
Usage Examples
|
||||
</span>
|
||||
</a>
|
||||
<nav aria-label="Usage Examples" class="md-nav">
|
||||
<ul class="md-nav__list">
|
||||
<li class="md-nav__item">
|
||||
<a class="md-nav__link" href="#adding-content-via-api">
|
||||
<span class="md-ellipsis">
|
||||
Adding Content via API
|
||||
</span>
|
||||
</a>
|
||||
<nav aria-label="Adding Content via API" class="md-nav">
|
||||
<ul class="md-nav__list">
|
||||
<li class="md-nav__item">
|
||||
<a class="md-nav__link" href="#using-api-token">
|
||||
<span class="md-ellipsis">
|
||||
Using API Token:
|
||||
</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="md-nav__item">
|
||||
<a class="md-nav__link" href="#using-session-cookies">
|
||||
<span class="md-ellipsis">
|
||||
Using Session Cookies:
|
||||
</span>
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</li>
|
||||
<li class="md-nav__item">
|
||||
<a class="md-nav__link" href="#getting-torrents">
|
||||
<span class="md-ellipsis">
|
||||
Getting Torrents
|
||||
</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="md-nav__item">
|
||||
<a class="md-nav__link" href="#starting-a-repair-job">
|
||||
<span class="md-ellipsis">
|
||||
Starting a Repair Job
|
||||
</span>
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="md-content" data-md-component="content">
|
||||
<article class="md-content__inner md-typeset">
|
||||
<h1 id="api-documentation">API Documentation<a class="headerlink" href="#api-documentation" title="Permanent link">¶</a></h1>
|
||||
<p>Decypharr provides a RESTful API for managing torrents, debrid services, and Arr integrations. The API requires authentication and all endpoints are prefixed with <code>/api</code>.</p>
|
||||
<h2 id="authentication">Authentication<a class="headerlink" href="#authentication" title="Permanent link">¶</a></h2>
|
||||
<p>The API supports two authentication methods:</p>
|
||||
<h3 id="1-session-based-authentication-cookies">1. Session-based Authentication (Cookies)<a class="headerlink" href="#1-session-based-authentication-cookies" title="Permanent link">¶</a></h3>
|
||||
<p>Log in through the web interface (<code>/login</code>) to establish an authenticated session. The session cookie (<code>auth-session</code>) will be automatically included in subsequent API requests from the same browser session.</p>
|
||||
<h3 id="2-api-token-authentication-bearer-token">2. API Token Authentication (Bearer Token)<a class="headerlink" href="#2-api-token-authentication-bearer-token" title="Permanent link">¶</a></h3>
|
||||
<p>Use API tokens for programmatic access. Include the token in the <code>Authorization</code> header for each request:</p>
|
||||
<ul>
|
||||
<li><code>Authorization: Bearer <your-token></code></li>
|
||||
</ul>
|
||||
<h2 id="interactive-api-documentation">Interactive API Documentation<a class="headerlink" href="#interactive-api-documentation" title="Permanent link">¶</a></h2>
|
||||
<p><iframe class="swagger-ui-iframe" frameborder="0" id="1990fcf4" src="swagger-1990fcf4.html" style="overflow:hidden;width:100%;" width="100%"></iframe></p>
|
||||
<h2 id="api-endpoints-overview">API Endpoints Overview<a class="headerlink" href="#api-endpoints-overview" title="Permanent link">¶</a></h2>
|
||||
<h3 id="arrs-management">Arrs Management<a class="headerlink" href="#arrs-management" title="Permanent link">¶</a></h3>
|
||||
<ul>
|
||||
<li><code>GET /api/arrs</code> - Get all configured Arr applications (Sonarr, Radarr, etc.)</li>
|
||||
</ul>
|
||||
<h3 id="content-management">Content Management<a class="headerlink" href="#content-management" title="Permanent link">¶</a></h3>
|
||||
<ul>
|
||||
<li><code>POST /api/add</code> - Add torrent files or magnet links for processing through debrid services</li>
|
||||
</ul>
|
||||
<h3 id="repair-operations">Repair Operations<a class="headerlink" href="#repair-operations" title="Permanent link">¶</a></h3>
|
||||
<ul>
|
||||
<li><code>POST /api/repair</code> - Start repair process for media items</li>
|
||||
<li><code>GET /api/repair/jobs</code> - Get all repair jobs</li>
|
||||
<li><code>POST /api/repair/jobs/{id}/process</code> - Process a specific repair job</li>
|
||||
<li><code>POST /api/repair/jobs/{id}/stop</code> - Stop a running repair job</li>
|
||||
<li><code>DELETE /api/repair/jobs</code> - Delete multiple repair jobs</li>
|
||||
</ul>
|
||||
<h3 id="torrent-management">Torrent Management<a class="headerlink" href="#torrent-management" title="Permanent link">¶</a></h3>
|
||||
<ul>
|
||||
<li><code>GET /api/torrents</code> - Get all torrents</li>
|
||||
<li><code>DELETE /api/torrents/{category}/{hash}</code> - Delete a specific torrent</li>
|
||||
<li><code>DELETE /api/torrents/</code> - Delete multiple torrents</li>
|
||||
</ul>
|
||||
<h2 id="usage-examples">Usage Examples<a class="headerlink" href="#usage-examples" title="Permanent link">¶</a></h2>
|
||||
<h3 id="adding-content-via-api">Adding Content via API<a class="headerlink" href="#adding-content-via-api" title="Permanent link">¶</a></h3>
|
||||
<h4 id="using-api-token">Using API Token:<a class="headerlink" href="#using-api-token" title="Permanent link">¶</a></h4>
|
||||
<div class="highlight"><pre><span></span><code>curl<span class="w"> </span>-H<span class="w"> </span><span class="s2">"Authorization: Bearer </span><span class="nv">$API_TOKEN</span><span class="s2">"</span><span class="w"> </span>-X<span class="w"> </span>POST<span class="w"> </span>http://localhost:8080/api/add<span class="w"> </span><span class="se">\</span>
|
||||
<span class="w"> </span>-F<span class="w"> </span><span class="s2">"arr=sonarr"</span><span class="w"> </span><span class="se">\</span>
|
||||
<span class="w"> </span>-F<span class="w"> </span><span class="s2">"debrid=realdebrid"</span><span class="w"> </span><span class="se">\</span>
|
||||
<span class="w"> </span>-F<span class="w"> </span><span class="s2">"urls=magnet:?xt=urn:btih:..."</span><span class="w"> </span><span class="se">\</span>
|
||||
<span class="w"> </span>-F<span class="w"> </span><span class="s2">"downloadUncached=true"</span>
|
||||
<span class="w"> </span>-F<span class="w"> </span><span class="s2">"file=@/path/to/torrent/file.torrent"</span>
|
||||
<span class="w"> </span>-F<span class="w"> </span><span class="s2">"callbackUrl=http://your.callback.url/endpoint"</span>
|
||||
</code></pre></div>
|
||||
<h4 id="using-session-cookies">Using Session Cookies:<a class="headerlink" href="#using-session-cookies" title="Permanent link">¶</a></h4>
|
||||
<div class="highlight"><pre><span></span><code><span class="c1"># Login first (this sets the session cookie)</span>
|
||||
curl<span class="w"> </span>-c<span class="w"> </span>cookies.txt<span class="w"> </span>-X<span class="w"> </span>POST<span class="w"> </span>http://localhost:8080/login<span class="w"> </span><span class="se">\</span>
|
||||
<span class="w"> </span>-H<span class="w"> </span><span class="s2">"Content-Type: application/json"</span><span class="w"> </span><span class="se">\</span>
|
||||
<span class="w"> </span>-d<span class="w"> </span><span class="s1">'{"username": "your_username", "password": "your_password"}'</span>
|
||||
|
||||
<span class="c1"># Then use the session cookie for API calls</span>
|
||||
curl<span class="w"> </span>-b<span class="w"> </span>cookies.txt<span class="w"> </span>-X<span class="w"> </span>POST<span class="w"> </span>http://localhost:8080/api/add<span class="w"> </span><span class="se">\</span>
|
||||
<span class="w"> </span>-F<span class="w"> </span><span class="s2">"arr=sonarr"</span><span class="w"> </span><span class="se">\</span>
|
||||
<span class="w"> </span>-F<span class="w"> </span><span class="s2">"debrid=realdebrid"</span><span class="w"> </span><span class="se">\</span>
|
||||
<span class="w"> </span>-F<span class="w"> </span><span class="s2">"urls=magnet:?xt=urn:btih:..."</span><span class="w"> </span><span class="se">\</span>
|
||||
<span class="w"> </span>-F<span class="w"> </span><span class="s2">"downloadUncached=true"</span>
|
||||
</code></pre></div>
|
||||
<h3 id="getting-torrents">Getting Torrents<a class="headerlink" href="#getting-torrents" title="Permanent link">¶</a></h3>
|
||||
<div class="highlight"><pre><span></span><code><span class="c1"># With API token</span>
|
||||
curl<span class="w"> </span>-H<span class="w"> </span><span class="s2">"Authorization: Bearer </span><span class="nv">$API_TOKEN</span><span class="s2">"</span><span class="w"> </span>-X<span class="w"> </span>GET<span class="w"> </span>http://localhost:8080/api/torrents
|
||||
</code></pre></div>
|
||||
<h3 id="starting-a-repair-job">Starting a Repair Job<a class="headerlink" href="#starting-a-repair-job" title="Permanent link">¶</a></h3>
|
||||
<div class="highlight"><pre><span></span><code><span class="c1"># With API token</span>
|
||||
curl<span class="w"> </span>-H<span class="w"> </span><span class="s2">"Authorization: Bearer </span><span class="nv">$API_TOKEN</span><span class="s2">"</span><span class="w"> </span>-X<span class="w"> </span>POST<span class="w"> </span>http://localhost:8080/api/repair<span class="w"> </span><span class="se">\</span>
|
||||
<span class="w"> </span>-H<span class="w"> </span><span class="s2">"Content-Type: application/json"</span><span class="w"> </span><span class="se">\</span>
|
||||
<span class="w"> </span>-d<span class="w"> </span><span class="s1">'{</span>
|
||||
<span class="s1"> "arrName": "sonarr",</span>
|
||||
<span class="s1"> "mediaIds": ["123", "456"],</span>
|
||||
<span class="s1"> "autoProcess": true,</span>
|
||||
<span class="s1"> "async": true</span>
|
||||
<span class="s1"> }'</span>
|
||||
</code></pre></div>
|
||||
</article>
|
||||
</div>
|
||||
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
|
||||
</div>
|
||||
</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.search.highlight", "navigation.search.suggest", "navigation.search.share", "navigation.search.suggest", "navigation.search.share", "navigation.search.highlight", "navigation.search.suggest", "navigation.search.share"], "search": "../assets/javascripts/workers/search.d50fe291.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.50899def.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"
|
||||
|
||||
window.scheme = document.body.getAttribute("data-md-color-scheme")
|
||||
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>
|
||||
120
api/swagger-1990fcf4.html
Normal file
120
api/swagger-1990fcf4.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;background: ;">
|
||||
<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: "../api-spec.yaml",
|
||||
|
||||
|
||||
"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",
|
||||
"syntaxHighlight.theme": "agate"
|
||||
|
||||
})
|
||||
|
||||
|
||||
|
||||
const scheme = parent.scheme
|
||||
if (scheme === "slate") {
|
||||
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("1990fcf4");
|
||||
});
|
||||
|
||||
// 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