gqli 0.6.0 → 1.2.0

data/doc/file.README.html

@@ -6,15 +6,15 @@
 <title>
   File: README
   
-    &mdash; Documentation by YARD 0.9.16
+    &mdash; Documentation by YARD 0.9.27
   
 </title>
 
-  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="css/style.css" type="text/css" />
 
-  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" />
 
-<script type="text/javascript" charset="utf-8">
+<script type="text/javascript">
   pathId = "README";
   relpath = '';
 </script>
@@ -65,9 +65,7 @@
 <blockquote>
 <p><strong>DISCLAIMER:</strong></p>
 
-<p>This gem is in stable state and will be updated with more features. You can
-start using it for your respective projects, although there is no support
-available from Contentful.</p>
+<p>This gem is in stable state and will be updated with more features. You can start using it for your respective projects, although there is no support available from Contentful.</p>
 
 <p>This gem is not covered under the Contentful SLAs.</p>
 
@@ -90,9 +88,7 @@ available from Contentful.</p>
 
 <h3 id="label-Creating+a+GraphQL+Client">Creating a GraphQL Client</h3>
 
-<p>For the examples throughout this README, we&#39;ll be using the Contentful
-and Github GraphQL APIs, for which we have factory methods. Therefore,
-here&#39;s the initialization code required for both of them:</p>
+<p>For the examples throughout this README, we&#39;ll be using the Contentful and Github GraphQL APIs, for which we have factory methods. Therefore, here&#39;s the initialization code required for both of them:</p>
 
 <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>gqli</span><span class='tstring_end'>&#39;</span></span>
 
@@ -106,8 +102,7 @@ here&#39;s the initialization code required for both of them:</p>
 <span class='const'>GITHUB_GQL</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="GQLi.html" title="GQLi (module)">GQLi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="GQLi/Github.html" title="GQLi::Github (module)">Github</a></span></span><span class='period'>.</span><span class='id identifier rubyid_create'><span class='object_link'><a href="GQLi/Github.html#create-class_method" title="GQLi::Github.create (method)">create</a></span></span><span class='lparen'>(</span><span class='const'>GITHUB_ACCESS_TOKEN</span><span class='rparen'>)</span>
 </code></pre>
 
-<p><em>Note</em>: Please feel free to contribute factories for your favorite
-GraphQL services.</p>
+<p><em>Note</em>: Please feel free to contribute factories for your favorite GraphQL services.</p>
 
 <p>For creating a custom GraphQL client:</p>
 
@@ -124,8 +119,7 @@ GraphQL services.</p>
 
 <h3 id="label-Creating+a+Query">Creating a Query</h3>
 
-<p>Queries are the way to request data from a GraphQL API. This gem provides a
-simple DSL to create your own queries.</p>
+<p>Queries are the way to request data from a GraphQL API. This gem provides a simple DSL to create your own queries.</p>
 
 <p>The query operator is <code>GQLi::DSL.query</code>.</p>
 
@@ -153,13 +147,11 @@ simple DSL to create your own queries.</p>
 
 <h3 id="label-Divide+and+conquer+-+using+Fragments">Divide and conquer - using Fragments</h3>
 
-<p>In order to reuse parts of queries, we can split chunks of our queries into
-Fragments.</p>
+<p>In order to reuse parts of queries, we can split chunks of our queries into Fragments.</p>
 
 <p>The fragment operator is <code>GQLi::DSL.fragment</code>.</p>
 
-<p>To include fragments within other nodes, use the <code><em>_</em></code>
-operator as shown below.</p>
+<p>To include fragments within other nodes, use the <code><em>_</em></code> operator as shown below.</p>
 
 <p>To do type matching, use the <code>__on</code> operator as shown below.</p>
 
@@ -203,10 +195,7 @@ operator as shown below.</p>
 
 <h3 id="label-Executing+the+queries">Executing the queries</h3>
 
-<p>To execute the queries, you need to pass a <code>Query</code> object to the
-client&#39;s <code>#execute</code> method. This will return a
-<code>Response</code> object which contains the <code>data</code> and the
-<code>query</code> executed.</p>
+<p>To execute the queries, you need to pass a <code>Query</code> object to the client&#39;s <code>#execute</code> method. This will return a <code>Response</code> object which contains the <code>data</code> and the <code>query</code> executed.</p>
 
 <p>For example:</p>
 
