Leahnaya/chaotic-api
1
0
Fork 0
mirror of https://github.com/unitehenry/chaotic-api.git synced 2026-08-22 01:35:08 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

Deploy website

Browse Source 
Deploy website version based on 6806d401baa5d29e95ba922a21f443a28beac17a
This commit is contained in:
unitehenry
2019-08-25 21:55:26 -04:00
parent be05563655
commit c63586bcf6
26 changed files with 140 additions and 102 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
docs/documentation.html
View File

@@ -1,4 +1,4 @@
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Documentation · Chaotic TCG API</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="Documentation for the Chaotic Trading Card Game API."/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Documentation · Chaotic TCG API"/><meta property="og:type" content="website"/><meta property="og:url" content="https://unitehenry.github.io/chaotic-api/"/><meta property="og:description" content="Documentation for the Chaotic Trading Card Game API."/><meta property="og:image" content="https://unitehenry.github.io/chaotic-api/img/undraw_online.svg"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://unitehenry.github.io/chaotic-api/img/undraw_tweetstorm.svg"/><link rel="shortcut icon" href="/chaotic-api/img/favicon.ico"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script src="/chaotic-api/js/scrollSpy.js"></script><link rel="stylesheet" href="/chaotic-api/css/main.css"/><script src="/chaotic-api/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/chaotic-api/"><img class="logo" src="/chaotic-api/img/card-back.png" alt="Chaotic TCG API"/><h2 class="headerTitleWithLogo">Chaotic TCG API</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class="siteNavItemActive"><a href="/chaotic-api/docs/documentation" target="_self">Documentation</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container mainContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://github.com/unitehenry/chaotic-api/blob/master/docs/docs/documentation.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 class="postHeaderTitle">Documentation</h1></header><article><div><span><p>Documentation for the Chaotic Trading Card Game API.</p>
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Documentation · Chaotic TCG API</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="Documentation for the Chaotic Trading Card Game API."/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Documentation · Chaotic TCG API"/><meta property="og:type" content="website"/><meta property="og:url" content="https://unitehenry.github.io//chaotic-game/"/><meta property="og:description" content="Documentation for the Chaotic Trading Card Game API."/><meta property="og:image" content="https://unitehenry.github.io//chaotic-game/img/undraw_online.svg"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://unitehenry.github.io//chaotic-game/img/undraw_tweetstorm.svg"/><link rel="shortcut icon" href="/chaotic-game/img/favicon.ico"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script src="/chaotic-game/js/scrollSpy.js"></script><link rel="stylesheet" href="/chaotic-game/css/main.css"/><script src="/chaotic-game/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/chaotic-game/"><img class="logo" src="/chaotic-game/img/card-back.png" alt="Chaotic TCG API"/><h2 class="headerTitleWithLogo">Chaotic TCG API</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class="siteNavItemActive"><a href="/chaotic-game/docs/documentation" target="_self">Documentation</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container mainContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://github.com/unitehenry/chaotic-api/blob/master/docs/docs/documentation.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 class="postHeaderTitle">Documentation</h1></header><article><div><span><p>Documentation for the Chaotic Trading Card Game API.</p>
<h2><a class="anchor" aria-hidden="true" id="getting-started"></a><a href="#getting-started" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Getting Started</h2>
<p>To begin with this API, let's start by making our first API call to the server.</p>
<h3><a class="anchor" aria-hidden="true" id="making-an-api-call"></a><a href="#making-an-api-call" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Making an API Call</h3>
@@ -159,14 +159,25 @@
</tbody>
</table>
<h3><a class="anchor" aria-hidden="true" id="mugic"></a><a href="#mugic" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Mugic</h3>
<p>|Property|Type|Details|
|:-:|:-:|:-:|`
|_id|String|Unique database id|
|Name|String|Name of the card|
|Set|String|The set id of the card|
|Rarity|String|The cards rarity in the game|
|Id|Number|The card's id number in its respective set|
|Tribe|String|The card's tribe in the game|</p>
<table>
<thead>
<tr><th style="text-align:center">Property</th><th style="text-align:center">Type</th><th style="text-align:center">Details</th></tr>
</thead>
<tbody>
<tr><td style="text-align:center">_id</td><td style="text-align:center">String</td><td style="text-align:center">Unique database id</td></tr>
<tr><td style="text-align:center">Name</td><td style="text-align:center">String</td><td style="text-align:center">Name of the card</td></tr>
<tr><td style="text-align:center">Set</td><td style="text-align:center">String</td><td style="text-align:center">The set id of the card</td></tr>
<tr><td style="text-align:center">Rarity</td><td style="text-align:center">String</td><td style="text-align:center">The cards rarity in the game</td></tr>
<tr><td style="text-align:center">Id</td><td style="text-align:center">Number</td><td style="text-align:center">The card's id number in its respective set</td></tr>
<tr><td style="text-align:center">Tribe</td><td style="text-align:center">String</td><td style="text-align:center">The card's tribe in the game</td></tr>
<tr><td style="text-align:center">Cost</td><td style="text-align:center">Number</td><td style="text-align:center">The cards mugic cost</td></tr>
<tr><td style="text-align:center">Ability</td><td style="text-align:center">String</td><td style="text-align:center">Card's printed mechanical game text</td></tr>
<tr><td style="text-align:center">Flavor</td><td style="text-align:center">String</td><td style="text-align:center">The card's printed flavor text</td></tr>
<tr><td style="text-align:center">Unique</td><td style="text-align:center">String</td><td style="text-align:center"></td></tr>
<tr><td style="text-align:center">Past</td><td style="text-align:center">String</td><td style="text-align:center"></td></tr>
<tr><td style="text-align:center">Artist</td><td style="text-align:center">String</td><td style="text-align:center">The card art illustrator</td></tr>
</tbody>
</table>
<h3><a class="anchor" aria-hidden="true" id="battlegear"></a><a href="#battlegear" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Battlegear</h3>
<table>
<thead>
@@ -178,8 +189,16 @@
<tr><td style="text-align:center">Set</td><td style="text-align:center">String</td><td style="text-align:center">The set id of the card</td></tr>
<tr><td style="text-align:center">Rarity</td><td style="text-align:center">String</td><td style="text-align:center">The cards rarity in the game</td></tr>
<tr><td style="text-align:center">Id</td><td style="text-align:center">Number</td><td style="text-align:center">The card's id number in its respective set</td></tr>
<tr><td style="text-align:center">Ability</td><td style="text-align:center">String</td><td style="text-align:center">Card's printed mechanical game text</td></tr>
<tr><td style="text-align:center">Flavor Text</td><td style="text-align:center">String</td><td style="text-align:center">The card's printed flavor text</td></tr>
<tr><td style="text-align:center">Unique</td><td style="text-align:center">String</td><td style="text-align:center"></td></tr>
<tr><td style="text-align:center">Loyal</td><td style="text-align:center">String</td><td style="text-align:center"></td></tr>
<tr><td style="text-align:center">Legendary</td><td style="text-align:center">String</td><td style="text-align:center"></td></tr>
<tr><td style="text-align:center">Past</td><td style="text-align:center">String</td><td style="text-align:center"></td></tr>
<tr><td style="text-align:center">Shard</td><td style="text-align:center">String</td><td style="text-align:center"></td></tr>
<tr><td style="text-align:center">Artist</td><td style="text-align:center">String</td><td style="text-align:center">The card art illustrator</td></tr>
</tbody>
</table>
<h2><a class="anchor" aria-hidden="true" id="api-limits"></a><a href="#api-limits" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>API Limits</h2>
<p><strong>The API limits all calls from original source to 100 calls every 15 minutes</strong></p>
</span></div></article></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#getting-started">Getting Started</a><ul class="toc-headings"><li><a href="#making-an-api-call">Making an API Call</a></li><li><a href="#getting-card-images">Getting card images</a></li></ul></li><li><a href="#chaotic-cards">Chaotic Cards</a><ul class="toc-headings"><li><a href="#requesting-all-cards">Requesting all cards</a></li><li><a href="#requesting-all-cards-by-a-type">Requesting all cards by a type</a></li><li><a href="#filtering-cards-by-set">Filtering cards by set</a></li><li><a href="#getting-specific-card-data">Getting Specific Card Data</a></li></ul></li><li><a href="#valid-parameters">Valid Parameters</a><ul class="toc-headings"><li><a href="#card-types">Card Types</a></li><li><a href="#card-sets">Card Sets</a></li></ul></li><li><a href="#models">Models</a><ul class="toc-headings"><li><a href="#creature">Creature</a></li><li><a href="#location">Location</a></li><li><a href="#attack">Attack</a></li><li><a href="#mugic">Mugic</a></li><li><a href="#battlegear">Battlegear</a></li></ul></li><li><a href="#api-limits">API Limits</a></li></ul></nav></div><footer class="nav-footer" id="footer" style="display:none"><section class="sitemap"><a href="/chaotic-api/" class="nav-home"><img src="/chaotic-api/img/card-back.png" alt="Chaotic TCG API" width="66" height="58"/></a><div><h5>Docs</h5><a href="/chaotic-api/docs/en/doc1.html">Getting Started (or other categories)</a><a href="/chaotic-api/docs/en/doc2.html">Guides (or other categories)</a><a href="/chaotic-api/docs/en/doc3.html">API Reference (or other categories)</a></div><div><h5>Community</h5><a href="/chaotic-api/en/users.html">User Showcase</a><a href="https://stackoverflow.com/questions/tagged/" target="_blank" rel="noreferrer noopener">Stack Overflow</a><a href="https://discordapp.com/">Project Chat</a><a href="https://twitter.com/" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="/chaotic-api/blog">Blog</a><a href="https://github.com/">GitHub</a><a class="github-button" data-icon="octicon-star" data-count-href="/facebook/docusaurus/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><a href="https://opensource.facebook.com/" target="_blank" rel="noreferrer noopener" class="fbOpenSource"><img src="/chaotic-api/img/oss_logo.png" alt="Facebook Open Source" width="170" height="45"/></a><section class="copyright">Copyright © 2019 Henry Unite</section></footer></div></body></html>
</span></div></article></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#getting-started">Getting Started</a><ul class="toc-headings"><li><a href="#making-an-api-call">Making an API Call</a></li><li><a href="#getting-card-images">Getting card images</a></li></ul></li><li><a href="#chaotic-cards">Chaotic Cards</a><ul class="toc-headings"><li><a href="#requesting-all-cards">Requesting all cards</a></li><li><a href="#requesting-all-cards-by-a-type">Requesting all cards by a type</a></li><li><a href="#filtering-cards-by-set">Filtering cards by set</a></li><li><a href="#getting-specific-card-data">Getting Specific Card Data</a></li></ul></li><li><a href="#valid-parameters">Valid Parameters</a><ul class="toc-headings"><li><a href="#card-types">Card Types</a></li><li><a href="#card-sets">Card Sets</a></li></ul></li><li><a href="#models">Models</a><ul class="toc-headings"><li><a href="#creature">Creature</a></li><li><a href="#location">Location</a></li><li><a href="#attack">Attack</a></li><li><a href="#mugic">Mugic</a></li><li><a href="#battlegear">Battlegear</a></li></ul></li><li><a href="#api-limits">API Limits</a></li></ul></nav></div><footer class="nav-footer" id="footer" style="display:none"><section class="sitemap"><a href="/chaotic-game/" class="nav-home"><img src="/chaotic-game/img/card-back.png" alt="Chaotic TCG API" width="66" height="58"/></a><div><h5>Docs</h5><a href="/chaotic-game/docs/en/doc1.html">Getting Started (or other categories)</a><a href="/chaotic-game/docs/en/doc2.html">Guides (or other categories)</a><a href="/chaotic-game/docs/en/doc3.html">API Reference (or other categories)</a></div><div><h5>Community</h5><a href="/chaotic-game/en/users.html">User Showcase</a><a href="https://stackoverflow.com/questions/tagged/" target="_blank" rel="noreferrer noopener">Stack Overflow</a><a href="https://discordapp.com/">Project Chat</a><a href="https://twitter.com/" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="/chaotic-game/blog">Blog</a><a href="https://github.com/">GitHub</a><a class="github-button" data-icon="octicon-star" data-count-href="/facebook/docusaurus/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><a href="https://opensource.facebook.com/" target="_blank" rel="noreferrer noopener" class="fbOpenSource"><img src="/chaotic-game/img/oss_logo.png" alt="Facebook Open Source" width="170" height="45"/></a><section class="copyright">Copyright © 2019 Henry Unite</section></footer></div></body></html>