mirror of
https://codeberg.org/timelimit/timelimit-server.git
synced 2025-10-03 01:39:31 +02:00
Add basically API documentation
This commit is contained in:
parent
ab16134a8e
commit
d021497e52
149 changed files with 7811 additions and 39 deletions
|
@ -0,0 +1,99 @@
|
|||
# SerializedInstalledApp Schema
|
||||
|
||||
```txt
|
||||
https://timelimit.io/ServerDataStatus#/definitions/SerializedInstalledApp
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|
||||
| :------------------ | ---------- | -------------- | ------------ | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------------------------- |
|
||||
| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [ServerDataStatus.schema.json\*](ServerDataStatus.schema.json "open original schema") |
|
||||
|
||||
## SerializedInstalledApp Type
|
||||
|
||||
`object` ([SerializedInstalledApp](serverdatastatus-definitions-serializedinstalledapp.md))
|
||||
|
||||
# SerializedInstalledApp Properties
|
||||
|
||||
| Property | Type | Required | Nullable | Defined by |
|
||||
| :-------------------------------- | --------- | -------- | -------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| [packageName](#packageName) | `string` | Required | cannot be null | [ServerDataStatus](serverdatastatus-definitions-serializedinstalledapp-properties-packagename.md "https://timelimit.io/ServerDataStatus#/definitions/SerializedInstalledApp/properties/packageName") |
|
||||
| [title](#title) | `string` | Required | cannot be null | [ServerDataStatus](serverdatastatus-definitions-serializedinstalledapp-properties-title.md "https://timelimit.io/ServerDataStatus#/definitions/SerializedInstalledApp/properties/title") |
|
||||
| [isLaunchable](#isLaunchable) | `boolean` | Required | cannot be null | [ServerDataStatus](serverdatastatus-definitions-serializedinstalledapp-properties-islaunchable.md "https://timelimit.io/ServerDataStatus#/definitions/SerializedInstalledApp/properties/isLaunchable") |
|
||||
| [recommendation](#recommendation) | `string` | Required | cannot be null | [ServerDataStatus](serverdatastatus-definitions-serializedinstalledapp-properties-apprecommendation.md "https://timelimit.io/ServerDataStatus#/definitions/SerializedInstalledApp/properties/recommendation") |
|
||||
|
||||
## packageName
|
||||
|
||||
|
||||
|
||||
|
||||
`packageName`
|
||||
|
||||
- is required
|
||||
- Type: `string`
|
||||
- cannot be null
|
||||
- defined in: [ServerDataStatus](serverdatastatus-definitions-serializedinstalledapp-properties-packagename.md "https://timelimit.io/ServerDataStatus#/definitions/SerializedInstalledApp/properties/packageName")
|
||||
|
||||
### packageName Type
|
||||
|
||||
`string`
|
||||
|
||||
## title
|
||||
|
||||
|
||||
|
||||
|
||||
`title`
|
||||
|
||||
- is required
|
||||
- Type: `string`
|
||||
- cannot be null
|
||||
- defined in: [ServerDataStatus](serverdatastatus-definitions-serializedinstalledapp-properties-title.md "https://timelimit.io/ServerDataStatus#/definitions/SerializedInstalledApp/properties/title")
|
||||
|
||||
### title Type
|
||||
|
||||
`string`
|
||||
|
||||
## isLaunchable
|
||||
|
||||
|
||||
|
||||
|
||||
`isLaunchable`
|
||||
|
||||
- is required
|
||||
- Type: `boolean`
|
||||
- cannot be null
|
||||
- defined in: [ServerDataStatus](serverdatastatus-definitions-serializedinstalledapp-properties-islaunchable.md "https://timelimit.io/ServerDataStatus#/definitions/SerializedInstalledApp/properties/isLaunchable")
|
||||
|
||||
### isLaunchable Type
|
||||
|
||||
`boolean`
|
||||
|
||||
## recommendation
|
||||
|
||||
|
||||
|
||||
|
||||
`recommendation`
|
||||
|
||||
- is required
|
||||
- Type: `string` ([AppRecommendation](serverdatastatus-definitions-serializedinstalledapp-properties-apprecommendation.md))
|
||||
- cannot be null
|
||||
- defined in: [ServerDataStatus](serverdatastatus-definitions-serializedinstalledapp-properties-apprecommendation.md "https://timelimit.io/ServerDataStatus#/definitions/SerializedInstalledApp/properties/recommendation")
|
||||
|
||||
### recommendation Type
|
||||
|
||||
`string` ([AppRecommendation](serverdatastatus-definitions-serializedinstalledapp-properties-apprecommendation.md))
|
||||
|
||||
### recommendation Constraints
|
||||
|
||||
**enum**: the value of this property must be equal to one of the following values:
|
||||
|
||||
| Value | Explanation |
|
||||
| :------------ | ----------- |
|
||||
| `"blacklist"` | |
|
||||
| `"none"` | |
|
||||
| `"whitelist"` | |
|
Loading…
Add table
Add a link
Reference in a new issue