graphqldoc
Version:
Generate GraphQL docs from schema.
230 lines (226 loc) • 18.2 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8" />
<meta http-equiv="x-ua-compatible" content="ie=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<link href="https://fonts.googleapis.com/icon?family=Material+Icons" rel="stylesheet">
<link type="text/css" rel="stylesheet" href="./styles/graphdoc.css" />
<title>Pokemon | Pokémon GraphQL API</title>
<link href="https://fonts.googleapis.com/css?family=Ubuntu+Mono:400,700" rel="stylesheet"><link type="text/css" rel="stylesheet" href="./assets/code.css" /><script src="./assets/line-link.js"></script><link type="text/css" rel="stylesheet" href="./assets/require-by.css" />
</head>
<body class="slds-scrollable--y">
<nav class="slds-grid slds-grid--vertical slds-col--rule-right">
<header class="slds-p-around--medium slds-col slds-shrik slds-grow-none">
<button class="slds-button slds-button--icon slds-float--right js-toggle-navigation less-than-medium">
<i class="material-icons">close</i>
</button>
<a href="https://github.com/lucasbento/graphql-pokemon" target="_blank" style="display:block;padding:1rem 35%"><img src="https://raw.githubusercontent.com/lucasbento/graphql-pokemon/master/content/logo.png" /></a>
<div class="slds-p-top--small">
<input id="type-search" type="text" placeholder="Search a type" autofocus="" class="slds-input" />
</div>
</header>
<div id="navication-scroll" class="slds-scrollable--y slds-col slds-grow">
<div class="slds-grid slds-grid--vertical slds-navigation-list--vertical">
<h4 class="slds-text-title--caps slds-p-around--medium">Schema</h4>
<ul>
<li title="Query">
<a href="query.doc.html" class="slds-navigation-list--vertical__action slds-text-link--reset slds-truncate">
Query
</a>
</li>
</ul>
</div>
<div class="slds-grid slds-grid--vertical slds-navigation-list--vertical">
<h4 class="slds-text-title--caps slds-p-around--medium">Scalars</h4>
<ul>
<li title="Boolean">
<a href="boolean.doc.html" class="slds-navigation-list--vertical__action slds-text-link--reset slds-truncate">
Boolean
</a>
</li>
<li title="Float">
<a href="float.doc.html" class="slds-navigation-list--vertical__action slds-text-link--reset slds-truncate">
Float
</a>
</li>
<li title="ID">
<a href="id.doc.html" class="slds-navigation-list--vertical__action slds-text-link--reset slds-truncate">
ID
</a>
</li>
<li title="Int">
<a href="int.doc.html" class="slds-navigation-list--vertical__action slds-text-link--reset slds-truncate">
Int
</a>
</li>
<li title="String">
<a href="string.doc.html" class="slds-navigation-list--vertical__action slds-text-link--reset slds-truncate">
String
</a>
</li>
</ul>
</div>
<div class="slds-grid slds-grid--vertical slds-navigation-list--vertical">
<h4 class="slds-text-title--caps slds-p-around--medium">Enums</h4>
<ul>
<li title="__DirectiveLocation">
<a href="directivelocation.spec.html" class="slds-navigation-list--vertical__action slds-text-link--reset slds-truncate">
__DirectiveLocation
</a>
</li>
<li title="__TypeKind">
<a href="typekind.spec.html" class="slds-navigation-list--vertical__action slds-text-link--reset slds-truncate">
__TypeKind
</a>
</li>
</ul>
</div>
<div class="slds-grid slds-grid--vertical slds-navigation-list--vertical">
<h4 class="slds-text-title--caps slds-p-around--medium">Objects</h4>
<ul>
<li title="Attack">
<a href="attack.doc.html" class="slds-navigation-list--vertical__action slds-text-link--reset slds-truncate">
Attack
</a>
</li>
<li class="slds-is-active" title="Pokemon">
<a href="pokemon.doc.html" class="slds-navigation-list--vertical__action slds-text-link--reset slds-truncate">
Pokemon
</a>
</li>
<li title="PokemonAttack">
<a href="pokemonattack.doc.html" class="slds-navigation-list--vertical__action slds-text-link--reset slds-truncate">
PokemonAttack
</a>
</li>
<li title="PokemonDimension">
<a href="pokemondimension.doc.html" class="slds-navigation-list--vertical__action slds-text-link--reset slds-truncate">
PokemonDimension
</a>
</li>
<li title="PokemonEvolutionRequirement">
<a href="pokemonevolutionrequirement.doc.html" class="slds-navigation-list--vertical__action slds-text-link--reset slds-truncate">
PokemonEvolutionRequirement
</a>
</li>
<li title="__Directive">
<a href="directive.spec.html" class="slds-navigation-list--vertical__action slds-text-link--reset slds-truncate">
__Directive
</a>
</li>
<li title="__EnumValue">
<a href="enumvalue.spec.html" class="slds-navigation-list--vertical__action slds-text-link--reset slds-truncate">
__EnumValue
</a>
</li>
<li title="__Field">
<a href="field.spec.html" class="slds-navigation-list--vertical__action slds-text-link--reset slds-truncate">
__Field
</a>
</li>
<li title="__InputValue">
<a href="inputvalue.spec.html" class="slds-navigation-list--vertical__action slds-text-link--reset slds-truncate">
__InputValue
</a>
</li>
<li title="__Schema">
<a href="schema.spec.html" class="slds-navigation-list--vertical__action slds-text-link--reset slds-truncate">
__Schema
</a>
</li>
<li title="__Type">
<a href="type.spec.html" class="slds-navigation-list--vertical__action slds-text-link--reset slds-truncate">
__Type
</a>
</li>
</ul>
</div>
<div class="slds-grid slds-grid--vertical slds-navigation-list--vertical">
<h4 class="slds-text-title--caps slds-p-around--medium">Directives</h4>
<ul>
<li title="deprecated">
<a href="deprecated.doc.html" class="slds-navigation-list--vertical__action slds-text-link--reset slds-truncate">
deprecated
</a>
</li>
<li title="include">
<a href="include.doc.html" class="slds-navigation-list--vertical__action slds-text-link--reset slds-truncate">
include
</a>
</li>
<li title="skip">
<a href="skip.doc.html" class="slds-navigation-list--vertical__action slds-text-link--reset slds-truncate">
skip
</a>
</li>
</ul>
</div>
</div>
</nav>
<main><section class="title slds-theme--inverse">
<div class="container slds-grid">
<div>
<button class="slds-button js-toggle-navigation less-than-medium">
<i class="material-icons slds-button__icon slds-button__icon--left">menu</i>
<span class="slds-text-title--caps">Types</span>
</button>
</div>
<div class="slds-col--bump-left">
<a class="slds-button js-toggle-navigation" target="_blank" href="https://graphql-pokemon.now.sh/">
<span class="slds-text-title--caps">GraphiQL</span>
<i class="material-icons slds-button__icon slds-button__icon--rigth">open_in_new</i>
</a>
</div>
</div>
<div class="container">
<p class="slds-text-title--caps slds-text-color--weak">OBJECT</p>
<h1 class="slds-text-heading--large">Pokemon</h1>
<div class="slds-text-body--regular"><p>Represents a Pokémon</p>
</div>
</div>
</section>
<section>
<div class="container">
<h2 id="graphql-schema-definition" class="graphdoc-section__title slds-text-heading--medium slds-m-top--small">
<a href="#graphql-schema-definition">
<i class="material-icons">link</i>
</a>
GraphQL Schema definition
</h2>
<code class="highlight"><table class="code"><tbody><tr class="row"><td id="L1" class="td-index">1</td><td id="LC1" class="td-code"><span class="keyword operator ts">type</span> <span class="identifier">Pokemon</span> {</td></tr><tr class="row"><td id="L2" class="td-index">2</td><td id="LC2" class="td-code"></td></tr><tr class="row"><td id="L3" class="td-index">3</td><td id="LC3" class="td-code"><span class="tab"><span class="comment line"># The ID of an object</span></span></td></tr><tr class="row"><td id="L4" class="td-index">4</td><td id="LC4" class="td-code"><span class="tab"><span class="meta">id</span>: <a class="support type" href="id.doc.html">ID</a>! </span></td></tr><tr class="row"><td id="L5" class="td-index">5</td><td id="LC5" class="td-code"></td></tr><tr class="row"><td id="L6" class="td-index">6</td><td id="LC6" class="td-code"><span class="tab"><span class="comment line"># The identifier of this Pokémon</span></span></td></tr><tr class="row"><td id="L7" class="td-index">7</td><td id="LC7" class="td-code"><span class="tab"><span class="meta">number</span>: <a class="support type" href="string.doc.html">String</a> </span></td></tr><tr class="row"><td id="L8" class="td-index">8</td><td id="LC8" class="td-code"></td></tr><tr class="row"><td id="L9" class="td-index">9</td><td id="LC9" class="td-code"><span class="tab"><span class="comment line"># The name of this Pokémon</span></span></td></tr><tr class="row"><td id="L10" class="td-index">10</td><td id="LC10" class="td-code"><span class="tab"><span class="meta">name</span>: <a class="support type" href="string.doc.html">String</a> </span></td></tr><tr class="row"><td id="L11" class="td-index">11</td><td id="LC11" class="td-code"></td></tr><tr class="row"><td id="L12" class="td-index">12</td><td id="LC12" class="td-code"><span class="tab"><span class="comment line"># The minimum and maximum weight of this Pokémon</span></span></td></tr><tr class="row"><td id="L13" class="td-index">13</td><td id="LC13" class="td-code"><span class="tab"><span class="meta">weight</span>: <a class="support type" href="pokemondimension.doc.html">PokemonDimension</a> </span></td></tr><tr class="row"><td id="L14" class="td-index">14</td><td id="LC14" class="td-code"></td></tr><tr class="row"><td id="L15" class="td-index">15</td><td id="LC15" class="td-code"><span class="tab"><span class="comment line"># The minimum and maximum weight of this Pokémon</span></span></td></tr><tr class="row"><td id="L16" class="td-index">16</td><td id="LC16" class="td-code"><span class="tab"><span class="meta">height</span>: <a class="support type" href="pokemondimension.doc.html">PokemonDimension</a> </span></td></tr><tr class="row"><td id="L17" class="td-index">17</td><td id="LC17" class="td-code"></td></tr><tr class="row"><td id="L18" class="td-index">18</td><td id="LC18" class="td-code"><span class="tab"><span class="comment line"># The classification of this Pokémon</span></span></td></tr><tr class="row"><td id="L19" class="td-index">19</td><td id="LC19" class="td-code"><span class="tab"><span class="meta">classification</span>: <a class="support type" href="string.doc.html">String</a> </span></td></tr><tr class="row"><td id="L20" class="td-index">20</td><td id="LC20" class="td-code"></td></tr><tr class="row"><td id="L21" class="td-index">21</td><td id="LC21" class="td-code"><span class="tab"><span class="comment line"># The type(s) of this Pokémon</span></span></td></tr><tr class="row"><td id="L22" class="td-index">22</td><td id="LC22" class="td-code"><span class="tab"><span class="meta">types</span>: [<a class="support type" href="string.doc.html">String</a>] </span></td></tr><tr class="row"><td id="L23" class="td-index">23</td><td id="LC23" class="td-code"></td></tr><tr class="row"><td id="L24" class="td-index">24</td><td id="LC24" class="td-code"><span class="tab"><span class="comment line"># The type(s) of Pokémons that this Pokémon is resistant to</span></span></td></tr><tr class="row"><td id="L25" class="td-index">25</td><td id="LC25" class="td-code"><span class="tab"><span class="meta">resistant</span>: [<a class="support type" href="string.doc.html">String</a>] </span></td></tr><tr class="row"><td id="L26" class="td-index">26</td><td id="LC26" class="td-code"></td></tr><tr class="row"><td id="L27" class="td-index">27</td><td id="LC27" class="td-code"><span class="tab"><span class="comment line"># The attacks of this Pokémon</span></span></td></tr><tr class="row"><td id="L28" class="td-index">28</td><td id="LC28" class="td-code"><span class="tab"><span class="meta">attacks</span>: <a class="support type" href="pokemonattack.doc.html">PokemonAttack</a> </span></td></tr><tr class="row"><td id="L29" class="td-index">29</td><td id="LC29" class="td-code"></td></tr><tr class="row"><td id="L30" class="td-index">30</td><td id="LC30" class="td-code"><span class="tab"><span class="comment line"># The type(s) of Pokémons that this Pokémon weak to</span></span></td></tr><tr class="row"><td id="L31" class="td-index">31</td><td id="LC31" class="td-code"><span class="tab"><span class="meta">weaknesses</span>: [<a class="support type" href="string.doc.html">String</a>] </span></td></tr><tr class="row"><td id="L32" class="td-index">32</td><td id="LC32" class="td-code"></td></tr><tr class="row"><td id="L33" class="td-index">33</td><td id="LC33" class="td-code"><span class="tab"><span class="meta">fleeRate</span>: <a class="support type" href="float.doc.html">Float</a> </span></td></tr><tr class="row"><td id="L34" class="td-index">34</td><td id="LC34" class="td-code"></td></tr><tr class="row"><td id="L35" class="td-index">35</td><td id="LC35" class="td-code"><span class="tab"><span class="comment line"># The maximum CP of this Pokémon</span></span></td></tr><tr class="row"><td id="L36" class="td-index">36</td><td id="LC36" class="td-code"><span class="tab"><span class="meta">maxCP</span>: <a class="support type" href="int.doc.html">Int</a> </span></td></tr><tr class="row"><td id="L37" class="td-index">37</td><td id="LC37" class="td-code"></td></tr><tr class="row"><td id="L38" class="td-index">38</td><td id="LC38" class="td-code"><span class="tab"><span class="comment line"># The evolutions of this Pokémon</span></span></td></tr><tr class="row"><td id="L39" class="td-index">39</td><td id="LC39" class="td-code"><span class="tab"><span class="meta">evolutions</span>: [<a class="support type" href="pokemon.doc.html">Pokemon</a>] </span></td></tr><tr class="row"><td id="L40" class="td-index">40</td><td id="LC40" class="td-code"></td></tr><tr class="row"><td id="L41" class="td-index">41</td><td id="LC41" class="td-code"><span class="tab"><span class="comment line"># The evolution requirements of this Pokémon</span></span></td></tr><tr class="row"><td id="L42" class="td-index">42</td><td id="LC42" class="td-code"><span class="tab"><span class="meta">evolutionRequirements</span>: <a class="support type" href="pokemonevolutionrequirement.doc.html">PokemonEvolutionRequirement</a> </span></td></tr><tr class="row"><td id="L43" class="td-index">43</td><td id="LC43" class="td-code"></td></tr><tr class="row"><td id="L44" class="td-index">44</td><td id="LC44" class="td-code"><span class="tab"><span class="comment line"># The maximum HP of this Pokémon</span></span></td></tr><tr class="row"><td id="L45" class="td-index">45</td><td id="LC45" class="td-code"><span class="tab"><span class="meta">maxHP</span>: <a class="support type" href="int.doc.html">Int</a> </span></td></tr><tr class="row"><td id="L46" class="td-index">46</td><td id="LC46" class="td-code"></td></tr><tr class="row"><td id="L47" class="td-index">47</td><td id="LC47" class="td-code"><span class="tab"><span class="meta">image</span>: <a class="support type" href="string.doc.html">String</a> </span></td></tr><tr class="row"><td id="L48" class="td-index">48</td><td id="LC48" class="td-code"></td></tr><tr class="row"><td id="L49" class="td-index">49</td><td id="LC49" class="td-code">}</td></tr></tbody></table></code>
</div>
</section>
<section>
<div class="container">
<h2 id="required-by" class="graphdoc-section__title slds-text-heading--medium slds-m-top--small">
<a href="#required-by">
<i class="material-icons">link</i>
</a>
Required by
</h2>
<ul class="require-by"><li><a href="pokemon.doc.html" title="Pokemon - Represents a Pokémon">Pokemon<em>Represents a Pokémon</em></a><li><li><a href="query.doc.html" title="Query - Query any Pokémon by number or name">Query<em>Query any Pokémon by number or name</em></a><li></ul>
</div>
</section>
<footer>
<div class="container slds-p-around--large">
<p class="slds-text-align--right slds-text-title--caps">
Generated with <a href="https://github.com/CodeSignal/graphqldoc#readme" target="_blank">graphqldoc 2.5.1</a>
</p>
</div>
</footer>
</main>
<script src="./scripts/focus-active.js"></script>
<script src="./scripts/filter-types.js"></script>
<script src="./scripts/toggle-navigation.js"></script>
<script>
(function (i, s, o, g, r, a, m) {
i['GoogleAnalyticsObject'] = r; i[r] = i[r] || function () {
(i[r].q = i[r].q || []).push(arguments)
}, i[r].l = 1 * new Date(); a = s.createElement(o),
m = s.getElementsByTagName(o)[0]; a.async = 1; a.src = g; m.parentNode.insertBefore(a, m)
})(window, document, 'script', 'https://www.google-analytics.com/analytics.js', 'ga');
ga('create', 'UA-54154153-2', 'auto');
ga('send', 'pageview');
</script>
</body>