Addon catalog#
POST /api/addons#
Add an addon
Adds a recommended addon. An officer must be signed in.
Request body
Model: AddonCreate
Field |
Type |
Required |
Description |
|---|---|---|---|
|
string |
yes |
|
|
string |
yes |
|
|
string |
yes |
|
|
string |
yes |
|
|
string |
yes |
|
|
string | null |
no |
|
|
no |
Response 201 — The newly created addon.
Model: AddonSchema
Field |
Type |
Required |
Description |
|---|---|---|---|
|
string (uuid) |
yes |
|
|
string |
yes |
|
|
string |
yes |
|
|
string |
yes |
|
|
string |
yes |
|
|
string |
yes |
|
|
string | null |
yes |
|
|
no |
||
|
string (date-time) |
yes |
DELETE /api/addons/{addon_id}#
Remove an addon
Removes an addon. An officer must be signed in.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
|
path |
string (uuid) |
yes |
The addon’s ID. |
Response 204 — The addon was removed.
PATCH /api/addons/{addon_id}#
Edit an addon
Edits an addon. An officer must be signed in.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
|
path |
string (uuid) |
yes |
The addon’s ID. |
Request body
Model: AddonUpdate
Field |
Type |
Required |
Description |
|---|---|---|---|
|
string | null |
no |
|
|
string | null |
no |
|
|
string | null |
no |
|
|
string | null |
no |
|
|
string | null |
no |
|
|
AddonOrigin | null |
no |
Response 200 — The updated addon.
Model: AddonSchema
Field |
Type |
Required |
Description |
|---|---|---|---|
|
string (uuid) |
yes |
|
|
string |
yes |
|
|
string |
yes |
|
|
string |
yes |
|
|
string |
yes |
|
|
string |
yes |
|
|
string | null |
yes |
|
|
no |
||
|
string (date-time) |
yes |