mirror of
https://codeberg.org/timelimit/timelimit-server.git
synced 2025-10-03 09:49:32 +02:00
63 lines
3.1 KiB
Markdown
63 lines
3.1 KiB
Markdown
# SerializedDeleteCategoryAction Schema
|
|
|
|
```txt
|
|
https://timelimit.io/SerializedParentAction#/definitions/SerializedDeleteCategoryAction
|
|
```
|
|
|
|
|
|
|
|
|
|
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|
|
| :------------------ | ---------- | -------------- | ------------ | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------------------------------------- |
|
|
| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [SerializedParentAction.schema.json\*](SerializedParentAction.schema.json "open original schema") |
|
|
|
|
## SerializedDeleteCategoryAction Type
|
|
|
|
`object` ([SerializedDeleteCategoryAction](serializedparentaction-definitions-serializeddeletecategoryaction.md))
|
|
|
|
# SerializedDeleteCategoryAction Properties
|
|
|
|
| Property | Type | Required | Nullable | Defined by |
|
|
| :------------------------ | -------- | -------- | -------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| [type](#type) | `string` | Required | cannot be null | [SerializedParentAction](serializedparentaction-definitions-serializeddeletecategoryaction-properties-type.md "https://timelimit.io/SerializedParentAction#/definitions/SerializedDeleteCategoryAction/properties/type") |
|
|
| [categoryId](#categoryid) | `string` | Required | cannot be null | [SerializedParentAction](serializedparentaction-definitions-serializeddeletecategoryaction-properties-categoryid.md "https://timelimit.io/SerializedParentAction#/definitions/SerializedDeleteCategoryAction/properties/categoryId") |
|
|
|
|
## type
|
|
|
|
|
|
|
|
|
|
`type`
|
|
|
|
- is required
|
|
- Type: `string`
|
|
- cannot be null
|
|
- defined in: [SerializedParentAction](serializedparentaction-definitions-serializeddeletecategoryaction-properties-type.md "https://timelimit.io/SerializedParentAction#/definitions/SerializedDeleteCategoryAction/properties/type")
|
|
|
|
### type Type
|
|
|
|
`string`
|
|
|
|
### type Constraints
|
|
|
|
**enum**: the value of this property must be equal to one of the following values:
|
|
|
|
| Value | Explanation |
|
|
| :------------------ | ----------- |
|
|
| `"DELETE_CATEGORY"` | |
|
|
|
|
## categoryId
|
|
|
|
|
|
|
|
|
|
`categoryId`
|
|
|
|
- is required
|
|
- Type: `string`
|
|
- cannot be null
|
|
- defined in: [SerializedParentAction](serializedparentaction-definitions-serializeddeletecategoryaction-properties-categoryid.md "https://timelimit.io/SerializedParentAction#/definitions/SerializedDeleteCategoryAction/properties/categoryId")
|
|
|
|
### categoryId Type
|
|
|
|
`string`
|