@@ -265,33 +254,21 @@ Best Friend:
 
 <h3 id="label-Schema+Introspection+and+Validation">Schema Introspection and Validation</h3>
 
-<p>By default this library will fetch and cache a copy of the GraphQL Schema
-for any API you create a client for.</p>
+<p>By default this library will fetch and cache a copy of the GraphQL Schema for any API you create a client for.</p>
 
-<p>This schema is used for query validation before running queries against the
-APIs. In case a query is invalid for the given schema, an exception will be
-raised.</p>
+<p>This schema is used for query validation before running queries against the APIs. In case a query is invalid for the given schema, an exception will be raised.</p>
 
-<p>To disable schema caching completely, when you initialize your client, send
-<code>validate_query: false</code>.</p>
+<p>To disable schema caching completely, when you initialize your client, send <code>validate_query: false</code>.</p>
 
-<p>Queries executed using the <code>#execute</code> method on the client will
-be validated before executing the request if the option is set to
-<code>true</code> (which it is by default).</p>
+<p>Queries executed using the <code>#execute</code> method on the client will be validated before executing the request if the option is set to <code>true</code> (which it is by default).</p>
 
 <p>To avoid validating a query, you can use <code>#execute!</code> instead.</p>
 
-<p>To validate the query outside of the scope of an HTTP request, you can use
-<code>MY_CLIENT.schema.valid?(query)</code>.</p>
+<p>To validate the query outside of the scope of an HTTP request, you can use <code>MY_CLIENT.schema.valid?(query)</code>.</p>
 
 <h3 id="label-Embedding+the+DSL+in+your+classes">Embedding the DSL in your classes</h3>
 
-<p>If you want to avoid the need for prepending all GQLi DSL&#39;s calls with
-<code>GQLi::DSL.</code>, then you can <code>extend</code> and/or
-<code>include</code> the module within your own classes. When using
-<code>extend</code>, you will have access to the DSL at a class level. When
-using <code>include</code> you will have access to the DSL at an object
-level.</p>
+<p>If you want to avoid the need for prepending all GQLi DSL&#39;s calls with <code>GQLi::DSL.</code>, then you can <code>extend</code> and/or <code>include</code> the module within your own classes. When using <code>extend</code>, you will have access to the DSL at a class level. When using <code>include</code> you will have access to the DSL at an object level.</p>
 
 <pre class="code ruby"><code class="ruby"><span class='kw'>class</span> <span class='const'>ContentfulClient</span>
   <span class='id identifier rubyid_extend'>extend</span> <span class='const'><span class='object_link'><a href="GQLi.html" title="GQLi (module)">GQLi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="GQLi/DSL.html" title="GQLi::DSL (module)">DSL</a></span></span> <span class='comment'># Makes DSL available at a class level
@@ -344,12 +321,9 @@ level.</p>
 
 <h3 id="label-Dealing+with+name+collisions">Dealing with name collisions</h3>
 
-<p>By defining queries via a DSL, you may sometimes find that the fields you
-query for are also the names of built-in methods or reserved keywords of
-the language.</p>
+<p>By defining queries via a DSL, you may sometimes find that the fields you query for are also the names of built-in methods or reserved keywords of the language.</p>
 
-<p>To avoid collisions you can use the <code>__node</code> helper, for
-example:</p>
+<p>To avoid collisions you can use the <code>__node</code> helper, for example:</p>
 
 <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_query'>query</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="GQLi.html" title="GQLi (module)">GQLi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="GQLi/DSL.html" title="GQLi::DSL (module)">DSL</a></span></span><span class='period'>.</span><span class='id identifier rubyid_query'><span class='object_link'><a href="GQLi/DSL.html#query-class_method" title="GQLi::DSL.query (method)">query</a></span></span> <span class='lbrace'>{</span>
   <span class='id identifier rubyid_catCollection'>catCollection</span> <span class='lbrace'>{</span>
@@ -362,8 +336,7 @@ example:</p>
 <span class='rbrace'>}</span>
 </code></pre>
 
