Skip to content

Commit ac79217

Browse files
committed
docs: add note to resource embedding and vertical filtering section
Adds a note about resource embedding and vertical filtering sections that they are top-level operations. This resolves #4352. Signed-off-by: Taimoor Zaeem <[email protected]>
1 parent 58efc26 commit ac79217

File tree

2 files changed

+8
-0
lines changed

2 files changed

+8
-0
lines changed

docs/references/api/resource_embedding.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@ Resource Embedding
55

66
PostgREST allows including related resources in a single API call. This reduces the need for many API requests.
77

8+
.. note::
9+
10+
Resource embedding is a **top-level** operation, which means that for mutation queries, it is performed on the affected resource **after** the mutation.
11+
812
.. _fk_join:
913

1014
Foreign Key Joins

docs/references/api/tables_views.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -233,6 +233,10 @@ Vertical Filtering
233233

234234
When certain columns are wide (such as those holding binary data), it is more efficient for the server to withhold them in a response. The client can specify which columns are required using the :code:`select` parameter.
235235

236+
.. note::
237+
238+
Vertical filtering is a **top-level** operation, which means that for mutation queries, it is performed on the affected resource **after** the mutation.
239+
236240
.. code-block:: bash
237241
238242
curl "http://localhost:3000/people?select=first_name,age"

0 commit comments

Comments
 (0)