Add documentation of the json schemas

2026-08-31 19:03:45 +02:00 · 2020-04-27 02:00:00 +02:00
parent 7a4cfd72c0
commit 6f0ba87199
461 changed files with 20587 additions and 8 deletions
@@ -0,0 +1,57 @@
+# SignInByMailCodeRequest Schema
+
+```txt
+https://timelimit.io/SignInByMailCodeRequest
+```
+
+
+
+
+| Abstract            | Extensible | Status         | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                                                        |
+| :------------------ | ---------- | -------------- | ------------ | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------------------------------------- |
+| Can be instantiated | Yes        | Unknown status | No           | Forbidden         | Forbidden             | none                | [SignInByMailCodeRequest.schema.json](SignInByMailCodeRequest.schema.json "open original schema") |
+
+## SignInByMailCodeRequest Type
+
+`object` ([SignInByMailCodeRequest](signinbymailcoderequest.md))
+
+# SignInByMailCodeRequest Definitions
+
+# SignInByMailCodeRequest Properties
+
+| Property                          | Type     | Required | Nullable       | Defined by                                                                                                                                                     |
+| :-------------------------------- | -------- | -------- | -------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [mailLoginToken](#mailLoginToken) | `string` | Required | cannot be null | [SignInByMailCodeRequest](signinbymailcoderequest-properties-maillogintoken.md "https&#x3A;//timelimit.io/SignInByMailCodeRequest#/properties/mailLoginToken") |
+| [receivedCode](#receivedCode)     | `string` | Required | cannot be null | [SignInByMailCodeRequest](signinbymailcoderequest-properties-receivedcode.md "https&#x3A;//timelimit.io/SignInByMailCodeRequest#/properties/receivedCode")     |
+
+## mailLoginToken
+
+
+
+
+`mailLoginToken`
+
+-   is required
+-   Type: `string`
+-   cannot be null
+-   defined in: [SignInByMailCodeRequest](signinbymailcoderequest-properties-maillogintoken.md "https&#x3A;//timelimit.io/SignInByMailCodeRequest#/properties/mailLoginToken")
+
+### mailLoginToken Type
+
+`string`
+
+## receivedCode
+
+
+
+
+`receivedCode`
+
+-   is required
+-   Type: `string`
+-   cannot be null
+-   defined in: [SignInByMailCodeRequest](signinbymailcoderequest-properties-receivedcode.md "https&#x3A;//timelimit.io/SignInByMailCodeRequest#/properties/receivedCode")
+
+### receivedCode Type
+
+`string`