-<p>The helper method <code>__node</code>, can also receive arguments and have
-children nodes as expected from any other node declaration, for example:</p>
+<p>The helper method <code>__node</code>, can also receive arguments and have children nodes as expected from any other node declaration, for example:</p>
 
 <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_query'>query</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="GQLi.html" title="GQLi (module)">GQLi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="GQLi/DSL.html" title="GQLi::DSL (module)">DSL</a></span></span><span class='period'>.</span><span class='id identifier rubyid_query'><span class='object_link'><a href="GQLi/DSL.html#query-class_method" title="GQLi::DSL.query (method)">query</a></span></span> <span class='lbrace'>{</span>
   <span class='id identifier rubyid___node'>__node</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>catCollection</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='label'>limit:</span> <span class='int'>5</span><span class='rparen'>)</span> <span class='lbrace'>{</span>
@@ -376,9 +349,7 @@ children nodes as expected from any other node declaration, for example:</p>
 
 <h3 id="label-Directives">Directives</h3>
 
-<p>In GraphQL, nodes can be selectively included or removed by the usage of
-directives, there are 2 directives available for the querying specification
-to do this: <code>@include</code> and <code>@skip</code>.</p>
+<p>In GraphQL, nodes can be selectively included or removed by the usage of directives, there are 2 directives available for the querying specification to do this: <code>@include</code> and <code>@skip</code>.</p>
 
 <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_query'>query</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="GQLi.html" title="GQLi (module)">GQLi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="GQLi/DSL.html" title="GQLi::DSL (module)">DSL</a></span></span><span class='period'>.</span><span class='id identifier rubyid_query'><span class='object_link'><a href="GQLi/DSL.html#query-class_method" title="GQLi::DSL.query (method)">query</a></span></span> <span class='lbrace'>{</span>
   <span class='id identifier rubyid_someNode'>someNode</span><span class='lparen'>(</span><span class='symbol'>:@include</span> <span class='op'>=&gt;</span> <span class='lbrace'>{</span><span class='label'>if:</span> <span class='id identifier rubyid_object'>object</span><span class='period'>.</span><span class='id identifier rubyid_includes_some_node?'>includes_some_node?</span><span class='rbrace'>}</span><span class='rparen'>)</span>
@@ -392,25 +363,18 @@ to do this: <code>@include</code> and <code>@skip</code>.</p>
 }
 </code></pre>
 
-<p>This behaviour is equivalent to using native Ruby to include/exclude a
-field from the query:</p>
+<p>This behaviour is equivalent to using native Ruby to include/exclude a field from the query:</p>
 
 <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_query'>query</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="GQLi.html" title="GQLi (module)">GQLi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="GQLi/DSL.html" title="GQLi::DSL (module)">DSL</a></span></span><span class='period'>.</span><span class='id identifier rubyid_query'><span class='object_link'><a href="GQLi/DSL.html#query-class_method" title="GQLi::DSL.query (method)">query</a></span></span> <span class='lbrace'>{</span>
   <span class='id identifier rubyid_someNode'>someNode</span> <span class='kw'>if</span> <span class='id identifier rubyid_object'>object</span><span class='period'>.</span><span class='id identifier rubyid_includes_some_node?'>includes_some_node?</span>
 <span class='rbrace'>}</span>
 </code></pre>
 
-<p>The difference is that by using the native implementation, in case of the
-condition not being met, the node will be completely not included in the
-outgoing query.</p>
+<p>The difference is that by using the native implementation, in case of the condition not being met, the node will be completely not included in the outgoing query.</p>
 
 <h3 id="label-Enums">Enums</h3>
 
-<p><a href="https://graphql.org/learn/schema/#enumeration-types">Enums</a> are
-a list of predefined values that are defined on the type system level.
-Since Ruby doesn&#39;t have built-in Enums that can be translated directly
-into GraphQL Enums, we created the <code>__enum</code> helper that you can
-use within your queries to transform your values into an Enum value.</p>
+<p><a href="https://graphql.org/learn/schema/#enumeration-types">Enums</a> are a list of predefined values that are defined on the type system level. Since Ruby doesn&#39;t have built-in Enums that can be translated directly into GraphQL Enums, we created the <code>__enum</code> helper that you can use within your queries to transform your values into an Enum value.</p>
 
 <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_query'>query</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="GQLi.html" title="GQLi (module)">GQLi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="GQLi/DSL.html" title="GQLi::DSL (module)">DSL</a></span></span><span class='period'>.</span><span class='id identifier rubyid_query'><span class='object_link'><a href="GQLi/DSL.html#query-class_method" title="GQLi::DSL.query (method)">query</a></span></span> <span class='lbrace'>{</span>
   <span class='id identifier rubyid_catCollection'>catCollection</span><span class='lparen'>(</span><span class='label'>order:</span> <span class='id identifier rubyid___enum'>__enum</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>lives_ASC</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='rparen'>)</span> <span class='lbrace'>{</span>
@@ -434,9 +398,7 @@ use within your queries to transform your values into an Enum value.</p>
 
 <h3 id="label-Aliases">Aliases</h3>
 
-<p>There may be times where it is useful to have parts of the query aliased,
-for example, when querying for <code>pinned</code> and
-<code>unpinned</code> articles for a news site.</p>
+<p>There may be times where it is useful to have parts of the query aliased, for example, when querying for <code>pinned</code> and <code>unpinned</code> articles for a news site.</p>
 
 <p>This can be accomplished as follows:</p>
 
@@ -464,42 +426,27 @@ for example, when querying for <code>pinned</code> and
 <span class='rbrace'>}</span>
 </code></pre>
 
