johanels/photoprism
1
0
Fork 0
mirror of https://github.com/photoprism/photoprism.git synced 2025-12-11 16:24:11 +01:00
Code Issues Packages Projects Releases Wiki Activity

API: Update swagger annotations #2132

Browse Source
This commit is contained in:
graciousgrey
2024-07-24 16:49:29 +02:00
parent c95df6e072
commit 273594b6f2
2 changed files with 306 additions and 67 deletions
Download Patch File Download Diff File Expand all files Collapse all files

89
internal/api/batch.go
View File

@@ -23,8 +23,16 @@ import (
// BatchPhotosArchive moves multiple photos to the archive. // BatchPhotosArchive moves multiple photos to the archive.
// //
// @Tags Photos // @Summary moves multiple photos to the archive
// @Router /api/v1/batch/photos/archive [post] // @Id BatchPhotosArchive
// @Tags Photos
// @Produce json
// @Success 200 {object} i18n.Response
// @Failure 400 {object} i18n.Response
// @Failure 404 {object} i18n.Response
// @Failure 500 {object} i18n.Response
// @Param photos body form.Selection true "Photo Selection"
// @Router /api/v1/batch/photos/archive [post]
func BatchPhotosArchive(router *gin.RouterGroup) { func BatchPhotosArchive(router *gin.RouterGroup) {
router.POST("/batch/photos/archive", func(c *gin.Context) { router.POST("/batch/photos/archive", func(c *gin.Context) {
s := Auth(c, acl.ResourcePhotos, acl.ActionDelete) s := Auth(c, acl.ResourcePhotos, acl.ActionDelete)
@@ -88,8 +96,16 @@ func BatchPhotosArchive(router *gin.RouterGroup) {
// BatchPhotosRestore restores multiple photos from the archive. // BatchPhotosRestore restores multiple photos from the archive.
// //
// @Tags Photos // @Summary restores multiple photos from the archive
// @Router /api/v1/batch/photos/restore [post] // @Id BatchPhotosRestore
// @Tags Photos
// @Produce json
// @Success 200 {object} i18n.Response
// @Failure 400 {object} i18n.Response
// @Failure 404 {object} i18n.Response
// @Failure 500 {object} i18n.Response
// @Param photos body form.Selection true "Photo Selection"
// @Router /api/v1/batch/photos/restore [post]
func BatchPhotosRestore(router *gin.RouterGroup) { func BatchPhotosRestore(router *gin.RouterGroup) {
router.POST("/batch/photos/restore", func(c *gin.Context) { router.POST("/batch/photos/restore", func(c *gin.Context) {
s := Auth(c, acl.ResourcePhotos, acl.ActionDelete) s := Auth(c, acl.ResourcePhotos, acl.ActionDelete)
@@ -151,8 +167,15 @@ func BatchPhotosRestore(router *gin.RouterGroup) {
// BatchPhotosApprove approves multiple photos that are currently under review. // BatchPhotosApprove approves multiple photos that are currently under review.
// //
// @Tags Photos // @Summary approves multiple photos that are currently under review
// @Router /api/v1/batch/photos/approve [post] // @Id BatchPhotosApprove
// @Tags Photos
// @Produce json
// @Success 200 {object} i18n.Response
// @Failure 400 {object} i18n.Response
// @Failure 404 {object} i18n.Response
// @Param photos body form.Selection true "Photo Selection"
// @Router /api/v1/batch/photos/approve [post]
func BatchPhotosApprove(router *gin.RouterGroup) { func BatchPhotosApprove(router *gin.RouterGroup) {
router.POST("batch/photos/approve", func(c *gin.Context) { router.POST("batch/photos/approve", func(c *gin.Context) {
s := Auth(c, acl.ResourcePhotos, acl.ActionUpdate) s := Auth(c, acl.ResourcePhotos, acl.ActionUpdate)
@@ -204,8 +227,15 @@ func BatchPhotosApprove(router *gin.RouterGroup) {
// BatchAlbumsDelete permanently removes multiple albums. // BatchAlbumsDelete permanently removes multiple albums.
// //
// @Tags Albums // @Summary permanently removes multiple albums
// @Router /api/v1/batch/albums/delete [post] // @Id BatchAlbumsDelete
// @Tags Albums
// @Produce json
// @Success 200 {object} i18n.Response
// @Failure 400 {object} i18n.Response
// @Failure 404 {object} i18n.Response
// @Param albums body form.Selection true "Album Selection"
// @Router /api/v1/batch/albums/delete [post]
func BatchAlbumsDelete(router *gin.RouterGroup) { func BatchAlbumsDelete(router *gin.RouterGroup) {
router.POST("/batch/albums/delete", func(c *gin.Context) { router.POST("/batch/albums/delete", func(c *gin.Context) {
s := Auth(c, acl.ResourceAlbums, acl.ActionDelete) s := Auth(c, acl.ResourceAlbums, acl.ActionDelete)
@@ -269,10 +299,18 @@ func BatchAlbumsDelete(router *gin.RouterGroup) {
}) })
} }
// BatchPhotosPrivate flags multiple photos as private. // BatchPhotosPrivate toggles private state of multiple photos.
// //
// @Tags Photos // @Summary toggles private state of multiple photos
// @Router /api/v1/batch/photos/private [post] // @Id BatchPhotosPrivate
// @Tags Photos
// @Produce json
// @Success 200 {object} i18n.Response
// @Failure 400 {object} i18n.Response
// @Failure 404 {object} i18n.Response
// @Failure 500 {object} i18n.Response
// @Param photos body form.Selection true "Photo Selection"
// @Router /api/v1/batch/photos/private [post]
func BatchPhotosPrivate(router *gin.RouterGroup) { func BatchPhotosPrivate(router *gin.RouterGroup) {
router.POST("/batch/photos/private", func(c *gin.Context) { router.POST("/batch/photos/private", func(c *gin.Context) {
s := Auth(c, acl.ResourcePhotos, acl.AccessPrivate) s := Auth(c, acl.ResourcePhotos, acl.AccessPrivate)
@@ -324,14 +362,15 @@ func BatchPhotosPrivate(router *gin.RouterGroup) {
// BatchLabelsDelete deletes multiple labels. // BatchLabelsDelete deletes multiple labels.
// //
// @Summary deletes multiple labels // @Summary deletes multiple labels
// @Id BatchLabelsDelete // @Id BatchLabelsDelete
// @Tags Labels // @Tags Labels
// @Produce json // @Produce json
// @Success 200 {object} i18n.Response // @Success 200 {object} i18n.Response
// @Failure 400 {object} i18n.Response // @Failure 400 {object} i18n.Response
// @Param labels body form.Selection true "Label Selection" // @Failure 500 {object} i18n.Response
// @Router /api/v1/batch/labels/delete [post] // @Param labels body form.Selection true "Label Selection"
// @Router /api/v1/batch/labels/delete [post]
func BatchLabelsDelete(router *gin.RouterGroup) { func BatchLabelsDelete(router *gin.RouterGroup) {
router.POST("/batch/labels/delete", func(c *gin.Context) { router.POST("/batch/labels/delete", func(c *gin.Context) {
s := Auth(c, acl.ResourceLabels, acl.ActionDelete) s := Auth(c, acl.ResourceLabels, acl.ActionDelete)
@@ -376,11 +415,15 @@ func BatchLabelsDelete(router *gin.RouterGroup) {
// BatchPhotosDelete permanently removes multiple photos from the archive. // BatchPhotosDelete permanently removes multiple photos from the archive.
// //
// @Summary permanently removes multiple or all photos from the archive // @Summary permanently removes multiple or all photos from the archive
// @Id BatchPhotosDelete // @Id BatchPhotosDelete
// @Tags Photos // @Tags Photos
// // @Produce json
// @Router /api/v1/batch/photos/delete [post] // @Success 200 {object} i18n.Response
// @Failure 400 {object} i18n.Response
// @Failure 403 {object} i18n.Response
// @Param photos body form.Selection true "All or Photo Selection"
// @Router /api/v1/batch/photos/delete [post]
func BatchPhotosDelete(router *gin.RouterGroup) { func BatchPhotosDelete(router *gin.RouterGroup) {
router.POST("/batch/photos/delete", func(c *gin.Context) { router.POST("/batch/photos/delete", func(c *gin.Context) {
s := Auth(c, acl.ResourcePhotos, acl.ActionDelete) s := Auth(c, acl.ResourcePhotos, acl.ActionDelete)

284
internal/api/swagger.json
View File

@@ -175,10 +175,45 @@
}, },
"/api/v1/batch/albums/delete": { "/api/v1/batch/albums/delete": {
"post": { "post": {
"produces": [
"application/json"
],
"tags": [ "tags": [
"Albums" "Albums"
], ],
"responses": {} "summary": "permanently removes multiple albums",
"operationId": "BatchAlbumsDelete",
"parameters": [
{
"description": "Album Selection",
"name": "albums",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/form.Selection"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/i18n.Response"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/i18n.Response"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/i18n.Response"
}
}
}
} }
}, },
"/api/v1/batch/labels/delete": { "/api/v1/batch/labels/delete": {
@@ -214,50 +249,247 @@
"schema": { "schema": {
"$ref": "#/definitions/i18n.Response" "$ref": "#/definitions/i18n.Response"
} }
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/i18n.Response"
}
} }
} }
} }
}, },
"/api/v1/batch/photos/approve": { "/api/v1/batch/photos/approve": {
"post": { "post": {
"produces": [
"application/json"
],
"tags": [ "tags": [
"Photos" "Photos"
], ],
"responses": {} "summary": "approves multiple photos that are currently under review",
"operationId": "BatchPhotosApprove",
"parameters": [
{
"description": "Photo Selection",
"name": "photos",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/form.Selection"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/i18n.Response"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/i18n.Response"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/i18n.Response"
}
}
}
} }
}, },
"/api/v1/batch/photos/archive": { "/api/v1/batch/photos/archive": {
"post": { "post": {
"produces": [
"application/json"
],
"tags": [ "tags": [
"Photos" "Photos"
], ],
"responses": {} "summary": "moves multiple photos to the archive",
"operationId": "BatchPhotosArchive",
"parameters": [
{
"description": "Photo Selection",
"name": "photos",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/form.Selection"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/i18n.Response"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/i18n.Response"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/i18n.Response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/i18n.Response"
}
}
}
} }
}, },
"/api/v1/batch/photos/delete": { "/api/v1/batch/photos/delete": {
"post": { "post": {
"produces": [
"application/json"
],
"tags": [ "tags": [
"Photos" "Photos"
], ],
"summary": "permanently removes multiple or all photos from the archive", "summary": "permanently removes multiple or all photos from the archive",
"operationId": "BatchPhotosDelete", "operationId": "BatchPhotosDelete",
"responses": {} "parameters": [
{
"description": "All or Photo Selection",
"name": "photos",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/form.Selection"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/i18n.Response"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/i18n.Response"
}
},
"403": {
"description": "Forbidden",
"schema": {
"$ref": "#/definitions/i18n.Response"
}
}
}
} }
}, },
"/api/v1/batch/photos/private": { "/api/v1/batch/photos/private": {
"post": { "post": {
"produces": [
"application/json"
],
"tags": [ "tags": [
"Photos" "Photos"
], ],
"responses": {} "summary": "toggles private state of multiple photos",
"operationId": "BatchPhotosPrivate",
"parameters": [
{
"description": "Photo Selection",
"name": "photos",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/form.Selection"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/i18n.Response"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/i18n.Response"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/i18n.Response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/i18n.Response"
}
}
}
} }
}, },
"/api/v1/batch/photos/restore": { "/api/v1/batch/photos/restore": {
"post": { "post": {
"produces": [
"application/json"
],
"tags": [ "tags": [
"Photos" "Photos"
], ],
"responses": {} "summary": "restores multiple photos from the archive",
"operationId": "BatchPhotosRestore",
"parameters": [
{
"description": "Photo Selection",
"name": "photos",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/form.Selection"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/i18n.Response"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/i18n.Response"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/i18n.Response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/i18n.Response"
}
}
}
} }
}, },
"/api/v1/config/options": { "/api/v1/config/options": {
@@ -1831,35 +2063,17 @@
1000000000, 1000000000,
60000000000, 60000000000,
3600000000000, 3600000000000,
-9223372036854775808,
9223372036854775807,
1, 1,
1000, 1000,
1000000, 1000000,
1000000000, 1000000000,
60000000000, 60000000000,
3600000000000,
-9223372036854775808,
9223372036854775807,
1, 1,
1000, 1000,
1000000, 1000000,
1000000000, 1000000000,
60000000000, 60000000000,
3600000000000, 3600000000000
-9223372036854775808,
9223372036854775807,
1,
1000,
1000000,
1000000000,
60000000000,
3600000000000,
1,
1000,
1000000,
1000000000,
60000000000
], ],
"x-enum-varnames": [ "x-enum-varnames": [
"minDuration", "minDuration",
@@ -1870,35 +2084,17 @@
"Second", "Second",
"Minute", "Minute",
"Hour", "Hour",
"minDuration",
"maxDuration",
"Nanosecond", "Nanosecond",
"Microsecond", "Microsecond",
"Millisecond", "Millisecond",
"Second", "Second",
"Minute", "Minute",
"Hour",
"minDuration",
"maxDuration",
"Nanosecond", "Nanosecond",
"Microsecond", "Microsecond",
"Millisecond", "Millisecond",
"Second", "Second",
"Minute", "Minute",
"Hour", "Hour"
"minDuration",
"maxDuration",
"Nanosecond",
"Microsecond",
"Millisecond",
"Second",
"Minute",
"Hour",
"Nanosecond",
"Microsecond",
"Millisecond",
"Second",
"Minute"
] ]
} }
}, },