spectaql
Version:
A powerful library for autogenerating static GraphQL API documentation
889 lines • 123 kB
HTML
<!doctype html>
<html class="no-js" lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<link rel="icon" type="image/png" href="images/favicon.png" sizes="32x32">
<title>GraphQL API Reference</title>
<link rel="stylesheet" href="stylesheets/spectaql.min.css" />
<script src="javascripts/spectaql.min.js"></script>
</head>
<body id="spectaql">
<div id="page" class="drawer-layout">
<div id="sidebar">
<div class="sidebar-top-container">
<div id="logo">
<img src="images/logo.png" title="GraphQL API Reference" /> </div>
<button class="close-button" aria-label="Close menu" type="button">
<span aria-hidden="true">×</span>
</button>
</div>
<nav id="nav" role="navigation">
<div class="nav-group">
<h4 class="nav-group-title">Introduction</h4>
<ul class="nav-group-items">
<li>
<a href="#introduction">Welcome</a>
</li>
<li>
<a href="#introduction-item-0">Important thing 1</a>
</li>
</ul>
</div>
<div class="nav-group">
<h4 class="nav-group-title">Operations</h4>
<ul class="nav-group-items">
<li class="nav-group-section">
<h5 class="nav-group-section-title">
<a href="#group-Operations-Queries">Queries</a>
</h5>
<ul class="nav-group-section-items">
<li>
<a href="#query-contactInfoInputQuery">contactInfoInputQuery</a>
</li>
<li>
<a href="#query-enumsQuery">enumsQuery</a>
</li>
<li>
<a href="#query-filterInputQuery">filterInputQuery</a>
</li>
<li>
<a href="#query-getInts">getInts</a>
</li>
<li>
<a href="#query-myQuery">myQuery</a>
</li>
<li>
<a href="#query-myTypes">myTypes</a>
</li>
<li>
<a href="#query-nodeQuery">nodeQuery</a>
</li>
<li>
<a href="#query-optionalsQuery">optionalsQuery</a>
</li>
<li>
<a href="#query-requiredsQuery">requiredsQuery</a>
</li>
<li>
<a href="#query-simpleTypes">simpleTypes</a>
</li>
<li>
<a href="#query-stringThing">stringThing</a>
</li>
</ul>
</li>
<li class="nav-group-section">
<h5 class="nav-group-section-title">
<a href="#group-Operations-Mutations">Mutations</a>
</h5>
<ul class="nav-group-section-items">
<li>
<a href="#mutation-myMutation">myMutation</a>
</li>
<li>
<a href="#mutation-stringThing">stringThing</a>
</li>
</ul>
</li>
</ul>
</div>
<div class="nav-group">
<h4 class="nav-group-title">Types</h4>
<ul class="nav-group-items">
<li>
<a href="#definition-AddressInput">AddressInput</a>
</li>
<li>
<a href="#definition-Boolean">Boolean</a>
</li>
<li>
<a href="#definition-Byte">Byte</a>
</li>
<li>
<a href="#definition-ContactInfoInput">ContactInfoInput</a>
</li>
<li>
<a href="#definition-DateTime">DateTime</a>
</li>
<li>
<a href="#definition-EpisodeEnum">EpisodeEnum</a>
</li>
<li>
<a href="#definition-FilterInput">FilterInput</a>
</li>
<li>
<a href="#definition-ID">ID</a>
</li>
<li>
<a href="#definition-Int">Int</a>
</li>
<li>
<a href="#definition-JSON">JSON</a>
</li>
<li>
<a href="#definition-JSONObject">JSONObject</a>
</li>
<li>
<a href="#definition-MyType">MyType</a>
</li>
<li>
<a href="#definition-Node">Node</a>
</li>
<li>
<a href="#definition-PhoneNumber">PhoneNumber</a>
</li>
<li>
<a href="#definition-SimpleTypeOne">SimpleTypeOne</a>
</li>
<li>
<a href="#definition-SimpleTypeTwo">SimpleTypeTwo</a>
</li>
<li>
<a href="#definition-SimpleTypes">SimpleTypes</a>
</li>
<li>
<a href="#definition-String">String</a>
</li>
<li>
<a href="#definition-URL">URL</a>
</li>
<li>
<a href="#definition-Void">Void</a>
</li>
</ul>
</div>
<div class="nav-group">
<h4 class="nav-group-title">Subscriptions</h4>
<ul class="nav-group-items">
<li>
<a href="#subscription-myTypeUpdatedSubscription">myTypeUpdatedSubscription</a>
</li>
</ul>
</div>
</nav>
</div>
<div id="docs">
<div id="mobile-navbar">
<button class="sidebar-open-button" type="button">
<span class="hamburger"></span>
</button>
</div>
<article id="content">
<h1 class="doc-heading">GraphQL API Reference</h1>
<div id="introduction" data-traverse-target="introduction">
<div id="welcome" class="doc-row">
<div class="doc-copy">
<p>Welcome to the party!</p>
</div>
<div class="doc-examples">
<div class="example-section welcome-contact-section">
<h5>Contact</h5>
<p class="contact-name">API Support</p>
<p class="contact-email">
<a href="mailto:support@example.com">support@example.com</a>
</p>
</div>
<div class="example-section welcome-license-section">
<h5>License</h5>
<p class="license-name">Apache 2.0</p>
<p class="license-url">
<a href="https://www.apache.org/licenses/LICENSE-2.0.html">https://www.apache.org/licenses/LICENSE-2.0.html</a>
</p>
</div>
<div class="example-section welcome-tos-section">
<h5>Terms of Service</h5>
<p>
<a href="https://www.example.com/terms">https://www.example.com/terms</a>
</p>
</div>
<div class="example-section welcome-api-endpoints-section example-section-is-code">
<h5>API Endpoints</h5> <pre><code>https://example.com/graphql</code></pre> </div>
<div class="example-section welcome-api-endpoints-section example-section-is-code">
<h5>Headers</h5> <pre><code>// Your foo from bar
Authorization: Bearer <YOUR_TOKEN_HERE></code></pre> </div>
</div>
</div>
<div id="introduction-item-0" class="introduction-item" data-traverse-target="introduction-item-0">
<h2 class="introduction-item-title">Important thing 1</h2>
<div class="doc-row">
<div class="doc-copy">
<p>Some important stuff we wanted you to know. Supports <code>markdown</code></p>
</div>
<div class="doc-examples"> </div>
</div>
</div>
</div>
<h1 id="group-Operations-Queries" class="group-heading" data-traverse-target="group-Operations-Queries">Queries</h1>
<section id="query-contactInfoInputQuery" class="operation operation-query" data-traverse-target="query-contactInfoInputQuery">
<h2 class="operation-heading "> <code>contactInfoInputQuery</code> </h2>
<div class="doc-row">
<div class="doc-copy">
<div class="operation-description doc-copy-section">
<h5>Description</h5>
<p>Without this Query, the <code>ContactInfoInput</code> would not be shown</p>
</div>
</div>
</div>
<div class="doc-row">
<div class="doc-copy">
<div class="operation-response doc-copy-section">
<h5>Response</h5>
<p> Returns a
<a href="#definition-MyType"><code>MyType</code></a>
</p>
</div>
<div class="operation-arguments doc-copy-section">
<h5>Arguments</h5>
<table>
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<span class="property-name"><code>input</code></span> -
<span class="property-type">
<a href="#definition-ContactInfoInput"><code>ContactInfoInput</code></a>
</span>
</td>
<td> Without this arg, the <code>ContactInfoInput</code> would not be shown </td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="doc-examples">
<h4 class="example-heading">Example</h4>
<div class="example-section example-section-is-code operation-query-example">
<h5>Query</h5>
<html>
<head></head>
<body><pre><code class="hljs language-gql"><span class="hljs-symbol"><span class="hljs-keyword">query</span> ContactInfoInputQuery<span class="hljs-tag">(<span class="hljs-code">$input</span>:<span class="hljs-type"> ContactInfoInput)</span> {
contactInfoInputQuery(input: <span class="hljs-code">$input</span>)</span> <span class="hljs-tag">{
<span class="hljs-symbol">url</span>
<span class="hljs-symbol">json</span>
<span class="hljs-symbol">jso</span>
<span class="hljs-symbol">vd</span>
<span class="hljs-symbol">byte</span>
<span class="hljs-symbol">createdAt</span>
<span class="hljs-symbol">nonRequiredField</span>
<span class="hljs-symbol">requiredField</span>
<span class="hljs-symbol">episode</span>
<span class="hljs-symbol">requiredArrayField</span>
<span class="hljs-symbol">doubleRequiredArrayField</span>
}</span></span>
}
</code></pre> </body>
</html>
</div>
<div class="example-section example-section-is-code operation-variables-example">
<h5>Variables</h5>
<html>
<head></head>
<body><pre><code class="hljs language-json"><span class="hljs-punctuation">{</span><span class="hljs-attr">"input"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">ContactInfoInput</span><span class="hljs-punctuation">}</span>
</code></pre> </body>
</html>
</div>
<div class="example-section example-section-is-code operation-response-example">
<h5>Response</h5>
<html>
<head></head>
<body><pre><code class="hljs language-json"><span class="hljs-punctuation">{</span>
<span class="hljs-attr">"data"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
<span class="hljs-attr">"contactInfoInputQuery"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
<span class="hljs-attr">"url"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"http://www.test.com/"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"json"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span><span class="hljs-punctuation">}</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"jso"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span><span class="hljs-punctuation">}</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"vd"</span><span class="hljs-punctuation">:</span> <span class="hljs-keyword">null</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"byte"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">[</span><span class="hljs-number">196</span><span class="hljs-punctuation">,</span> <span class="hljs-number">189</span><span class="hljs-punctuation">,</span> <span class="hljs-number">173</span><span class="hljs-punctuation">,</span> <span class="hljs-number">171</span><span class="hljs-punctuation">,</span> <span class="hljs-number">167</span><span class="hljs-punctuation">,</span> <span class="hljs-number">163</span><span class="hljs-punctuation">]</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"createdAt"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"2016-10-07T01:08:03.420Z"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"nonRequiredField"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"Metadata example of `nonRequiredField`"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"requiredField"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"Generated Field example for requiredField"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"episode"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"NEWHOPE"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"requiredArrayField"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">[</span><span class="hljs-string">"Generated Field example for requiredArrayField"</span><span class="hljs-punctuation">]</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"doubleRequiredArrayField"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">[</span>
<span class="hljs-string">"Generated Field example for doubleRequiredArrayField"</span>
<span class="hljs-punctuation">]</span>
<span class="hljs-punctuation">}</span>
<span class="hljs-punctuation">}</span>
<span class="hljs-punctuation">}</span>
</code></pre> </body>
</html>
</div>
</div>
</div>
</section>
<section id="query-enumsQuery" class="operation operation-query" data-traverse-target="query-enumsQuery">
<div class="operation-group-name">
<a href="#group-Operations-Queries">Queries</a>
</div>
<h2 class="operation-heading "> <code>enumsQuery</code> </h2>
<div class="doc-row">
<div class="doc-copy">
<div class="operation-response doc-copy-section">
<h5>Response</h5>
<p> Returns a
<a href="#definition-String"><code>String</code></a>
</p>
</div>
<div class="operation-arguments doc-copy-section">
<h5>Arguments</h5>
<table>
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<span class="property-name"><code>enums</code></span> -
<span class="property-type">
<a href="#definition-EpisodeEnum"><code>[EpisodeEnum!]!</code></a>
</span>
</td>
<td> Default = <code>[EMPIRE, JEDI]</code> </td>
</tr>
<tr>
<td>
<span class="property-name"><code>enum</code></span> -
<span class="property-type">
<a href="#definition-EpisodeEnum"><code>EpisodeEnum!</code></a>
</span>
</td>
<td> enum defaults should get literalized. Default = <code>EMPIRE</code> </td>
</tr>
<tr>
<td>
<span class="property-name"><code>ints</code></span> -
<span class="property-type">
<a href="#definition-Int"><code>[Int]</code></a>
</span>
</td>
<td> everything else should get JSON5.parsed. Default = <code>[1, 2, 3]</code> </td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="doc-examples">
<h4 class="example-heading">Example</h4>
<div class="example-section example-section-is-code operation-query-example">
<h5>Query</h5>
<html>
<head></head>
<body><pre><code class="hljs language-gql"><span class="hljs-symbol"><span class="hljs-keyword">query</span> EnumsQuery<span class="hljs-tag">(
<span class="hljs-code">$enums</span>: <span class="hljs-type">[EpisodeEnum!</span>]!,
<span class="hljs-code">$enum</span>:<span class="hljs-type"> EpisodeEnum!</span>,
<span class="hljs-code">$ints</span>: <span class="hljs-type">[Int]</span>
)</span> <span class="hljs-tag">{
<span class="hljs-symbol">enumsQuery<span class="hljs-tag">(
enums: <span class="hljs-code">$enums</span>,
enum: <span class="hljs-code">$enum</span>,
ints: <span class="hljs-code">$ints</span>
)</span></span>
}</span></span>
</code></pre> </body>
</html>
</div>
<div class="example-section example-section-is-code operation-variables-example">
<h5>Variables</h5>
<html>
<head></head>
<body><pre><code class="hljs language-json"><span class="hljs-punctuation">{</span><span class="hljs-attr">"enums"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">[</span><span class="hljs-string">"EMPIRE"</span><span class="hljs-punctuation">,</span> <span class="hljs-string">"JEDI"</span><span class="hljs-punctuation">]</span><span class="hljs-punctuation">,</span> <span class="hljs-attr">"enum"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"EMPIRE"</span><span class="hljs-punctuation">,</span> <span class="hljs-attr">"ints"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">[</span><span class="hljs-number">1</span><span class="hljs-punctuation">,</span> <span class="hljs-number">2</span><span class="hljs-punctuation">,</span> <span class="hljs-number">3</span><span class="hljs-punctuation">]</span><span class="hljs-punctuation">}</span>
</code></pre> </body>
</html>
</div>
<div class="example-section example-section-is-code operation-response-example">
<h5>Response</h5>
<html>
<head></head>
<body><pre><code class="hljs language-json"><span class="hljs-punctuation">{</span><span class="hljs-attr">"data"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span><span class="hljs-attr">"enumsQuery"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"abc123"</span><span class="hljs-punctuation">}</span><span class="hljs-punctuation">}</span>
</code></pre> </body>
</html>
</div>
</div>
</div>
</section>
<section id="query-filterInputQuery" class="operation operation-query" data-traverse-target="query-filterInputQuery">
<div class="operation-group-name">
<a href="#group-Operations-Queries">Queries</a>
</div>
<h2 class="operation-heading "> <code>filterInputQuery</code> </h2>
<div class="doc-row">
<div class="doc-copy">
<div class="operation-description doc-copy-section">
<h5>Description</h5>
<p>Without this Query, the <code>FilterInput</code> would not be shown</p>
</div>
</div>
</div>
<div class="doc-row">
<div class="doc-copy">
<div class="operation-response doc-copy-section">
<h5>Response</h5>
<p> Returns a
<a href="#definition-MyType"><code>MyType</code></a>
</p>
</div>
<div class="operation-arguments doc-copy-section">
<h5>Arguments</h5>
<table>
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<span class="property-name"><code>filter</code></span> -
<span class="property-type">
<a href="#definition-FilterInput"><code>FilterInput</code></a>
</span>
</td>
<td> Without this Query, the <code>FilterInput</code> would not be shown </td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="doc-examples">
<h4 class="example-heading">Example</h4>
<div class="example-section example-section-is-code operation-query-example">
<h5>Query</h5>
<html>
<head></head>
<body><pre><code class="hljs language-gql"><span class="hljs-symbol"><span class="hljs-keyword">query</span> FilterInputQuery<span class="hljs-tag">(<span class="hljs-code">$filter</span>:<span class="hljs-type"> FilterInput)</span> {
filterInputQuery(filter: <span class="hljs-code">$filter</span>)</span> <span class="hljs-tag">{
<span class="hljs-symbol">url</span>
<span class="hljs-symbol">json</span>
<span class="hljs-symbol">jso</span>
<span class="hljs-symbol">vd</span>
<span class="hljs-symbol">byte</span>
<span class="hljs-symbol">createdAt</span>
<span class="hljs-symbol">nonRequiredField</span>
<span class="hljs-symbol">requiredField</span>
<span class="hljs-symbol">episode</span>
<span class="hljs-symbol">requiredArrayField</span>
<span class="hljs-symbol">doubleRequiredArrayField</span>
}</span></span>
}
</code></pre> </body>
</html>
</div>
<div class="example-section example-section-is-code operation-variables-example">
<h5>Variables</h5>
<html>
<head></head>
<body><pre><code class="hljs language-json"><span class="hljs-punctuation">{</span><span class="hljs-attr">"filter"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">FilterInput</span><span class="hljs-punctuation">}</span>
</code></pre> </body>
</html>
</div>
<div class="example-section example-section-is-code operation-response-example">
<h5>Response</h5>
<html>
<head></head>
<body><pre><code class="hljs language-json"><span class="hljs-punctuation">{</span>
<span class="hljs-attr">"data"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
<span class="hljs-attr">"filterInputQuery"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
<span class="hljs-attr">"url"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"http://www.test.com/"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"json"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span><span class="hljs-punctuation">}</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"jso"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span><span class="hljs-punctuation">}</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"vd"</span><span class="hljs-punctuation">:</span> <span class="hljs-keyword">null</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"byte"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">[</span><span class="hljs-number">196</span><span class="hljs-punctuation">,</span> <span class="hljs-number">189</span><span class="hljs-punctuation">,</span> <span class="hljs-number">173</span><span class="hljs-punctuation">,</span> <span class="hljs-number">171</span><span class="hljs-punctuation">,</span> <span class="hljs-number">167</span><span class="hljs-punctuation">,</span> <span class="hljs-number">163</span><span class="hljs-punctuation">]</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"createdAt"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"2016-10-07T01:08:03.420Z"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"nonRequiredField"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"Metadata example of `nonRequiredField`"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"requiredField"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"Generated Field example for requiredField"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"episode"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"NEWHOPE"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"requiredArrayField"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">[</span><span class="hljs-string">"Generated Field example for requiredArrayField"</span><span class="hljs-punctuation">]</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"doubleRequiredArrayField"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">[</span>
<span class="hljs-string">"Generated Field example for doubleRequiredArrayField"</span>
<span class="hljs-punctuation">]</span>
<span class="hljs-punctuation">}</span>
<span class="hljs-punctuation">}</span>
<span class="hljs-punctuation">}</span>
</code></pre> </body>
</html>
</div>
</div>
</div>
</section>
<section id="query-getInts" class="operation operation-query" data-traverse-target="query-getInts">
<div class="operation-group-name">
<a href="#group-Operations-Queries">Queries</a>
</div>
<h2 class="operation-heading "> <code>getInts</code> </h2>
<div class="doc-row">
<div class="doc-copy">
<div class="operation-response doc-copy-section">
<h5>Response</h5>
<p> Returns
<a href="#definition-Int"><code>[Int]</code></a>
</p>
</div>
</div>
<div class="doc-examples">
<h4 class="example-heading">Example</h4>
<div class="example-section example-section-is-code operation-query-example">
<h5>Query</h5>
<html>
<head></head>
<body><pre><code class="hljs language-gql"><span class="hljs-symbol"><span class="hljs-keyword">query</span> GetInts <span class="hljs-tag">{
<span class="hljs-symbol">getInts</span>
}</span></span>
</code></pre> </body>
</html>
</div>
<div class="example-section example-section-is-code operation-response-example">
<h5>Response</h5>
<html>
<head></head>
<body><pre><code class="hljs language-json"><span class="hljs-punctuation">{</span><span class="hljs-attr">"data"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span><span class="hljs-attr">"getInts"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">[</span><span class="hljs-number">42</span><span class="hljs-punctuation">]</span><span class="hljs-punctuation">}</span><span class="hljs-punctuation">}</span>
</code></pre> </body>
</html>
</div>
</div>
</div>
</section>
<section id="query-myQuery" class="operation operation-query" data-traverse-target="query-myQuery">
<div class="operation-group-name">
<a href="#group-Operations-Queries">Queries</a>
</div>
<h2 class="operation-heading operation-deprecated"> <code>myQuery</code> </h2>
<div class="doc-row">
<div class="doc-copy">
<div class="doc-copy-section">
<div class="deprecation-reason"> <code>myQuery</code> is going away </div>
</div>
</div>
</div>
<div class="doc-row">
<div class="doc-copy">
<div class="operation-description doc-copy-section">
<h5>Description</h5>
<p><code>Markdown</code> and reference interpolation like
<a href="#definition-String"><code>[String!]!</code></a> are supported</p>
</div>
</div>
</div>
<div class="doc-row">
<div class="doc-copy">
<div class="operation-response doc-copy-section">
<h5>Response</h5>
<p> Returns a
<a href="#definition-String"><code>String</code></a>
</p>
</div>
<div class="operation-arguments doc-copy-section">
<h5>Arguments</h5>
<table>
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<span class="property-name"><code>nonReqQueryArg</code></span> -
<span class="property-type">
<a href="#definition-String"><code>String</code></a>
</span>
</td>
<td> <code>Markdown</code> and reference interpolation like
<a href="#definition-String"><code>[String!]!</code></a> are supported. Default = <code>"some default string"</code> </td>
</tr>
<tr>
<td>
<span class="property-name"><code>reqQueryArg</code></span> -
<span class="property-type">
<a href="#definition-String"><code>String</code></a>
</span>
</td>
<td> </td>
</tr>
<tr>
<td>
<span class="property-name"><code>reqQueryArrayArg</code></span> -
<span class="property-type">
<a href="#definition-String"><code>[String]!</code></a>
</span>
</td>
<td> </td>
</tr>
<tr>
<td>
<span class="property-name"><code>dblReqQueryArrayArg</code></span> -
<span class="property-type">
<a href="#definition-String"><code>[String!]!</code></a>
</span>
</td>
<td> </td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="doc-examples">
<h4 class="example-heading">Example</h4>
<div class="example-section example-section-is-code operation-query-example">
<h5>Query</h5>
<html>
<head></head>
<body><pre><code class="hljs language-gql"><span class="hljs-symbol"><span class="hljs-keyword">query</span> MyQuery<span class="hljs-tag">(
<span class="hljs-code">$nonReqQueryArg</span>:<span class="hljs-type"> String,</span>
<span class="hljs-code">$reqQueryArg</span>:<span class="hljs-type"> String,</span>
<span class="hljs-code">$reqQueryArrayArg</span>: <span class="hljs-type">[String]</span>!,
<span class="hljs-code">$dblReqQueryArrayArg</span>: <span class="hljs-type">[String!</span>]!
)</span> <span class="hljs-tag">{
<span class="hljs-symbol">myQuery<span class="hljs-tag">(
nonReqQueryArg: <span class="hljs-code">$nonReqQueryArg</span>,
reqQueryArg: <span class="hljs-code">$reqQueryArg</span>,
reqQueryArrayArg: <span class="hljs-code">$reqQueryArrayArg</span>,
dblReqQueryArrayArg: <span class="hljs-code">$dblReqQueryArrayArg</span>
)</span></span>
}</span></span>
</code></pre> </body>
</html>
</div>
<div class="example-section example-section-is-code operation-variables-example">
<h5>Variables</h5>
<html>
<head></head>
<body><pre><code class="hljs language-json"><span class="hljs-punctuation">{</span>
<span class="hljs-attr">"nonReqQueryArg"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"Metadata example of `nonReqQueryArg`"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"reqQueryArg"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"Special generated Argument example for myQuery reqQueryArg"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"reqQueryArrayArg"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">[</span>
<span class="hljs-string">"Special generated Argument example for myQuery reqQueryArrayArg"</span>
<span class="hljs-punctuation">]</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"dblReqQueryArrayArg"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">[</span>
<span class="hljs-string">"Special generated Argument example for myQuery dblReqQueryArrayArg"</span>
<span class="hljs-punctuation">]</span>
<span class="hljs-punctuation">}</span>
</code></pre> </body>
</html>
</div>
<div class="example-section example-section-is-code operation-response-example">
<h5>Response</h5>
<html>
<head></head>
<body><pre><code class="hljs language-json"><span class="hljs-punctuation">{</span><span class="hljs-attr">"data"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span><span class="hljs-attr">"myQuery"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"abc123"</span><span class="hljs-punctuation">}</span><span class="hljs-punctuation">}</span>
</code></pre> </body>
</html>
</div>
</div>
</div>
</section>
<section id="query-myTypes" class="operation operation-query" data-traverse-target="query-myTypes">
<div class="operation-group-name">
<a href="#group-Operations-Queries">Queries</a>
</div>
<h2 class="operation-heading "> <code>myTypes</code> </h2>
<div class="doc-row">
<div class="doc-copy">
<div class="operation-response doc-copy-section">
<h5>Response</h5>
<p> Returns
<a href="#definition-MyType"><code>[MyType]</code></a>
</p>
</div>
</div>
<div class="doc-examples">
<h4 class="example-heading">Example</h4>
<div class="example-section example-section-is-code operation-query-example">
<h5>Query</h5>
<html>
<head></head>
<body><pre><code class="hljs language-gql"><span class="hljs-symbol"><span class="hljs-keyword">query</span> MyTypes <span class="hljs-tag">{
<span class="hljs-symbol">myTypes <span class="hljs-tag">{
<span class="hljs-symbol">url</span>
<span class="hljs-symbol">json</span>
<span class="hljs-symbol">jso</span>
<span class="hljs-symbol">vd</span>
<span class="hljs-symbol">byte</span>
<span class="hljs-symbol">createdAt</span>
<span class="hljs-symbol">nonRequiredField</span>
<span class="hljs-symbol">requiredField</span>
<span class="hljs-symbol">episode</span>
<span class="hljs-symbol">requiredArrayField</span>
<span class="hljs-symbol">doubleRequiredArrayField</span>
}</span></span>
}</span></span>
</code></pre> </body>
</html>
</div>
<div class="example-section example-section-is-code operation-response-example">
<h5>Response</h5>
<html>
<head></head>
<body><pre><code class="hljs language-json"><span class="hljs-punctuation">{</span>
<span class="hljs-attr">"data"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
<span class="hljs-attr">"myTypes"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span>
<span class="hljs-attr">"url"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"http://www.test.com/"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"json"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span><span class="hljs-punctuation">}</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"jso"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span><span class="hljs-punctuation">}</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"vd"</span><span class="hljs-punctuation">:</span> <span class="hljs-keyword">null</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"byte"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">[</span><span class="hljs-number">196</span><span class="hljs-punctuation">,</span> <span class="hljs-number">189</span><span class="hljs-punctuation">,</span> <span class="hljs-number">173</span><span class="hljs-punctuation">,</span> <span class="hljs-number">171</span><span class="hljs-punctuation">,</span> <span class="hljs-number">167</span><span class="hljs-punctuation">,</span> <span class="hljs-number">163</span><span class="hljs-punctuation">]</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"createdAt"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"2016-10-07T01:08:03.420Z"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"nonRequiredField"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"Metadata example of `nonRequiredField`"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"requiredField"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"Generated Field example for requiredField"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"episode"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"NEWHOPE"</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"requiredArrayField"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">[</span><span class="hljs-string">"Generated Field example for requiredArrayField"</span><span class="hljs-punctuation">]</span><span class="hljs-punctuation">,</span>
<span class="hljs-attr">"doubleRequiredArrayField"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">[</span>
<span class="hljs-string">"Generated Field example for doubleRequiredArrayField"</span>
<span class="hljs-punctuation">]</span>
<span class="hljs-punctuation">}</span>
<span class="hljs-punctuation">}</span>
<span class="hljs-punctuation">}</span>
</code></pre> </body>
</html>
</div>
</div>
</div>
</section>
<section id="query-nodeQuery" class="operation operation-query" data-traverse-target="query-nodeQuery">
<div class="operation-group-name">
<a href="#group-Operations-Queries">Queries</a>
</div>
<h2 class="operation-heading "> <code>nodeQuery</code> </h2>
<div class="doc-row">
<div class="doc-copy">
<div class="operation-response doc-copy-section">
<h5>Response</h5>
<p> Returns a
<a href="#definition-Node"><code>Node</code></a>
</p>
</div>
<div class="operation-arguments doc-copy-section">
<h5>Arguments</h5>
<table>
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<span class="property-name"><code>id</code></span> -
<span class="property-type">
<a href="#definition-String"><code>String!</code></a>
</span>
</td>
<td> </td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="doc-examples">
<h4 class="example-heading">Example</h4>
<div class="example-section example-section-is-code operation-query-example">
<h5>Query</h5>
<html>
<head></head>
<body><pre><code class="hljs language-gql"><span class="hljs-symbol"><span class="hljs-keyword">query</span> NodeQuery<span class="hljs-tag">(<span class="hljs-code">$id</span>:<span class="hljs-type"> String!</span>)</span> <span class="hljs-tag">{
<span class="hljs-symbol">nodeQuery<span class="hljs-tag">(id: <span class="hljs-code">$id</span>)</span> <span class="hljs-tag">{
<span class="hljs-symbol">id</span>
}</span></span>
}</span></span>
</code></pre> </body>
</html>
</div>
<div class="example-section example-section-is-code operation-variables-example">
<h5>Variables</h5>
<html>
<head></head>
<body><pre><code class="hljs language-json"><span class="hljs-punctuation">{</span><span class="hljs-attr">"id"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"Generated Argument example for nodeQuery id"</span><span class="hljs-punctuation">}</span>
</code></pre> </body>
</html>
</div>
<div class="example-section example-section-is-code operation-response-example">
<h5>Response</h5>
<html>
<head></head>
<body><pre><code class="hljs language-json"><span class="hljs-punctuation">{</span><span class="hljs-attr">"data"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span><span class="hljs-attr">"nodeQuery"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">{</span><span class="hljs-attr">"id"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"abc123"</span><span class="hljs-punctuation">}</span><span class="hljs-punctuation">}</span><span class="hljs-punctuation">}</span>
</code></pre> </body>
</html>
</div>
</div>
</div>
</section>
<section id="query-optionalsQuery" class="operation operation-query" data-traverse-target="query-optionalsQuery">
<div class="operation-group-name">
<a href="#group-Operations-Queries">Queries</a>
</div>
<h2 class="operation-heading "> <code>optionalsQuery</code> </h2>
<div class="doc-row">
<div class="doc-copy">
<div class="operation-description doc-copy-section">
<h5>Description</h5>
<p>I'm the optionals query</p>
</div>
</div>
</div>
<div class="doc-row">
<div class="doc-copy">
<div class="operation-response doc-copy-section">
<h5>Response</h5>
<p> Returns
<a href="#definition-String"><code>[String]</code></a>
</p>
</div>
<div class="operation-arguments doc-copy-section">
<h5>Arguments</h5>
<table>
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<span class="property-name"><code>optionalArg</code></span> -
<span class="property-type">
<a href="#definition-String"><code>[String]</code></a>
</span>
</td>
<td> </td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="doc-examples">
<h4 class="example-heading">Example</h4>
<div class="example-section example-section-is-code operation-query-example">
<h5>Query</h5>
<html>
<head></head>
<body><pre><code class="hljs language-gql"><span class="hljs-symbol"><span class="hljs-keyword">query</span> OptionalsQuery<span class="hljs-tag">(<span class="hljs-code">$optionalArg</span>: <span class="hljs-type">[String]</span>)</span> <span class="hljs-tag">{
<span class="hljs-symbol">optionalsQuery<span class="hljs-tag">(optionalArg: <span class="hljs-code">$optionalArg</span>)</span></span>
}</span></span>
</code></pre> </body>
</html>
</div>
<div class="example-section example-section-is-code operation-variables-example">
<h5>Variables</h5>
<html>
<head></head>
<body><pre><code class="hljs language-json"><span class="hljs-punctuation">{</span><span class="hljs-attr">"optionalArg"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">[</span><span class="hljs-string">"Generated Argument example for optionalsQuery optionalArg"</span><span class="hljs-punctuation">]</span><span class="hljs-punctuation">}</span>
</code></pre> </body>
</html>
</div>
<div class="example-section example-section-is-code operation-response-example">
<h5>Response</h5>
<html>
<head></head>
<body><