-<h2 id="label-Yet+to+be+implemented">Yet to be implemented</h2>
-<ul><li>
-<p>Mutation queries</p>
-</li><li>
-<p>Subscription queries</p>
-</li></ul>
-
 <h2 id="label-Get+involved">Get involved</h2>
 
-<p><a href="http://makeapullrequest.com"><img
-src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?maxAge=31557600"></a></p>
+<p><a href="http://makeapullrequest.com"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?maxAge=31557600"></a></p>
 
 <p>We appreciate any help on our repositories.</p>
 
 <h2 id="label-License">License</h2>
 
-<p>This repository is published under the <a href="LICENSE.txt">MIT</a>
-license.</p>
+<p>This repository is published under the <a href="LICENSE.txt">MIT</a> license.</p>
 
 <h2 id="label-Code+of+Conduct">Code of Conduct</h2>
 
-<p>We want to provide a safe, inclusive, welcoming, and harassment-free space
-and experience for all participants, regardless of gender identity and
-expression, sexual orientation, disability, physical appearance,
-socioeconomic status, body size, ethnicity, nationality, level of
-experience, age, religion (or lack thereof), or other identity markers.</p>
+<p>We want to provide a safe, inclusive, welcoming, and harassment-free space and experience for all participants, regardless of gender identity and expression, sexual orientation, disability, physical appearance, socioeconomic status, body size, ethnicity, nationality, level of experience, age, religion (or lack thereof), or other identity markers.</p>
 
-<p><a
-href="https://github.com/contentful-developer-relations/community-code-of-conduct">Read
-our full Code of Conduct</a>.</p>
+<p><a href="https://github.com/contentful-developer-relations/community-code-of-conduct">Read our full Code of Conduct</a>.</p>
 </div></div>
 
       <div id="footer">
-  Generated on Sat Feb 16 22:53:59 2019 by
+  Generated on Mon Jan  3 17:37:12 2022 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.16 (ruby-2.5.3).
+  0.9.27 (ruby-3.0.3).
 </div>
 
     </div>

data/doc/file_list.html

@@ -4,9 +4,9 @@
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <meta charset="utf-8" />
     
-      <link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" charset="utf-8" />
+      <link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" />
     
-      <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
+      <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" />
     
 
     

data/doc/frames.html

@@ -2,9 +2,9 @@
 <html>
 <head>
   <meta charset="utf-8">
-	<title>Documentation by YARD 0.9.16</title>
+	<title>Documentation by YARD 0.9.27</title>
 </head>
