104 lines
2.8 KiB
Svelte
104 lines
2.8 KiB
Svelte
<script>
|
|
import CodeBlock from "@/components/base/CodeBlock.svelte";
|
|
import CommonHelper from "@/utils/CommonHelper";
|
|
|
|
export let collection;
|
|
|
|
let responseTab = 200;
|
|
let responses = [];
|
|
|
|
$: responses = [
|
|
{
|
|
code: 200,
|
|
body: JSON.stringify(
|
|
{
|
|
otpId: CommonHelper.randomString(15),
|
|
},
|
|
null,
|
|
2,
|
|
),
|
|
},
|
|
{
|
|
code: 400,
|
|
body: `
|
|
{
|
|
"status": 400,
|
|
"message": "An error occurred while validating the submitted data.",
|
|
"data": {
|
|
"email": {
|
|
"code": "validation_is_email",
|
|
"message": "Must be a valid email address."
|
|
}
|
|
}
|
|
}
|
|
`,
|
|
},
|
|
{
|
|
code: 429,
|
|
body: `
|
|
{
|
|
"status": 429,
|
|
"message": "You've send too many OTP requests, please try again later.",
|
|
"data": {}
|
|
}
|
|
`,
|
|
},
|
|
];
|
|
</script>
|
|
|
|
<div class="alert alert-success">
|
|
<strong class="label label-primary">POST</strong>
|
|
<div class="content">
|
|
<p>
|
|
/api/collections/<strong>{collection.name}</strong>/request-otp
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="section-title">Body 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>
|
|
<tr>
|
|
<td>
|
|
<div class="inline-flex">
|
|
<span class="label label-success">Required</span>
|
|
<span>email</span>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<span class="label">String</span>
|
|
</td>
|
|
<td>The auth record email address to send the OTP request (if exists).</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
<div class="section-title">Responses</div>
|
|
<div class="tabs">
|
|
<div class="tabs-header compact combined left">
|
|
{#each responses as response (response.code)}
|
|
<button
|
|
class="tab-item"
|
|
class:active={responseTab === response.code}
|
|
on:click={() => (responseTab = response.code)}
|
|
>
|
|
{response.code}
|
|
</button>
|
|
{/each}
|
|
</div>
|
|
<div class="tabs-content">
|
|
{#each responses as response (response.code)}
|
|
<div class="tab-item" class:active={responseTab === response.code}>
|
|
<CodeBlock content={response.body} />
|
|
</div>
|
|
{/each}
|
|
</div>
|
|
</div>
|