vincent/aptly
1
0
Fork 0
mirror of https://github.com/aptly-dev/aptly.git synced 2026-07-16 12:08:04 +00:00
Code Issues Projects Releases Wiki Activity

add api documentation stubs

Browse Source
This commit is contained in:
André Roth
2024-10-04 01:06:25 +02:00
parent f9ae9b323a
commit ba86851d07
11 changed files with 347 additions and 44 deletions
Download Patch File Download Diff File Expand all files Collapse all files
api/snapshot.go
+64 -8
View File
@@ -39,7 +39,14 @@ func apiSnapshotsList(c *gin.Context) {
c.JSON(200, result)
}
// POST /api/mirrors/:name/snapshots/
// @Summary TODO
// @Description **ToDo**
// @Description To Do
// @Tags Snapshots
// @Produce json
// @Success 200 {object} string "msg"
// @Failure 404 {object} Error "Not Found"
// @Router /api/mirrors/{name}/snapshots [post]
func apiSnapshotsCreateFromMirror(c *gin.Context) {
var (
err error
@@ -98,7 +105,14 @@ func apiSnapshotsCreateFromMirror(c *gin.Context) {
})
}
// POST /api/snapshots
// @Summary TODO
// @Description **ToDo**
// @Description To Do
// @Tags Snapshots
// @Produce json
// @Success 200 {object} string "msg"
// @Failure 404 {object} Error "Not Found"
// @Router /api/snapshots [post]
func apiSnapshotsCreate(c *gin.Context) {
var (
err error
@@ -173,7 +187,14 @@ func apiSnapshotsCreate(c *gin.Context) {
})
}
// POST /api/repos/:name/snapshots
// @Summary TODO
// @Description **ToDo**
// @Description To Do
// @Tags Snapshots
// @Produce json
// @Success 200 {object} string "msg"
// @Failure 404 {object} Error "Not Found"
// @Router /api/repos/{name}/snapshots [post]
func apiSnapshotsCreateFromRepository(c *gin.Context) {
var (
err error
@@ -227,7 +248,14 @@ func apiSnapshotsCreateFromRepository(c *gin.Context) {
})
}
// PUT /api/snapshots/:name
// @Summary TODO
// @Description **ToDo**
// @Description To Do
// @Tags Snapshots
// @Produce json
// @Success 200 {object} string "msg"
// @Failure 404 {object} Error "Not Found"
// @Router /api/snapshots/{name} [put]
func apiSnapshotsUpdate(c *gin.Context) {
var (
err error
@@ -277,7 +305,14 @@ func apiSnapshotsUpdate(c *gin.Context) {
})
}
// GET /api/snapshots/:name
// @Summary TODO
// @Description **ToDo**
// @Description To Do
// @Tags Snapshots
// @Produce json
// @Success 200 {object} string "msg"
// @Failure 404 {object} Error "Not Found"
// @Router /api/snapshots/{name} [get]
func apiSnapshotsShow(c *gin.Context) {
collectionFactory := context.NewCollectionFactory()
collection := collectionFactory.SnapshotCollection()
@@ -297,7 +332,14 @@ func apiSnapshotsShow(c *gin.Context) {
c.JSON(200, snapshot)
}
// DELETE /api/snapshots/:name
// @Summary TODO
// @Description **ToDo**
// @Description To Do
// @Tags Snapshots
// @Produce json
// @Success 200 {object} string "msg"
// @Failure 404 {object} Error "Not Found"
// @Router /api/snapshots/{name} [delete]
func apiSnapshotsDrop(c *gin.Context) {
name := c.Params.ByName("name")
force := c.Request.URL.Query().Get("force") == "1"
@@ -336,7 +378,14 @@ func apiSnapshotsDrop(c *gin.Context) {
})
}
// GET /api/snapshots/:name/diff/:withSnapshot
// @Summary TODO
// @Description **ToDo**
// @Description To Do
// @Tags Snapshots
// @Produce json
// @Success 200 {object} string "msg"
// @Failure 404 {object} Error "Not Found"
// @Router /api/snapshots/{name}/diff/{withSnapshot} [get]
func apiSnapshotsDiff(c *gin.Context) {
onlyMatching := c.Request.URL.Query().Get("onlyMatching") == "1"
@@ -387,7 +436,14 @@ func apiSnapshotsDiff(c *gin.Context) {
c.JSON(200, result)
}
// GET /api/snapshots/:name/packages
// @Summary TODO
// @Description **ToDo**
// @Description To Do
// @Tags Snapshots
// @Produce json
// @Success 200 {object} string "msg"
// @Failure 404 {object} Error "Not Found"
// @Router /api/snapshots/{name}/packages [get]
func apiSnapshotsSearchPackages(c *gin.Context) {
collectionFactory := context.NewCollectionFactory()
collection := collectionFactory.SnapshotCollection()