diff options
| -rw-r--r-- | HelpTOC.json | 1 | ||||
| -rw-r--r-- | Map.jhm | 1 | ||||
| -rw-r--r-- | config.json | 1 | ||||
| -rw-r--r-- | current.help.version | 0 | ||||
| -rw-r--r-- | index.html | 9 | ||||
| -rw-r--r-- | patchwork-api.html | 1 | ||||
| -rw-r--r-- | patchwork-archive.html | 1 | ||||
| -rw-r--r-- | vtuber-captcha.html | 100 | ||||
| -rw-r--r-- | welcome.html | 1 |
9 files changed, 115 insertions, 0 deletions
diff --git a/HelpTOC.json b/HelpTOC.json new file mode 100644 index 0000000..e1e181e --- /dev/null +++ b/HelpTOC.json @@ -0,0 +1 @@ +{"entities":{"pages":{"Welcome":{"id":"Welcome","title":"Welcome","url":"welcome.html","level":0,"tabIndex":0},"Patchwork-Archive":{"id":"Patchwork-Archive","title":"Patchwork Archive","url":"patchwork-archive.html","level":0,"pages":["Patchwork-API"],"tabIndex":1},"Patchwork-API":{"id":"Patchwork-API","title":"Patchwork Archive API","url":"patchwork-api.html","level":1,"parentId":"Patchwork-Archive","tabIndex":0},"VTuber-Captcha":{"id":"VTuber-Captcha","title":"VTuber Captcha","url":"vtuber-captcha.html","level":0,"tabIndex":2}}},"topLevelIds":["Welcome","Patchwork-Archive","VTuber-Captcha"]}
\ No newline at end of file @@ -0,0 +1 @@ +<?xml version='1.0' encoding='UTF-8'?><map version="2.0"><mapID target="Welcome.md" url="welcome.html" default="yes"/><mapID target="Welcome" url="welcome.html" default="yes"/><mapID target="Patchwork-Archive.md" url="patchwork-archive.html" default="no"/><mapID target="Patchwork-Archive" url="patchwork-archive.html" default="no"/><mapID target="Patchwork-API.md" url="patchwork-api.html" default="no"/><mapID target="Patchwork-API" url="patchwork-api.html" default="no"/><mapID target="VTuber-Captcha.md" url="vtuber-captcha.html" default="no"/><mapID target="VTuber-Captcha" url="vtuber-captcha.html" default="no"/></map>
\ No newline at end of file diff --git a/config.json b/config.json new file mode 100644 index 0000000..be9cf97 --- /dev/null +++ b/config.json @@ -0,0 +1 @@ +{"productVersion":"","productId":"hi","stage":"release","downloadTitle":"Get Project Knowledge Base","keymaps":{},"searchMaxHits":75,"productName":"Project Knowledge Base"}
\ No newline at end of file diff --git a/current.help.version b/current.help.version new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/current.help.version diff --git a/index.html b/index.html new file mode 100644 index 0000000..1072df3 --- /dev/null +++ b/index.html @@ -0,0 +1,9 @@ +<!DOCTYPE html> +<html lang="en-US"> +<meta charset="utf-8"> +<title>You will be redirected shortly</title> +<meta http-equiv="refresh" content="0; url=welcome.html"> +<h1>Redirecting…</h1> +<a href="welcome.html">Click here if you are not redirected.</a> +<script>location = "welcome.html"</script> +</html> diff --git a/patchwork-api.html b/patchwork-api.html new file mode 100644 index 0000000..32e997e --- /dev/null +++ b/patchwork-api.html @@ -0,0 +1 @@ +<!DOCTYPE html SYSTEM "about:legacy-compat"><html lang="en-US" data-colors-preset="contrast" data-primary-color="#307FFF"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="robots" content="noindex"> <meta name="built-on" content="2023-12-15T23:52:21.657995328"><meta name="build-number" content="${buildNumber}"> <title>Patchwork Archive API | Project Knowledge Base</title><script id="virtual-toc-data" type="application/json">[]</script><script id="topic-shortcuts" type="application/json"></script><link href="https://resources.jetbrains.com/writerside/apidoc/6.6.6-b205/app.css" rel="stylesheet"> <link rel="apple-touch-icon" sizes="180x180" href="https://jetbrains.com/apple-touch-icon.png"><link rel="icon" type="image/png" sizes="32x32" href="https://jetbrains.com/favicon-32x32.png"><link rel="icon" type="image/png" sizes="16x16" href="https://jetbrains.com/favicon-16x16.png"><link rel="manifest" href="https://jetbrains.com/site.webmanifest"><link rel="mask-icon" href="https://jetbrains.com/safari-pinned-tab.svg" color="#000000"><meta name="msapplication-TileColor" content="#000000"/><meta name="msapplication-TileImage" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-144x144.png"/><meta name="msapplication-square70x70logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-70x70.png"/><meta name="msapplication-square150x150logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-150x150.png"/><meta name="msapplication-wide310x150logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-310x150.png"/><meta name="msapplication-square310x310logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-310x310.png"/> <meta name="image" content=""><!-- Open Graph --><meta property="og:title" content="Patchwork Archive API | Project Knowledge Base"/><meta property="og:description" content=""/><meta property="og:image" content=""/><meta property="og:site_name" content="Project Knowledge Base Help"/><meta property="og:type" content="website"/><meta property="og:locale" content="en_US"/><meta property="og:url" content="patchwork-api.html"/><!-- End Open Graph --><!-- Twitter Card --><meta name="twitter:card" content="summary_large_image"><meta name="twitter:site" content=""><meta name="twitter:title" content="Patchwork Archive API | Project Knowledge Base"><meta name="twitter:description" content=""><meta name="twitter:creator" content=""><meta name="twitter:image:src" content=""><!-- End Twitter Card --><!-- Schema.org WebPage --><script type="application/ld+json"> { "@context": "http://schema.org", "@type": "WebPage", "@id": "patchwork-api.html#webpage", "url": "patchwork-api.html", "name": "Patchwork Archive API | Project Knowledge Base", "description": "", "image": "", "inLanguage":"en-US" }</script><!-- End Schema.org --><!-- Schema.org WebSite --><script type="application/ld+json"> { "@type": "WebSite", "@id": "/#website", "url": "/", "name": "Project Knowledge Base Help" }</script><!-- End Schema.org --></head> <body data-id="Patchwork-API" data-main-title="Patchwork Archive API" data-article-props="{"seeAlsoStyle":"links"}" data-template="article" data-breadcrumbs="Patchwork-Archive.md|Patchwork Archive" > <div class="wrapper"><main class="panel _main"><header class="panel__header"><div class="container"><h3>Project Knowledge Base Help</h3><div class="panel-trigger"></div></div></header><section class="panel__content"><div class="container"><article class="article" data-shortcut-switcher="inactive"><h1 data-toc="Patchwork-API" id="Patchwork-API.md">Patchwork Archive API</h1> <p id="57782b5c_3479">API data from Patchwork Archive is public and <span class="control" id="57782b5c_3480">no API key</span> is required to access what is publicly available on the frontend.</p><p id="57782b5c_3481">Below is an offering of what endpoints are available publicly. If you are for whatever reason hosting an instance of <span class="control" id="57782b5c_3482">Patchwork-Backend</span> please refer to the <span class="control" id="57782b5c_3483">README</span> in the repository for worker and queuer API endpoints <section class="chapter"><h2 id="57782b5c_3484" data-toc="57782b5c_3484" >Gets archived videos from a particular channel</h2><div class="api-endpoint"><img alt="GET method" src="https://img.shields.io/badge/-GET-167DFF" title="GET method"><copier tooltip-text="Copy path: /channel/{channel_id}"><span>/channel/{channel_id}</span></copier></div><p id="57782b5c_3486">Gets a paginated result of archived videos matching a channel id</p><section class="chapter"><h3 id="57782b5c_3487" data-toc="57782b5c_3487" >Request parameters</h3><api-block data-chapter-level="3"><primary-column><api-param-group id="57782b5c_3489" master-collapse="true" data-chapter-level="3"><script type="application/json">{"header":"Path","contents":[{"id":"api_doc_1","name":"channel_id","description":"YouTube Channel ID","required":"true","typeName":"string","typeKind":"PRIMITIVE","contentsLabel":"Child attributes"}],"kind":"ApiParamGroup"}</script></api-param-group><api-param-group id="57782b5c_3490" master-collapse="true" data-chapter-level="3"><script type="application/json">{"header":"Query","contents":[{"id":"api_doc_2","name":"page","description":"Page of video to show (starts on page 1)","required":"true","typeName":"integer","typeKind":"PRIMITIVE","contentsLabel":"Child attributes"}],"kind":"ApiParamGroup"}</script></api-param-group></primary-column><secondary-column></secondary-column></api-block></section><section class="chapter"><h3 id="57782b5c_3491" data-toc="57782b5c_3491" >Responses</h3><api-block data-chapter-level="3"><primary-column><api-param-group id="57782b5c_3492" master-collapse="true" data-chapter-level="3"><script type="application/json">{ "contents" : [{"statusCode":"200","statusType":"OK","name":"successful operation","description":"successful operation","contentType":["application/json"],"contents":[{"id":"api_doc_7","name":"application/json","typeName":"Array of Video","typeKind":"ARRAY","recursive":false,"contentsLabel":"Child attributes","contents":[{"id":"api_doc_1","name":"channel_id","required":"true","typeName":"string","typeKind":"PRIMITIVE","contentsLabel":"Child attributes"},{"id":"api_doc_2","name":"channel_name","required":"true","typeName":"string","typeKind":"PRIMITIVE","contentsLabel":"Child attributes"},{"id":"api_doc_3","name":"description","required":"true","typeName":"string","typeKind":"PRIMITIVE","contentsLabel":"Child attributes"},{"id":"api_doc_4","name":"title","required":"true","typeName":"string","typeKind":"PRIMITIVE","contentsLabel":"Child attributes"},{"id":"api_doc_5","name":"upload_date","required":"true","typeName":"string","typeKind":"PRIMITIVE","contentsLabel":"Child attributes"},{"id":"api_doc_6","name":"video_id","required":"true","typeName":"string","typeKind":"PRIMITIVE","contentsLabel":"Child attributes"}]}],"kind":"ApiResponse"}] }</script></api-param-group></primary-column><secondary-column></secondary-column></api-block></section></section><section class="chapter"><h2 id="57782b5c_3494" data-toc="57782b5c_3494" >Gets archived videos from a particular channel</h2><div class="api-endpoint"><img alt="GET method" src="https://img.shields.io/badge/-GET-167DFF" title="GET method"><copier tooltip-text="Copy path: /channel_name"><span>/channel_name</span></copier></div><p id="57782b5c_3496">Gets a paginated result of archived videos matching a channel id</p><section class="chapter"><h3 id="57782b5c_3497" data-toc="57782b5c_3497" >Request parameters</h3><api-block data-chapter-level="3"><primary-column><api-param-group id="57782b5c_3499" master-collapse="true" data-chapter-level="3"><script type="application/json">{"header":"Query","contents":[{"id":"api_doc_1","name":"channel_id","description":"YouTube Channel ID","required":"true","typeName":"string","typeKind":"PRIMITIVE","contentsLabel":"Child attributes"}],"kind":"ApiParamGroup"}</script></api-param-group></primary-column><secondary-column></secondary-column></api-block></section><section class="chapter"><h3 id="57782b5c_3500" data-toc="57782b5c_3500" >Responses</h3><api-block data-chapter-level="3"><primary-column><api-param-group id="57782b5c_3501" master-collapse="true" data-chapter-level="3"><script type="application/json">{ "contents" : [{"statusCode":"200","statusType":"OK","name":"successful operation","description":"successful operation","contentType":["application/json"],"contents":[{"id":"api_doc_2","name":"application/json","typeName":"object","typeKind":"OBJECT","recursive":false,"contentsLabel":"Child attributes","contents":[{"id":"api_doc_1","name":"channel_name","typeName":"string","typeKind":"PRIMITIVE","contentsLabel":"Child attributes"}]}],"kind":"ApiResponse"}] }</script></api-param-group></primary-column><secondary-column></secondary-column></api-block></section></section><section class="chapter"><h2 id="57782b5c_3503" data-toc="57782b5c_3503" >Get basic information regarding a specific video</h2><div class="api-endpoint"><img alt="GET method" src="https://img.shields.io/badge/-GET-167DFF" title="GET method"><copier tooltip-text="Copy path: /video/{video_id}"><span>/video/{video_id}</span></copier></div><p id="57782b5c_3505">Pulls basic information about a video from fallback database only</p><section class="chapter"><h3 id="57782b5c_3506" data-toc="57782b5c_3506" >Request parameters</h3><api-block data-chapter-level="3"><primary-column><api-param-group id="57782b5c_3508" master-collapse="true" data-chapter-level="3"><script type="application/json">{"header":"Path","contents":[{"id":"api_doc_1","name":"video_id","description":"YouTube Video ID","required":"true","typeName":"string","typeKind":"PRIMITIVE","contentsLabel":"Child attributes"}],"kind":"ApiParamGroup"}</script></api-param-group></primary-column><secondary-column></secondary-column></api-block></section><section class="chapter"><h3 id="57782b5c_3509" data-toc="57782b5c_3509" >Responses</h3><api-block data-chapter-level="3"><primary-column><api-param-group id="57782b5c_3510" master-collapse="true" data-chapter-level="3"><script type="application/json">{ "contents" : [{"statusCode":"200","statusType":"OK","name":"successful operation","description":"successful operation","contentType":["application/json"],"contents":[{"id":"api_doc_7","name":"application/json","typeName":"object","typeKind":"OBJECT","recursive":false,"contentsLabel":"Child attributes","contents":[{"id":"api_doc_1","name":"channel_id","typeName":"string","typeKind":"PRIMITIVE","contentsLabel":"Child attributes"},{"id":"api_doc_2","name":"channel_name","typeName":"string","typeKind":"PRIMITIVE","contentsLabel":"Child attributes"},{"id":"api_doc_3","name":"description","typeName":"string","typeKind":"PRIMITIVE","contentsLabel":"Child attributes"},{"id":"api_doc_4","name":"title","typeName":"string","typeKind":"PRIMITIVE","contentsLabel":"Child attributes"},{"id":"api_doc_5","name":"upload_date","typeName":"string","typeKind":"PRIMITIVE","contentsLabel":"Child attributes"},{"id":"api_doc_6","name":"video_id","typeName":"string","typeKind":"PRIMITIVE","contentsLabel":"Child attributes"}]}],"kind":"ApiResponse"}, {"statusCode":"404","statusType":"ERROR","name":"Video not found","description":"Video not found","contentType":["application/json"],"contents":[{"id":"api_doc_2","name":"application/json","typeName":"object","typeKind":"OBJECT","recursive":false,"contentsLabel":"Child attributes","contents":[{"id":"api_doc_1","name":"error","typeName":"string","typeKind":"PRIMITIVE","contentsLabel":"Child attributes"}]}],"kind":"ApiResponse"}] }</script></api-param-group></primary-column><secondary-column></secondary-column></api-block></section></section><section class="chapter"><h2 id="57782b5c_3514" data-toc="57782b5c_3514" >Get a singular random video</h2><div class="api-endpoint"><img alt="GET method" src="https://img.shields.io/badge/-GET-167DFF" title="GET method"><copier tooltip-text="Copy path: /random_video"><span>/random_video</span></copier></div><section class="chapter"><h3 id="57782b5c_3516" data-toc="57782b5c_3516" >Responses</h3><api-block data-chapter-level="3"><primary-column><api-param-group id="57782b5c_3517" master-collapse="true" data-chapter-level="3"><script type="application/json">{ "contents" : [{"statusCode":"200","statusType":"OK","name":"successful operation","description":"successful operation","contentType":["application/json"],"contents":[{"id":"api_doc_7","name":"application/json","typeName":"Video","typeKind":"OBJECT","recursive":false,"contentsLabel":"Child attributes","contents":[{"id":"api_doc_1","name":"channel_id","required":"true","typeName":"string","typeKind":"PRIMITIVE","contentsLabel":"Child attributes"},{"id":"api_doc_2","name":"channel_name","required":"true","typeName":"string","typeKind":"PRIMITIVE","contentsLabel":"Child attributes"},{"id":"api_doc_3","name":"description","required":"true","typeName":"string","typeKind":"PRIMITIVE","contentsLabel":"Child attributes"},{"id":"api_doc_4","name":"title","required":"true","typeName":"string","typeKind":"PRIMITIVE","contentsLabel":"Child attributes"},{"id":"api_doc_5","name":"upload_date","required":"true","typeName":"string","typeKind":"PRIMITIVE","contentsLabel":"Child attributes"},{"id":"api_doc_6","name":"video_id","required":"true","typeName":"string","typeKind":"PRIMITIVE","contentsLabel":"Child attributes"}]}],"kind":"ApiResponse"}] }</script></api-param-group></primary-column><secondary-column></secondary-column></api-block></section></section><section class="chapter"><h2 id="57782b5c_3519" data-toc="57782b5c_3519" >Get multiple random videos</h2><div class="api-endpoint"><img alt="GET method" src="https://img.shields.io/badge/-GET-167DFF" title="GET method"><copier tooltip-text="Copy path: /discover_videos"><span>/discover_videos</span></copier></div><section class="chapter"><h3 id="57782b5c_3521" data-toc="57782b5c_3521" >Request parameters</h3><api-block data-chapter-level="3"><primary-column><api-param-group id="57782b5c_3523" master-collapse="true" data-chapter-level="3"><script type="application/json">{"header":"Query","contents":[{"id":"api_doc_1","name":"count","description":"Number of random videos to get (default\u003d1)","typeName":"integer","typeKind":"PRIMITIVE","contentsLabel":"Child attributes"}],"kind":"ApiParamGroup"}</script></api-param-group></primary-column><secondary-column></secondary-column></api-block></section><section class="chapter"><h3 id="57782b5c_3524" data-toc="57782b5c_3524" >Responses</h3><api-block data-chapter-level="3"><primary-column><api-param-group id="57782b5c_3525" master-collapse="true" data-chapter-level="3"><script type="application/json">{ "contents" : [{"statusCode":"200","statusType":"OK","name":"successful operation","description":"successful operation","contentType":["application/json"],"contents":[{"id":"api_doc_7","name":"application/json","typeName":"Array of Video","typeKind":"ARRAY","recursive":false,"contentsLabel":"Child attributes","contents":[{"id":"api_doc_1","name":"channel_id","required":"true","typeName":"string","typeKind":"PRIMITIVE","contentsLabel":"Child attributes"},{"id":"api_doc_2","name":"channel_name","required":"true","typeName":"string","typeKind":"PRIMITIVE","contentsLabel":"Child attributes"},{"id":"api_doc_3","name":"description","required":"true","typeName":"string","typeKind":"PRIMITIVE","contentsLabel":"Child attributes"},{"id":"api_doc_4","name":"title","required":"true","typeName":"string","typeKind":"PRIMITIVE","contentsLabel":"Child attributes"},{"id":"api_doc_5","name":"upload_date","required":"true","typeName":"string","typeKind":"PRIMITIVE","contentsLabel":"Child attributes"},{"id":"api_doc_6","name":"video_id","required":"true","typeName":"string","typeKind":"PRIMITIVE","contentsLabel":"Child attributes"}]}],"kind":"ApiResponse"}] }</script></api-param-group></primary-column><secondary-column></secondary-column></api-block></section></section><section class="chapter"><h2 id="57782b5c_3527" data-toc="57782b5c_3527" >Get paginated search results for some keyword</h2><div class="api-endpoint"><img alt="GET method" src="https://img.shields.io/badge/-GET-167DFF" title="GET method"><copier tooltip-text="Copy path: /search/results"><span>/search/results</span></copier></div><section class="chapter"><h3 id="57782b5c_3529" data-toc="57782b5c_3529" >Request parameters</h3><api-block data-chapter-level="3"><primary-column><api-param-group id="57782b5c_3531" master-collapse="true" data-chapter-level="3"><script type="application/json">{"header":"Query","contents":[{"id":"api_doc_1","name":"q","description":"Keywords to search for","required":"true","typeName":"string","typeKind":"PRIMITIVE","contentsLabel":"Child attributes"},{"id":"api_doc_2","name":"page","description":"Page number for results (default\u003d1)","typeName":"integer","typeKind":"PRIMITIVE","contentsLabel":"Child attributes"}],"kind":"ApiParamGroup"}</script></api-param-group></primary-column><secondary-column></secondary-column></api-block></section><section class="chapter"><h3 id="57782b5c_3532" data-toc="57782b5c_3532" >Responses</h3><api-block data-chapter-level="3"><primary-column><api-param-group id="57782b5c_3533" master-collapse="true" data-chapter-level="3"><script type="application/json">{ "contents" : [{"statusCode":"200","statusType":"OK","name":"successful operation","description":"successful operation","contentType":["application/json"],"contents":[{"id":"api_doc_7","name":"application/json","typeName":"Array of Video","typeKind":"ARRAY","recursive":false,"contentsLabel":"Child attributes","contents":[{"id":"api_doc_1","name":"channel_id","required":"true","typeName":"string","typeKind":"PRIMITIVE","contentsLabel":"Child attributes"},{"id":"api_doc_2","name":"channel_name","required":"true","typeName":"string","typeKind":"PRIMITIVE","contentsLabel":"Child attributes"},{"id":"api_doc_3","name":"description","required":"true","typeName":"string","typeKind":"PRIMITIVE","contentsLabel":"Child attributes"},{"id":"api_doc_4","name":"title","required":"true","typeName":"string","typeKind":"PRIMITIVE","contentsLabel":"Child attributes"},{"id":"api_doc_5","name":"upload_date","required":"true","typeName":"string","typeKind":"PRIMITIVE","contentsLabel":"Child attributes"},{"id":"api_doc_6","name":"video_id","required":"true","typeName":"string","typeKind":"PRIMITIVE","contentsLabel":"Child attributes"}]}],"kind":"ApiResponse"}] }</script></api-param-group></primary-column><secondary-column></secondary-column></api-block></section></section><section class="chapter"><h2 id="57782b5c_3535" data-toc="57782b5c_3535" >Get today's daily features videos</h2><div class="api-endpoint"><img alt="GET method" src="https://img.shields.io/badge/-GET-167DFF" title="GET method"><copier tooltip-text="Copy path: /daily_featured_videos"><span>/daily_featured_videos</span></copier></div><p id="57782b5c_3537">Either 1 or 2 video objects in an array depending on calculated hash</p><section class="chapter"><h3 id="57782b5c_3538" data-toc="57782b5c_3538" >Responses</h3><api-block data-chapter-level="3"><primary-column><api-param-group id="57782b5c_3539" master-collapse="true" data-chapter-level="3"><script type="application/json">{ "contents" : [{"statusCode":"200","statusType":"OK","name":"successful operation","description":"successful operation","contentType":["application/json"],"contents":[{"id":"api_doc_7","name":"application/json","typeName":"Array of Video","typeKind":"ARRAY","recursive":false,"contentsLabel":"Child attributes","contents":[{"id":"api_doc_1","name":"channel_id","required":"true","typeName":"string","typeKind":"PRIMITIVE","contentsLabel":"Child attributes"},{"id":"api_doc_2","name":"channel_name","required":"true","typeName":"string","typeKind":"PRIMITIVE","contentsLabel":"Child attributes"},{"id":"api_doc_3","name":"description","required":"true","typeName":"string","typeKind":"PRIMITIVE","contentsLabel":"Child attributes"},{"id":"api_doc_4","name":"title","required":"true","typeName":"string","typeKind":"PRIMITIVE","contentsLabel":"Child attributes"},{"id":"api_doc_5","name":"upload_date","required":"true","typeName":"string","typeKind":"PRIMITIVE","contentsLabel":"Child attributes"},{"id":"api_doc_6","name":"video_id","required":"true","typeName":"string","typeKind":"PRIMITIVE","contentsLabel":"Child attributes"}]}],"kind":"ApiResponse"}] }</script></api-param-group></primary-column><secondary-column></secondary-column></api-block></section></section><section class="chapter"><h2 id="57782b5c_3541" data-toc="57782b5c_3541" >Get the 6 most recently archived videos</h2><div class="api-endpoint"><img alt="GET method" src="https://img.shields.io/badge/-GET-167DFF" title="GET method"><copier tooltip-text="Copy path: /recently_archived"><span>/recently_archived</span></copier></div><section class="chapter"><h3 id="57782b5c_3543" data-toc="57782b5c_3543" >Responses</h3><api-block data-chapter-level="3"><primary-column><api-param-group id="57782b5c_3544" master-collapse="true" data-chapter-level="3"><script type="application/json">{ "contents" : [{"statusCode":"200","statusType":"OK","name":"successful operation","description":"successful operation","contentType":["application/json"],"contents":[{"id":"api_doc_7","name":"application/json","typeName":"Array of Video","typeKind":"ARRAY","recursive":false,"contentsLabel":"Child attributes","contents":[{"id":"api_doc_1","name":"channel_id","required":"true","typeName":"string","typeKind":"PRIMITIVE","contentsLabel":"Child attributes"},{"id":"api_doc_2","name":"channel_name","required":"true","typeName":"string","typeKind":"PRIMITIVE","contentsLabel":"Child attributes"},{"id":"api_doc_3","name":"description","required":"true","typeName":"string","typeKind":"PRIMITIVE","contentsLabel":"Child attributes"},{"id":"api_doc_4","name":"title","required":"true","typeName":"string","typeKind":"PRIMITIVE","contentsLabel":"Child attributes"},{"id":"api_doc_5","name":"upload_date","required":"true","typeName":"string","typeKind":"PRIMITIVE","contentsLabel":"Child attributes"},{"id":"api_doc_6","name":"video_id","required":"true","typeName":"string","typeKind":"PRIMITIVE","contentsLabel":"Child attributes"}]}],"kind":"ApiResponse"}] }</script></api-param-group></primary-column><secondary-column></secondary-column></api-block></section></section><section class="chapter"><h2 id="57782b5c_3546" data-toc="57782b5c_3546" >Get detailed information about the video if available</h2><div class="api-endpoint"><img alt="GET method" src="https://img.shields.io/badge/-GET-167DFF" title="GET method"><copier tooltip-text="Copy path: /database/video_data/{video_id}"><span>/database/video_data/{video_id}</span></copier></div><p id="57782b5c_3548">If info.json generated by yt-dlp is available it will be directly delivered here, if not, fallback video data from the database is used instead</p><section class="chapter"><h3 id="57782b5c_3549" data-toc="57782b5c_3549" >Request parameters</h3><api-block data-chapter-level="3"><primary-column><api-param-group id="57782b5c_3551" master-collapse="true" data-chapter-level="3"><script type="application/json">{"header":"Path","contents":[{"id":"api_doc_1","name":"video_id","description":"YouTube Video ID","required":"true","typeName":"string","typeKind":"PRIMITIVE","contentsLabel":"Child attributes"}],"kind":"ApiParamGroup"}</script></api-param-group></primary-column><secondary-column></secondary-column></api-block></section><section class="chapter"><h3 id="57782b5c_3552" data-toc="57782b5c_3552" >Responses</h3><api-block data-chapter-level="3"><primary-column><api-param-group id="57782b5c_3553" master-collapse="true" data-chapter-level="3"><script type="application/json">{ "contents" : [{"statusCode":"200","statusType":"OK","name":"successful operation.","description":"successful operation.","contentType":["application/json"],"contents":[{"id":"api_doc_7","name":"application/json","typeName":"Video","typeKind":"OBJECT","recursive":false,"contentsLabel":"Child attributes","contents":[{"id":"api_doc_1","name":"channel_id","required":"true","typeName":"string","typeKind":"PRIMITIVE","contentsLabel":"Child attributes"},{"id":"api_doc_2","name":"channel_name","required":"true","typeName":"string","typeKind":"PRIMITIVE","contentsLabel":"Child attributes"},{"id":"api_doc_3","name":"description","required":"true","typeName":"string","typeKind":"PRIMITIVE","contentsLabel":"Child attributes"},{"id":"api_doc_4","name":"title","required":"true","typeName":"string","typeKind":"PRIMITIVE","contentsLabel":"Child attributes"},{"id":"api_doc_5","name":"upload_date","required":"true","typeName":"string","typeKind":"PRIMITIVE","contentsLabel":"Child attributes"},{"id":"api_doc_6","name":"video_id","required":"true","typeName":"string","typeKind":"PRIMITIVE","contentsLabel":"Child attributes"}]}],"kind":"ApiResponse"}] }</script></api-param-group></primary-column><secondary-column></secondary-column></api-block></section></section><section class="chapter"><h2 id="57782b5c_3555" data-toc="57782b5c_3555" >Get the status of the database</h2><div class="api-endpoint"><img alt="GET method" src="https://img.shields.io/badge/-GET-167DFF" title="GET method"><copier tooltip-text="Copy path: /database/status"><span>/database/status</span></copier></div><section class="chapter"><h3 id="57782b5c_3557" data-toc="57782b5c_3557" >Responses</h3><api-block data-chapter-level="3"><primary-column><api-param-group id="57782b5c_3558" master-collapse="true" data-chapter-level="3"><script type="application/json">{ "contents" : [{"statusCode":"200","statusType":"OK","name":"successful operation.","description":"successful operation.","contentType":["application/json"],"contents":[{"id":"api_doc_2","name":"application/json","typeName":"object","typeKind":"OBJECT","recursive":false,"contentsLabel":"Child attributes","contents":[{"id":"api_doc_1","name":"OK","typeName":"string","typeKind":"PRIMITIVE","contentsLabel":"Child attributes"}]}],"kind":"ApiResponse"}, {"statusCode":"500","statusType":"ERROR","name":"database is down","description":"database is down","contentType":["application/json"],"contents":[{"id":"api_doc_2","name":"application/json","typeName":"object","typeKind":"OBJECT","recursive":false,"contentsLabel":"Child attributes","contents":[{"id":"api_doc_1","name":"FAIL","typeName":"string","typeKind":"PRIMITIVE","contentsLabel":"Child attributes"}]}],"kind":"ApiResponse"}] }</script></api-param-group></primary-column><secondary-column></secondary-column></api-block></section></section><section class="chapter"><h2 id="57782b5c_3562" data-toc="57782b5c_3562" >Get the status of the database</h2><div class="api-endpoint"><img alt="GET method" src="https://img.shields.io/badge/-GET-167DFF" title="GET method"><copier tooltip-text="Copy path: /storage/status"><span>/storage/status</span></copier></div><p id="57782b5c_3564">Gets the number of videos archived and space used in GB</p><section class="chapter"><h3 id="57782b5c_3565" data-toc="57782b5c_3565" >Responses</h3><api-block data-chapter-level="3"><primary-column><api-param-group id="57782b5c_3566" master-collapse="true" data-chapter-level="3"><script type="application/json">{ "contents" : [{"statusCode":"200","statusType":"OK","name":"successful operation.","description":"successful operation.","contentType":["application/json"],"contents":[{"id":"api_doc_3","name":"application/json","typeName":"object","typeKind":"OBJECT","recursive":false,"contentsLabel":"Child attributes","contents":[{"id":"api_doc_1","name":"number_of_files","typeName":"integer","typeKind":"PRIMITIVE","contentsLabel":"Child attributes"},{"id":"api_doc_2","name":"storage_size","typeName":"integer","typeKind":"PRIMITIVE","contentsLabel":"Child attributes"}]}],"kind":"ApiResponse"}] }</script></api-param-group></primary-column><secondary-column></secondary-column></api-block></section></section></p><div class="last-modified"> Last modified: 16 December 2023</div><div data-feedback-placeholder="true"></div><div class="navigation-links _bottom"> <a class="navigation-links__prev" href="patchwork-archive.html">Patchwork Archive</a> <a class="navigation-links__next" href="vtuber-captcha.html">VTuber Captcha</a> </div></article><div id="disqus_thread"></div></div></section></main></div> <script src="https://resources.jetbrains.com/writerside/apidoc/6.6.6-b205/app.js"></script></body></html>
\ No newline at end of file diff --git a/patchwork-archive.html b/patchwork-archive.html new file mode 100644 index 0000000..24a64d6 --- /dev/null +++ b/patchwork-archive.html @@ -0,0 +1 @@ +<!DOCTYPE html SYSTEM "about:legacy-compat"><html lang="en-US" data-colors-preset="contrast" data-primary-color="#307FFF"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="robots" content="noindex"> <meta name="built-on" content="2023-12-15T23:52:21.657234376"><meta name="build-number" content="${buildNumber}"> <title>Patchwork Archive | Project Knowledge Base</title><script id="virtual-toc-data" type="application/json">[]</script><script id="topic-shortcuts" type="application/json"></script><link href="https://resources.jetbrains.com/writerside/apidoc/6.6.6-b205/app.css" rel="stylesheet"> <link rel="apple-touch-icon" sizes="180x180" href="https://jetbrains.com/apple-touch-icon.png"><link rel="icon" type="image/png" sizes="32x32" href="https://jetbrains.com/favicon-32x32.png"><link rel="icon" type="image/png" sizes="16x16" href="https://jetbrains.com/favicon-16x16.png"><link rel="manifest" href="https://jetbrains.com/site.webmanifest"><link rel="mask-icon" href="https://jetbrains.com/safari-pinned-tab.svg" color="#000000"><meta name="msapplication-TileColor" content="#000000"/><meta name="msapplication-TileImage" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-144x144.png"/><meta name="msapplication-square70x70logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-70x70.png"/><meta name="msapplication-square150x150logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-150x150.png"/><meta name="msapplication-wide310x150logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-310x150.png"/><meta name="msapplication-square310x310logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-310x310.png"/> <meta name="image" content=""><!-- Open Graph --><meta property="og:title" content="Patchwork Archive | Project Knowledge Base"/><meta property="og:description" content=""/><meta property="og:image" content=""/><meta property="og:site_name" content="Project Knowledge Base Help"/><meta property="og:type" content="website"/><meta property="og:locale" content="en_US"/><meta property="og:url" content="patchwork-archive.html"/><!-- End Open Graph --><!-- Twitter Card --><meta name="twitter:card" content="summary_large_image"><meta name="twitter:site" content=""><meta name="twitter:title" content="Patchwork Archive | Project Knowledge Base"><meta name="twitter:description" content=""><meta name="twitter:creator" content=""><meta name="twitter:image:src" content=""><!-- End Twitter Card --><!-- Schema.org WebPage --><script type="application/ld+json"> { "@context": "http://schema.org", "@type": "WebPage", "@id": "patchwork-archive.html#webpage", "url": "patchwork-archive.html", "name": "Patchwork Archive | Project Knowledge Base", "description": "", "image": "", "inLanguage":"en-US" }</script><!-- End Schema.org --><!-- Schema.org WebSite --><script type="application/ld+json"> { "@type": "WebSite", "@id": "/#website", "url": "/", "name": "Project Knowledge Base Help" }</script><!-- End Schema.org --></head> <body data-id="Patchwork-Archive" data-main-title="Patchwork Archive" data-article-props="{"seeAlsoStyle":"links"}" data-template="article" data-breadcrumbs="" > <div class="wrapper"><main class="panel _main"><header class="panel__header"><div class="container"><h3>Project Knowledge Base Help</h3><div class="panel-trigger"></div></div></header><section class="panel__content"><div class="container"><article class="article" data-shortcut-switcher="inactive"><h1 data-toc="Patchwork-Archive" id="Patchwork-Archive.md">Patchwork Archive</h1> <p id="18718138_1329">Patchwork Archive is a project that centers around the preservation and archival of music created by virtual youtubers.</p><p id="18718138_1330">Worker scripts are ran which download and store videos identified as music, which are then hosted at <span class="emphasis" id="18718138_1331"><a href="https://patchwork.moekyun.me" id="18718138_1332" data-external="true" rel="noopener noreferrer" >patchwork.moekyun.me</a></span></p><p id="18718138_1333">In this section you'll find various information about Patchwork Archive as well as the documentation for how to call the publicly available API.</p><figure id="18718138_1334"><img alt="Patchwork Archive Video Page" src="https://github.com/Patchwork-Archive/Patchwork-Browser/assets/21994085/30b2cabf-07b4-4331-8ebf-709520d42baa" title="Patchwork Archive Video Page" ></figure><div class="last-modified"> Last modified: 16 December 2023</div><div data-feedback-placeholder="true"></div><div class="navigation-links _bottom"> <a class="navigation-links__prev" href="welcome.html">Welcome</a> <a class="navigation-links__next" href="patchwork-api.html">Patchwork Archive API</a> </div></article><div id="disqus_thread"></div></div></section></main></div> <script src="https://resources.jetbrains.com/writerside/apidoc/6.6.6-b205/app.js"></script></body></html>
\ No newline at end of file diff --git a/vtuber-captcha.html b/vtuber-captcha.html new file mode 100644 index 0000000..eacb0d9 --- /dev/null +++ b/vtuber-captcha.html @@ -0,0 +1,100 @@ +<!DOCTYPE html SYSTEM "about:legacy-compat"><html lang="en-US" data-colors-preset="contrast" data-primary-color="#307FFF"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="robots" content="noindex"> <meta name="built-on" content="2023-12-15T23:52:21.656668549"><meta name="build-number" content="${buildNumber}"> <title>VTuber Captcha | Project Knowledge Base</title><script id="virtual-toc-data" type="application/json">[{"id":"available-endpoints","level":0,"title":"Available Endpoints","anchor":"#available-endpoints"},{"id":"affiliation-org","level":0,"title":"/affiliation/\u003corg\u003e","anchor":"#affiliation-org"},{"id":"authenticating-answers-against-the-server","level":0,"title":"Authenticating Answers Against The Server","anchor":"#authenticating-answers-against-the-server"},{"id":"supported-keywords","level":0,"title":"Supported Keywords","anchor":"#supported-keywords"},{"id":"organization","level":0,"title":"Organization","anchor":"#organization"}]</script><script id="topic-shortcuts" type="application/json"></script><link href="https://resources.jetbrains.com/writerside/apidoc/6.6.6-b205/app.css" rel="stylesheet"> <link rel="apple-touch-icon" sizes="180x180" href="https://jetbrains.com/apple-touch-icon.png"><link rel="icon" type="image/png" sizes="32x32" href="https://jetbrains.com/favicon-32x32.png"><link rel="icon" type="image/png" sizes="16x16" href="https://jetbrains.com/favicon-16x16.png"><link rel="manifest" href="https://jetbrains.com/site.webmanifest"><link rel="mask-icon" href="https://jetbrains.com/safari-pinned-tab.svg" color="#000000"><meta name="msapplication-TileColor" content="#000000"/><meta name="msapplication-TileImage" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-144x144.png"/><meta name="msapplication-square70x70logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-70x70.png"/><meta name="msapplication-square150x150logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-150x150.png"/><meta name="msapplication-wide310x150logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-310x150.png"/><meta name="msapplication-square310x310logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-310x310.png"/> <meta name="image" content=""><!-- Open Graph --><meta property="og:title" content="VTuber Captcha | Project Knowledge Base"/><meta property="og:description" content=""/><meta property="og:image" content=""/><meta property="og:site_name" content="Project Knowledge Base Help"/><meta property="og:type" content="website"/><meta property="og:locale" content="en_US"/><meta property="og:url" content="vtuber-captcha.html"/><!-- End Open Graph --><!-- Twitter Card --><meta name="twitter:card" content="summary_large_image"><meta name="twitter:site" content=""><meta name="twitter:title" content="VTuber Captcha | Project Knowledge Base"><meta name="twitter:description" content=""><meta name="twitter:creator" content=""><meta name="twitter:image:src" content=""><!-- End Twitter Card --><!-- Schema.org WebPage --><script type="application/ld+json"> { "@context": "http://schema.org", "@type": "WebPage", "@id": "vtuber-captcha.html#webpage", "url": "vtuber-captcha.html", "name": "VTuber Captcha | Project Knowledge Base", "description": "", "image": "", "inLanguage":"en-US" }</script><!-- End Schema.org --><!-- Schema.org WebSite --><script type="application/ld+json"> { "@type": "WebSite", "@id": "/#website", "url": "/", "name": "Project Knowledge Base Help" }</script><!-- End Schema.org --></head> <body data-id="VTuber-Captcha" data-main-title="VTuber Captcha" data-article-props="{"seeAlsoStyle":"links"}" data-template="article" data-breadcrumbs="" > <div class="wrapper"><main class="panel _main"><header class="panel__header"><div class="container"><h3>Project Knowledge Base Help</h3><div class="panel-trigger"></div></div></header><section class="panel__content"><div class="container"><article class="article" data-shortcut-switcher="inactive"><h1 data-toc="VTuber-Captcha" id="VTuber-Captcha.md">VTuber Captcha</h1> <p id="64dbd8f7_1749">A simple web API that serves VTuber related CAPTCHAs including server-side verification. Bring your own frontend to display the data.</p><section class="chapter"><h2 id="available-endpoints" data-toc="available-endpoints" >Available Endpoints</h2><p id="64dbd8f7_1750">The base URL or the API currently is: <code class="code" id="64dbd8f7_1751">https://vtuber-captcha.vercel.app/api</code></p><p id="64dbd8f7_1752">Below are the current API endpoints supported: <a href="https://github.com/pinapelz/vtuber-captcha/wiki/Authenticating-Answers-Against-the-API" id="64dbd8f7_1753" data-external="true" rel="noopener noreferrer" >Authenticating Against the API</a></p></section><section class="chapter"><h2 id="affiliation-org" data-toc="affiliation-org" >/affiliation/<org></h2><p id="64dbd8f7_1754">Returns a captcha asking user to identify which of the VTubers are affiliated with a particular organization or group</p><p id="64dbd8f7_1755"><span class="control" id="64dbd8f7_1756">Path Parameters</span></p><ul class="list _ul" id="64dbd8f7_1757"><li class="list__item" id="64dbd8f7_1758"><p><code class="code" id="64dbd8f7_1759"><org></code>: Refer to <a href="https://github.com/pinapelz/vtuber-captcha/wiki/Supported-Terms#organizations" id="64dbd8f7_1760" data-external="true" rel="noopener noreferrer" >organization page</a> for a list of supported terms <span class="control" id="64dbd8f7_1761">Query Parameters</span></p></li><li class="list__item" id="64dbd8f7_1762"><p><code class="code" id="64dbd8f7_1763">server_auth</code>: false if answers to captcha should be sent to response, true if you would like the API to store the answer and authenticate against it. </p><ul class="list _ul" id="64dbd8f7_1764"><li class="list__item" id="64dbd8f7_1765"><p>Default: <code class="code" id="64dbd8f7_1766">false</code></p></li><li class="list__item" id="64dbd8f7_1767"><p>Enums: <code class="code" id="64dbd8f7_1768">true, false</code></p></li></ul></li></ul></section><section class="chapter"><h2 id="authenticating-answers-against-the-server" data-toc="authenticating-answers-against-the-server" >Authenticating Answers Against The Server</h2><p id="64dbd8f7_1769">The API supports server-side verification meaning that the answer to the CAPTCHA is never sent to you after making the initial request.</p><p id="64dbd8f7_1770">Instead, each request will be assigned a session-token which uniquely identifies the CAPTCHA. The server then saves the answer to the CAPTCHA. This makes it safe for you to directly call the API client-side from a frontend without the need for a middle-man to store the answer.</p><p id="64dbd8f7_1771">To authenticate answers against the API. You need to specify the query parameter <code class="code" id="64dbd8f7_1772">?server_auth=true</code></p><p id="64dbd8f7_1773"><span class="control" id="64dbd8f7_1774">Example Response with <code class="code" id="64dbd8f7_1775">?server_auth=true</code></span></p><div class="code-block" data-lang="none" > +{ + "category": "affiliation", + "onFail": { + "extra": null, + "text": "You got some wrong" + }, + "questions": [ + { + "id": "UCgZuwn-O7Szh9cAgHqJ6vjw", + "image": "https://yt3.ggpht.com/ytc/AMLnZu_aQ3akSpFc9SVPcFMXATjdKZAcmy1aXtGq364A=s800-c-k-c0x00ffffff-no-rj", + "name": "Aloe Ch.魔乃アロエ" + }, + { + "id": "UC7MMNHR-kf9EN1rXiesMTMw", + "image": "https://yt3.ggpht.com/8SFoIMf_6XTf0jyeLd6Txdl96BqSyGhb250P3qEh7E4ui8fLNxLXLiLf7phYVy0CIYx3as42=s800-c-k-c0x00ffffff-no-rj", + "name": "Magni Dezmond Ch. HOLOSTARS-EN" + }, + { + "id": "UCwL7dgTxKo8Y4RFIKWaf8gA", + "image": "https://yt3.ggpht.com/ytc/AOPolaStFlTJ6ISi2Wuwz7L_OLHHShXfoVPDDnqsPWLb=s800-c-k-c0x00ffffff-no-rj", + "name": "Oga Ch.荒咬オウガ" + }, + { + "id": "UCdn5BQ06XqgXoAxIhbqw5Rg", + "image": "https://yt3.ggpht.com/ytc/AOPolaSFPK_6xlqthNXIpMC7OTWfGsDAoNkR9OexBYxcpA=s800-c-k-c0x00ffffff-no-rj", + "name": "フブキCh。白上フブキ" + }, + { + "id": "UCa9Y57gfeY0Zro_noHRVrnw", + "image": "https://yt3.ggpht.com/O7m_5HMY_O8yxR3Jhn9cEO1fLNL_GifMERExnAmfY7JrdTRsTjNijTcNYTPN97Llj3zGn8Susw=s800-c-k-c0x00ffffff-no-rj", + "name": "Luna Ch. 姫森ルーナ" + }, + { + "id": "UC1CfXB_kRs3C-zaeTG3oGyg", + "image": "https://yt3.ggpht.com/B2tq3IQAFxUe9W3MaMc0V62bmlTWCSoTuCk-Y-Ab8yXkZKdIswQhHABZhz2e4YM1-B_Kxen_7w=s800-c-k-c0x00ffffff-no-rj", + "name": "HAACHAMA Ch 赤井はあと" + }, + { + "id": "UCw1KNjVqfrJSfcFd6zlcSzA", + "image": "https://yt3.ggpht.com/7QQ7vnkdwS7e8cLY6YYRoLTLftUxQCopsIxE7L9Qd6vXW_TsCjb4YZDVqYTJ3qceAAqWtwQH=s800-c-k-c0x00ffffff-no-rj", + "name": "Nia Suzune / 鈴音にあ [PRISM Project]" + }, + { + "id": "UCambvP8yxNDot4FzQc9cgiw", + "image": "https://yt3.ggpht.com/EgL9iOOKL7KiLIBxjqJO6gmVJE7BJ4xqfmgyis_QQ9zdbYAD_Pco7xagjdpWCTFoPbgxEXyJ=s800-c-k-c0x00ffffff-no-rj", + "name": "宇佐美リト / Usami Rito【にじさんじ】" + }, + { + "id": "UCqEp6RdtsMbUNrCdCswr6pA", + "image": "https://yt3.ggpht.com/ytc/AMLnZu9ZF7fPn4IghqjrWH-SFrdSzlY9EMtkkoUntGLWLA=s800-c-k-c0x00ffffff-no-rj", + "name": "海夜叉神/黄泉波咲夜【にじさんじ】" + }, + { + "id": "UC6TfqY40Xt1Y0J-N18c85qQ", + "image": "https://yt3.ggpht.com/50JCdIpi9B-ZxDaveVfSyKuvRyj8d2DgLe0sMkd_UxuxN-VcGQ54W4M-6T0wXzJV2TdfAeZglSc=s800-c-k-c0x00ffffff-no-rj", + "name": "安土桃" + }, + { + "id": "UCFTLzh12_nrtzqBPsTCqenA", + "image": "https://yt3.ggpht.com/ytc/AOPolaRF12upNUVmDXfH2A7ViS-gyKCcAvAQXTyEmbWAcA=s800-c-k-c0x00ffffff-no-rj", + "name": "アキロゼCh。Vtuber/ホロライブ所属" + }, + { + "id": "UCMwGHR0BTZuLsmjY_NT5Pwg", + "image": "https://yt3.ggpht.com/f4uYWHJxiGwyXm8NUlm818N1MRnywtgL6wM8JdWqWsKBzI7v1eg8dxDWG7igkWuukUSiufydqPg=s800-c-k-c0x00ffffff-no-rj", + "name": "Ninomae Ina'nis Ch. hololive-EN" + }, + { + "id": "UC6oW4FXETgEGOFTxWmI2h5Q", + "image": "https://yt3.ggpht.com/ytc/AMLnZu_clEsYJi5qCPCpxCuw2qMwB5rfcm2hgDITVRRn=s800-c-k-c0x00ffffff-no-rj", + "name": "Noor【NIJISANJI IN】" + }, + { + "id": "UC_sFNM0z0MWm9A6WlKPuMMg", + "image": "https://yt3.ggpht.com/JDCIBWj11TgjY2Uyba_efZ0n5hzjysMB9GxkvHGkIN_sfFQJR5mx3iVPqgJ96IPcYjZpCLsb=s800-c-k-c0x00ffffff-no-rj", + "name": "Nerissa Ravencroft Ch. hololive-EN" + }, + { + "id": "UCnYhIk9aGEx_bIgheVjs53w", + "image": "https://yt3.ggpht.com/ytc/AOPolaRL4Pk2cC2Q0GXLV-N9tSPZkCDp_c2RqdQEBpY-=s800-c-k-c0x00ffffff-no-rj", + "name": "Luto Araka / 新火ると [PRISM Project]" + }, + { + "id": "UCIytNcoz4pWzXfLda0DoULQ", + "image": "https://yt3.ggpht.com/21x1Ab6pEffGItAcNTjcYUkG3IzQ1y--5cUUjtEhrUEuz2iCttL08vswnPRe1XvtBaZ0yUAm=s800-c-k-c0x00ffffff-no-rj", + "name": "エクス・アルビオ -Ex Albio-" + } + ], + "session": "GUQkquh03dwF84EAxif_EA", + "title": "Select all the VTuber affiliated with Hololive" +} +</div><p id="64dbd8f7_1777">To check your answers against the API. Send <code class="code" id="64dbd8f7_1778">session</code> token and the <code class="code" id="64dbd8f7_1779">id</code> of each selected element as a string comma separated as part of a data payload to <code class="code" id="64dbd8f7_1780">/api/verify</code></p><p id="64dbd8f7_1781">Example Payload</p><div class="code-block" data-lang="none" > +session: "j4WjkoMcPgNX8_gnNXf8HA" +answer: "UC0ZTVxCHkZanT5dnP2FZD4Q,UC4WvIIAo89_AzGUh1AZ6Dkg,UCe0JiGnjPfEwEIbWASbOimw" +</div><p id="64dbd8f7_1783">Response:</p><div class="code-block" data-lang="none" > +{ + success: false +} +</div><p id="64dbd8f7_1785">In the case above the user selected:</p><ul class="list _ul" id="64dbd8f7_1786"><li class="list__item" id="64dbd8f7_1787"><p>UC0ZTVxCHkZanT5dnP2FZD4Q</p></li><li class="list__item" id="64dbd8f7_1788"><p>UC4WvIIAo89_AzGUh1AZ6Dkg</p></li><li class="list__item" id="64dbd8f7_1789"><p>UCe0JiGnjPfEwEIbWASbOimw</p></li></ul><p id="64dbd8f7_1790">and their answer was incorrect.</p><p id="64dbd8f7_1791">After failing a captcha, the token becomes invalidated and a request for a new CAPTCHA must be made</p></section><section class="chapter"><h2 id="supported-keywords" data-toc="supported-keywords" >Supported Keywords</h2></section><section class="chapter"><h2 id="organization" data-toc="organization" >Organization</h2><ul class="list _ul" id="64dbd8f7_1792"><li class="list__item" id="64dbd8f7_1793"><p>Hololive: All hololive Production affiliated members, including Holostars</p></li><li class="list__item" id="64dbd8f7_1794"><p>Nijisanji: All Nijisanji affiliated livers, including EN branches (does not include VirtuaReal)</p></li></ul></section><div class="last-modified"> Last modified: 16 December 2023</div><div data-feedback-placeholder="true"></div><div class="navigation-links _bottom"> <a class="navigation-links__prev" href="patchwork-api.html">Patchwork Archive API</a> </div></article><div id="disqus_thread"></div></div></section></main></div> <script src="https://resources.jetbrains.com/writerside/apidoc/6.6.6-b205/app.js"></script></body></html>
\ No newline at end of file diff --git a/welcome.html b/welcome.html new file mode 100644 index 0000000..8e59e19 --- /dev/null +++ b/welcome.html @@ -0,0 +1 @@ +<!DOCTYPE html SYSTEM "about:legacy-compat"><html lang="en-US" data-colors-preset="contrast" data-primary-color="#307FFF"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="robots" content="noindex"> <meta name="built-on" content="2023-12-15T23:52:21.656467094"><meta name="build-number" content="${buildNumber}"> <title>Welcome | Project Knowledge Base</title><script id="virtual-toc-data" type="application/json">[]</script><script id="topic-shortcuts" type="application/json"></script><link href="https://resources.jetbrains.com/writerside/apidoc/6.6.6-b205/app.css" rel="stylesheet"> <link rel="apple-touch-icon" sizes="180x180" href="https://jetbrains.com/apple-touch-icon.png"><link rel="icon" type="image/png" sizes="32x32" href="https://jetbrains.com/favicon-32x32.png"><link rel="icon" type="image/png" sizes="16x16" href="https://jetbrains.com/favicon-16x16.png"><link rel="manifest" href="https://jetbrains.com/site.webmanifest"><link rel="mask-icon" href="https://jetbrains.com/safari-pinned-tab.svg" color="#000000"><meta name="msapplication-TileColor" content="#000000"/><meta name="msapplication-TileImage" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-144x144.png"/><meta name="msapplication-square70x70logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-70x70.png"/><meta name="msapplication-square150x150logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-150x150.png"/><meta name="msapplication-wide310x150logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-310x150.png"/><meta name="msapplication-square310x310logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-310x310.png"/> <meta name="image" content=""><!-- Open Graph --><meta property="og:title" content="Welcome | Project Knowledge Base"/><meta property="og:description" content=""/><meta property="og:image" content=""/><meta property="og:site_name" content="Project Knowledge Base Help"/><meta property="og:type" content="website"/><meta property="og:locale" content="en_US"/><meta property="og:url" content="welcome.html"/><!-- End Open Graph --><!-- Twitter Card --><meta name="twitter:card" content="summary_large_image"><meta name="twitter:site" content=""><meta name="twitter:title" content="Welcome | Project Knowledge Base"><meta name="twitter:description" content=""><meta name="twitter:creator" content=""><meta name="twitter:image:src" content=""><!-- End Twitter Card --><!-- Schema.org WebPage --><script type="application/ld+json"> { "@context": "http://schema.org", "@type": "WebPage", "@id": "welcome.html#webpage", "url": "welcome.html", "name": "Welcome | Project Knowledge Base", "description": "", "image": "", "inLanguage":"en-US" }</script><!-- End Schema.org --><!-- Schema.org WebSite --><script type="application/ld+json"> { "@type": "WebSite", "@id": "/#website", "url": "/", "name": "Project Knowledge Base Help" }</script><!-- End Schema.org --></head> <body data-id="Welcome" data-main-title="Welcome" data-article-props="{"seeAlsoStyle":"links"}" data-template="article" data-breadcrumbs="" > <div class="wrapper"><main class="panel _main"><header class="panel__header"><div class="container"><h3>Project Knowledge Base Help</h3><div class="panel-trigger"></div></div></header><section class="panel__content"><div class="container"><article class="article" data-shortcut-switcher="inactive"><h1 data-toc="Welcome" id="Welcome.md">Welcome</h1> <p id="a4a8acae_1322">Welcome to a collection of documentation for some of the various things I have over on GitHub.</p><p id="a4a8acae_1323">These docs should serve as both a guide and archive of previously of both currently active and previously projects.</p><div class="last-modified"> Last modified: 16 December 2023</div><div data-feedback-placeholder="true"></div><div class="navigation-links _bottom"> <a class="navigation-links__next" href="patchwork-archive.html">Patchwork Archive</a> </div></article><div id="disqus_thread"></div></div></section></main></div> <script src="https://resources.jetbrains.com/writerside/apidoc/6.6.6-b205/app.js"></script></body></html>
\ No newline at end of file |