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

API: Add code comments

Browse Source
This commit is contained in:
Michael Mayer
2021-08-31 13:33:27 +02:00
parent 20d690b768
commit 72b517d7c7
2 changed files with 8 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
internal/api/import.go
View File

@@ -21,6 +21,8 @@ import (
"github.com/photoprism/photoprism/pkg/txt"
)
// StartImport imports media files from a directory and converts/indexes them as needed.
//
// POST /api/v1/import*
func StartImport(router *gin.RouterGroup) {
router.POST("/import/*path", func(c *gin.Context) {
@@ -118,6 +120,8 @@ func StartImport(router *gin.RouterGroup) {
})
}
// CancelImport stops the current import operation.
//
// DELETE /api/v1/import
func CancelImport(router *gin.RouterGroup) {
router.DELETE("/import", func(c *gin.Context) {

4
internal/api/index.go
View File

@@ -16,6 +16,8 @@ import (
"github.com/photoprism/photoprism/pkg/txt"
)
// StartIndexing indexes media files in the "originals" folder.
//
// POST /api/v1/index
func StartIndexing(router *gin.RouterGroup) {
router.POST("/index", func(c *gin.Context) {
@@ -100,6 +102,8 @@ func StartIndexing(router *gin.RouterGroup) {
})
}
// CancelIndexing stops indexing media files in the "originals" folder.
//
// DELETE /api/v1/index
func CancelIndexing(router *gin.RouterGroup) {
router.DELETE("/index", func(c *gin.Context) {