-<script type="text/javascript" charset="utf-8">
+<script type="text/javascript">
   var match = unescape(window.location.hash).match(/^#!(.+)/);
   var name = match ? match[1] : 'index.html';
   name = name.replace(/^(\w+):\/\//, '').replace(/^\/\//, '');

data/doc/index.html

@@ -6,15 +6,15 @@
 <title>
   File: README
   
-    &mdash; Documentation by YARD 0.9.16
+    &mdash; Documentation by YARD 0.9.27
   
 </title>
 
-  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="css/style.css" type="text/css" />
 
-  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" />
 
-<script type="text/javascript" charset="utf-8">
+<script type="text/javascript">
   pathId = "README";
   relpath = '';
 </script>
@@ -65,9 +65,7 @@
 <blockquote>
 <p><strong>DISCLAIMER:</strong></p>
 
-<p>This gem is in stable state and will be updated with more features. You can
-start using it for your respective projects, although there is no support
-available from Contentful.</p>
+<p>This gem is in stable state and will be updated with more features. You can start using it for your respective projects, although there is no support available from Contentful.</p>
 
 <p>This gem is not covered under the Contentful SLAs.</p>
 
@@ -90,9 +88,7 @@ available from Contentful.</p>
 
 <h3 id="label-Creating+a+GraphQL+Client">Creating a GraphQL Client</h3>
 
-<p>For the examples throughout this README, we&#39;ll be using the Contentful
-and Github GraphQL APIs, for which we have factory methods. Therefore,
-here&#39;s the initialization code required for both of them:</p>
+<p>For the examples throughout this README, we&#39;ll be using the Contentful and Github GraphQL APIs, for which we have factory methods. Therefore, here&#39;s the initialization code required for both of them:</p>
 
 <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>gqli</span><span class='tstring_end'>&#39;</span></span>
 
@@ -106,8 +102,7 @@ here&#39;s the initialization code required for both of them:</p>
 <span class='const'>GITHUB_GQL</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="GQLi.html" title="GQLi (module)">GQLi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="GQLi/Github.html" title="GQLi::Github (module)">Github</a></span></span><span class='period'>.</span><span class='id identifier rubyid_create'><span class='object_link'><a href="GQLi/Github.html#create-class_method" title="GQLi::Github.create (method)">create</a></span></span><span class='lparen'>(</span><span class='const'>GITHUB_ACCESS_TOKEN</span><span class='rparen'>)</span>
 </code></pre>
 
-<p><em>Note</em>: Please feel free to contribute factories for your favorite
-GraphQL services.</p>
+<p><em>Note</em>: Please feel free to contribute factories for your favorite GraphQL services.</p>
 
 <p>For creating a custom GraphQL client:</p>
 
@@ -124,8 +119,7 @@ GraphQL services.</p>
 
 <h3 id="label-Creating+a+Query">Creating a Query</h3>
 
-<p>Queries are the way to request data from a GraphQL API. This gem provides a
-simple DSL to create your own queries.</p>
+<p>Queries are the way to request data from a GraphQL API. This gem provides a simple DSL to create your own queries.</p>
 
 <p>The query operator is <code>GQLi::DSL.query</code>.</p>
 
@@ -153,13 +147,11 @@ simple DSL to create your own queries.</p>
 
 <h3 id="label-Divide+and+conquer+-+using+Fragments">Divide and conquer - using Fragments</h3>
 
-<p>In order to reuse parts of queries, we can split chunks of our queries into
-Fragments.</p>
+<p>In order to reuse parts of queries, we can split chunks of our queries into Fragments.</p>
 
 <p>The fragment operator is <code>GQLi::DSL.fragment</code>.</p>
 
-<p>To include fragments within other nodes, use the <code><em>_</em></code>
-operator as shown below.</p>
+<p>To include fragments within other nodes, use the <code><em>_</em></code> operator as shown below.</p>
 
 <p>To do type matching, use the <code>__on</code> operator as shown below.</p>
 
@@ -203,10 +195,7 @@ operator as shown below.</p>
 
 <h3 id="label-Executing+the+queries">Executing the queries</h3>
 
-<p>To execute the queries, you need to pass a <code>Query</code> object to the
-client&#39;s <code>#execute</code> method. This will return a
-<code>Response</code> object which contains the <code>data</code> and the
-<code>query</code> executed.</p>
+<p>To execute the queries, you need to pass a <code>Query</code> object to the client&#39;s <code>#execute</code> method. This will return a <code>Response</code> object which contains the <code>data</code> and the <code>query</code> executed.</p>
 
 <p>For example:</p>
 
@@ -265,33 +254,21 @@ Best Friend:
 
 <h3 id="label-Schema+Introspection+and+Validation">Schema Introspection and Validation</h3>
 
-<p>By default this library will fetch and cache a copy of the GraphQL Schema
-for any API you create a client for.</p>
+<p>By default this library will fetch and cache a copy of the GraphQL Schema for any API you create a client for.</p>
 
-<p>This schema is used for query validation before running queries against the
-APIs. In case a query is invalid for the given schema, an exception will be
-raised.</p>
+<p>This schema is used for query validation before running queries against the APIs. In case a query is invalid for the given schema, an exception will be raised.</p>
 
-<p>To disable schema caching completely, when you initialize your client, send
-<code>validate_query: false</code>.</p>
+<p>To disable schema caching completely, when you initialize your client, send <code>validate_query: false</code>.</p>
 
-<p>Queries executed using the <code>#execute</code> method on the client will
-be validated before executing the request if the option is set to
-<code>true</code> (which it is by default).</p>
+<p>Queries executed using the <code>#execute</code> method on the client will be validated before executing the request if the option is set to <code>true</code> (which it is by default).</p>
 
 <p>To avoid validating a query, you can use <code>#execute!</code> instead.</p>
 
-<p>To validate the query outside of the scope of an HTTP request, you can use
-<code>MY_CLIENT.schema.valid?(query)</code>.</p>
+<p>To validate the query outside of the scope of an HTTP request, you can use <code>MY_CLIENT.schema.valid?(query)</code>.</p>
 
 <h3 id="label-Embedding+the+DSL+in+your+classes">Embedding the DSL in your classes</h3>
 
-<p>If you want to avoid the need for prepending all GQLi DSL&#39;s calls with
-<code>GQLi::DSL.</code>, then you can <code>extend</code> and/or
-<code>include</code> the module within your own classes. When using
-<code>extend</code>, you will have access to the DSL at a class level. When
-using <code>include</code> you will have access to the DSL at an object
-level.</p>
+<p>If you want to avoid the need for prepending all GQLi DSL&#39;s calls with <code>GQLi::DSL.</code>, then you can <code>extend</code> and/or <code>include</code> the module within your own classes. When using <code>extend</code>, you will have access to the DSL at a class level. When using <code>include</code> you will have access to the DSL at an object level.</p>
 
 <pre class="code ruby"><code class="ruby"><span class='kw'>class</span> <span class='const'>ContentfulClient</span>
   <span class='id identifier rubyid_extend'>extend</span> <span class='const'><span class='object_link'><a href="GQLi.html" title="GQLi (module)">GQLi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="GQLi/DSL.html" title="GQLi::DSL (module)">DSL</a></span></span> <span class='comment'># Makes DSL available at a class level
@@ -344,12 +321,9 @@ level.</p>
 
 <h3 id="label-Dealing+with+name+collisions">Dealing with name collisions</h3>
 
-<p>By defining queries via a DSL, you may sometimes find that the fields you
-query for are also the names of built-in methods or reserved keywords of
-the language.</p>
+<p>By defining queries via a DSL, you may sometimes find that the fields you query for are also the names of built-in methods or reserved keywords of the language.</p>
 
-<p>To avoid collisions you can use the <code>__node</code> helper, for
-example:</p>
+<p>To avoid collisions you can use the <code>__node</code> helper, for example:</p>
 
 <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_query'>query</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="GQLi.html" title="GQLi (module)">GQLi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="GQLi/DSL.html" title="GQLi::DSL (module)">DSL</a></span></span><span class='period'>.</span><span class='id identifier rubyid_query'><span class='object_link'><a href="GQLi/DSL.html#query-class_method" title="GQLi::DSL.query (method)">query</a></span></span> <span class='lbrace'>{</span>
   <span class='id identifier rubyid_catCollection'>catCollection</span> <span class='lbrace'>{</span>
@@ -362,8 +336,7 @@ example:</p>
 <span class='rbrace'>}</span>
 </code></pre>
 
-<p>The helper method <code>__node</code>, can also receive arguments and have
-children nodes as expected from any other node declaration, for example:</p>
+<p>The helper method <code>__node</code>, can also receive arguments and have children nodes as expected from any other node declaration, for example:</p>
 
 <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_query'>query</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="GQLi.html" title="GQLi (module)">GQLi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="GQLi/DSL.html" title="GQLi::DSL (module)">DSL</a></span></span><span class='period'>.</span><span class='id identifier rubyid_query'><span class='object_link'><a href="GQLi/DSL.html#query-class_method" title="GQLi::DSL.query (method)">query</a></span></span> <span class='lbrace'>{</span>
   <span class='id identifier rubyid___node'>__node</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>catCollection</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='label'>limit:</span> <span class='int'>5</span><span class='rparen'>)</span> <span class='lbrace'>{</span>
@@ -376,9 +349,7 @@ children nodes as expected from any other node declaration, for example:</p>
 
 <h3 id="label-Directives">Directives</h3>
 
-<p>In GraphQL, nodes can be selectively included or removed by the usage of
-directives, there are 2 directives available for the querying specification
-to do this: <code>@include</code> and <code>@skip</code>.</p>
+<p>In GraphQL, nodes can be selectively included or removed by the usage of directives, there are 2 directives available for the querying specification to do this: <code>@include</code> and <code>@skip</code>.</p>
 
 <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_query'>query</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="GQLi.html" title="GQLi (module)">GQLi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="GQLi/DSL.html" title="GQLi::DSL (module)">DSL</a></span></span><span class='period'>.</span><span class='id identifier rubyid_query'><span class='object_link'><a href="GQLi/DSL.html#query-class_method" title="GQLi::DSL.query (method)">query</a></span></span> <span class='lbrace'>{</span>
   <span class='id identifier rubyid_someNode'>someNode</span><span class='lparen'>(</span><span class='symbol'>:@include</span> <span class='op'>=&gt;</span> <span class='lbrace'>{</span><span class='label'>if:</span> <span class='id identifier rubyid_object'>object</span><span class='period'>.</span><span class='id identifier rubyid_includes_some_node?'>includes_some_node?</span><span class='rbrace'>}</span><span class='rparen'>)</span>
@@ -392,25 +363,18 @@ to do this: <code>@include</code> and <code>@skip</code>.</p>
 }
 </code></pre>
 
-<p>This behaviour is equivalent to using native Ruby to include/exclude a
-field from the query:</p>
+<p>This behaviour is equivalent to using native Ruby to include/exclude a field from the query:</p>
 
 <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_query'>query</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="GQLi.html" title="GQLi (module)">GQLi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="GQLi/DSL.html" title="GQLi::DSL (module)">DSL</a></span></span><span class='period'>.</span><span class='id identifier rubyid_query'><span class='object_link'><a href="GQLi/DSL.html#query-class_method" title="GQLi::DSL.query (method)">query</a></span></span> <span class='lbrace'>{</span>
   <span class='id identifier rubyid_someNode'>someNode</span> <span class='kw'>if</span> <span class='id identifier rubyid_object'>object</span><span class='period'>.</span><span class='id identifier rubyid_includes_some_node?'>includes_some_node?</span>
 <span class='rbrace'>}</span>
 </code></pre>
 
