mirror of
https://github.com/hay-kot/homebox.git
synced 2024-11-23 09:05:42 +00:00
efd7069fe4
* add allow registration to API Summary * code gen * use env for troubleshooting * disable registration toggle based on backend
1584 lines
33 KiB
YAML
1584 lines
33 KiB
YAML
basePath: /api
|
|
definitions:
|
|
repo.DocumentOut:
|
|
properties:
|
|
id:
|
|
type: string
|
|
path:
|
|
type: string
|
|
title:
|
|
type: string
|
|
type: object
|
|
repo.Group:
|
|
properties:
|
|
createdAt:
|
|
type: string
|
|
currency:
|
|
type: string
|
|
id:
|
|
type: string
|
|
name:
|
|
type: string
|
|
updatedAt:
|
|
type: string
|
|
type: object
|
|
repo.GroupStatistics:
|
|
properties:
|
|
totalItemPrice:
|
|
type: number
|
|
totalItems:
|
|
type: integer
|
|
totalLabels:
|
|
type: integer
|
|
totalLocations:
|
|
type: integer
|
|
totalUsers:
|
|
type: integer
|
|
totalWithWarranty:
|
|
type: integer
|
|
type: object
|
|
repo.GroupUpdate:
|
|
properties:
|
|
currency:
|
|
type: string
|
|
name:
|
|
type: string
|
|
type: object
|
|
repo.ItemAttachment:
|
|
properties:
|
|
createdAt:
|
|
type: string
|
|
document:
|
|
$ref: '#/definitions/repo.DocumentOut'
|
|
id:
|
|
type: string
|
|
type:
|
|
type: string
|
|
updatedAt:
|
|
type: string
|
|
type: object
|
|
repo.ItemAttachmentUpdate:
|
|
properties:
|
|
title:
|
|
type: string
|
|
type:
|
|
type: string
|
|
type: object
|
|
repo.ItemCreate:
|
|
properties:
|
|
description:
|
|
type: string
|
|
labelIds:
|
|
items:
|
|
type: string
|
|
type: array
|
|
locationId:
|
|
description: Edges
|
|
type: string
|
|
name:
|
|
type: string
|
|
parentId:
|
|
type: string
|
|
x-nullable: true
|
|
type: object
|
|
repo.ItemField:
|
|
properties:
|
|
booleanValue:
|
|
type: boolean
|
|
id:
|
|
type: string
|
|
name:
|
|
type: string
|
|
numberValue:
|
|
type: integer
|
|
textValue:
|
|
type: string
|
|
timeValue:
|
|
type: string
|
|
type:
|
|
type: string
|
|
type: object
|
|
repo.ItemOut:
|
|
properties:
|
|
archived:
|
|
type: boolean
|
|
assetId:
|
|
example: "0"
|
|
type: string
|
|
attachments:
|
|
items:
|
|
$ref: '#/definitions/repo.ItemAttachment'
|
|
type: array
|
|
children:
|
|
items:
|
|
$ref: '#/definitions/repo.ItemSummary'
|
|
type: array
|
|
createdAt:
|
|
type: string
|
|
description:
|
|
type: string
|
|
fields:
|
|
items:
|
|
$ref: '#/definitions/repo.ItemField'
|
|
type: array
|
|
id:
|
|
type: string
|
|
insured:
|
|
type: boolean
|
|
labels:
|
|
items:
|
|
$ref: '#/definitions/repo.LabelSummary'
|
|
type: array
|
|
lifetimeWarranty:
|
|
description: Warranty
|
|
type: boolean
|
|
location:
|
|
$ref: '#/definitions/repo.LocationSummary'
|
|
description: Edges
|
|
x-nullable: true
|
|
x-omitempty: true
|
|
manufacturer:
|
|
type: string
|
|
modelNumber:
|
|
type: string
|
|
name:
|
|
type: string
|
|
notes:
|
|
description: Extras
|
|
type: string
|
|
parent:
|
|
$ref: '#/definitions/repo.ItemSummary'
|
|
x-nullable: true
|
|
x-omitempty: true
|
|
purchaseFrom:
|
|
type: string
|
|
purchasePrice:
|
|
example: "0"
|
|
type: string
|
|
purchaseTime:
|
|
description: Purchase
|
|
type: string
|
|
quantity:
|
|
type: integer
|
|
serialNumber:
|
|
type: string
|
|
soldNotes:
|
|
type: string
|
|
soldPrice:
|
|
example: "0"
|
|
type: string
|
|
soldTime:
|
|
description: Sold
|
|
type: string
|
|
soldTo:
|
|
type: string
|
|
updatedAt:
|
|
type: string
|
|
warrantyDetails:
|
|
type: string
|
|
warrantyExpires:
|
|
type: string
|
|
type: object
|
|
repo.ItemSummary:
|
|
properties:
|
|
archived:
|
|
type: boolean
|
|
createdAt:
|
|
type: string
|
|
description:
|
|
type: string
|
|
id:
|
|
type: string
|
|
insured:
|
|
type: boolean
|
|
labels:
|
|
items:
|
|
$ref: '#/definitions/repo.LabelSummary'
|
|
type: array
|
|
location:
|
|
$ref: '#/definitions/repo.LocationSummary'
|
|
description: Edges
|
|
x-nullable: true
|
|
x-omitempty: true
|
|
name:
|
|
type: string
|
|
purchasePrice:
|
|
example: "0"
|
|
type: string
|
|
quantity:
|
|
type: integer
|
|
updatedAt:
|
|
type: string
|
|
type: object
|
|
repo.ItemUpdate:
|
|
properties:
|
|
archived:
|
|
type: boolean
|
|
assetId:
|
|
type: string
|
|
description:
|
|
type: string
|
|
fields:
|
|
items:
|
|
$ref: '#/definitions/repo.ItemField'
|
|
type: array
|
|
id:
|
|
type: string
|
|
insured:
|
|
type: boolean
|
|
labelIds:
|
|
items:
|
|
type: string
|
|
type: array
|
|
lifetimeWarranty:
|
|
description: Warranty
|
|
type: boolean
|
|
locationId:
|
|
description: Edges
|
|
type: string
|
|
manufacturer:
|
|
type: string
|
|
modelNumber:
|
|
type: string
|
|
name:
|
|
type: string
|
|
notes:
|
|
description: Extras
|
|
type: string
|
|
parentId:
|
|
type: string
|
|
x-nullable: true
|
|
x-omitempty: true
|
|
purchaseFrom:
|
|
type: string
|
|
purchasePrice:
|
|
example: "0"
|
|
type: string
|
|
purchaseTime:
|
|
description: Purchase
|
|
type: string
|
|
quantity:
|
|
type: integer
|
|
serialNumber:
|
|
description: Identifications
|
|
type: string
|
|
soldNotes:
|
|
type: string
|
|
soldPrice:
|
|
example: "0"
|
|
type: string
|
|
soldTime:
|
|
description: Sold
|
|
type: string
|
|
soldTo:
|
|
type: string
|
|
warrantyDetails:
|
|
type: string
|
|
warrantyExpires:
|
|
description: Sold
|
|
type: string
|
|
type: object
|
|
repo.LabelCreate:
|
|
properties:
|
|
color:
|
|
type: string
|
|
description:
|
|
type: string
|
|
name:
|
|
type: string
|
|
type: object
|
|
repo.LabelOut:
|
|
properties:
|
|
createdAt:
|
|
type: string
|
|
description:
|
|
type: string
|
|
id:
|
|
type: string
|
|
items:
|
|
items:
|
|
$ref: '#/definitions/repo.ItemSummary'
|
|
type: array
|
|
name:
|
|
type: string
|
|
updatedAt:
|
|
type: string
|
|
type: object
|
|
repo.LabelSummary:
|
|
properties:
|
|
createdAt:
|
|
type: string
|
|
description:
|
|
type: string
|
|
id:
|
|
type: string
|
|
name:
|
|
type: string
|
|
updatedAt:
|
|
type: string
|
|
type: object
|
|
repo.LocationCreate:
|
|
properties:
|
|
description:
|
|
type: string
|
|
name:
|
|
type: string
|
|
parentId:
|
|
type: string
|
|
x-nullable: true
|
|
type: object
|
|
repo.LocationOut:
|
|
properties:
|
|
children:
|
|
items:
|
|
$ref: '#/definitions/repo.LocationSummary'
|
|
type: array
|
|
createdAt:
|
|
type: string
|
|
description:
|
|
type: string
|
|
id:
|
|
type: string
|
|
items:
|
|
items:
|
|
$ref: '#/definitions/repo.ItemSummary'
|
|
type: array
|
|
name:
|
|
type: string
|
|
parent:
|
|
$ref: '#/definitions/repo.LocationSummary'
|
|
updatedAt:
|
|
type: string
|
|
type: object
|
|
repo.LocationOutCount:
|
|
properties:
|
|
createdAt:
|
|
type: string
|
|
description:
|
|
type: string
|
|
id:
|
|
type: string
|
|
itemCount:
|
|
type: integer
|
|
name:
|
|
type: string
|
|
updatedAt:
|
|
type: string
|
|
type: object
|
|
repo.LocationSummary:
|
|
properties:
|
|
createdAt:
|
|
type: string
|
|
description:
|
|
type: string
|
|
id:
|
|
type: string
|
|
name:
|
|
type: string
|
|
updatedAt:
|
|
type: string
|
|
type: object
|
|
repo.LocationUpdate:
|
|
properties:
|
|
description:
|
|
type: string
|
|
id:
|
|
type: string
|
|
name:
|
|
type: string
|
|
parentId:
|
|
type: string
|
|
x-nullable: true
|
|
type: object
|
|
repo.MaintenanceEntry:
|
|
properties:
|
|
cost:
|
|
example: "0"
|
|
type: string
|
|
date:
|
|
type: string
|
|
description:
|
|
type: string
|
|
id:
|
|
type: string
|
|
name:
|
|
type: string
|
|
type: object
|
|
repo.MaintenanceEntryCreate:
|
|
properties:
|
|
cost:
|
|
example: "0"
|
|
type: string
|
|
date:
|
|
type: string
|
|
description:
|
|
type: string
|
|
name:
|
|
type: string
|
|
type: object
|
|
repo.MaintenanceEntryUpdate:
|
|
properties:
|
|
cost:
|
|
example: "0"
|
|
type: string
|
|
date:
|
|
type: string
|
|
description:
|
|
type: string
|
|
name:
|
|
type: string
|
|
type: object
|
|
repo.MaintenanceLog:
|
|
properties:
|
|
costAverage:
|
|
type: number
|
|
costTotal:
|
|
type: number
|
|
entries:
|
|
items:
|
|
$ref: '#/definitions/repo.MaintenanceEntry'
|
|
type: array
|
|
itemId:
|
|
type: string
|
|
type: object
|
|
repo.PaginationResult-repo_ItemSummary:
|
|
properties:
|
|
items:
|
|
items:
|
|
$ref: '#/definitions/repo.ItemSummary'
|
|
type: array
|
|
page:
|
|
type: integer
|
|
pageSize:
|
|
type: integer
|
|
total:
|
|
type: integer
|
|
type: object
|
|
repo.TotalsByOrganizer:
|
|
properties:
|
|
id:
|
|
type: string
|
|
name:
|
|
type: string
|
|
total:
|
|
type: number
|
|
type: object
|
|
repo.TreeItem:
|
|
properties:
|
|
children:
|
|
items:
|
|
$ref: '#/definitions/repo.TreeItem'
|
|
type: array
|
|
id:
|
|
type: string
|
|
name:
|
|
type: string
|
|
type:
|
|
type: string
|
|
type: object
|
|
repo.UserOut:
|
|
properties:
|
|
email:
|
|
type: string
|
|
groupId:
|
|
type: string
|
|
groupName:
|
|
type: string
|
|
id:
|
|
type: string
|
|
isOwner:
|
|
type: boolean
|
|
isSuperuser:
|
|
type: boolean
|
|
name:
|
|
type: string
|
|
type: object
|
|
repo.UserUpdate:
|
|
properties:
|
|
email:
|
|
type: string
|
|
name:
|
|
type: string
|
|
type: object
|
|
repo.ValueOverTime:
|
|
properties:
|
|
end:
|
|
type: string
|
|
entries:
|
|
items:
|
|
$ref: '#/definitions/repo.ValueOverTimeEntry'
|
|
type: array
|
|
start:
|
|
type: string
|
|
valueAtEnd:
|
|
type: number
|
|
valueAtStart:
|
|
type: number
|
|
type: object
|
|
repo.ValueOverTimeEntry:
|
|
properties:
|
|
date:
|
|
type: string
|
|
name:
|
|
type: string
|
|
value:
|
|
type: number
|
|
type: object
|
|
server.ErrorResponse:
|
|
properties:
|
|
error:
|
|
type: string
|
|
fields:
|
|
additionalProperties:
|
|
type: string
|
|
type: object
|
|
type: object
|
|
server.Result:
|
|
properties:
|
|
details: {}
|
|
error:
|
|
type: boolean
|
|
item: {}
|
|
message:
|
|
type: string
|
|
type: object
|
|
server.Results:
|
|
properties:
|
|
items: {}
|
|
type: object
|
|
services.UserRegistration:
|
|
properties:
|
|
email:
|
|
type: string
|
|
name:
|
|
type: string
|
|
password:
|
|
type: string
|
|
token:
|
|
type: string
|
|
type: object
|
|
v1.ActionAmountResult:
|
|
properties:
|
|
completed:
|
|
type: integer
|
|
type: object
|
|
v1.ApiSummary:
|
|
properties:
|
|
allowRegistration:
|
|
type: boolean
|
|
build:
|
|
$ref: '#/definitions/v1.Build'
|
|
demo:
|
|
type: boolean
|
|
health:
|
|
type: boolean
|
|
message:
|
|
type: string
|
|
title:
|
|
type: string
|
|
versions:
|
|
items:
|
|
type: string
|
|
type: array
|
|
type: object
|
|
v1.Build:
|
|
properties:
|
|
buildTime:
|
|
type: string
|
|
commit:
|
|
type: string
|
|
version:
|
|
type: string
|
|
type: object
|
|
v1.ChangePassword:
|
|
properties:
|
|
current:
|
|
type: string
|
|
new:
|
|
type: string
|
|
type: object
|
|
v1.GroupInvitation:
|
|
properties:
|
|
expiresAt:
|
|
type: string
|
|
token:
|
|
type: string
|
|
uses:
|
|
type: integer
|
|
type: object
|
|
v1.GroupInvitationCreate:
|
|
properties:
|
|
expiresAt:
|
|
type: string
|
|
uses:
|
|
type: integer
|
|
type: object
|
|
v1.ItemAttachmentToken:
|
|
properties:
|
|
token:
|
|
type: string
|
|
type: object
|
|
v1.TokenResponse:
|
|
properties:
|
|
attachmentToken:
|
|
type: string
|
|
expiresAt:
|
|
type: string
|
|
token:
|
|
type: string
|
|
type: object
|
|
info:
|
|
contact:
|
|
name: Don't
|
|
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!.
|
|
license:
|
|
name: MIT
|
|
title: Go API Templates
|
|
version: "1.0"
|
|
paths:
|
|
/v1/actions/ensure-asset-ids:
|
|
post:
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/v1.ActionAmountResult'
|
|
security:
|
|
- Bearer: []
|
|
summary: Ensures all items in the database have an asset id
|
|
tags:
|
|
- Group
|
|
/v1/actions/zero-item-time-fields:
|
|
post:
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/v1.ActionAmountResult'
|
|
security:
|
|
- Bearer: []
|
|
summary: Resets all item date fields to the beginning of the day
|
|
tags:
|
|
- Group
|
|
/v1/assets/{id}:
|
|
get:
|
|
parameters:
|
|
- description: Asset ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/repo.PaginationResult-repo_ItemSummary'
|
|
security:
|
|
- Bearer: []
|
|
summary: Gets an item by Asset ID
|
|
tags:
|
|
- Assets
|
|
/v1/groups:
|
|
get:
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/repo.Group'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get the current user's group
|
|
tags:
|
|
- Group
|
|
put:
|
|
parameters:
|
|
- description: User Data
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/repo.GroupUpdate'
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/repo.Group'
|
|
security:
|
|
- Bearer: []
|
|
summary: Updates some fields of the current users group
|
|
tags:
|
|
- Group
|
|
/v1/groups/invitations:
|
|
post:
|
|
parameters:
|
|
- description: User Data
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/v1.GroupInvitationCreate'
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/v1.GroupInvitation'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get the current user
|
|
tags:
|
|
- Group
|
|
/v1/groups/statistics:
|
|
get:
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/repo.GroupStatistics'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get the current user's group statistics
|
|
tags:
|
|
- Statistics
|
|
/v1/groups/statistics/labels:
|
|
get:
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
items:
|
|
$ref: '#/definitions/repo.TotalsByOrganizer'
|
|
type: array
|
|
security:
|
|
- Bearer: []
|
|
summary: Get the current user's group statistics
|
|
tags:
|
|
- Statistics
|
|
/v1/groups/statistics/locations:
|
|
get:
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
items:
|
|
$ref: '#/definitions/repo.TotalsByOrganizer'
|
|
type: array
|
|
security:
|
|
- Bearer: []
|
|
summary: Get the current user's group statistics
|
|
tags:
|
|
- Statistics
|
|
/v1/groups/statistics/purchase-price:
|
|
get:
|
|
parameters:
|
|
- description: start date
|
|
in: query
|
|
name: start
|
|
type: string
|
|
- description: end date
|
|
in: query
|
|
name: end
|
|
type: string
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/repo.ValueOverTime'
|
|
security:
|
|
- Bearer: []
|
|
summary: Queries the changes overtime of the purchase price over time
|
|
tags:
|
|
- Statistics
|
|
/v1/items:
|
|
get:
|
|
parameters:
|
|
- description: search string
|
|
in: query
|
|
name: q
|
|
type: string
|
|
- description: page number
|
|
in: query
|
|
name: page
|
|
type: integer
|
|
- description: items per page
|
|
in: query
|
|
name: pageSize
|
|
type: integer
|
|
- collectionFormat: multi
|
|
description: label Ids
|
|
in: query
|
|
items:
|
|
type: string
|
|
name: labels
|
|
type: array
|
|
- collectionFormat: multi
|
|
description: location Ids
|
|
in: query
|
|
items:
|
|
type: string
|
|
name: locations
|
|
type: array
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/repo.PaginationResult-repo_ItemSummary'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get All Items
|
|
tags:
|
|
- Items
|
|
post:
|
|
parameters:
|
|
- description: Item Data
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/repo.ItemCreate'
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/repo.ItemSummary'
|
|
security:
|
|
- Bearer: []
|
|
summary: Create a new item
|
|
tags:
|
|
- Items
|
|
/v1/items/{id}:
|
|
delete:
|
|
parameters:
|
|
- description: Item ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"204":
|
|
description: No Content
|
|
security:
|
|
- Bearer: []
|
|
summary: deletes a item
|
|
tags:
|
|
- Items
|
|
get:
|
|
parameters:
|
|
- description: Item ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/repo.ItemOut'
|
|
security:
|
|
- Bearer: []
|
|
summary: Gets a item and fields
|
|
tags:
|
|
- Items
|
|
put:
|
|
parameters:
|
|
- description: Item ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
- description: Item Data
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/repo.ItemUpdate'
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/repo.ItemOut'
|
|
security:
|
|
- Bearer: []
|
|
summary: updates a item
|
|
tags:
|
|
- Items
|
|
/v1/items/{id}/attachments:
|
|
post:
|
|
parameters:
|
|
- description: Item ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
- description: File attachment
|
|
in: formData
|
|
name: file
|
|
required: true
|
|
type: file
|
|
- description: Type of file
|
|
in: formData
|
|
name: type
|
|
required: true
|
|
type: string
|
|
- description: name of the file including extension
|
|
in: formData
|
|
name: name
|
|
required: true
|
|
type: string
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/repo.ItemOut'
|
|
"422":
|
|
description: Unprocessable Entity
|
|
schema:
|
|
$ref: '#/definitions/server.ErrorResponse'
|
|
security:
|
|
- Bearer: []
|
|
summary: imports items into the database
|
|
tags:
|
|
- Items Attachments
|
|
/v1/items/{id}/attachments/{attachment_id}:
|
|
delete:
|
|
parameters:
|
|
- description: Item ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
- description: Attachment ID
|
|
in: path
|
|
name: attachment_id
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"204":
|
|
description: No Content
|
|
security:
|
|
- Bearer: []
|
|
summary: retrieves an attachment for an item
|
|
tags:
|
|
- Items Attachments
|
|
get:
|
|
parameters:
|
|
- description: Item ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
- description: Attachment ID
|
|
in: path
|
|
name: attachment_id
|
|
required: true
|
|
type: string
|
|
produces:
|
|
- application/octet-stream
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/v1.ItemAttachmentToken'
|
|
security:
|
|
- Bearer: []
|
|
summary: retrieves an attachment for an item
|
|
tags:
|
|
- Items Attachments
|
|
put:
|
|
parameters:
|
|
- description: Item ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
- description: Attachment ID
|
|
in: path
|
|
name: attachment_id
|
|
required: true
|
|
type: string
|
|
- description: Attachment Update
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/repo.ItemAttachmentUpdate'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/repo.ItemOut'
|
|
security:
|
|
- Bearer: []
|
|
summary: retrieves an attachment for an item
|
|
tags:
|
|
- Items Attachments
|
|
/v1/items/{id}/maintenance:
|
|
get:
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/repo.MaintenanceLog'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get Maintenance Log
|
|
tags:
|
|
- Maintenance
|
|
post:
|
|
parameters:
|
|
- description: Entry Data
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/repo.MaintenanceEntryCreate'
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/repo.MaintenanceEntry'
|
|
security:
|
|
- Bearer: []
|
|
summary: Create Maintenance Entry
|
|
tags:
|
|
- Maintenance
|
|
/v1/items/{id}/maintenance/{entry_id}:
|
|
delete:
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"204":
|
|
description: No Content
|
|
security:
|
|
- Bearer: []
|
|
summary: Delete Maintenance Entry
|
|
tags:
|
|
- Maintenance
|
|
put:
|
|
parameters:
|
|
- description: Entry Data
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/repo.MaintenanceEntryUpdate'
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/repo.MaintenanceEntry'
|
|
security:
|
|
- Bearer: []
|
|
summary: Update Maintenance Entry
|
|
tags:
|
|
- Maintenance
|
|
/v1/items/fields:
|
|
get:
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
items:
|
|
type: string
|
|
type: array
|
|
security:
|
|
- Bearer: []
|
|
summary: imports items into the database
|
|
tags:
|
|
- Items
|
|
/v1/items/fields/values:
|
|
get:
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
items:
|
|
type: string
|
|
type: array
|
|
security:
|
|
- Bearer: []
|
|
summary: imports items into the database
|
|
tags:
|
|
- Items
|
|
/v1/items/import:
|
|
post:
|
|
parameters:
|
|
- description: Image to upload
|
|
in: formData
|
|
name: csv
|
|
required: true
|
|
type: file
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"204":
|
|
description: No Content
|
|
security:
|
|
- Bearer: []
|
|
summary: imports items into the database
|
|
tags:
|
|
- Items
|
|
/v1/labels:
|
|
get:
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
allOf:
|
|
- $ref: '#/definitions/server.Results'
|
|
- properties:
|
|
items:
|
|
items:
|
|
$ref: '#/definitions/repo.LabelOut'
|
|
type: array
|
|
type: object
|
|
security:
|
|
- Bearer: []
|
|
summary: Get All Labels
|
|
tags:
|
|
- Labels
|
|
post:
|
|
parameters:
|
|
- description: Label Data
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/repo.LabelCreate'
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/repo.LabelSummary'
|
|
security:
|
|
- Bearer: []
|
|
summary: Create a new label
|
|
tags:
|
|
- Labels
|
|
/v1/labels/{id}:
|
|
delete:
|
|
parameters:
|
|
- description: Label ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"204":
|
|
description: No Content
|
|
security:
|
|
- Bearer: []
|
|
summary: deletes a label
|
|
tags:
|
|
- Labels
|
|
get:
|
|
parameters:
|
|
- description: Label ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/repo.LabelOut'
|
|
security:
|
|
- Bearer: []
|
|
summary: Gets a label and fields
|
|
tags:
|
|
- Labels
|
|
put:
|
|
parameters:
|
|
- description: Label ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/repo.LabelOut'
|
|
security:
|
|
- Bearer: []
|
|
summary: updates a label
|
|
tags:
|
|
- Labels
|
|
/v1/locations:
|
|
get:
|
|
parameters:
|
|
- description: Filter locations with parents
|
|
in: query
|
|
name: filterChildren
|
|
type: boolean
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
allOf:
|
|
- $ref: '#/definitions/server.Results'
|
|
- properties:
|
|
items:
|
|
items:
|
|
$ref: '#/definitions/repo.LocationOutCount'
|
|
type: array
|
|
type: object
|
|
security:
|
|
- Bearer: []
|
|
summary: Get All Locations
|
|
tags:
|
|
- Locations
|
|
post:
|
|
parameters:
|
|
- description: Location Data
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/repo.LocationCreate'
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/repo.LocationSummary'
|
|
security:
|
|
- Bearer: []
|
|
summary: Create a new location
|
|
tags:
|
|
- Locations
|
|
/v1/locations/{id}:
|
|
delete:
|
|
parameters:
|
|
- description: Location ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"204":
|
|
description: No Content
|
|
security:
|
|
- Bearer: []
|
|
summary: deletes a location
|
|
tags:
|
|
- Locations
|
|
get:
|
|
parameters:
|
|
- description: Location ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/repo.LocationOut'
|
|
security:
|
|
- Bearer: []
|
|
summary: Gets a location and fields
|
|
tags:
|
|
- Locations
|
|
put:
|
|
parameters:
|
|
- description: Location ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
- description: Location Data
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/repo.LocationUpdate'
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/repo.LocationOut'
|
|
security:
|
|
- Bearer: []
|
|
summary: updates a location
|
|
tags:
|
|
- Locations
|
|
/v1/locations/tree:
|
|
get:
|
|
parameters:
|
|
- description: include items in response tree
|
|
in: query
|
|
name: withItems
|
|
type: boolean
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
allOf:
|
|
- $ref: '#/definitions/server.Results'
|
|
- properties:
|
|
items:
|
|
items:
|
|
$ref: '#/definitions/repo.TreeItem'
|
|
type: array
|
|
type: object
|
|
security:
|
|
- Bearer: []
|
|
summary: Get All Locations
|
|
tags:
|
|
- Locations
|
|
/v1/qrcode:
|
|
get:
|
|
parameters:
|
|
- description: data to be encoded into qrcode
|
|
in: query
|
|
name: data
|
|
type: string
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: image/jpeg
|
|
schema:
|
|
type: string
|
|
security:
|
|
- Bearer: []
|
|
summary: Encode data into QRCode
|
|
tags:
|
|
- Items
|
|
/v1/reporting/bill-of-materials:
|
|
get:
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: text/csv
|
|
schema:
|
|
type: string
|
|
security:
|
|
- Bearer: []
|
|
summary: Generates a Bill of Materials CSV
|
|
tags:
|
|
- Reporting
|
|
/v1/status:
|
|
get:
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/v1.ApiSummary'
|
|
summary: Retrieves the basic information about the API
|
|
tags:
|
|
- Base
|
|
/v1/users/change-password:
|
|
put:
|
|
parameters:
|
|
- description: Password Payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/v1.ChangePassword'
|
|
responses:
|
|
"204":
|
|
description: No Content
|
|
security:
|
|
- Bearer: []
|
|
summary: Updates the users password
|
|
tags:
|
|
- User
|
|
/v1/users/login:
|
|
post:
|
|
consumes:
|
|
- application/x-www-form-urlencoded
|
|
- application/json
|
|
parameters:
|
|
- description: string
|
|
example: admin@admin.com
|
|
in: formData
|
|
name: username
|
|
type: string
|
|
- description: string
|
|
example: admin
|
|
in: formData
|
|
name: password
|
|
type: string
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/v1.TokenResponse'
|
|
summary: User Login
|
|
tags:
|
|
- Authentication
|
|
/v1/users/logout:
|
|
post:
|
|
responses:
|
|
"204":
|
|
description: No Content
|
|
security:
|
|
- Bearer: []
|
|
summary: User Logout
|
|
tags:
|
|
- Authentication
|
|
/v1/users/refresh:
|
|
get:
|
|
description: |-
|
|
handleAuthRefresh returns a handler that will issue a new token from an existing token.
|
|
This does not validate that the user still exists within the database.
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
security:
|
|
- Bearer: []
|
|
summary: User Token Refresh
|
|
tags:
|
|
- Authentication
|
|
/v1/users/register:
|
|
post:
|
|
parameters:
|
|
- description: User Data
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/services.UserRegistration'
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"204":
|
|
description: No Content
|
|
summary: Get the current user
|
|
tags:
|
|
- User
|
|
/v1/users/self:
|
|
delete:
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"204":
|
|
description: No Content
|
|
security:
|
|
- Bearer: []
|
|
summary: Deletes the user account
|
|
tags:
|
|
- User
|
|
get:
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
allOf:
|
|
- $ref: '#/definitions/server.Result'
|
|
- properties:
|
|
item:
|
|
$ref: '#/definitions/repo.UserOut'
|
|
type: object
|
|
security:
|
|
- Bearer: []
|
|
summary: Get the current user
|
|
tags:
|
|
- User
|
|
put:
|
|
parameters:
|
|
- description: User Data
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/repo.UserUpdate'
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
allOf:
|
|
- $ref: '#/definitions/server.Result'
|
|
- properties:
|
|
item:
|
|
$ref: '#/definitions/repo.UserUpdate'
|
|
type: object
|
|
security:
|
|
- Bearer: []
|
|
summary: Update the current user
|
|
tags:
|
|
- User
|
|
securityDefinitions:
|
|
Bearer:
|
|
description: '"Type ''Bearer TOKEN'' to correctly set the API Key"'
|
|
in: header
|
|
name: Authorization
|
|
type: apiKey
|
|
swagger: "2.0"
|