2022-08-30 02:30:36 +00:00
{
"swagger" : "2.0" ,
"info" : {
2023-03-24 03:10:19 +00:00
"description" : "Track, Manage, and Organize your Things." ,
2023-03-07 06:18:58 +00:00
"title" : "Homebox API" ,
2022-08-30 02:30:36 +00:00
"contact" : {
"name" : "Don't"
} ,
"version" : "1.0"
} ,
"basePath" : "/api" ,
"paths" : {
2022-11-13 23:17:55 +00:00
"/v1/actions/ensure-asset-ids" : {
"post" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
2023-03-07 06:18:58 +00:00
"description" : "Ensures all items in the database have an asset ID" ,
2022-11-13 23:17:55 +00:00
"produces" : [
"application/json"
] ,
"tags" : [
2023-03-07 06:18:58 +00:00
"Actions"
2022-11-13 23:17:55 +00:00
] ,
2023-03-07 06:18:58 +00:00
"summary" : "Ensure Asset IDs" ,
2023-02-09 02:59:04 +00:00
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"$ref" : "#/definitions/v1.ActionAmountResult"
}
}
}
}
} ,
2023-02-26 02:54:40 +00:00
"/v1/actions/ensure-import-refs" : {
"post" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
2023-03-07 06:18:58 +00:00
"description" : "Ensures all items in the database have an import ref" ,
2023-02-26 02:54:40 +00:00
"produces" : [
"application/json"
] ,
"tags" : [
2023-03-07 06:18:58 +00:00
"Actions"
2023-02-26 02:54:40 +00:00
] ,
2023-03-07 06:18:58 +00:00
"summary" : "Ensures Import Refs" ,
2023-02-26 02:54:40 +00:00
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"$ref" : "#/definitions/v1.ActionAmountResult"
}
}
}
}
} ,
2023-02-09 02:59:04 +00:00
"/v1/actions/zero-item-time-fields" : {
"post" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
2023-03-07 06:18:58 +00:00
"description" : "Resets all item date fields to the beginning of the day" ,
2023-02-09 02:59:04 +00:00
"produces" : [
"application/json"
] ,
"tags" : [
2023-03-07 06:18:58 +00:00
"Actions"
2023-02-09 02:59:04 +00:00
] ,
2023-03-07 06:18:58 +00:00
"summary" : "Zero Out Time Fields" ,
2022-11-13 23:17:55 +00:00
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
2023-02-09 02:59:04 +00:00
"$ref" : "#/definitions/v1.ActionAmountResult"
2022-11-13 23:17:55 +00:00
}
}
}
}
} ,
2023-01-14 18:24:11 +00:00
"/v1/assets/{id}" : {
"get" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
"produces" : [
"application/json"
] ,
"tags" : [
2023-03-07 06:18:58 +00:00
"Items"
2023-01-14 18:24:11 +00:00
] ,
2023-03-07 06:18:58 +00:00
"summary" : "Get Item by Asset ID" ,
2023-01-14 18:24:11 +00:00
"parameters" : [
{
"type" : "string" ,
"description" : "Asset ID" ,
"name" : "id" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"$ref" : "#/definitions/repo.PaginationResult-repo_ItemSummary"
}
}
}
}
} ,
2022-10-15 20:15:55 +00:00
"/v1/groups" : {
"get" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"Group"
] ,
2023-03-07 06:18:58 +00:00
"summary" : "Get Group" ,
2022-10-15 20:15:55 +00:00
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"$ref" : "#/definitions/repo.Group"
}
}
}
} ,
"put" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"Group"
] ,
2023-03-07 06:18:58 +00:00
"summary" : "Update Group" ,
2022-10-15 20:15:55 +00:00
"parameters" : [
{
"description" : "User Data" ,
"name" : "payload" ,
"in" : "body" ,
"required" : true ,
"schema" : {
"$ref" : "#/definitions/repo.GroupUpdate"
}
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"$ref" : "#/definitions/repo.Group"
}
}
}
}
} ,
2022-10-07 02:54:09 +00:00
"/v1/groups/invitations" : {
"post" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
"produces" : [
"application/json"
] ,
"tags" : [
2022-10-15 20:15:55 +00:00
"Group"
2022-10-07 02:54:09 +00:00
] ,
2023-03-07 06:18:58 +00:00
"summary" : "Create Group Invitation" ,
2022-10-07 02:54:09 +00:00
"parameters" : [
{
"description" : "User Data" ,
"name" : "payload" ,
"in" : "body" ,
"required" : true ,
"schema" : {
"$ref" : "#/definitions/v1.GroupInvitationCreate"
}
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"$ref" : "#/definitions/v1.GroupInvitation"
}
}
}
}
} ,
2022-11-01 21:58:05 +00:00
"/v1/groups/statistics" : {
"get" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
"produces" : [
"application/json"
] ,
"tags" : [
2022-12-05 21:36:32 +00:00
"Statistics"
2022-11-01 21:58:05 +00:00
] ,
2023-03-07 06:18:58 +00:00
"summary" : "Get Group Statistics" ,
2022-11-01 21:58:05 +00:00
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"$ref" : "#/definitions/repo.GroupStatistics"
}
}
}
}
} ,
2022-12-05 21:36:32 +00:00
"/v1/groups/statistics/labels" : {
"get" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"Statistics"
] ,
2023-03-07 06:18:58 +00:00
"summary" : "Get Label Statistics" ,
2022-12-05 21:36:32 +00:00
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/repo.TotalsByOrganizer"
}
}
}
}
}
} ,
"/v1/groups/statistics/locations" : {
"get" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"Statistics"
] ,
2023-03-07 06:18:58 +00:00
"summary" : "Get Location Statistics" ,
2022-12-05 21:36:32 +00:00
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/repo.TotalsByOrganizer"
}
}
}
}
}
} ,
"/v1/groups/statistics/purchase-price" : {
"get" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"Statistics"
] ,
2023-03-07 06:18:58 +00:00
"summary" : "Get Purchase Price Statistics" ,
2022-12-05 21:36:32 +00:00
"parameters" : [
{
"type" : "string" ,
"description" : "start date" ,
"name" : "start" ,
"in" : "query"
} ,
{
"type" : "string" ,
"description" : "end date" ,
"name" : "end" ,
"in" : "query"
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"$ref" : "#/definitions/repo.ValueOverTime"
}
}
}
}
} ,
2022-09-03 09:17:48 +00:00
"/v1/items" : {
"get" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"Items"
] ,
2023-03-07 06:18:58 +00:00
"summary" : "Query All Items" ,
2022-10-13 05:13:07 +00:00
"parameters" : [
{
"type" : "string" ,
"description" : "search string" ,
"name" : "q" ,
"in" : "query"
} ,
{
"type" : "integer" ,
"description" : "page number" ,
"name" : "page" ,
"in" : "query"
} ,
{
"type" : "integer" ,
"description" : "items per page" ,
"name" : "pageSize" ,
"in" : "query"
} ,
{
"type" : "array" ,
"items" : {
"type" : "string"
} ,
"collectionFormat" : "multi" ,
"description" : "label Ids" ,
"name" : "labels" ,
"in" : "query"
} ,
{
"type" : "array" ,
"items" : {
"type" : "string"
} ,
"collectionFormat" : "multi" ,
"description" : "location Ids" ,
"name" : "locations" ,
"in" : "query"
}
] ,
2022-09-03 09:17:48 +00:00
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
2022-10-13 05:13:07 +00:00
"$ref" : "#/definitions/repo.PaginationResult-repo_ItemSummary"
2022-09-03 09:17:48 +00:00
}
}
}
} ,
"post" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"Items"
] ,
2023-03-07 06:18:58 +00:00
"summary" : "Create Item" ,
2022-09-03 09:17:48 +00:00
"parameters" : [
{
"description" : "Item Data" ,
"name" : "payload" ,
"in" : "body" ,
"required" : true ,
"schema" : {
2022-09-27 23:52:13 +00:00
"$ref" : "#/definitions/repo.ItemCreate"
2022-09-03 09:17:48 +00:00
}
}
] ,
"responses" : {
2023-03-21 04:32:10 +00:00
"201" : {
"description" : "Created" ,
2022-09-03 09:17:48 +00:00
"schema" : {
2022-09-27 23:52:13 +00:00
"$ref" : "#/definitions/repo.ItemSummary"
2022-09-03 09:17:48 +00:00
}
}
}
}
} ,
2023-02-26 02:54:40 +00:00
"/v1/items/export" : {
"get" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
"tags" : [
"Items"
] ,
2023-03-07 06:18:58 +00:00
"summary" : "Export Items" ,
2023-02-26 02:54:40 +00:00
"responses" : {
"200" : {
"description" : "text/csv" ,
"schema" : {
"type" : "string"
}
}
}
}
} ,
2023-02-05 21:12:54 +00:00
"/v1/items/fields" : {
"get" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"Items"
] ,
2023-03-07 06:18:58 +00:00
"summary" : "Get All Custom Field Names" ,
2023-02-05 21:12:54 +00:00
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"type" : "array" ,
"items" : {
"type" : "string"
}
}
}
}
}
} ,
"/v1/items/fields/values" : {
"get" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"Items"
] ,
2023-03-07 06:18:58 +00:00
"summary" : "Get All Custom Field Values" ,
2023-02-05 21:12:54 +00:00
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"type" : "array" ,
"items" : {
"type" : "string"
}
}
}
}
}
} ,
2022-09-06 19:15:07 +00:00
"/v1/items/import" : {
"post" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"Items"
] ,
2023-03-07 06:18:58 +00:00
"summary" : "Import Items" ,
2022-09-06 19:15:07 +00:00
"parameters" : [
{
"type" : "file" ,
"description" : "Image to upload" ,
"name" : "csv" ,
"in" : "formData" ,
"required" : true
}
] ,
"responses" : {
"204" : {
2022-10-13 05:13:07 +00:00
"description" : "No Content"
2022-09-06 19:15:07 +00:00
}
}
}
} ,
2022-09-03 09:17:48 +00:00
"/v1/items/{id}" : {
"get" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"Items"
] ,
2023-03-07 06:18:58 +00:00
"summary" : "Get Item" ,
2022-09-03 09:17:48 +00:00
"parameters" : [
{
"type" : "string" ,
"description" : "Item ID" ,
"name" : "id" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
2022-09-27 23:52:13 +00:00
"$ref" : "#/definitions/repo.ItemOut"
2022-09-03 09:17:48 +00:00
}
}
}
} ,
"put" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"Items"
] ,
2023-03-07 06:18:58 +00:00
"summary" : "Update Item" ,
2022-09-03 09:17:48 +00:00
"parameters" : [
{
"type" : "string" ,
"description" : "Item ID" ,
"name" : "id" ,
"in" : "path" ,
"required" : true
2022-09-12 22:47:27 +00:00
} ,
{
"description" : "Item Data" ,
"name" : "payload" ,
"in" : "body" ,
"required" : true ,
"schema" : {
2022-09-27 23:52:13 +00:00
"$ref" : "#/definitions/repo.ItemUpdate"
2022-09-12 22:47:27 +00:00
}
2022-09-03 09:17:48 +00:00
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
2022-09-27 23:52:13 +00:00
"$ref" : "#/definitions/repo.ItemOut"
2022-09-03 09:17:48 +00:00
}
}
}
} ,
"delete" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"Items"
] ,
2023-03-07 06:18:58 +00:00
"summary" : "Delete Item" ,
2022-09-03 09:17:48 +00:00
"parameters" : [
{
"type" : "string" ,
"description" : "Item ID" ,
"name" : "id" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"204" : {
2022-10-13 05:13:07 +00:00
"description" : "No Content"
2022-09-03 09:17:48 +00:00
}
}
2023-06-02 21:56:40 +00:00
} ,
"patch" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"Items"
] ,
"summary" : "Update Item" ,
"parameters" : [
{
"type" : "string" ,
"description" : "Item ID" ,
"name" : "id" ,
"in" : "path" ,
"required" : true
} ,
{
"description" : "Item Data" ,
"name" : "payload" ,
"in" : "body" ,
"required" : true ,
"schema" : {
"$ref" : "#/definitions/repo.ItemPatch"
}
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"$ref" : "#/definitions/repo.ItemOut"
}
}
}
2022-09-03 09:17:48 +00:00
}
} ,
2022-09-24 19:33:38 +00:00
"/v1/items/{id}/attachments" : {
"post" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
"produces" : [
"application/json"
] ,
"tags" : [
2022-10-16 05:41:27 +00:00
"Items Attachments"
2022-09-24 19:33:38 +00:00
] ,
2023-03-07 06:18:58 +00:00
"summary" : "Create Item Attachment" ,
2022-09-24 19:33:38 +00:00
"parameters" : [
{
"type" : "string" ,
"description" : "Item ID" ,
"name" : "id" ,
"in" : "path" ,
"required" : true
} ,
{
"type" : "file" ,
"description" : "File attachment" ,
"name" : "file" ,
"in" : "formData" ,
"required" : true
} ,
{
"type" : "string" ,
"description" : "Type of file" ,
"name" : "type" ,
"in" : "formData" ,
"required" : true
} ,
{
"type" : "string" ,
"description" : "name of the file including extension" ,
"name" : "name" ,
"in" : "formData" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
2022-09-27 23:52:13 +00:00
"$ref" : "#/definitions/repo.ItemOut"
2022-09-24 19:33:38 +00:00
}
} ,
"422" : {
"description" : "Unprocessable Entity" ,
"schema" : {
2023-07-27 21:21:28 +00:00
"$ref" : "#/definitions/validate.ErrorResponse"
2022-09-24 19:33:38 +00:00
}
}
}
}
} ,
"/v1/items/{id}/attachments/{attachment_id}" : {
"get" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
"produces" : [
"application/octet-stream"
] ,
"tags" : [
2022-10-16 05:41:27 +00:00
"Items Attachments"
2022-09-24 19:33:38 +00:00
] ,
2023-03-07 06:18:58 +00:00
"summary" : "Get Item Attachment" ,
2022-09-24 19:33:38 +00:00
"parameters" : [
{
"type" : "string" ,
"description" : "Item ID" ,
"name" : "id" ,
"in" : "path" ,
"required" : true
} ,
{
"type" : "string" ,
"description" : "Attachment ID" ,
"name" : "attachment_id" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
2022-09-27 23:52:13 +00:00
"$ref" : "#/definitions/v1.ItemAttachmentToken"
2022-09-24 19:33:38 +00:00
}
}
}
} ,
"put" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
"tags" : [
2022-10-16 05:41:27 +00:00
"Items Attachments"
2022-09-24 19:33:38 +00:00
] ,
2023-03-07 06:18:58 +00:00
"summary" : "Update Item Attachment" ,
2022-09-24 19:33:38 +00:00
"parameters" : [
{
"type" : "string" ,
"description" : "Item ID" ,
"name" : "id" ,
"in" : "path" ,
"required" : true
} ,
{
"type" : "string" ,
"description" : "Attachment ID" ,
"name" : "attachment_id" ,
"in" : "path" ,
"required" : true
} ,
{
"description" : "Attachment Update" ,
"name" : "payload" ,
"in" : "body" ,
"required" : true ,
"schema" : {
2022-09-27 23:52:13 +00:00
"$ref" : "#/definitions/repo.ItemAttachmentUpdate"
2022-09-24 19:33:38 +00:00
}
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
2022-09-27 23:52:13 +00:00
"$ref" : "#/definitions/repo.ItemOut"
2022-09-24 19:33:38 +00:00
}
}
}
} ,
"delete" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
"tags" : [
2022-10-16 05:41:27 +00:00
"Items Attachments"
2022-09-24 19:33:38 +00:00
] ,
2023-03-07 06:18:58 +00:00
"summary" : "Delete Item Attachment" ,
2022-09-24 19:33:38 +00:00
"parameters" : [
{
"type" : "string" ,
"description" : "Item ID" ,
"name" : "id" ,
"in" : "path" ,
"required" : true
} ,
{
"type" : "string" ,
"description" : "Attachment ID" ,
"name" : "attachment_id" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"204" : {
2022-10-13 05:13:07 +00:00
"description" : "No Content"
2022-09-24 19:33:38 +00:00
}
}
}
} ,
2022-12-10 05:57:57 +00:00
"/v1/items/{id}/maintenance" : {
"get" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"Maintenance"
] ,
"summary" : "Get Maintenance Log" ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"$ref" : "#/definitions/repo.MaintenanceLog"
}
}
}
} ,
"post" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"Maintenance"
] ,
"summary" : "Create Maintenance Entry" ,
"parameters" : [
{
"description" : "Entry Data" ,
"name" : "payload" ,
"in" : "body" ,
"required" : true ,
"schema" : {
"$ref" : "#/definitions/repo.MaintenanceEntryCreate"
}
}
] ,
"responses" : {
2023-03-21 04:32:10 +00:00
"201" : {
"description" : "Created" ,
2022-12-10 05:57:57 +00:00
"schema" : {
"$ref" : "#/definitions/repo.MaintenanceEntry"
}
}
}
}
} ,
"/v1/items/{id}/maintenance/{entry_id}" : {
"put" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"Maintenance"
] ,
"summary" : "Update Maintenance Entry" ,
"parameters" : [
{
"description" : "Entry Data" ,
"name" : "payload" ,
"in" : "body" ,
"required" : true ,
"schema" : {
"$ref" : "#/definitions/repo.MaintenanceEntryUpdate"
}
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"$ref" : "#/definitions/repo.MaintenanceEntry"
}
}
}
} ,
"delete" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"Maintenance"
] ,
"summary" : "Delete Maintenance Entry" ,
"responses" : {
"204" : {
"description" : "No Content"
}
}
}
} ,
2022-09-01 23:11:14 +00:00
"/v1/labels" : {
"get" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"Labels"
] ,
"summary" : "Get All Labels" ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
2023-03-21 05:48:22 +00:00
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/repo.LabelOut"
}
2022-09-01 23:11:14 +00:00
}
}
}
} ,
"post" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"Labels"
] ,
2023-03-07 06:18:58 +00:00
"summary" : "Create Label" ,
2022-09-01 23:11:14 +00:00
"parameters" : [
{
"description" : "Label Data" ,
"name" : "payload" ,
"in" : "body" ,
"required" : true ,
"schema" : {
2022-09-27 23:52:13 +00:00
"$ref" : "#/definitions/repo.LabelCreate"
2022-09-01 23:11:14 +00:00
}
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
2022-09-27 23:52:13 +00:00
"$ref" : "#/definitions/repo.LabelSummary"
2022-09-01 23:11:14 +00:00
}
}
}
}
} ,
"/v1/labels/{id}" : {
"get" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"Labels"
] ,
2023-03-07 06:18:58 +00:00
"summary" : "Get Label" ,
2022-09-01 23:11:14 +00:00
"parameters" : [
{
"type" : "string" ,
"description" : "Label ID" ,
"name" : "id" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
2022-09-27 23:52:13 +00:00
"$ref" : "#/definitions/repo.LabelOut"
2022-09-01 23:11:14 +00:00
}
}
}
} ,
"put" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"Labels"
] ,
2023-03-07 06:18:58 +00:00
"summary" : "Update Label" ,
2022-09-01 23:11:14 +00:00
"parameters" : [
{
"type" : "string" ,
"description" : "Label ID" ,
"name" : "id" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
2022-09-27 23:52:13 +00:00
"$ref" : "#/definitions/repo.LabelOut"
2022-09-01 23:11:14 +00:00
}
}
}
} ,
"delete" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"Labels"
] ,
2023-03-07 06:18:58 +00:00
"summary" : "Delete Label" ,
2022-09-01 23:11:14 +00:00
"parameters" : [
{
"type" : "string" ,
"description" : "Label ID" ,
"name" : "id" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"204" : {
2022-10-13 05:13:07 +00:00
"description" : "No Content"
2022-09-01 23:11:14 +00:00
}
}
}
} ,
2022-08-31 05:22:01 +00:00
"/v1/locations" : {
"get" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"Locations"
] ,
"summary" : "Get All Locations" ,
2022-11-02 19:54:43 +00:00
"parameters" : [
{
"type" : "boolean" ,
"description" : "Filter locations with parents" ,
"name" : "filterChildren" ,
"in" : "query"
}
] ,
2022-08-31 05:22:01 +00:00
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
2023-03-21 05:48:22 +00:00
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/repo.LocationOutCount"
}
2022-08-31 05:22:01 +00:00
}
}
}
} ,
"post" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"Locations"
] ,
2023-03-07 06:18:58 +00:00
"summary" : "Create Location" ,
2022-08-31 05:22:01 +00:00
"parameters" : [
{
"description" : "Location Data" ,
"name" : "payload" ,
"in" : "body" ,
"required" : true ,
"schema" : {
2022-09-27 23:52:13 +00:00
"$ref" : "#/definitions/repo.LocationCreate"
2022-08-31 05:22:01 +00:00
}
}
] ,
2022-09-01 22:32:03 +00:00
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
2022-09-27 23:52:13 +00:00
"$ref" : "#/definitions/repo.LocationSummary"
2022-09-01 22:32:03 +00:00
}
}
}
}
} ,
2023-01-28 20:53:00 +00:00
"/v1/locations/tree" : {
"get" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"Locations"
] ,
2023-03-07 06:18:58 +00:00
"summary" : "Get Locations Tree" ,
2023-01-28 20:53:00 +00:00
"parameters" : [
{
"type" : "boolean" ,
"description" : "include items in response tree" ,
"name" : "withItems" ,
"in" : "query"
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
2023-03-21 05:48:22 +00:00
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/repo.TreeItem"
}
2023-01-28 20:53:00 +00:00
}
}
}
}
} ,
2022-09-01 22:32:03 +00:00
"/v1/locations/{id}" : {
"get" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"Locations"
] ,
2023-03-07 06:18:58 +00:00
"summary" : "Get Location" ,
2022-09-01 22:32:03 +00:00
"parameters" : [
{
"type" : "string" ,
"description" : "Location ID" ,
"name" : "id" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
2022-09-27 23:52:13 +00:00
"$ref" : "#/definitions/repo.LocationOut"
2022-09-01 22:32:03 +00:00
}
}
}
} ,
"put" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"Locations"
] ,
2023-03-07 06:18:58 +00:00
"summary" : "Update Location" ,
2022-09-01 22:32:03 +00:00
"parameters" : [
{
"type" : "string" ,
"description" : "Location ID" ,
"name" : "id" ,
"in" : "path" ,
"required" : true
2022-10-24 04:54:39 +00:00
} ,
{
"description" : "Location Data" ,
"name" : "payload" ,
"in" : "body" ,
"required" : true ,
"schema" : {
"$ref" : "#/definitions/repo.LocationUpdate"
}
2022-09-01 22:32:03 +00:00
}
] ,
2022-08-31 05:22:01 +00:00
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
2022-09-27 23:52:13 +00:00
"$ref" : "#/definitions/repo.LocationOut"
2022-08-31 05:22:01 +00:00
}
}
}
2022-09-01 22:32:03 +00:00
} ,
"delete" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"Locations"
] ,
2023-03-07 06:18:58 +00:00
"summary" : "Delete Location" ,
2022-09-01 22:32:03 +00:00
"parameters" : [
{
"type" : "string" ,
"description" : "Location ID" ,
"name" : "id" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"204" : {
2022-10-13 05:13:07 +00:00
"description" : "No Content"
2022-09-01 22:32:03 +00:00
}
}
2022-08-31 05:22:01 +00:00
}
} ,
2023-03-07 06:18:58 +00:00
"/v1/notifiers" : {
"get" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"Notifiers"
] ,
"summary" : "Get Notifiers" ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
2023-03-21 05:48:22 +00:00
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/repo.NotifierOut"
}
2023-03-07 06:18:58 +00:00
}
}
}
} ,
"post" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"Notifiers"
] ,
"summary" : "Create Notifier" ,
"parameters" : [
{
"description" : "Notifier Data" ,
"name" : "payload" ,
"in" : "body" ,
"required" : true ,
"schema" : {
"$ref" : "#/definitions/repo.NotifierCreate"
}
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"$ref" : "#/definitions/repo.NotifierOut"
}
}
}
}
} ,
"/v1/notifiers/test" : {
"post" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"Notifiers"
] ,
"summary" : "Test Notifier" ,
"parameters" : [
{
"type" : "string" ,
"description" : "Notifier ID" ,
"name" : "id" ,
"in" : "path" ,
"required" : true
} ,
{
"type" : "string" ,
"description" : "URL" ,
"name" : "url" ,
"in" : "query" ,
"required" : true
}
] ,
"responses" : {
"204" : {
"description" : "No Content"
}
}
}
} ,
"/v1/notifiers/{id}" : {
"put" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
"tags" : [
"Notifiers"
] ,
"summary" : "Update Notifier" ,
"parameters" : [
{
"type" : "string" ,
"description" : "Notifier ID" ,
"name" : "id" ,
"in" : "path" ,
"required" : true
} ,
{
"description" : "Notifier Data" ,
"name" : "payload" ,
"in" : "body" ,
"required" : true ,
"schema" : {
"$ref" : "#/definitions/repo.NotifierUpdate"
}
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"$ref" : "#/definitions/repo.NotifierOut"
}
}
}
} ,
"delete" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
"tags" : [
"Notifiers"
] ,
"summary" : "Delete a Notifier" ,
"parameters" : [
{
"type" : "string" ,
"description" : "Notifier ID" ,
"name" : "id" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"204" : {
"description" : "No Content"
}
}
}
} ,
2023-01-19 05:44:06 +00:00
"/v1/qrcode" : {
"get" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"Items"
] ,
2023-03-07 06:18:58 +00:00
"summary" : "Create QR Code" ,
2023-01-19 05:44:06 +00:00
"parameters" : [
{
"type" : "string" ,
"description" : "data to be encoded into qrcode" ,
"name" : "data" ,
"in" : "query"
}
] ,
"responses" : {
"200" : {
"description" : "image/jpeg" ,
"schema" : {
"type" : "string"
}
}
}
}
} ,
2023-02-13 19:00:29 +00:00
"/v1/reporting/bill-of-materials" : {
"get" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"Reporting"
] ,
2023-03-07 06:18:58 +00:00
"summary" : "Export Bill of Materials" ,
2023-02-13 19:00:29 +00:00
"responses" : {
"200" : {
"description" : "text/csv" ,
"schema" : {
"type" : "string"
}
}
}
}
} ,
2022-09-04 02:42:03 +00:00
"/v1/status" : {
"get" : {
"produces" : [
"application/json"
] ,
"tags" : [
"Base"
] ,
2023-03-07 06:18:58 +00:00
"summary" : "Application Info" ,
2022-09-04 02:42:03 +00:00
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
2022-09-27 23:52:13 +00:00
"$ref" : "#/definitions/v1.ApiSummary"
2022-09-04 02:42:03 +00:00
}
}
}
}
} ,
2022-10-09 17:23:21 +00:00
"/v1/users/change-password" : {
"put" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
"tags" : [
"User"
] ,
2023-03-07 06:18:58 +00:00
"summary" : "Change Password" ,
2022-10-09 17:23:21 +00:00
"parameters" : [
{
"description" : "Password Payload" ,
"name" : "payload" ,
"in" : "body" ,
"required" : true ,
"schema" : {
"$ref" : "#/definitions/v1.ChangePassword"
}
}
] ,
"responses" : {
"204" : {
2022-10-13 05:13:07 +00:00
"description" : "No Content"
2022-10-09 17:23:21 +00:00
}
}
}
} ,
2022-08-30 02:30:36 +00:00
"/v1/users/login" : {
"post" : {
"consumes" : [
"application/x-www-form-urlencoded" ,
"application/json"
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"Authentication"
] ,
"summary" : "User Login" ,
"parameters" : [
{
"type" : "string" ,
"example" : "admin@admin.com" ,
"description" : "string" ,
"name" : "username" ,
"in" : "formData"
} ,
{
"type" : "string" ,
"example" : "admin" ,
"description" : "string" ,
"name" : "password" ,
"in" : "formData"
2023-03-23 05:52:25 +00:00
} ,
{
"description" : "Login Data" ,
"name" : "payload" ,
"in" : "body" ,
"required" : true ,
"schema" : {
"$ref" : "#/definitions/v1.LoginForm"
}
2022-08-30 02:30:36 +00:00
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
2022-09-27 23:52:13 +00:00
"$ref" : "#/definitions/v1.TokenResponse"
2022-08-30 02:30:36 +00:00
}
}
}
}
} ,
"/v1/users/logout" : {
"post" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
"tags" : [
"Authentication"
] ,
"summary" : "User Logout" ,
"responses" : {
"204" : {
2022-10-13 05:13:07 +00:00
"description" : "No Content"
2022-08-30 02:30:36 +00:00
}
}
}
} ,
"/v1/users/refresh" : {
"get" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
"description" : "handleAuthRefresh returns a handler that will issue a new token from an existing token.\nThis does not validate that the user still exists within the database." ,
"tags" : [
"Authentication"
] ,
"summary" : "User Token Refresh" ,
"responses" : {
"200" : {
2022-10-13 05:13:07 +00:00
"description" : "OK"
2022-08-30 02:30:36 +00:00
}
}
}
} ,
2022-08-30 18:05:11 +00:00
"/v1/users/register" : {
"post" : {
"produces" : [
"application/json"
] ,
"tags" : [
"User"
] ,
2023-03-07 06:18:58 +00:00
"summary" : "Register New User" ,
2022-08-30 18:05:11 +00:00
"parameters" : [
{
"description" : "User Data" ,
"name" : "payload" ,
"in" : "body" ,
"required" : true ,
"schema" : {
2022-09-27 23:52:13 +00:00
"$ref" : "#/definitions/services.UserRegistration"
2022-08-30 18:05:11 +00:00
}
}
] ,
"responses" : {
2022-08-31 05:22:01 +00:00
"204" : {
2022-10-13 05:13:07 +00:00
"description" : "No Content"
2022-08-30 18:05:11 +00:00
}
}
}
} ,
2022-08-30 02:30:36 +00:00
"/v1/users/self" : {
"get" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"User"
] ,
2023-03-07 06:18:58 +00:00
"summary" : "Get User Self" ,
2022-08-30 02:30:36 +00:00
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"allOf" : [
{
2023-03-21 04:32:10 +00:00
"$ref" : "#/definitions/v1.Wrapped"
2022-08-30 02:30:36 +00:00
} ,
{
"type" : "object" ,
"properties" : {
"item" : {
2022-09-27 23:52:13 +00:00
"$ref" : "#/definitions/repo.UserOut"
2022-08-30 02:30:36 +00:00
}
}
}
]
}
}
}
} ,
"put" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"User"
] ,
2023-03-07 06:18:58 +00:00
"summary" : "Update Account" ,
2022-08-30 02:30:36 +00:00
"parameters" : [
{
"description" : "User Data" ,
"name" : "payload" ,
"in" : "body" ,
"required" : true ,
"schema" : {
2022-09-27 23:52:13 +00:00
"$ref" : "#/definitions/repo.UserUpdate"
2022-08-30 02:30:36 +00:00
}
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"allOf" : [
{
2023-03-21 04:32:10 +00:00
"$ref" : "#/definitions/v1.Wrapped"
2022-08-30 02:30:36 +00:00
} ,
{
"type" : "object" ,
"properties" : {
"item" : {
2022-09-27 23:52:13 +00:00
"$ref" : "#/definitions/repo.UserUpdate"
2022-08-30 02:30:36 +00:00
}
}
}
]
}
}
}
2022-09-04 02:42:03 +00:00
} ,
"delete" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"User"
] ,
2023-03-07 06:18:58 +00:00
"summary" : "Delete Account" ,
2022-09-04 02:42:03 +00:00
"responses" : {
"204" : {
2022-10-13 05:13:07 +00:00
"description" : "No Content"
2022-09-04 02:42:03 +00:00
}
2022-08-30 02:30:36 +00:00
}
}
}
} ,
"definitions" : {
2022-09-27 23:52:13 +00:00
"repo.DocumentOut" : {
2022-08-30 18:05:11 +00:00
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
2022-09-12 22:47:27 +00:00
"path" : {
2022-08-30 18:05:11 +00:00
"type" : "string"
} ,
2022-09-12 22:47:27 +00:00
"title" : {
2022-09-09 18:20:38 +00:00
"type" : "string"
2022-08-30 18:05:11 +00:00
}
}
} ,
2022-10-15 20:15:55 +00:00
"repo.Group" : {
"type" : "object" ,
"properties" : {
"createdAt" : {
"type" : "string"
} ,
"currency" : {
"type" : "string"
} ,
"id" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"updatedAt" : {
"type" : "string"
}
}
} ,
2022-11-01 21:58:05 +00:00
"repo.GroupStatistics" : {
"type" : "object" ,
"properties" : {
2022-12-05 21:36:32 +00:00
"totalItemPrice" : {
"type" : "number"
} ,
2022-11-01 21:58:05 +00:00
"totalItems" : {
"type" : "integer"
} ,
"totalLabels" : {
"type" : "integer"
} ,
"totalLocations" : {
"type" : "integer"
} ,
"totalUsers" : {
"type" : "integer"
2022-12-05 21:36:32 +00:00
} ,
"totalWithWarranty" : {
"type" : "integer"
2022-11-01 21:58:05 +00:00
}
}
} ,
2022-10-15 20:15:55 +00:00
"repo.GroupUpdate" : {
"type" : "object" ,
"properties" : {
"currency" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
}
}
} ,
2022-09-27 23:52:13 +00:00
"repo.ItemAttachment" : {
2022-08-30 18:05:11 +00:00
"type" : "object" ,
"properties" : {
2022-09-12 22:47:27 +00:00
"createdAt" : {
2022-08-30 18:05:11 +00:00
"type" : "string"
} ,
2022-09-12 22:47:27 +00:00
"document" : {
2022-09-27 23:52:13 +00:00
"$ref" : "#/definitions/repo.DocumentOut"
2022-08-30 18:05:11 +00:00
} ,
"id" : {
"type" : "string"
} ,
2022-09-24 19:33:38 +00:00
"type" : {
"type" : "string"
} ,
2022-09-12 22:47:27 +00:00
"updatedAt" : {
2022-08-30 18:05:11 +00:00
"type" : "string"
}
}
} ,
2022-09-27 23:52:13 +00:00
"repo.ItemAttachmentUpdate" : {
2022-09-24 19:33:38 +00:00
"type" : "object" ,
"properties" : {
"title" : {
"type" : "string"
} ,
"type" : {
"type" : "string"
}
}
} ,
2022-09-27 23:52:13 +00:00
"repo.ItemCreate" : {
2022-08-30 18:05:11 +00:00
"type" : "object" ,
2023-03-21 04:32:10 +00:00
"required" : [
"name"
] ,
2022-08-30 18:05:11 +00:00
"properties" : {
"description" : {
2023-03-21 04:32:10 +00:00
"type" : "string" ,
2023-03-21 05:48:22 +00:00
"maxLength" : 1000
2022-08-30 18:05:11 +00:00
} ,
2022-09-12 22:47:27 +00:00
"labelIds" : {
"type" : "array" ,
"items" : {
"type" : "string"
}
2022-08-30 18:05:11 +00:00
} ,
2022-09-12 22:47:27 +00:00
"locationId" : {
"description" : "Edges" ,
2022-08-30 18:05:11 +00:00
"type" : "string"
} ,
"name" : {
2023-03-21 04:32:10 +00:00
"type" : "string" ,
"maxLength" : 255 ,
"minLength" : 1
2022-10-24 04:54:39 +00:00
} ,
"parentId" : {
"type" : "string" ,
"x-nullable" : true
2022-08-30 18:05:11 +00:00
}
}
} ,
2022-10-16 05:41:27 +00:00
"repo.ItemField" : {
"type" : "object" ,
"properties" : {
"booleanValue" : {
"type" : "boolean"
} ,
"id" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"numberValue" : {
"type" : "integer"
} ,
"textValue" : {
"type" : "string"
} ,
"type" : {
"type" : "string"
}
}
} ,
2022-09-27 23:52:13 +00:00
"repo.ItemOut" : {
2022-08-30 18:05:11 +00:00
"type" : "object" ,
"properties" : {
2022-11-01 07:30:42 +00:00
"archived" : {
"type" : "boolean"
} ,
2022-11-13 23:17:55 +00:00
"assetId" : {
"type" : "string" ,
"example" : "0"
} ,
2022-09-12 22:47:27 +00:00
"attachments" : {
2022-08-30 18:05:11 +00:00
"type" : "array" ,
"items" : {
2022-09-27 23:52:13 +00:00
"$ref" : "#/definitions/repo.ItemAttachment"
2022-08-30 18:05:11 +00:00
}
2022-09-12 22:47:27 +00:00
} ,
2022-10-24 04:54:39 +00:00
"children" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/repo.ItemSummary"
}
} ,
2022-09-12 22:47:27 +00:00
"createdAt" : {
2022-08-30 18:05:11 +00:00
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
2022-10-16 05:41:27 +00:00
"fields" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/repo.ItemField"
}
} ,
2022-08-30 18:05:11 +00:00
"id" : {
"type" : "string"
} ,
2022-09-12 22:47:27 +00:00
"insured" : {
"type" : "boolean"
2022-08-30 18:05:11 +00:00
} ,
2022-09-12 22:47:27 +00:00
"labels" : {
2022-08-30 18:05:11 +00:00
"type" : "array" ,
"items" : {
2022-09-27 23:52:13 +00:00
"$ref" : "#/definitions/repo.LabelSummary"
2022-08-30 18:05:11 +00:00
}
} ,
2022-09-12 22:47:27 +00:00
"lifetimeWarranty" : {
"description" : "Warranty" ,
"type" : "boolean"
2022-08-30 18:05:11 +00:00
} ,
2022-09-12 22:47:27 +00:00
"location" : {
"description" : "Edges" ,
2022-10-24 04:54:39 +00:00
"x-nullable" : true ,
"x-omitempty" : true ,
2022-09-27 23:52:13 +00:00
"$ref" : "#/definitions/repo.LocationSummary"
2022-08-30 18:05:11 +00:00
} ,
2022-09-12 22:47:27 +00:00
"manufacturer" : {
2022-08-30 18:05:11 +00:00
"type" : "string"
} ,
2022-09-12 22:47:27 +00:00
"modelNumber" : {
"type" : "string"
2022-08-30 18:05:11 +00:00
} ,
"name" : {
"type" : "string"
} ,
2022-09-12 22:47:27 +00:00
"notes" : {
"description" : "Extras" ,
2022-08-30 18:05:11 +00:00
"type" : "string"
} ,
2022-10-24 04:54:39 +00:00
"parent" : {
"x-nullable" : true ,
"x-omitempty" : true ,
"$ref" : "#/definitions/repo.ItemSummary"
} ,
2022-09-12 22:47:27 +00:00
"purchaseFrom" : {
"type" : "string"
2022-08-30 02:30:36 +00:00
} ,
2022-09-12 22:47:27 +00:00
"purchasePrice" : {
"type" : "string" ,
"example" : "0"
} ,
"purchaseTime" : {
"description" : "Purchase" ,
2022-08-30 02:30:36 +00:00
"type" : "string"
} ,
2022-09-12 22:47:27 +00:00
"quantity" : {
"type" : "integer"
} ,
"serialNumber" : {
2022-08-30 02:30:36 +00:00
"type" : "string"
} ,
2022-09-12 22:47:27 +00:00
"soldNotes" : {
2022-08-30 02:30:36 +00:00
"type" : "string"
} ,
2022-09-12 22:47:27 +00:00
"soldPrice" : {
"type" : "string" ,
"example" : "0"
} ,
"soldTime" : {
"description" : "Sold" ,
2022-09-03 09:17:48 +00:00
"type" : "string"
} ,
2022-09-12 22:47:27 +00:00
"soldTo" : {
"type" : "string"
2022-09-03 09:17:48 +00:00
} ,
2022-09-12 22:47:27 +00:00
"updatedAt" : {
2022-09-03 09:17:48 +00:00
"type" : "string"
} ,
2022-09-12 22:47:27 +00:00
"warrantyDetails" : {
"type" : "string"
} ,
"warrantyExpires" : {
2022-09-03 09:17:48 +00:00
"type" : "string"
}
}
} ,
2023-06-02 21:56:40 +00:00
"repo.ItemPatch" : {
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
"quantity" : {
"type" : "integer" ,
"x-nullable" : true ,
"x-omitempty" : true
}
}
} ,
2022-09-27 23:52:13 +00:00
"repo.ItemSummary" : {
2022-09-03 09:17:48 +00:00
"type" : "object" ,
"properties" : {
2022-11-01 07:30:42 +00:00
"archived" : {
"type" : "boolean"
} ,
2022-09-03 09:17:48 +00:00
"createdAt" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"id" : {
"type" : "string"
} ,
2022-09-12 22:47:27 +00:00
"insured" : {
"type" : "boolean"
} ,
2022-09-03 09:17:48 +00:00
"labels" : {
"type" : "array" ,
"items" : {
2022-09-27 23:52:13 +00:00
"$ref" : "#/definitions/repo.LabelSummary"
2022-09-03 09:17:48 +00:00
}
} ,
"location" : {
"description" : "Edges" ,
2022-10-24 04:54:39 +00:00
"x-nullable" : true ,
"x-omitempty" : true ,
2022-09-27 23:52:13 +00:00
"$ref" : "#/definitions/repo.LocationSummary"
2022-09-03 09:17:48 +00:00
} ,
"name" : {
"type" : "string"
} ,
2022-12-30 01:19:15 +00:00
"purchasePrice" : {
"type" : "string" ,
"example" : "0"
} ,
2022-09-12 22:47:27 +00:00
"quantity" : {
"type" : "integer"
} ,
2022-09-03 09:17:48 +00:00
"updatedAt" : {
"type" : "string"
}
}
} ,
2022-09-27 23:52:13 +00:00
"repo.ItemUpdate" : {
2022-09-01 22:32:03 +00:00
"type" : "object" ,
"properties" : {
2022-11-01 07:30:42 +00:00
"archived" : {
"type" : "boolean"
} ,
2022-11-13 23:17:55 +00:00
"assetId" : {
"type" : "string"
} ,
2022-09-01 22:32:03 +00:00
"description" : {
"type" : "string"
} ,
2022-10-16 05:41:27 +00:00
"fields" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/repo.ItemField"
}
} ,
2022-09-01 22:32:03 +00:00
"id" : {
"type" : "string"
} ,
2022-09-12 22:47:27 +00:00
"insured" : {
"type" : "boolean"
} ,
"labelIds" : {
2022-09-03 09:17:48 +00:00
"type" : "array" ,
"items" : {
2022-09-12 22:47:27 +00:00
"type" : "string"
2022-09-03 09:17:48 +00:00
}
} ,
2022-09-09 18:20:38 +00:00
"lifetimeWarranty" : {
"description" : "Warranty" ,
"type" : "boolean"
} ,
2022-09-12 22:47:27 +00:00
"locationId" : {
2022-09-03 09:17:48 +00:00
"description" : "Edges" ,
2022-09-12 22:47:27 +00:00
"type" : "string"
2022-09-03 09:17:48 +00:00
} ,
"manufacturer" : {
"type" : "string"
} ,
"modelNumber" : {
2022-09-01 22:32:03 +00:00
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
2022-09-03 09:17:48 +00:00
"notes" : {
"description" : "Extras" ,
"type" : "string"
} ,
2022-10-24 04:54:39 +00:00
"parentId" : {
"type" : "string" ,
"x-nullable" : true ,
"x-omitempty" : true
} ,
2022-09-03 09:17:48 +00:00
"purchaseFrom" : {
"type" : "string"
} ,
"purchasePrice" : {
2022-09-12 22:47:27 +00:00
"type" : "string" ,
"example" : "0"
2022-09-03 09:17:48 +00:00
} ,
"purchaseTime" : {
"description" : "Purchase" ,
"type" : "string"
} ,
2022-09-12 22:47:27 +00:00
"quantity" : {
"type" : "integer"
} ,
2022-09-03 09:17:48 +00:00
"serialNumber" : {
"description" : "Identifications" ,
"type" : "string"
} ,
"soldNotes" : {
"type" : "string"
} ,
"soldPrice" : {
2022-09-12 22:47:27 +00:00
"type" : "string" ,
"example" : "0"
2022-09-03 09:17:48 +00:00
} ,
"soldTime" : {
"description" : "Sold" ,
"type" : "string"
} ,
"soldTo" : {
"type" : "string"
} ,
2022-09-09 18:20:38 +00:00
"warrantyDetails" : {
"type" : "string"
} ,
"warrantyExpires" : {
2023-02-15 17:40:35 +00:00
"description" : "Sold" ,
2022-09-09 18:20:38 +00:00
"type" : "string"
2022-09-01 22:32:03 +00:00
}
}
} ,
2022-09-27 23:52:13 +00:00
"repo.LabelCreate" : {
2022-09-02 01:52:40 +00:00
"type" : "object" ,
2023-03-21 04:32:10 +00:00
"required" : [
"name"
] ,
2022-09-02 01:52:40 +00:00
"properties" : {
"color" : {
"type" : "string"
} ,
"description" : {
2023-03-21 04:32:10 +00:00
"type" : "string" ,
"maxLength" : 255
2022-09-02 01:52:40 +00:00
} ,
"name" : {
2023-03-21 04:32:10 +00:00
"type" : "string" ,
"maxLength" : 255 ,
"minLength" : 1
2022-09-02 01:52:40 +00:00
}
}
2022-09-01 23:11:14 +00:00
} ,
2022-09-27 23:52:13 +00:00
"repo.LabelOut" : {
2022-09-02 01:52:40 +00:00
"type" : "object" ,
"properties" : {
"createdAt" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"id" : {
"type" : "string"
} ,
"items" : {
"type" : "array" ,
"items" : {
2022-09-27 23:52:13 +00:00
"$ref" : "#/definitions/repo.ItemSummary"
2022-09-02 01:52:40 +00:00
}
} ,
"name" : {
"type" : "string"
} ,
"updatedAt" : {
"type" : "string"
}
}
2022-09-01 23:11:14 +00:00
} ,
2022-09-27 23:52:13 +00:00
"repo.LabelSummary" : {
2022-09-02 01:52:40 +00:00
"type" : "object" ,
"properties" : {
"createdAt" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"id" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"updatedAt" : {
"type" : "string"
}
}
2022-09-01 23:11:14 +00:00
} ,
2022-09-27 23:52:13 +00:00
"repo.LocationCreate" : {
"type" : "object" ,
"properties" : {
"description" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
2023-01-28 20:53:00 +00:00
} ,
"parentId" : {
"type" : "string" ,
"x-nullable" : true
2022-09-27 23:52:13 +00:00
}
}
} ,
"repo.LocationOut" : {
2022-09-03 09:17:48 +00:00
"type" : "object" ,
"properties" : {
2022-10-24 04:54:39 +00:00
"children" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/repo.LocationSummary"
}
} ,
2022-09-03 09:17:48 +00:00
"createdAt" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"id" : {
"type" : "string"
} ,
2022-09-27 23:52:13 +00:00
"items" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/repo.ItemSummary"
}
2022-09-03 09:17:48 +00:00
} ,
"name" : {
"type" : "string"
} ,
2022-10-24 04:54:39 +00:00
"parent" : {
"$ref" : "#/definitions/repo.LocationSummary"
} ,
2022-09-03 09:17:48 +00:00
"updatedAt" : {
"type" : "string"
}
}
} ,
2022-09-27 23:52:13 +00:00
"repo.LocationOutCount" : {
2022-08-31 05:22:01 +00:00
"type" : "object" ,
"properties" : {
2022-09-27 23:52:13 +00:00
"createdAt" : {
"type" : "string"
} ,
2022-08-31 05:22:01 +00:00
"description" : {
"type" : "string"
} ,
2022-09-27 23:52:13 +00:00
"id" : {
"type" : "string"
} ,
"itemCount" : {
"type" : "integer"
} ,
2022-08-31 05:22:01 +00:00
"name" : {
"type" : "string"
2022-09-27 23:52:13 +00:00
} ,
"updatedAt" : {
"type" : "string"
2022-08-31 05:22:01 +00:00
}
}
} ,
2022-09-27 23:52:13 +00:00
"repo.LocationSummary" : {
2022-09-01 22:32:03 +00:00
"type" : "object" ,
"properties" : {
"createdAt" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"id" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"updatedAt" : {
"type" : "string"
}
}
} ,
2022-10-24 04:54:39 +00:00
"repo.LocationUpdate" : {
"type" : "object" ,
"properties" : {
"description" : {
"type" : "string"
} ,
"id" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"parentId" : {
"type" : "string" ,
"x-nullable" : true
}
}
} ,
2022-12-10 05:57:57 +00:00
"repo.MaintenanceEntry" : {
"type" : "object" ,
"properties" : {
2023-02-27 03:42:23 +00:00
"completedDate" : {
"description" : "Sold" ,
"type" : "string"
} ,
2022-12-10 05:57:57 +00:00
"cost" : {
"type" : "string" ,
"example" : "0"
} ,
"description" : {
"type" : "string"
} ,
"id" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
2023-02-27 03:42:23 +00:00
} ,
"scheduledDate" : {
"description" : "Sold" ,
"type" : "string"
2022-12-10 05:57:57 +00:00
}
}
} ,
"repo.MaintenanceEntryCreate" : {
"type" : "object" ,
2023-03-21 05:48:22 +00:00
"required" : [
"name"
] ,
2022-12-10 05:57:57 +00:00
"properties" : {
2023-02-27 03:42:23 +00:00
"completedDate" : {
"description" : "Sold" ,
"type" : "string"
} ,
2022-12-10 05:57:57 +00:00
"cost" : {
"type" : "string" ,
"example" : "0"
} ,
"description" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
2023-02-27 03:42:23 +00:00
} ,
"scheduledDate" : {
"description" : "Sold" ,
"type" : "string"
2022-12-10 05:57:57 +00:00
}
}
} ,
"repo.MaintenanceEntryUpdate" : {
"type" : "object" ,
"properties" : {
2023-02-27 03:42:23 +00:00
"completedDate" : {
"description" : "Sold" ,
"type" : "string"
} ,
2022-12-10 05:57:57 +00:00
"cost" : {
"type" : "string" ,
"example" : "0"
} ,
"description" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
2023-02-27 03:42:23 +00:00
} ,
"scheduledDate" : {
"description" : "Sold" ,
"type" : "string"
2022-12-10 05:57:57 +00:00
}
}
} ,
"repo.MaintenanceLog" : {
"type" : "object" ,
"properties" : {
"costAverage" : {
"type" : "number"
} ,
"costTotal" : {
"type" : "number"
} ,
"entries" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/repo.MaintenanceEntry"
}
} ,
"itemId" : {
"type" : "string"
}
}
} ,
2023-03-07 06:18:58 +00:00
"repo.NotifierCreate" : {
"type" : "object" ,
"required" : [
"name" ,
"url"
] ,
"properties" : {
"isActive" : {
"type" : "boolean"
} ,
"name" : {
"type" : "string" ,
"maxLength" : 255 ,
"minLength" : 1
} ,
"url" : {
"type" : "string"
}
}
} ,
"repo.NotifierOut" : {
"type" : "object" ,
"properties" : {
"createdAt" : {
"type" : "string"
} ,
"groupId" : {
"type" : "string"
} ,
"id" : {
"type" : "string"
} ,
"isActive" : {
"type" : "boolean"
} ,
"name" : {
"type" : "string"
} ,
"updatedAt" : {
"type" : "string"
} ,
"userId" : {
"type" : "string"
}
}
} ,
"repo.NotifierUpdate" : {
"type" : "object" ,
"required" : [
"name"
] ,
"properties" : {
"isActive" : {
"type" : "boolean"
} ,
"name" : {
"type" : "string" ,
"maxLength" : 255 ,
"minLength" : 1
} ,
"url" : {
"type" : "string" ,
"x-nullable" : true
}
}
} ,
2022-10-13 05:13:07 +00:00
"repo.PaginationResult-repo_ItemSummary" : {
"type" : "object" ,
"properties" : {
"items" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/repo.ItemSummary"
}
} ,
"page" : {
"type" : "integer"
} ,
"pageSize" : {
"type" : "integer"
} ,
"total" : {
"type" : "integer"
}
}
} ,
2022-12-05 21:36:32 +00:00
"repo.TotalsByOrganizer" : {
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"total" : {
"type" : "number"
}
}
} ,
2023-01-28 20:53:00 +00:00
"repo.TreeItem" : {
"type" : "object" ,
"properties" : {
"children" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/repo.TreeItem"
}
} ,
"id" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"type" : {
"type" : "string"
}
}
} ,
2022-09-27 23:52:13 +00:00
"repo.UserOut" : {
2022-08-31 05:22:01 +00:00
"type" : "object" ,
"properties" : {
2022-09-27 23:52:13 +00:00
"email" : {
2022-08-31 05:22:01 +00:00
"type" : "string"
} ,
2022-09-27 23:52:13 +00:00
"groupId" : {
"type" : "string"
} ,
"groupName" : {
2022-08-31 05:22:01 +00:00
"type" : "string"
} ,
"id" : {
"type" : "string"
} ,
2022-10-09 17:44:13 +00:00
"isOwner" : {
"type" : "boolean"
} ,
2022-09-27 23:52:13 +00:00
"isSuperuser" : {
"type" : "boolean"
} ,
2022-08-31 05:22:01 +00:00
"name" : {
"type" : "string"
2022-09-27 23:52:13 +00:00
}
}
} ,
"repo.UserUpdate" : {
"type" : "object" ,
"properties" : {
"email" : {
"type" : "string"
2022-08-31 05:22:01 +00:00
} ,
2022-09-27 23:52:13 +00:00
"name" : {
2022-08-31 05:22:01 +00:00
"type" : "string"
}
2022-08-30 02:30:36 +00:00
}
} ,
2022-12-05 21:36:32 +00:00
"repo.ValueOverTime" : {
"type" : "object" ,
"properties" : {
"end" : {
"type" : "string"
} ,
"entries" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/repo.ValueOverTimeEntry"
}
} ,
"start" : {
"type" : "string"
} ,
"valueAtEnd" : {
"type" : "number"
} ,
"valueAtStart" : {
"type" : "number"
}
}
} ,
"repo.ValueOverTimeEntry" : {
"type" : "object" ,
"properties" : {
"date" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"value" : {
"type" : "number"
}
}
} ,
2022-09-27 23:52:13 +00:00
"services.UserRegistration" : {
2022-08-30 02:30:36 +00:00
"type" : "object" ,
"properties" : {
"email" : {
"type" : "string"
} ,
2022-08-30 18:05:11 +00:00
"name" : {
2022-08-30 02:30:36 +00:00
"type" : "string"
} ,
2022-08-30 18:05:11 +00:00
"password" : {
"type" : "string"
2022-10-07 02:54:09 +00:00
} ,
"token" : {
"type" : "string"
2022-08-30 18:05:11 +00:00
}
}
} ,
2023-02-09 02:59:04 +00:00
"v1.ActionAmountResult" : {
"type" : "object" ,
"properties" : {
"completed" : {
"type" : "integer"
}
}
} ,
2022-09-27 23:52:13 +00:00
"v1.ApiSummary" : {
2022-09-12 22:47:27 +00:00
"type" : "object" ,
"properties" : {
2023-02-15 17:58:38 +00:00
"allowRegistration" : {
"type" : "boolean"
} ,
2022-09-27 23:52:13 +00:00
"build" : {
"$ref" : "#/definitions/v1.Build"
2022-09-12 22:47:27 +00:00
} ,
2022-10-12 20:53:22 +00:00
"demo" : {
"type" : "boolean"
} ,
2022-09-27 23:52:13 +00:00
"health" : {
"type" : "boolean"
} ,
"message" : {
2022-09-12 22:47:27 +00:00
"type" : "string"
} ,
2022-09-27 23:52:13 +00:00
"title" : {
2022-09-12 22:47:27 +00:00
"type" : "string"
} ,
2022-09-27 23:52:13 +00:00
"versions" : {
"type" : "array" ,
"items" : {
"type" : "string"
}
}
}
} ,
"v1.Build" : {
"type" : "object" ,
"properties" : {
"buildTime" : {
2022-09-12 22:47:27 +00:00
"type" : "string"
} ,
2022-09-27 23:52:13 +00:00
"commit" : {
"type" : "string"
2022-09-12 22:47:27 +00:00
} ,
2022-09-27 23:52:13 +00:00
"version" : {
2022-09-12 22:47:27 +00:00
"type" : "string"
}
}
} ,
2022-10-09 17:23:21 +00:00
"v1.ChangePassword" : {
"type" : "object" ,
"properties" : {
"current" : {
"type" : "string"
} ,
"new" : {
"type" : "string"
}
}
} ,
2022-10-07 02:54:09 +00:00
"v1.GroupInvitation" : {
"type" : "object" ,
"properties" : {
"expiresAt" : {
"type" : "string"
} ,
"token" : {
"type" : "string"
} ,
"uses" : {
"type" : "integer"
}
}
} ,
"v1.GroupInvitationCreate" : {
"type" : "object" ,
2023-03-21 04:32:10 +00:00
"required" : [
"uses"
] ,
2022-10-07 02:54:09 +00:00
"properties" : {
"expiresAt" : {
"type" : "string"
} ,
"uses" : {
2023-03-21 04:32:10 +00:00
"type" : "integer" ,
"maximum" : 100 ,
"minimum" : 1
2022-10-07 02:54:09 +00:00
}
}
} ,
2022-09-27 23:52:13 +00:00
"v1.ItemAttachmentToken" : {
2022-08-30 18:05:11 +00:00
"type" : "object" ,
"properties" : {
2022-09-27 23:52:13 +00:00
"token" : {
2022-08-30 02:30:36 +00:00
"type" : "string"
}
}
} ,
2023-03-23 05:52:25 +00:00
"v1.LoginForm" : {
"type" : "object" ,
"properties" : {
"password" : {
"type" : "string"
} ,
"stayLoggedIn" : {
"type" : "boolean"
} ,
"username" : {
"type" : "string"
}
}
} ,
2022-09-27 23:52:13 +00:00
"v1.TokenResponse" : {
2022-08-30 02:30:36 +00:00
"type" : "object" ,
"properties" : {
2022-12-03 19:55:00 +00:00
"attachmentToken" : {
"type" : "string"
} ,
2022-09-27 23:52:13 +00:00
"expiresAt" : {
2022-08-30 02:30:36 +00:00
"type" : "string"
} ,
2022-09-27 23:52:13 +00:00
"token" : {
2022-08-30 02:30:36 +00:00
"type" : "string"
}
}
2023-03-21 04:32:10 +00:00
} ,
"v1.Wrapped" : {
"type" : "object" ,
"properties" : {
"item" : { }
}
2023-07-27 21:21:28 +00:00
} ,
"validate.ErrorResponse" : {
"type" : "object" ,
"properties" : {
"error" : {
"type" : "string"
} ,
"fields" : {
"type" : "string"
}
}
2022-08-30 02:30:36 +00:00
}
} ,
"securityDefinitions" : {
"Bearer" : {
"description" : "\"Type 'Bearer TOKEN' to correctly set the API Key\"" ,
"type" : "apiKey" ,
"name" : "Authorization" ,
"in" : "header"
}
}
}