colin
/
pocketbase
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

updated fields query param examples for the auth actions

This commit is contained in:
Gani Georgiev 2023-12-29 21:47:04 +02:00
parent 6d942c7d30
commit 0ae9f24a81
4 changed files with 7 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
ui/src/components/collections/docs/AuthRefreshDocs.svelte
View File

@ -138,7 +138,7 @@
Only the relations to which the request user has permissions to <strong>view</strong> will be expanded. Only the relations to which the request user has permissions to <strong>view</strong> will be expanded.
</td> </td>
</tr> </tr>
<FieldsQueryParam /> <FieldsQueryParam prefix="record." />
</tbody> </tbody>
</table> </table>

2
ui/src/components/collections/docs/AuthWithOAuth2Docs.svelte
View File

@ -234,7 +234,7 @@
Only the relations to which the request user has permissions to <strong>view</strong> will be expanded. Only the relations to which the request user has permissions to <strong>view</strong> will be expanded.
</td> </td>
</tr> </tr>
<FieldsQueryParam /> <FieldsQueryParam prefix="record." />
</tbody> </tbody>
</table> </table>

2
ui/src/components/collections/docs/AuthWithPasswordDocs.svelte
View File

@ -197,7 +197,7 @@
Only the relations to which the request user has permissions to <strong>view</strong> will be expanded. Only the relations to which the request user has permissions to <strong>view</strong> will be expanded.
</td> </td>
</tr> </tr>
<FieldsQueryParam /> <FieldsQueryParam prefix="record." />
</tbody> </tbody>
</table> </table>

10
ui/src/components/collections/docs/FieldsQueryParam.svelte
View File

@ -1,5 +1,7 @@
<script> <script>
import CodeBlock from "@/components/base/CodeBlock.svelte"; import CodeBlock from "@/components/base/CodeBlock.svelte";
export let prefix = ""; // examples prefix (eg. "record.")
</script> </script>
<tr> <tr>
@ -11,11 +13,7 @@
<p> <p>
Comma separated string of the fields to return in the JSON response Comma separated string of the fields to return in the JSON response
<em>(by default returns all fields)</em>. Ex.: <em>(by default returns all fields)</em>. Ex.:
<CodeBlock <CodeBlock content="?fields=*,{prefix}expand.relField.name" />
content={`
?fields=*,expand.relField.name
`}
/>
</p> </p>
<p> <p>
<code>*</code> targets all keys from the specific depth level. <code>*</code> targets all keys from the specific depth level.
@ -28,7 +26,7 @@
Returns a short plain text version of the field string value. Returns a short plain text version of the field string value.
<br /> <br />
Ex.: Ex.:
<code>?fields=*,description:excerpt(200,true)</code> <code>?fields=*,{prefix}description:excerpt(200,true)</code>
</li> </li>
</ul> </ul>
</td> </td>