yetangitu/timelimit-server
1
0
Fork 0
mirror of https://codeberg.org/timelimit/timelimit-server.git synced 2025-10-05 19:42:39 +02:00
Code Issues Projects Releases Wiki Activity

Add documentation of the json schemas

Browse source
This commit is contained in:
Jonas Lochmann 2020-04-27 02:00:00 +02:00
parent 7a4cfd72c0
commit 6f0ba87199
No known key found for this signature in database
GPG key ID: 8B8C9AEE10FA5B36
461 changed files with 20587 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

55
docs/schema/clientpushchangesrequest.md Normal file
View file

@ -0,0 +1,55 @@
# ClientPushChangesRequest Schema
```txt
https://timelimit.io/ClientPushChangesRequest
```
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | ---------- | -------------- | ------------ | :---------------- | --------------------- | ------------------- | --------------------------------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [ClientPushChangesRequest.schema.json](ClientPushChangesRequest.schema.json "open original schema") |
## ClientPushChangesRequest Type
`object` ([ClientPushChangesRequest](clientpushchangesrequest.md))
# ClientPushChangesRequest Properties
| Property | Type | Required | Nullable | Defined by |
| :---------------------------------- | -------- | -------- | -------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| [deviceAuthToken](#deviceAuthToken) | `string` | Required | cannot be null | [ClientPushChangesRequest](clientpushchangesrequest-properties-deviceauthtoken.md "https://timelimit.io/ClientPushChangesRequest#/properties/deviceAuthToken") |
| [actions](#actions) | `array` | Required | cannot be null | [ClientPushChangesRequest](clientpushchangesrequest-properties-actions.md "https://timelimit.io/ClientPushChangesRequest#/properties/actions") |
## deviceAuthToken
`deviceAuthToken`
- is required
- Type: `string`
- cannot be null
- defined in: [ClientPushChangesRequest](clientpushchangesrequest-properties-deviceauthtoken.md "https://timelimit.io/ClientPushChangesRequest#/properties/deviceAuthToken")
### deviceAuthToken Type
`string`
## actions
`actions`
- is required
- Type: `object[]` ([Details](clientpushchangesrequest-properties-actions-items.md))
- cannot be null
- defined in: [ClientPushChangesRequest](clientpushchangesrequest-properties-actions.md "https://timelimit.io/ClientPushChangesRequest#/properties/actions")
### actions Type
`object[]` ([Details](clientpushchangesrequest-properties-actions-items.md))