Skip to content

Commit

Permalink
swagger: document /api/snapshots/pull
Browse files Browse the repository at this point in the history
  • Loading branch information
neolynx committed Oct 3, 2024
1 parent 4013873 commit 82bb5b0
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion api/snapshot.go
Original file line number Diff line number Diff line change
Expand Up @@ -483,7 +483,23 @@ func apiSnapshotsMerge(c *gin.Context) {
})
}

// POST /api/snapshots/pull
// @Summary Snapshot Pull
// @Description Create empty mirror with specified parameters.
// @Tags Snapshots
// @Param all-matches query int false "all-matches: 1 to enable"
// @Param dry-run query int false "dry-run: 1 to enable"
// @Param no-deps query int false "no-deps: 1 to enable"
// @Param no-remove query int false "no-remove: 1 to enable"
// @Accept json
// @Param Source body string true "source name where packages and dependencies will be searched"
// @Param To body string true "snapshot where packages and dependencies will be pulled to"
// @Param Destination body string true "name of the snapshot that will be created"
// @Param Queries body []string true "list of package queries, in the simplest form, name of package to be pulled from"
// @Param Architectures body []string true "list of architectures"
// @Produce json
// @Success 200
// @Failure 400 {object} Error "Bad Request"
// @Router /api/snapshots/pull [post]
func apiSnapshotsPull(c *gin.Context) {
var (
err error
Expand Down

0 comments on commit 82bb5b0

Please sign in to comment.