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

added fields query param to the api docs preview

Browse Source
This commit is contained in:
Gani Georgiev
2023-05-20 05:58:52 +03:00
parent 3820f3d7d7
commit f49e90bd0b
48 changed files with 896 additions and 818 deletions
Download Patch File Download Diff File Expand all files Collapse all files
ui/src/components/collections/docs/AuthMethodsDocs.svelte
+15
View File
@@ -4,6 +4,7 @@
import CommonHelper from "@/utils/CommonHelper";
import CodeBlock from "@/components/base/CodeBlock.svelte";
import SdkTabs from "@/components/collections/docs/SdkTabs.svelte";
import FieldsQueryParam from "@/components/collections/docs/FieldsQueryParam.svelte";
export let collection = new Collection();
@@ -87,6 +88,20 @@
</div>
</div>
<div class="section-title">Query parameters</div>
<table class="table-compact table-border m-b-base">
<thead>
<tr>
<th>Param</th>
<th>Type</th>
<th width="50%">Description</th>
</tr>
</thead>
<tbody>
<FieldsQueryParam />
</tbody>
</table>
<div class="section-title">Responses</div>
<div class="tabs">
<div class="tabs-header compact left">
ui/src/components/collections/docs/AuthRefreshDocs.svelte
+2
View File
@@ -4,6 +4,7 @@
import CommonHelper from "@/utils/CommonHelper";
import CodeBlock from "@/components/base/CodeBlock.svelte";
import SdkTabs from "@/components/collections/docs/SdkTabs.svelte";
import FieldsQueryParam from "@/components/collections/docs/FieldsQueryParam.svelte";
export let collection = new Collection();
@@ -138,6 +139,7 @@
Only the relations to which the request user has permissions to <strong>view</strong> will be expanded.
</td>
</tr>
<FieldsQueryParam />
</tbody>
</table>
ui/src/components/collections/docs/AuthWithOAuth2Docs.svelte
+2
View File
@@ -4,6 +4,7 @@
import CommonHelper from "@/utils/CommonHelper";
import CodeBlock from "@/components/base/CodeBlock.svelte";
import SdkTabs from "@/components/collections/docs/SdkTabs.svelte";
import FieldsQueryParam from "@/components/collections/docs/FieldsQueryParam.svelte";
export let collection = new Collection();
@@ -234,6 +235,7 @@
Only the relations to which the request user has permissions to <strong>view</strong> will be expanded.
</td>
</tr>
<FieldsQueryParam />
</tbody>
</table>
ui/src/components/collections/docs/AuthWithPasswordDocs.svelte
+2
View File
@@ -4,6 +4,7 @@
import CommonHelper from "@/utils/CommonHelper";
import CodeBlock from "@/components/base/CodeBlock.svelte";
import SdkTabs from "@/components/collections/docs/SdkTabs.svelte";
import FieldsQueryParam from "@/components/collections/docs/FieldsQueryParam.svelte";
export let collection = new Collection();
@@ -197,6 +198,7 @@
Only the relations to which the request user has permissions to <strong>view</strong> will be expanded.
</td>
</tr>
<FieldsQueryParam />
</tbody>
</table>
ui/src/components/collections/docs/CreateApiDocs.svelte
+2
View File
@@ -4,6 +4,7 @@
import CommonHelper from "@/utils/CommonHelper";
import CodeBlock from "@/components/base/CodeBlock.svelte";
import SdkTabs from "@/components/collections/docs/SdkTabs.svelte";
import FieldsQueryParam from "@/components/collections/docs/FieldsQueryParam.svelte";
export let collection = new Collection();
@@ -311,6 +312,7 @@ await pb.collection('${collection?.name}').requestVerification('test@example.com
Only the relations to which the request user has permissions to <strong>view</strong> will be expanded.
</td>
</tr>
<FieldsQueryParam />
</tbody>
</table>
ui/src/components/collections/docs/FieldsQueryParam.svelte
+12
View File
@@ -0,0 +1,12 @@
<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>
</td>
</tr>
ui/src/components/collections/docs/ListApiDocs.svelte
+13 -2
View File
@@ -210,6 +210,16 @@
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>.
</td>
</tr>
</tbody>
</table>
@@ -217,13 +227,14 @@
<div class="tabs">
<div class="tabs-header compact left">
{#each responses as response (response.code)}
<div
<button
type="button"
class="tab-item"
class:active={responseTab === response.code}
on:click={() => (responseTab = response.code)}
>
{response.code}
</div>
</button>
{/each}
</div>
<div class="tabs-content">
ui/src/components/collections/docs/ListExternalAuthsDocs.svelte
+15
View File
@@ -4,6 +4,7 @@
import CommonHelper from "@/utils/CommonHelper";
import CodeBlock from "@/components/base/CodeBlock.svelte";
import SdkTabs from "@/components/collections/docs/SdkTabs.svelte";
import FieldsQueryParam from "@/components/collections/docs/FieldsQueryParam.svelte";
export let collection = new Collection();
@@ -139,6 +140,20 @@
</tbody>
</table>
<div class="section-title">Query parameters</div>
<table class="table-compact table-border m-b-base">
<thead>
<tr>
<th>Param</th>
<th>Type</th>
<th width="50%">Description</th>
</tr>
</thead>
<tbody>
<FieldsQueryParam />
</tbody>
</table>
<div class="section-title">Responses</div>
<div class="tabs">
<div class="tabs-header compact left">
ui/src/components/collections/docs/UpdateApiDocs.svelte
+2
View File
@@ -4,6 +4,7 @@
import CommonHelper from "@/utils/CommonHelper";
import CodeBlock from "@/components/base/CodeBlock.svelte";
import SdkTabs from "@/components/collections/docs/SdkTabs.svelte";
import FieldsQueryParam from "@/components/collections/docs/FieldsQueryParam.svelte";
export let collection = new Collection();
@@ -330,6 +331,7 @@ final record = await pb.collection('${collection?.name}').update('RECORD_ID', bo
the relations that the user has permissions to <strong>view</strong> will be expanded.
</td>
</tr>
<FieldsQueryParam />
</tbody>
</table>
ui/src/components/collections/docs/ViewApiDocs.svelte
+2
View File
@@ -4,6 +4,7 @@
import CommonHelper from "@/utils/CommonHelper";
import CodeBlock from "@/components/base/CodeBlock.svelte";
import SdkTabs from "@/components/collections/docs/SdkTabs.svelte";
import FieldsQueryParam from "@/components/collections/docs/FieldsQueryParam.svelte";
export let collection = new Collection();
@@ -134,6 +135,7 @@
Only the relations to which the request user has permissions to <strong>view</strong> will be expanded.
</td>
</tr>
<FieldsQueryParam />
</tbody>
</table>