mirror of
https://codeberg.org/timelimit/timelimit-server.git
synced 2026-08-31 19:03:45 +02:00
Add documentation of the json schemas
This commit is contained in:
@@ -0,0 +1,91 @@
|
||||
# LinkParentMailAddressRequest Schema
|
||||
|
||||
```txt
|
||||
https://timelimit.io/LinkParentMailAddressRequest
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|
||||
| :------------------ | ---------- | -------------- | ------------ | :---------------- | --------------------- | ------------------- | ----------------------------------------------------------------------------------------------------------- |
|
||||
| Can be instantiated | Yes | Unknown status | No | Forbidden | Forbidden | none | [LinkParentMailAddressRequest.schema.json](LinkParentMailAddressRequest.schema.json "open original schema") |
|
||||
|
||||
## LinkParentMailAddressRequest Type
|
||||
|
||||
`object` ([LinkParentMailAddressRequest](linkparentmailaddressrequest.md))
|
||||
|
||||
# LinkParentMailAddressRequest Definitions
|
||||
|
||||
# LinkParentMailAddressRequest Properties
|
||||
|
||||
| Property | Type | Required | Nullable | Defined by |
|
||||
| :---------------------------------------------------- | -------- | -------- | -------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| [mailAuthToken](#mailAuthToken) | `string` | Required | cannot be null | [LinkParentMailAddressRequest](linkparentmailaddressrequest-properties-mailauthtoken.md "https://timelimit.io/LinkParentMailAddressRequest#/properties/mailAuthToken") |
|
||||
| [deviceAuthToken](#deviceAuthToken) | `string` | Required | cannot be null | [LinkParentMailAddressRequest](linkparentmailaddressrequest-properties-deviceauthtoken.md "https://timelimit.io/LinkParentMailAddressRequest#/properties/deviceAuthToken") |
|
||||
| [parentUserId](#parentUserId) | `string` | Required | cannot be null | [LinkParentMailAddressRequest](linkparentmailaddressrequest-properties-parentuserid.md "https://timelimit.io/LinkParentMailAddressRequest#/properties/parentUserId") |
|
||||
| [parentPasswordSecondHash](#parentPasswordSecondHash) | `string` | Required | cannot be null | [LinkParentMailAddressRequest](linkparentmailaddressrequest-properties-parentpasswordsecondhash.md "https://timelimit.io/LinkParentMailAddressRequest#/properties/parentPasswordSecondHash") |
|
||||
|
||||
## mailAuthToken
|
||||
|
||||
|
||||
|
||||
|
||||
`mailAuthToken`
|
||||
|
||||
- is required
|
||||
- Type: `string`
|
||||
- cannot be null
|
||||
- defined in: [LinkParentMailAddressRequest](linkparentmailaddressrequest-properties-mailauthtoken.md "https://timelimit.io/LinkParentMailAddressRequest#/properties/mailAuthToken")
|
||||
|
||||
### mailAuthToken Type
|
||||
|
||||
`string`
|
||||
|
||||
## deviceAuthToken
|
||||
|
||||
|
||||
|
||||
|
||||
`deviceAuthToken`
|
||||
|
||||
- is required
|
||||
- Type: `string`
|
||||
- cannot be null
|
||||
- defined in: [LinkParentMailAddressRequest](linkparentmailaddressrequest-properties-deviceauthtoken.md "https://timelimit.io/LinkParentMailAddressRequest#/properties/deviceAuthToken")
|
||||
|
||||
### deviceAuthToken Type
|
||||
|
||||
`string`
|
||||
|
||||
## parentUserId
|
||||
|
||||
|
||||
|
||||
|
||||
`parentUserId`
|
||||
|
||||
- is required
|
||||
- Type: `string`
|
||||
- cannot be null
|
||||
- defined in: [LinkParentMailAddressRequest](linkparentmailaddressrequest-properties-parentuserid.md "https://timelimit.io/LinkParentMailAddressRequest#/properties/parentUserId")
|
||||
|
||||
### parentUserId Type
|
||||
|
||||
`string`
|
||||
|
||||
## parentPasswordSecondHash
|
||||
|
||||
|
||||
|
||||
|
||||
`parentPasswordSecondHash`
|
||||
|
||||
- is required
|
||||
- Type: `string`
|
||||
- cannot be null
|
||||
- defined in: [LinkParentMailAddressRequest](linkparentmailaddressrequest-properties-parentpasswordsecondhash.md "https://timelimit.io/LinkParentMailAddressRequest#/properties/parentPasswordSecondHash")
|
||||
|
||||
### parentPasswordSecondHash Type
|
||||
|
||||
`string`
|
||||
Reference in New Issue
Block a user