Deployed 08df171 with MkDocs version: 1.5.3

supabase · Dec 21, 2023 · d27ebf6 · d27ebf6
1 parent 487b347
commit d27ebf6
Show file tree

Hide file tree

Showing 6 changed files with 211 additions and 28 deletions.
diff --git a/changelog/index.html b/changelog/index.html
@@ -803,6 +803,8 @@ <h2 id="142">1.4.2</h2>
 <h2 id="master">master</h2>
 <ul>
 <li>bugfix: make non-default args non-null in UDFs</li>
+<li>bugfix: default value of a string type argument in a UDF was wrapped in single quotes</li>
+<li>feature: add support for array types in UDFs</li>
 </ul>
 
 

diff --git a/functions/index.html b/functions/index.html
diff --git a/search/search_index.json b/search/search_index.json
diff --git a/sitemap.xml b/sitemap.xml
@@ -2,82 +2,82 @@
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
     <url>
          <loc>https://supabase.github.io/pg_graphql/</loc>
-         <lastmod>2023-11-13</lastmod>
+         <lastmod>2023-12-21</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://supabase.github.io/pg_graphql/api/</loc>
-         <lastmod>2023-11-13</lastmod>
+         <lastmod>2023-12-21</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://supabase.github.io/pg_graphql/changelog/</loc>
-         <lastmod>2023-11-13</lastmod>
+         <lastmod>2023-12-21</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://supabase.github.io/pg_graphql/computed_fields/</loc>
-         <lastmod>2023-11-13</lastmod>
+         <lastmod>2023-12-21</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://supabase.github.io/pg_graphql/configuration/</loc>
-         <lastmod>2023-11-13</lastmod>
+         <lastmod>2023-12-21</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://supabase.github.io/pg_graphql/contributing/</loc>
-         <lastmod>2023-11-13</lastmod>
+         <lastmod>2023-12-21</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://supabase.github.io/pg_graphql/example_schema/</loc>
-         <lastmod>2023-11-13</lastmod>
+         <lastmod>2023-12-21</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://supabase.github.io/pg_graphql/functions/</loc>
-         <lastmod>2023-11-13</lastmod>
+         <lastmod>2023-12-21</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://supabase.github.io/pg_graphql/installation/</loc>
-         <lastmod>2023-11-13</lastmod>
+         <lastmod>2023-12-21</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://supabase.github.io/pg_graphql/quickstart/</loc>
-         <lastmod>2023-11-13</lastmod>
+         <lastmod>2023-12-21</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://supabase.github.io/pg_graphql/security/</loc>
-         <lastmod>2023-11-13</lastmod>
+         <lastmod>2023-12-21</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://supabase.github.io/pg_graphql/sql_interface/</loc>
-         <lastmod>2023-11-13</lastmod>
+         <lastmod>2023-12-21</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://supabase.github.io/pg_graphql/supabase/</loc>
-         <lastmod>2023-11-13</lastmod>
+         <lastmod>2023-12-21</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://supabase.github.io/pg_graphql/usage_with_apollo/</loc>
-         <lastmod>2023-11-13</lastmod>
+         <lastmod>2023-12-21</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://supabase.github.io/pg_graphql/usage_with_relay/</loc>
-         <lastmod>2023-11-13</lastmod>
+         <lastmod>2023-12-21</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://supabase.github.io/pg_graphql/views/</loc>
-         <lastmod>2023-11-13</lastmod>
+         <lastmod>2023-12-21</lastmod>
          <changefreq>daily</changefreq>
     </url>
 </urlset>
diff --git a/sitemap.xml.gz b/sitemap.xml.gz
diff --git a/supabase/index.html b/supabase/index.html
@@ -70,7 +70,7 @@
     <div data-md-component="skip">
 
 
-        <a href="#clients" class="md-skip">
+        <a href="#quickstart" class="md-skip">
           Skip to content
         </a>
 
@@ -403,6 +403,13 @@
     </label>
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 
+        <li class="md-nav__item">
+  <a href="#quickstart" class="md-nav__link">
+    Quickstart
+  </a>
+
+</li>
+
         <li class="md-nav__item">
   <a href="#clients" class="md-nav__link">
     Clients
@@ -646,6 +653,13 @@
     </label>
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 
+        <li class="md-nav__item">
+  <a href="#quickstart" class="md-nav__link">
+    Quickstart
+  </a>
+
+</li>
+
         <li class="md-nav__item">
   <a href="#clients" class="md-nav__link">
     Clients
@@ -794,6 +808,22 @@ <h1>Supabase</h1>
 </ul>
 <p>All requests resolve in a single round-trip leading to fast response times and high throughput.</p>
 <p>If you haven't created a Supabase project, do that <a href="https://database.new">here</a> so you can follow along with the guide.</p>
+<h2 id="quickstart">Quickstart</h2>
+<p><code>https://&lt;PROJECT_REF&gt;.supabase.co/graphql/v1</code> is your project's GraphQL API endpoint. See <a href="#project-reference-project_ref">PROJECT_REF</a> for instructions on finding your project's reference. Note that the url does not allow a trailing <code>/</code>.</p>
+<p>To access the API you MUST provide your project's <a href="#api-key-api_key">API key</a> as a header in every request. For example see line 2 of the cURL request below.</p>
+<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
+<span class="normal">2</span>
+<span class="normal">3</span>
+<span class="normal">4</span></pre></div></td><td class="code"><div><pre><span></span><code>curl<span class="w"> </span>-X<span class="w"> </span>POST<span class="w"> </span>https://&lt;PROJECT_REF&gt;.supabase.co/graphql/v1<span class="w"> </span><span class="se">\</span>
+<span class="w">    </span>-H<span class="w"> </span><span class="s1">&#39;apiKey: &lt;API_KEY&gt;&#39;</span><span class="w"> </span><span class="se">\</span>
+<span class="w">    </span>-H<span class="w"> </span><span class="s1">&#39;Content-Type: application/json&#39;</span><span class="w"> </span><span class="se">\</span>
+<span class="w">    </span>--data-raw<span class="w"> </span><span class="s1">&#39;{&quot;query&quot;: &quot;{ accountCollection(first: 1) { edges { node { id } } } }&quot;, &quot;variables&quot;: {}}&#39;</span>
+</code></pre></div></td></tr></table></div>
+<p>For user authentication, pass an <code>Authorization</code> header e.g.
+<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><code>    -H &#39;Authorization: Bearer &lt;JWT&gt;&#39;
+</code></pre></div></td></tr></table></div>
+See the <a href="https://supabase.com/docs/guides/auth/auth-email">auth docs</a> to understand how to sign-up/sign-in users to your application and retrieve a JWT. The <a href="../usage_with_apollo/">apollo</a> and <a href="../usage_with_relay/">relay</a> guides also include complete examples of using Supabase Auth with GraphQL. Supabase Auth works with <a href="https://supabase.com/docs/guides/auth/row-level-security">row level security (RLS)</a> allowing you to control which users can access tables/rows.</p>
+<p>The fastest way to get started with GraphQL on Supabase is using the <a href="#supabase-studio">GraphQL IDE (GraphiQL) built directly into Supabase Studio</a>.</p>
 <h2 id="clients">Clients</h2>
 <p>If you're new to GraphQL or Supabase, we strongly recommend starting with Supabase GraphQL by following the <a href="#supabase-studio">Supabase Studio guide</a>.</p>
 <p>For more experienced users, or when you're ready to productionize your application, access the API using <a href="#supabase-js">supabase-js</a>, <a href="#connecting-graphiql">GraphiQL</a>, or any HTTP client, for example <a href="#curl">cURL</a>.</p>