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,119 @@
|
||||
# RecoverParentPasswordRequest Schema
|
||||
|
||||
```txt
|
||||
https://timelimit.io/RecoverParentPasswordRequest
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|
||||
| :------------------ | ---------- | -------------- | ------------ | :---------------- | --------------------- | ------------------- | ----------------------------------------------------------------------------------------------------------- |
|
||||
| Can be instantiated | Yes | Unknown status | No | Forbidden | Forbidden | none | [RecoverParentPasswordRequest.schema.json](RecoverParentPasswordRequest.schema.json "open original schema") |
|
||||
|
||||
## RecoverParentPasswordRequest Type
|
||||
|
||||
`object` ([RecoverParentPasswordRequest](recoverparentpasswordrequest.md))
|
||||
|
||||
# RecoverParentPasswordRequest Definitions
|
||||
|
||||
## Definitions group ParentPassword
|
||||
|
||||
Reference this group by using
|
||||
|
||||
```json
|
||||
{"$ref":"https://timelimit.io/RecoverParentPasswordRequest#/definitions/ParentPassword"}
|
||||
```
|
||||
|
||||
| Property | Type | Required | Nullable | Defined by |
|
||||
| :------------------------ | -------- | -------- | -------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| [hash](#hash) | `string` | Required | cannot be null | [RecoverParentPasswordRequest](recoverparentpasswordrequest-definitions-parentpassword-properties-hash.md "https://timelimit.io/RecoverParentPasswordRequest#/definitions/ParentPassword/properties/hash") |
|
||||
| [secondHash](#secondHash) | `string` | Required | cannot be null | [RecoverParentPasswordRequest](recoverparentpasswordrequest-definitions-parentpassword-properties-secondhash.md "https://timelimit.io/RecoverParentPasswordRequest#/definitions/ParentPassword/properties/secondHash") |
|
||||
| [secondSalt](#secondSalt) | `string` | Required | cannot be null | [RecoverParentPasswordRequest](recoverparentpasswordrequest-definitions-parentpassword-properties-secondsalt.md "https://timelimit.io/RecoverParentPasswordRequest#/definitions/ParentPassword/properties/secondSalt") |
|
||||
|
||||
### hash
|
||||
|
||||
|
||||
|
||||
|
||||
`hash`
|
||||
|
||||
- is required
|
||||
- Type: `string`
|
||||
- cannot be null
|
||||
- defined in: [RecoverParentPasswordRequest](recoverparentpasswordrequest-definitions-parentpassword-properties-hash.md "https://timelimit.io/RecoverParentPasswordRequest#/definitions/ParentPassword/properties/hash")
|
||||
|
||||
#### hash Type
|
||||
|
||||
`string`
|
||||
|
||||
### secondHash
|
||||
|
||||
|
||||
|
||||
|
||||
`secondHash`
|
||||
|
||||
- is required
|
||||
- Type: `string`
|
||||
- cannot be null
|
||||
- defined in: [RecoverParentPasswordRequest](recoverparentpasswordrequest-definitions-parentpassword-properties-secondhash.md "https://timelimit.io/RecoverParentPasswordRequest#/definitions/ParentPassword/properties/secondHash")
|
||||
|
||||
#### secondHash Type
|
||||
|
||||
`string`
|
||||
|
||||
### secondSalt
|
||||
|
||||
|
||||
|
||||
|
||||
`secondSalt`
|
||||
|
||||
- is required
|
||||
- Type: `string`
|
||||
- cannot be null
|
||||
- defined in: [RecoverParentPasswordRequest](recoverparentpasswordrequest-definitions-parentpassword-properties-secondsalt.md "https://timelimit.io/RecoverParentPasswordRequest#/definitions/ParentPassword/properties/secondSalt")
|
||||
|
||||
#### secondSalt Type
|
||||
|
||||
`string`
|
||||
|
||||
# RecoverParentPasswordRequest Properties
|
||||
|
||||
| Property | Type | Required | Nullable | Defined by |
|
||||
| :------------------------------ | -------- | -------- | -------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| [mailAuthToken](#mailAuthToken) | `string` | Required | cannot be null | [RecoverParentPasswordRequest](recoverparentpasswordrequest-properties-mailauthtoken.md "https://timelimit.io/RecoverParentPasswordRequest#/properties/mailAuthToken") |
|
||||
| [password](#password) | `object` | Required | cannot be null | [RecoverParentPasswordRequest](recoverparentpasswordrequest-definitions-parentpassword.md "https://timelimit.io/RecoverParentPasswordRequest#/properties/password") |
|
||||
|
||||
## mailAuthToken
|
||||
|
||||
|
||||
|
||||
|
||||
`mailAuthToken`
|
||||
|
||||
- is required
|
||||
- Type: `string`
|
||||
- cannot be null
|
||||
- defined in: [RecoverParentPasswordRequest](recoverparentpasswordrequest-properties-mailauthtoken.md "https://timelimit.io/RecoverParentPasswordRequest#/properties/mailAuthToken")
|
||||
|
||||
### mailAuthToken Type
|
||||
|
||||
`string`
|
||||
|
||||
## password
|
||||
|
||||
|
||||
|
||||
|
||||
`password`
|
||||
|
||||
- is required
|
||||
- Type: `object` ([ParentPassword](recoverparentpasswordrequest-definitions-parentpassword.md))
|
||||
- cannot be null
|
||||
- defined in: [RecoverParentPasswordRequest](recoverparentpasswordrequest-definitions-parentpassword.md "https://timelimit.io/RecoverParentPasswordRequest#/properties/password")
|
||||
|
||||
### password Type
|
||||
|
||||
`object` ([ParentPassword](recoverparentpasswordrequest-definitions-parentpassword.md))
|
||||
Reference in New Issue
Block a user