-<p>The difference is that by using the native implementation, in case of the
-condition not being met, the node will be completely not included in the
-outgoing query.</p>
+<p>The difference is that by using the native implementation, in case of the condition not being met, the node will be completely not included in the outgoing query.</p>
 
 <h3 id="label-Enums">Enums</h3>
 
-<p><a href="https://graphql.org/learn/schema/#enumeration-types">Enums</a> are
-a list of predefined values that are defined on the type system level.
-Since Ruby doesn&#39;t have built-in Enums that can be translated directly
-into GraphQL Enums, we created the <code>__enum</code> helper that you can
-use within your queries to transform your values into an Enum value.</p>
+<p><a href="https://graphql.org/learn/schema/#enumeration-types">Enums</a> are a list of predefined values that are defined on the type system level. Since Ruby doesn&#39;t have built-in Enums that can be translated directly into GraphQL Enums, we created the <code>__enum</code> helper that you can use within your queries to transform your values into an Enum value.</p>
 
 <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_query'>query</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="GQLi.html" title="GQLi (module)">GQLi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="GQLi/DSL.html" title="GQLi::DSL (module)">DSL</a></span></span><span class='period'>.</span><span class='id identifier rubyid_query'><span class='object_link'><a href="GQLi/DSL.html#query-class_method" title="GQLi::DSL.query (method)">query</a></span></span> <span class='lbrace'>{</span>
   <span class='id identifier rubyid_catCollection'>catCollection</span><span class='lparen'>(</span><span class='label'>order:</span> <span class='id identifier rubyid___enum'>__enum</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>lives_ASC</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='rparen'>)</span> <span class='lbrace'>{</span>
@@ -434,9 +398,7 @@ use within your queries to transform your values into an Enum value.</p>
 
 <h3 id="label-Aliases">Aliases</h3>
 
-<p>There may be times where it is useful to have parts of the query aliased,
-for example, when querying for <code>pinned</code> and
-<code>unpinned</code> articles for a news site.</p>
+<p>There may be times where it is useful to have parts of the query aliased, for example, when querying for <code>pinned</code> and <code>unpinned</code> articles for a news site.</p>
 
 <p>This can be accomplished as follows:</p>
 
@@ -464,42 +426,27 @@ for example, when querying for <code>pinned</code> and
 <span class='rbrace'>}</span>
 </code></pre>
 
