2022-08-30 02:30:36 +00:00
{
"swagger" : "2.0" ,
"info" : {
"description" : "This is a simple Rest API Server Template that implements some basic User and Authentication patterns to help you get started and bootstrap your next project!." ,
"title" : "Go API Templates" ,
"contact" : {
"name" : "Don't"
} ,
"license" : {
"name" : "MIT"
} ,
"version" : "1.0"
} ,
"basePath" : "/api" ,
"paths" : {
2022-11-13 03:57:51 +00:00
"/v1/actions/ensure-asset-ids" : {
"post" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"Group"
] ,
"summary" : "Get the current user" ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"$ref" : "#/definitions/v1.EnsureAssetIDResult"
}
}
}
}
} ,
2022-10-15 20:15:55 +00:00
"/v1/groups" : {
"get" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"Group"
] ,
"summary" : "Get the current user's group" ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"$ref" : "#/definitions/repo.Group"
}
}
}
} ,
"put" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"Group"
] ,
"summary" : "Updates some fields of the current users group" ,
"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
] ,
"summary" : "Get the current user" ,
"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" : [
"Group"
] ,
"summary" : "Get the current user's group" ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"$ref" : "#/definitions/repo.GroupStatistics"
}
}
}
}
} ,
2022-09-03 09:17:48 +00:00
"/v1/items" : {
"get" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"Items"
] ,
"summary" : "Get 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"
] ,
"summary" : "Create a new item" ,
"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" : {
"200" : {
"description" : "OK" ,
"schema" : {
2022-09-27 23:52:13 +00:00
"$ref" : "#/definitions/repo.ItemSummary"
2022-09-03 09:17:48 +00:00
}
}
}
}
} ,
2022-09-06 19:15:07 +00:00
"/v1/items/import" : {
"post" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"Items"
] ,
"summary" : "imports items into the database" ,
"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"
] ,
"summary" : "Gets a item and fields" ,
"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"
] ,
"summary" : "updates a item" ,
"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"
] ,
"summary" : "deletes a item" ,
"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
}
}
}
} ,
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
] ,
"summary" : "imports items into the database" ,
"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" : {
2022-10-30 02:15:35 +00:00
"$ref" : "#/definitions/server.ErrorResponse"
2022-09-24 19:33:38 +00:00
}
}
}
}
} ,
"/v1/items/{id}/attachments/download" : {
"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
] ,
"summary" : "retrieves an attachment for an item" ,
"parameters" : [
{
"type" : "string" ,
"description" : "Item ID" ,
"name" : "id" ,
"in" : "path" ,
"required" : true
} ,
{
"type" : "string" ,
"description" : "Attachment token" ,
"name" : "token" ,
"in" : "query" ,
"required" : true
}
] ,
"responses" : {
"200" : {
2022-10-13 05:13:07 +00:00
"description" : "OK"
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
] ,
"summary" : "retrieves an attachment for an item" ,
"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
] ,
"summary" : "retrieves an attachment for an item" ,
"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
] ,
"summary" : "retrieves an attachment for an item" ,
"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-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" : {
"allOf" : [
{
"$ref" : "#/definitions/server.Results"
} ,
{
"type" : "object" ,
"properties" : {
"items" : {
"type" : "array" ,
"items" : {
2022-09-27 23:52:13 +00:00
"$ref" : "#/definitions/repo.LabelOut"
2022-09-01 23:11:14 +00:00
}
}
}
}
]
}
}
}
} ,
"post" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"Labels"
] ,
"summary" : "Create a new label" ,
"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"
] ,
"summary" : "Gets a label and fields" ,
"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"
] ,
"summary" : "updates a label" ,
"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"
] ,
"summary" : "deletes a label" ,
"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" : {
"allOf" : [
{
"$ref" : "#/definitions/server.Results"
} ,
{
"type" : "object" ,
"properties" : {
"items" : {
"type" : "array" ,
"items" : {
2022-09-27 23:52:13 +00:00
"$ref" : "#/definitions/repo.LocationOutCount"
2022-08-31 05:22:01 +00:00
}
}
}
}
]
}
}
}
} ,
"post" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"Locations"
] ,
"summary" : "Create a new location" ,
"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
}
}
}
}
} ,
"/v1/locations/{id}" : {
"get" : {
"security" : [
{
"Bearer" : [ ]
}
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"Locations"
] ,
"summary" : "Gets a location and fields" ,
"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"
] ,
"summary" : "updates a location" ,
"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"
] ,
"summary" : "deletes a location" ,
"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
}
} ,
2022-09-04 02:42:03 +00:00
"/v1/status" : {
"get" : {
"produces" : [
"application/json"
] ,
"tags" : [
"Base"
] ,
"summary" : "Retrieves the basic information about the API" ,
"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"
] ,
"summary" : "Updates the users password" ,
"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"
}
] ,
"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"
] ,
"summary" : "Get the current user" ,
"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"
] ,
"summary" : "Get the current user" ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"allOf" : [
{
"$ref" : "#/definitions/server.Result"
} ,
{
"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"
] ,
"summary" : "Update the current user" ,
"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" : [
{
"$ref" : "#/definitions/server.Result"
} ,
{
"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"
] ,
"summary" : "Deletes the user account" ,
"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" : {
"totalItems" : {
"type" : "integer"
} ,
"totalLabels" : {
"type" : "integer"
} ,
"totalLocations" : {
"type" : "integer"
} ,
"totalUsers" : {
"type" : "integer"
}
}
} ,
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" ,
"properties" : {
"description" : {
"type" : "string"
} ,
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" : {
"type" : "string"
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"
} ,
"timeValue" : {
"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 03:57:51 +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"
}
}
} ,
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-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 03:57:51 +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" : {
"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" ,
"properties" : {
"color" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
}
}
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"
}
}
} ,
"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-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-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-10-30 02:15:35 +00:00
"server.ErrorResponse" : {
"type" : "object" ,
"properties" : {
"error" : {
"type" : "string"
} ,
"fields" : {
"type" : "object" ,
"additionalProperties" : {
"type" : "string"
}
}
}
} ,
2022-09-27 23:52:13 +00:00
"server.Result" : {
2022-08-30 02:30:36 +00:00
"type" : "object" ,
"properties" : {
2022-09-27 23:52:13 +00:00
"details" : { } ,
"error" : {
"type" : "boolean"
} ,
"item" : { } ,
"message" : {
"type" : "string"
}
}
} ,
"server.Results" : {
"type" : "object" ,
"properties" : {
2022-10-13 05:13:07 +00:00
"items" : { }
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
}
}
} ,
2022-09-27 23:52:13 +00:00
"v1.ApiSummary" : {
2022-09-12 22:47:27 +00:00
"type" : "object" ,
"properties" : {
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-11-13 03:57:51 +00:00
"v1.EnsureAssetIDResult" : {
"type" : "object" ,
"properties" : {
"completed" : {
"type" : "integer"
}
}
} ,
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" ,
"properties" : {
"expiresAt" : {
"type" : "string"
} ,
"uses" : {
"type" : "integer"
}
}
} ,
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"
}
}
} ,
2022-09-27 23:52:13 +00:00
"v1.TokenResponse" : {
2022-08-30 02:30:36 +00:00
"type" : "object" ,
"properties" : {
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"
}
}
}
} ,
"securityDefinitions" : {
"Bearer" : {
"description" : "\"Type 'Bearer TOKEN' to correctly set the API Key\"" ,
"type" : "apiKey" ,
"name" : "Authorization" ,
"in" : "header"
}
}
}