updated api preview docs

This commit is contained in:
Gani Georgiev
2023-10-09 21:03:02 +03:00
parent ca1a395628
commit 3e487f7e9d
35 changed files with 210 additions and 198 deletions
@@ -1,12 +1,35 @@
<script>
import CodeBlock from "@/components/base/CodeBlock.svelte";
</script>
<tr>
<td id="query-page">fields</td>
<td>
<span class="label">String</span>
</td>
<td>
Comma separated string of the fields to return in the JSON response
<em>(by default returns all fields)</em>. For example:
<br>
<code>?fields=id,expand.relField.id,expand.relField.created</code>
<p>
Comma separated string of the fields to return in the JSON response
<em>(by default returns all fields)</em>. Ex.:
<CodeBlock
content={`
?fields=*,expand.relField.name
`}
/>
</p>
<p>
<code>*</code> targets all keys from the specific depth level.
</p>
<p>In addition, the following field modifiers are also supported:</p>
<ul>
<li>
<code>:excerpt(maxLength, withEllipsis?)</code>
<br />
Returns a short plain text version of the field string value.
<br />
Ex.:
<code>?fields=*,description:excerpt(200,true)</code>
</li>
</ul>
</td>
</tr>
@@ -4,6 +4,7 @@
import CodeBlock from "@/components/base/CodeBlock.svelte";
import FilterSyntax from "@/components/collections/docs/FilterSyntax.svelte";
import SdkTabs from "@/components/collections/docs/SdkTabs.svelte";
import FieldsQueryParam from "@/components/collections/docs/FieldsQueryParam.svelte";
export let collection;
@@ -209,20 +210,7 @@
Only the relations to which the request user has permissions to <strong>view</strong> will be expanded.
</td>
</tr>
<tr>
<td id="query-page">fields</td>
<td>
<span class="label">String</span>
</td>
<td>
Comma separated string of the fields to return in the JSON response
<em>(by default returns all fields)</em>.
<br />
Use <code>*</code> to target all keys from the specific depth level.
<br />
For example: <code>?fields=*,expand.author.name</code>
</td>
</tr>
<FieldsQueryParam />
<tr>
<td id="query-page">skipTotal</td>
<td>