-<h2 id="label-Yet+to+be+implemented">Yet to be implemented</h2>
-<ul><li>
-<p>Mutation queries</p>
-</li><li>
-<p>Subscription queries</p>
-</li></ul>
-
 <h2 id="label-Get+involved">Get involved</h2>
 
-<p><a href="http://makeapullrequest.com"><img
-src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?maxAge=31557600"></a></p>
+<p><a href="http://makeapullrequest.com"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?maxAge=31557600"></a></p>
 
 <p>We appreciate any help on our repositories.</p>
 
 <h2 id="label-License">License</h2>
 
-<p>This repository is published under the <a href="LICENSE.txt">MIT</a>
-license.</p>
+<p>This repository is published under the <a href="LICENSE.txt">MIT</a> license.</p>
 
 <h2 id="label-Code+of+Conduct">Code of Conduct</h2>
 
-<p>We want to provide a safe, inclusive, welcoming, and harassment-free space
-and experience for all participants, regardless of gender identity and
-expression, sexual orientation, disability, physical appearance,
-socioeconomic status, body size, ethnicity, nationality, level of
-experience, age, religion (or lack thereof), or other identity markers.</p>
+<p>We want to provide a safe, inclusive, welcoming, and harassment-free space and experience for all participants, regardless of gender identity and expression, sexual orientation, disability, physical appearance, socioeconomic status, body size, ethnicity, nationality, level of experience, age, religion (or lack thereof), or other identity markers.</p>
 
