mirror of
https://codeberg.org/timelimit/timelimit-server.git
synced 2025-10-03 09:49:32 +02:00
Add documentation of the json schemas
This commit is contained in:
parent
7a4cfd72c0
commit
6f0ba87199
461 changed files with 20587 additions and 8 deletions
91
docs/schema/removedevicerequest.md
Normal file
91
docs/schema/removedevicerequest.md
Normal file
|
@ -0,0 +1,91 @@
|
|||
# RemoveDeviceRequest Schema
|
||||
|
||||
```txt
|
||||
https://timelimit.io/RemoveDeviceRequest
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|
||||
| :------------------ | ---------- | -------------- | ------------ | :---------------- | --------------------- | ------------------- | ----------------------------------------------------------------------------------------- |
|
||||
| Can be instantiated | Yes | Unknown status | No | Forbidden | Forbidden | none | [RemoveDeviceRequest.schema.json](RemoveDeviceRequest.schema.json "open original schema") |
|
||||
|
||||
## RemoveDeviceRequest Type
|
||||
|
||||
`object` ([RemoveDeviceRequest](removedevicerequest.md))
|
||||
|
||||
# RemoveDeviceRequest Definitions
|
||||
|
||||
# RemoveDeviceRequest Properties
|
||||
|
||||
| Property | Type | Required | Nullable | Defined by |
|
||||
| :---------------------------------------------------- | -------- | -------- | -------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| [deviceAuthToken](#deviceAuthToken) | `string` | Required | cannot be null | [RemoveDeviceRequest](removedevicerequest-properties-deviceauthtoken.md "https://timelimit.io/RemoveDeviceRequest#/properties/deviceAuthToken") |
|
||||
| [parentUserId](#parentUserId) | `string` | Required | cannot be null | [RemoveDeviceRequest](removedevicerequest-properties-parentuserid.md "https://timelimit.io/RemoveDeviceRequest#/properties/parentUserId") |
|
||||
| [parentPasswordSecondHash](#parentPasswordSecondHash) | `string` | Required | cannot be null | [RemoveDeviceRequest](removedevicerequest-properties-parentpasswordsecondhash.md "https://timelimit.io/RemoveDeviceRequest#/properties/parentPasswordSecondHash") |
|
||||
| [deviceId](#deviceId) | `string` | Required | cannot be null | [RemoveDeviceRequest](removedevicerequest-properties-deviceid.md "https://timelimit.io/RemoveDeviceRequest#/properties/deviceId") |
|
||||
|
||||
## deviceAuthToken
|
||||
|
||||
|
||||
|
||||
|
||||
`deviceAuthToken`
|
||||
|
||||
- is required
|
||||
- Type: `string`
|
||||
- cannot be null
|
||||
- defined in: [RemoveDeviceRequest](removedevicerequest-properties-deviceauthtoken.md "https://timelimit.io/RemoveDeviceRequest#/properties/deviceAuthToken")
|
||||
|
||||
### deviceAuthToken Type
|
||||
|
||||
`string`
|
||||
|
||||
## parentUserId
|
||||
|
||||
|
||||
|
||||
|
||||
`parentUserId`
|
||||
|
||||
- is required
|
||||
- Type: `string`
|
||||
- cannot be null
|
||||
- defined in: [RemoveDeviceRequest](removedevicerequest-properties-parentuserid.md "https://timelimit.io/RemoveDeviceRequest#/properties/parentUserId")
|
||||
|
||||
### parentUserId Type
|
||||
|
||||
`string`
|
||||
|
||||
## parentPasswordSecondHash
|
||||
|
||||
|
||||
|
||||
|
||||
`parentPasswordSecondHash`
|
||||
|
||||
- is required
|
||||
- Type: `string`
|
||||
- cannot be null
|
||||
- defined in: [RemoveDeviceRequest](removedevicerequest-properties-parentpasswordsecondhash.md "https://timelimit.io/RemoveDeviceRequest#/properties/parentPasswordSecondHash")
|
||||
|
||||
### parentPasswordSecondHash Type
|
||||
|
||||
`string`
|
||||
|
||||
## deviceId
|
||||
|
||||
|
||||
|
||||
|
||||
`deviceId`
|
||||
|
||||
- is required
|
||||
- Type: `string`
|
||||
- cannot be null
|
||||
- defined in: [RemoveDeviceRequest](removedevicerequest-properties-deviceid.md "https://timelimit.io/RemoveDeviceRequest#/properties/deviceId")
|
||||
|
||||
### deviceId Type
|
||||
|
||||
`string`
|
Loading…
Add table
Add a link
Reference in a new issue