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,174 @@
+# SerializedChildAction Schema
+
+```txt
+https://timelimit.io/SerializedChildAction
+```
+
+
+
+
+| Abstract               | Extensible | Status         | Identifiable            | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                                                    |
+| :--------------------- | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | --------------------------------------------------------------------------------------------- |
+| Cannot be instantiated | Yes        | Unknown status | Unknown identifiability | Forbidden         | Allowed               | none                | [SerializedChildAction.schema.json](SerializedChildAction.schema.json "open original schema") |
+
+## SerializedChildAction Type
+
+merged type ([SerializedChildAction](serializedchildaction.md))
+
+any of
+
+-   [SerializedChildChangePasswordAction](serializedchildaction-definitions-serializedchildchangepasswordaction.md "check type definition")
+-   [SerializedChildSignInAction](serializedchildaction-definitions-serializedchildsigninaction.md "check type definition")
+
+# SerializedChildAction Definitions
+
+## Definitions group SerializedChildChangePasswordAction
+
+Reference this group by using
+
+```json
+{"$ref":"https://timelimit.io/SerializedChildAction#/definitions/SerializedChildChangePasswordAction"}
+```
+
+| Property              | Type     | Required | Nullable       | Defined by                                                                                                                                                                                                                           |
+| :-------------------- | -------- | -------- | -------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [type](#type)         | `string` | Required | cannot be null | [SerializedChildAction](serializedchildaction-definitions-serializedchildchangepasswordaction-properties-type.md "https&#x3A;//timelimit.io/SerializedChildAction#/definitions/SerializedChildChangePasswordAction/properties/type") |
+| [password](#password) | `object` | Required | cannot be null | [SerializedChildAction](serializedchildaction-definitions-parentpassword.md "https&#x3A;//timelimit.io/SerializedChildAction#/definitions/SerializedChildChangePasswordAction/properties/password")                                  |
+
+### type
+
+
+
+
+`type`
+
+-   is required
+-   Type: `string`
+-   cannot be null
+-   defined in: [SerializedChildAction](serializedchildaction-definitions-serializedchildchangepasswordaction-properties-type.md "https&#x3A;//timelimit.io/SerializedChildAction#/definitions/SerializedChildChangePasswordAction/properties/type")
+
+#### type Type
+
+`string`
+
+#### type Constraints
+
+**enum**: the value of this property must be equal to one of the following values:
+
+| Value                     | Explanation |
+| :------------------------ | ----------- |
+| `"CHILD_CHANGE_PASSWORD"` |             |
+
+### password
+
+
+
+
+`password`
+
+-   is required
+-   Type: `object` ([ParentPassword](serializedchildaction-definitions-parentpassword.md))
+-   cannot be null
+-   defined in: [SerializedChildAction](serializedchildaction-definitions-parentpassword.md "https&#x3A;//timelimit.io/SerializedChildAction#/definitions/SerializedChildChangePasswordAction/properties/password")
+
+#### password Type
+
+`object` ([ParentPassword](serializedchildaction-definitions-parentpassword.md))
+
+## Definitions group ParentPassword
+
+Reference this group by using
+
+```json
+{"$ref":"https://timelimit.io/SerializedChildAction#/definitions/ParentPassword"}
+```
+
+| Property                  | Type     | Required | Nullable       | Defined by                                                                                                                                                                                             |
+| :------------------------ | -------- | -------- | -------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [hash](#hash)             | `string` | Required | cannot be null | [SerializedChildAction](serializedchildaction-definitions-parentpassword-properties-hash.md "https&#x3A;//timelimit.io/SerializedChildAction#/definitions/ParentPassword/properties/hash")             |
+| [secondHash](#secondHash) | `string` | Required | cannot be null | [SerializedChildAction](serializedchildaction-definitions-parentpassword-properties-secondhash.md "https&#x3A;//timelimit.io/SerializedChildAction#/definitions/ParentPassword/properties/secondHash") |
+| [secondSalt](#secondSalt) | `string` | Required | cannot be null | [SerializedChildAction](serializedchildaction-definitions-parentpassword-properties-secondsalt.md "https&#x3A;//timelimit.io/SerializedChildAction#/definitions/ParentPassword/properties/secondSalt") |
+
+### hash
+
+
+
+
+`hash`
+
+-   is required
+-   Type: `string`
+-   cannot be null
+-   defined in: [SerializedChildAction](serializedchildaction-definitions-parentpassword-properties-hash.md "https&#x3A;//timelimit.io/SerializedChildAction#/definitions/ParentPassword/properties/hash")
+
+#### hash Type
+
+`string`
+
+### secondHash
+
+
+
+
+`secondHash`
+
+-   is required
+-   Type: `string`
+-   cannot be null
+-   defined in: [SerializedChildAction](serializedchildaction-definitions-parentpassword-properties-secondhash.md "https&#x3A;//timelimit.io/SerializedChildAction#/definitions/ParentPassword/properties/secondHash")
+
+#### secondHash Type
+
+`string`
+
+### secondSalt
+
+
+
+
+`secondSalt`
+
+-   is required
+-   Type: `string`
+-   cannot be null
+-   defined in: [SerializedChildAction](serializedchildaction-definitions-parentpassword-properties-secondsalt.md "https&#x3A;//timelimit.io/SerializedChildAction#/definitions/ParentPassword/properties/secondSalt")
+
+#### secondSalt Type
+
+`string`
+
+## Definitions group SerializedChildSignInAction
+
+Reference this group by using
+
+```json
+{"$ref":"https://timelimit.io/SerializedChildAction#/definitions/SerializedChildSignInAction"}
+```
+
+| Property      | Type     | Required | Nullable       | Defined by                                                                                                                                                                                                           |
+| :------------ | -------- | -------- | -------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [type](#type) | `string` | Required | cannot be null | [SerializedChildAction](serializedchildaction-definitions-serializedchildsigninaction-properties-type.md "https&#x3A;//timelimit.io/SerializedChildAction#/definitions/SerializedChildSignInAction/properties/type") |
+
+### type
+
+
+
+
+`type`
+
+-   is required
+-   Type: `string`
+-   cannot be null
+-   defined in: [SerializedChildAction](serializedchildaction-definitions-serializedchildsigninaction-properties-type.md "https&#x3A;//timelimit.io/SerializedChildAction#/definitions/SerializedChildSignInAction/properties/type")
+
+#### type Type
+
+`string`
+
+#### type Constraints
+
+**enum**: the value of this property must be equal to one of the following values:
+
+| Value             | Explanation |
+| :---------------- | ----------- |
+| `"CHILD_SIGN_IN"` |             |