-<p><a
-href="https://github.com/contentful-developer-relations/community-code-of-conduct">Read
-our full Code of Conduct</a>.</p>
+<p><a href="https://github.com/contentful-developer-relations/community-code-of-conduct">Read our full Code of Conduct</a>.</p>
 </div></div>
 
       <div id="footer">
-  Generated on Sat Feb 16 22:53:59 2019 by
+  Generated on Mon Jan  3 17:37:12 2022 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.16 (ruby-2.5.3).
+  0.9.27 (ruby-3.0.3).
 </div>
 
     </div>

data/doc/js/app.js

@@ -171,6 +171,7 @@ function generateTOC() {
   var counter = 0;
   var tags = ['h2', 'h3', 'h4', 'h5', 'h6'];
   var i;
+  var curli;
   if ($('#filecontents h1').length > 1) tags.unshift('h1');
   for (i = 0; i < tags.length; i++) { tags[i] = '#filecontents ' + tags[i]; }
   var lastTag = parseInt(tags[0][1], 10);
@@ -190,15 +191,25 @@ function generateTOC() {
     }
     if (thisTag > lastTag) {
       for (i = 0; i < thisTag - lastTag; i++) {
-        var tmp = $('<ol/>'); toc.append(tmp); toc = tmp;
+        if ( typeof(curli) == "undefined" ) {
+          curli = $('<li/>');
+          toc.append(curli);
+        }
+        toc = $('<ol/>');
+        curli.append(toc);
+        curli = undefined;
       }
     }
     if (thisTag < lastTag) {
-      for (i = 0; i < lastTag - thisTag; i++) toc = toc.parent();
+      for (i = 0; i < lastTag - thisTag; i++) {
+        toc = toc.parent();
+        toc = toc.parent();
+      }
     }
     var title = $(this).attr('toc-title');
     if (typeof(title) == "undefined") title = $(this).text();
-    toc.append('<li><a href="#' + this.id + '">' + title + '</a></li>');
+    curli =$('<li><a href="#' + this.id + '">' + title + '</a></li>'); 
+    toc.append(curli);
     lastTag = thisTag;
   });
   if (!show) return;
@@ -275,6 +286,16 @@ function mainFocus() {
   setTimeout(function() { $('#main').focus(); }, 10);
 }
 
+function navigationChange() {
+  // This works around the broken anchor navigation with the YARD template.
+  window.onpopstate = function() {
+    var hash = window.location.hash;
+    if (hash !== '' && $(hash)[0]) {
+      $(hash)[0].scrollIntoView();
+    }
+  };
+}
+
 $(document).ready(function() {
   navResizer();
   navExpander();
@@ -287,6 +308,7 @@ $(document).ready(function() {
   constantSummaryToggle();
   generateTOC();
   mainFocus();
+  navigationChange();
 });
 
 })();