Merge pull request #5490 from supabase/chore/apikey-reserved-keyword

chore: document #5465
supabase · Feb 16, 2022 · c097ad5 · c097ad5 · vercel · Feb 16, 2022
2 parents b012a92 + b7232b0
commit c097ad5
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/web/spec/dart.yml b/web/spec/dart.yml
@@ -370,6 +370,7 @@ pages:
       - By default, Supabase projects will return a maximum of 1,000 rows. This setting can be changed in Project API Settings. It's recommended that you keep it low to limit the payload size of accidental or malicious requests. You can use `range()` queries to paginate through your data.
       - `select()` can be combined with [Modifiers](/docs/reference/dart/using-modifiers)
       - `select()` can be combined with [Filters](/docs/reference/dart/using-filters)
+      - If using the Supabase hosted platform `apikey` is technically a reserved keyword, since the API gateway will pluck it out for authentication. [It should be avoided as a column name](https://github.com/supabase/supabase/issues/5465).
     examples:
       - name: Getting your data
         isSpotlight: true

diff --git a/web/spec/supabase.yml b/web/spec/supabase.yml
@@ -948,6 +948,7 @@ pages:
       - By default, Supabase projects will return a maximum of 1,000 rows. This setting can be changed in Project API Settings. It's recommended that you keep it low to limit the payload size of accidental or malicious requests. You can use `range()` queries to paginate through your data.
       - `select()` can be combined with [Modifiers](/docs/reference/javascript/using-modifiers)
       - `select()` can be combined with [Filters](/docs/reference/javascript/using-filters)
+      - If using the Supabase hosted platform `apikey` is technically a reserved keyword, since the API gateway will pluck it out for authentication. [It should be avoided as a column name](https://github.com/supabase/supabase/issues/5465). 
     examples:
       - name: Getting your data
         isSpotlight: true