mirrors/homebox
1
0
Fork 0
mirror of https://github.com/sysadminsmedia/homebox.git synced 2025-12-21 21:33:02 +01:00
Code Issues Packages Projects Releases Wiki Activity

For some reason swaggo doesn't mark the endpoints as deprecated

Browse Source
This commit is contained in:
Matthew Kilgore
2025-05-10 21:30:21 -04:00
parent c9473699d7
commit 22cb2f868b
5 changed files with 68 additions and 68 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
backend/app/api/handlers/v1/v1_ctrl_items.go
View File

@@ -22,7 +22,7 @@ import (
// HandleItemsGetAll godoc // HandleItemsGetAll godoc
// //
// @Summary Query All Items // @Summary (Deprecated) Query All Items
// @Tags Items // @Tags Items
// @Produce json // @Produce json
// @Param q query string false "search string" // @Param q query string false "search string"
@@ -113,7 +113,7 @@ func (ctrl *V1Controller) HandleItemsGetAll() errchain.HandlerFunc {
// HandleItemFullPath godoc // HandleItemFullPath godoc
// //
// @Summary Get the full path of an item // @Summary (Deprecated) Get the full path of an item
// @Tags Items // @Tags Items
// @Produce json // @Produce json
// @Param id path string true "Item ID" // @Param id path string true "Item ID"
@@ -156,7 +156,7 @@ func (ctrl *V1Controller) HandleItemFullPath() errchain.HandlerFunc {
// HandleItemsCreate godoc // HandleItemsCreate godoc
// //
// @Summary Create Item // @Summary (Deprecated) Create Item
// @Tags Items // @Tags Items
// @Produce json // @Produce json
// @Param payload body repo.ItemCreate true "Item Data" // @Param payload body repo.ItemCreate true "Item Data"
@@ -174,7 +174,7 @@ func (ctrl *V1Controller) HandleItemsCreate() errchain.HandlerFunc {
// HandleItemGet godocs // HandleItemGet godocs
// //
// @Summary Get Item // @Summary (Deprecated) Get Item
// @Tags Items // @Tags Items
// @Produce json // @Produce json
// @Param id path string true "Item ID" // @Param id path string true "Item ID"
@@ -194,7 +194,7 @@ func (ctrl *V1Controller) HandleItemGet() errchain.HandlerFunc {
// HandleItemDelete godocs // HandleItemDelete godocs
// //
// @Summary Delete Item // @Summary (Deprecated) Delete Item
// @Tags Items // @Tags Items
// @Produce json // @Produce json
// @Param id path string true "Item ID" // @Param id path string true "Item ID"
@@ -214,7 +214,7 @@ func (ctrl *V1Controller) HandleItemDelete() errchain.HandlerFunc {
// HandleItemUpdate godocs // HandleItemUpdate godocs
// //
// @Summary Update Item // @Summary (Deprecated) Update Item
// @Tags Items // @Tags Items
// @Produce json // @Produce json
// @Param id path string true "Item ID" // @Param id path string true "Item ID"
@@ -236,7 +236,7 @@ func (ctrl *V1Controller) HandleItemUpdate() errchain.HandlerFunc {
// HandleItemPatch godocs // HandleItemPatch godocs
// //
// @Summary Update Item // @Summary (Deprecated) Update Item
// @Tags Items // @Tags Items
// @Produce json // @Produce json
// @Param id path string true "Item ID" // @Param id path string true "Item ID"
@@ -263,7 +263,7 @@ func (ctrl *V1Controller) HandleItemPatch() errchain.HandlerFunc {
// HandleGetAllCustomFieldNames godocs // HandleGetAllCustomFieldNames godocs
// //
// @Summary Get All Custom Field Names // @Summary (Deprecated) Get All Custom Field Names
// @Tags Items // @Tags Items
// @Produce json // @Produce json
// @Success 200 // @Success 200
@@ -282,7 +282,7 @@ func (ctrl *V1Controller) HandleGetAllCustomFieldNames() errchain.HandlerFunc {
// HandleGetAllCustomFieldValues godocs // HandleGetAllCustomFieldValues godocs
// //
// @Summary Get All Custom Field Values // @Summary (Deprecated) Get All Custom Field Values
// @Tags Items // @Tags Items
// @Produce json // @Produce json
// @Success 200 // @Success 200
@@ -305,7 +305,7 @@ func (ctrl *V1Controller) HandleGetAllCustomFieldValues() errchain.HandlerFunc {
// HandleItemsImport godocs // HandleItemsImport godocs
// //
// @Summary Import Items // @Summary (Deprecated) Import Items
// @Tags Items // @Tags Items
// @Accept multipart/form-data // @Accept multipart/form-data
// @Produce json // @Produce json
@@ -342,7 +342,7 @@ func (ctrl *V1Controller) HandleItemsImport() errchain.HandlerFunc {
// HandleItemsExport godocs // HandleItemsExport godocs
// //
// @Summary Export Items // @Summary (Deprecated) Export Items
// @Tags Items // @Tags Items
// @Success 200 {string} string "text/csv" // @Success 200 {string} string "text/csv"
// @Router /v1/items/export [GET] // @Router /v1/items/export [GET]

12
backend/app/api/handlers/v1/v1_ctrl_locations.go
View File

@@ -14,7 +14,7 @@ import (
// HandleLocationTreeQuery godoc // HandleLocationTreeQuery godoc
// //
// @Summary Get Locations Tree // @Summary (Deprecated) Get Locations Tree
// @Tags Locations // @Tags Locations
// @Produce json // @Produce json
// @Param withItems query bool false "include items in response tree" // @Param withItems query bool false "include items in response tree"
@@ -33,7 +33,7 @@ func (ctrl *V1Controller) HandleLocationTreeQuery() errchain.HandlerFunc {
// HandleLocationGetAll godoc // HandleLocationGetAll godoc
// //
// @Summary Get All Locations // @Summary (Deprecated) Get All Locations
// @Tags Locations // @Tags Locations
// @Produce json // @Produce json
// @Param filterChildren query bool false "Filter locations with parents" // @Param filterChildren query bool false "Filter locations with parents"
@@ -52,7 +52,7 @@ func (ctrl *V1Controller) HandleLocationGetAll() errchain.HandlerFunc {
// HandleLocationCreate godoc // HandleLocationCreate godoc
// //
// @Summary Create Location // @Summary (Deprecated) Create Location
// @Tags Locations // @Tags Locations
// @Produce json // @Produce json
// @Param payload body repo.LocationCreate true "Location Data" // @Param payload body repo.LocationCreate true "Location Data"
@@ -71,7 +71,7 @@ func (ctrl *V1Controller) HandleLocationCreate() errchain.HandlerFunc {
// HandleLocationDelete godoc // HandleLocationDelete godoc
// //
// @Summary Delete Location // @Summary (Deprecated) Delete Location
// @Tags Locations // @Tags Locations
// @Produce json // @Produce json
// @Param id path string true "Location ID" // @Param id path string true "Location ID"
@@ -133,7 +133,7 @@ func (ctrl *V1Controller) GetLocationWithPrice(auth context.Context, gid uuid.UU
// HandleLocationGet godoc // HandleLocationGet godoc
// //
// @Summary Get Location // @Summary (Deprecated) Get Location
// @Tags Locations // @Tags Locations
// @Produce json // @Produce json
// @Param id path string true "Location ID" // @Param id path string true "Location ID"
@@ -154,7 +154,7 @@ func (ctrl *V1Controller) HandleLocationGet() errchain.HandlerFunc {
// HandleLocationUpdate godoc // HandleLocationUpdate godoc
// //
// @Summary Update Location // @Summary (Deprecated) Update Location
// @Tags Locations // @Tags Locations
// @Produce json // @Produce json
// @Param id path string true "Location ID" // @Param id path string true "Location ID"

34
backend/app/api/static/docs/docs.go
View File

@@ -391,7 +391,7 @@ const docTemplate = `{
"tags": [ "tags": [
"Items" "Items"
], ],
"summary": "Query All Items", "summary": "(Deprecated) Query All Items",
"deprecated": true, "deprecated": true,
"parameters": [ "parameters": [
{ {
@@ -464,7 +464,7 @@ const docTemplate = `{
"tags": [ "tags": [
"Items" "Items"
], ],
"summary": "Create Item", "summary": "(Deprecated) Create Item",
"deprecated": true, "deprecated": true,
"parameters": [ "parameters": [
{ {
@@ -497,7 +497,7 @@ const docTemplate = `{
"tags": [ "tags": [
"Items" "Items"
], ],
"summary": "Export Items", "summary": "(Deprecated) Export Items",
"deprecated": true, "deprecated": true,
"responses": { "responses": {
"200": { "200": {
@@ -522,7 +522,7 @@ const docTemplate = `{
"tags": [ "tags": [
"Items" "Items"
], ],
"summary": "Get All Custom Field Names", "summary": "(Deprecated) Get All Custom Field Names",
"deprecated": true, "deprecated": true,
"responses": { "responses": {
"200": { "200": {
@@ -550,7 +550,7 @@ const docTemplate = `{
"tags": [ "tags": [
"Items" "Items"
], ],
"summary": "Get All Custom Field Values", "summary": "(Deprecated) Get All Custom Field Values",
"deprecated": true, "deprecated": true,
"responses": { "responses": {
"200": { "200": {
@@ -581,7 +581,7 @@ const docTemplate = `{
"tags": [ "tags": [
"Items" "Items"
], ],
"summary": "Import Items", "summary": "(Deprecated) Import Items",
"deprecated": true, "deprecated": true,
"parameters": [ "parameters": [
{ {
@@ -612,7 +612,7 @@ const docTemplate = `{
"tags": [ "tags": [
"Items" "Items"
], ],
"summary": "Get Item", "summary": "(Deprecated) Get Item",
"deprecated": true, "deprecated": true,
"parameters": [ "parameters": [
{ {
@@ -644,7 +644,7 @@ const docTemplate = `{
"tags": [ "tags": [
"Items" "Items"
], ],
"summary": "Update Item", "summary": "(Deprecated) Update Item",
"deprecated": true, "deprecated": true,
"parameters": [ "parameters": [
{ {
@@ -685,7 +685,7 @@ const docTemplate = `{
"tags": [ "tags": [
"Items" "Items"
], ],
"summary": "Delete Item", "summary": "(Deprecated) Delete Item",
"deprecated": true, "deprecated": true,
"parameters": [ "parameters": [
{ {
@@ -714,7 +714,7 @@ const docTemplate = `{
"tags": [ "tags": [
"Items" "Items"
], ],
"summary": "Update Item", "summary": "(Deprecated) Update Item",
"deprecated": true, "deprecated": true,
"parameters": [ "parameters": [
{ {
@@ -1033,7 +1033,7 @@ const docTemplate = `{
"tags": [ "tags": [
"Items" "Items"
], ],
"summary": "Get the full path of an item", "summary": "(Deprecated) Get the full path of an item",
"deprecated": true, "deprecated": true,
"parameters": [ "parameters": [
{ {
@@ -1339,7 +1339,7 @@ const docTemplate = `{
"tags": [ "tags": [
"Locations" "Locations"
], ],
"summary": "Get All Locations", "summary": "(Deprecated) Get All Locations",
"deprecated": true, "deprecated": true,
"parameters": [ "parameters": [
{ {
@@ -1373,7 +1373,7 @@ const docTemplate = `{
"tags": [ "tags": [
"Locations" "Locations"
], ],
"summary": "Create Location", "summary": "(Deprecated) Create Location",
"deprecated": true, "deprecated": true,
"parameters": [ "parameters": [
{ {
@@ -1409,7 +1409,7 @@ const docTemplate = `{
"tags": [ "tags": [
"Locations" "Locations"
], ],
"summary": "Get Locations Tree", "summary": "(Deprecated) Get Locations Tree",
"deprecated": true, "deprecated": true,
"parameters": [ "parameters": [
{ {
@@ -1445,7 +1445,7 @@ const docTemplate = `{
"tags": [ "tags": [
"Locations" "Locations"
], ],
"summary": "Get Location", "summary": "(Deprecated) Get Location",
"deprecated": true, "deprecated": true,
"parameters": [ "parameters": [
{ {
@@ -1477,7 +1477,7 @@ const docTemplate = `{
"tags": [ "tags": [
"Locations" "Locations"
], ],
"summary": "Update Location", "summary": "(Deprecated) Update Location",
"deprecated": true, "deprecated": true,
"parameters": [ "parameters": [
{ {
@@ -1518,7 +1518,7 @@ const docTemplate = `{
"tags": [ "tags": [
"Locations" "Locations"
], ],
"summary": "Delete Location", "summary": "(Deprecated) Delete Location",
"deprecated": true, "deprecated": true,
"parameters": [ "parameters": [
{ {

34
backend/app/api/static/docs/swagger.json
View File

@@ -389,7 +389,7 @@
"tags": [ "tags": [
"Items" "Items"
], ],
"summary": "Query All Items", "summary": "(Deprecated) Query All Items",
"deprecated": true, "deprecated": true,
"parameters": [ "parameters": [
{ {
@@ -462,7 +462,7 @@
"tags": [ "tags": [
"Items" "Items"
], ],
"summary": "Create Item", "summary": "(Deprecated) Create Item",
"deprecated": true, "deprecated": true,
"parameters": [ "parameters": [
{ {
@@ -495,7 +495,7 @@
"tags": [ "tags": [
"Items" "Items"
], ],
"summary": "Export Items", "summary": "(Deprecated) Export Items",
"deprecated": true, "deprecated": true,
"responses": { "responses": {
"200": { "200": {
@@ -520,7 +520,7 @@
"tags": [ "tags": [
"Items" "Items"
], ],
"summary": "Get All Custom Field Names", "summary": "(Deprecated) Get All Custom Field Names",
"deprecated": true, "deprecated": true,
"responses": { "responses": {
"200": { "200": {
@@ -548,7 +548,7 @@
"tags": [ "tags": [
"Items" "Items"
], ],
"summary": "Get All Custom Field Values", "summary": "(Deprecated) Get All Custom Field Values",
"deprecated": true, "deprecated": true,
"responses": { "responses": {
"200": { "200": {
@@ -579,7 +579,7 @@
"tags": [ "tags": [
"Items" "Items"
], ],
"summary": "Import Items", "summary": "(Deprecated) Import Items",
"deprecated": true, "deprecated": true,
"parameters": [ "parameters": [
{ {
@@ -610,7 +610,7 @@
"tags": [ "tags": [
"Items" "Items"
], ],
"summary": "Get Item", "summary": "(Deprecated) Get Item",
"deprecated": true, "deprecated": true,
"parameters": [ "parameters": [
{ {
@@ -642,7 +642,7 @@
"tags": [ "tags": [
"Items" "Items"
], ],
"summary": "Update Item", "summary": "(Deprecated) Update Item",
"deprecated": true, "deprecated": true,
"parameters": [ "parameters": [
{ {
@@ -683,7 +683,7 @@
"tags": [ "tags": [
"Items" "Items"
], ],
"summary": "Delete Item", "summary": "(Deprecated) Delete Item",
"deprecated": true, "deprecated": true,
"parameters": [ "parameters": [
{ {
@@ -712,7 +712,7 @@
"tags": [ "tags": [
"Items" "Items"
], ],
"summary": "Update Item", "summary": "(Deprecated) Update Item",
"deprecated": true, "deprecated": true,
"parameters": [ "parameters": [
{ {
@@ -1031,7 +1031,7 @@
"tags": [ "tags": [
"Items" "Items"
], ],
"summary": "Get the full path of an item", "summary": "(Deprecated) Get the full path of an item",
"deprecated": true, "deprecated": true,
"parameters": [ "parameters": [
{ {
@@ -1337,7 +1337,7 @@
"tags": [ "tags": [
"Locations" "Locations"
], ],
"summary": "Get All Locations", "summary": "(Deprecated) Get All Locations",
"deprecated": true, "deprecated": true,
"parameters": [ "parameters": [
{ {
@@ -1371,7 +1371,7 @@
"tags": [ "tags": [
"Locations" "Locations"
], ],
"summary": "Create Location", "summary": "(Deprecated) Create Location",
"deprecated": true, "deprecated": true,
"parameters": [ "parameters": [
{ {
@@ -1407,7 +1407,7 @@
"tags": [ "tags": [
"Locations" "Locations"
], ],
"summary": "Get Locations Tree", "summary": "(Deprecated) Get Locations Tree",
"deprecated": true, "deprecated": true,
"parameters": [ "parameters": [
{ {
@@ -1443,7 +1443,7 @@
"tags": [ "tags": [
"Locations" "Locations"
], ],
"summary": "Get Location", "summary": "(Deprecated) Get Location",
"deprecated": true, "deprecated": true,
"parameters": [ "parameters": [
{ {
@@ -1475,7 +1475,7 @@
"tags": [ "tags": [
"Locations" "Locations"
], ],
"summary": "Update Location", "summary": "(Deprecated) Update Location",
"deprecated": true, "deprecated": true,
"parameters": [ "parameters": [
{ {
@@ -1516,7 +1516,7 @@
"tags": [ "tags": [
"Locations" "Locations"
], ],
"summary": "Delete Location", "summary": "(Deprecated) Delete Location",
"deprecated": true, "deprecated": true,
"parameters": [ "parameters": [
{ {

34
backend/app/api/static/docs/swagger.yaml
View File

@@ -1041,7 +1041,7 @@ paths:
$ref: '#/definitions/repo.PaginationResult-repo_ItemSummary' $ref: '#/definitions/repo.PaginationResult-repo_ItemSummary'
security: security:
- Bearer: [] - Bearer: []
summary: Query All Items summary: (Deprecated) Query All Items
tags: tags:
- Items - Items
post: post:
@@ -1062,7 +1062,7 @@ paths:
$ref: '#/definitions/repo.ItemSummary' $ref: '#/definitions/repo.ItemSummary'
security: security:
- Bearer: [] - Bearer: []
summary: Create Item summary: (Deprecated) Create Item
tags: tags:
- Items - Items
/v1/items/{id}: /v1/items/{id}:
@@ -1081,7 +1081,7 @@ paths:
description: No Content description: No Content
security: security:
- Bearer: [] - Bearer: []
summary: Delete Item summary: (Deprecated) Delete Item
tags: tags:
- Items - Items
get: get:
@@ -1101,7 +1101,7 @@ paths:
$ref: '#/definitions/repo.ItemOut' $ref: '#/definitions/repo.ItemOut'
security: security:
- Bearer: [] - Bearer: []
summary: Get Item summary: (Deprecated) Get Item
tags: tags:
- Items - Items
patch: patch:
@@ -1127,7 +1127,7 @@ paths:
$ref: '#/definitions/repo.ItemOut' $ref: '#/definitions/repo.ItemOut'
security: security:
- Bearer: [] - Bearer: []
summary: Update Item summary: (Deprecated) Update Item
tags: tags:
- Items - Items
put: put:
@@ -1153,7 +1153,7 @@ paths:
$ref: '#/definitions/repo.ItemOut' $ref: '#/definitions/repo.ItemOut'
security: security:
- Bearer: [] - Bearer: []
summary: Update Item summary: (Deprecated) Update Item
tags: tags:
- Items - Items
/v1/items/{id}/attachments: /v1/items/{id}/attachments:
@@ -1352,7 +1352,7 @@ paths:
type: array type: array
security: security:
- Bearer: [] - Bearer: []
summary: Get the full path of an item summary: (Deprecated) Get the full path of an item
tags: tags:
- Items - Items
/v1/items/export: /v1/items/export:
@@ -1365,7 +1365,7 @@ paths:
type: string type: string
security: security:
- Bearer: [] - Bearer: []
summary: Export Items summary: (Deprecated) Export Items
tags: tags:
- Items - Items
/v1/items/fields: /v1/items/fields:
@@ -1382,7 +1382,7 @@ paths:
type: array type: array
security: security:
- Bearer: [] - Bearer: []
summary: Get All Custom Field Names summary: (Deprecated) Get All Custom Field Names
tags: tags:
- Items - Items
/v1/items/fields/values: /v1/items/fields/values:
@@ -1399,7 +1399,7 @@ paths:
type: array type: array
security: security:
- Bearer: [] - Bearer: []
summary: Get All Custom Field Values summary: (Deprecated) Get All Custom Field Values
tags: tags:
- Items - Items
/v1/items/import: /v1/items/import:
@@ -1420,7 +1420,7 @@ paths:
description: No Content description: No Content
security: security:
- Bearer: [] - Bearer: []
summary: Import Items summary: (Deprecated) Import Items
tags: tags:
- Items - Items
/v1/labelmaker/assets/{id}: /v1/labelmaker/assets/{id}:
@@ -1606,7 +1606,7 @@ paths:
type: array type: array
security: security:
- Bearer: [] - Bearer: []
summary: Get All Locations summary: (Deprecated) Get All Locations
tags: tags:
- Locations - Locations
post: post:
@@ -1627,7 +1627,7 @@ paths:
$ref: '#/definitions/repo.LocationSummary' $ref: '#/definitions/repo.LocationSummary'
security: security:
- Bearer: [] - Bearer: []
summary: Create Location summary: (Deprecated) Create Location
tags: tags:
- Locations - Locations
/v1/locations/{id}: /v1/locations/{id}:
@@ -1646,7 +1646,7 @@ paths:
description: No Content description: No Content
security: security:
- Bearer: [] - Bearer: []
summary: Delete Location summary: (Deprecated) Delete Location
tags: tags:
- Locations - Locations
get: get:
@@ -1666,7 +1666,7 @@ paths:
$ref: '#/definitions/repo.LocationOut' $ref: '#/definitions/repo.LocationOut'
security: security:
- Bearer: [] - Bearer: []
summary: Get Location summary: (Deprecated) Get Location
tags: tags:
- Locations - Locations
put: put:
@@ -1692,7 +1692,7 @@ paths:
$ref: '#/definitions/repo.LocationOut' $ref: '#/definitions/repo.LocationOut'
security: security:
- Bearer: [] - Bearer: []
summary: Update Location summary: (Deprecated) Update Location
tags: tags:
- Locations - Locations
/v1/locations/tree: /v1/locations/tree:
@@ -1714,7 +1714,7 @@ paths:
type: array type: array
security: security:
- Bearer: [] - Bearer: []
summary: Get Locations Tree summary: (Deprecated) Get Locations Tree
tags: tags:
- Locations - Locations
/v1/maintenance: /v1/maintenance: