Add version annotation to API methods

http/handler/api/config.go

@@ -28,6 +28,7 @@ func NewConfig(store cfgstore.Store) *ConfigHandler {
 // Get returns the currently active Restreamer configuration
 // @Summary Retrieve the currently active Restreamer configuration
 // @Description Retrieve the currently active Restreamer configuration
+// @Tags v16.7.2
 // @ID config-3-get
 // @Produce json
 // @Success 200 {object} api.Config
@@ -45,6 +46,7 @@ func (p *ConfigHandler) Get(c echo.Context) error {
 // Set will set the given configuration as new active configuration
 // @Summary Update the current Restreamer configuration
 // @Description Update the current Restreamer configuration by providing a complete or partial configuration. Fields that are not provided will not be changed.
+// @Tags v16.7.2
 // @ID config-3-set
 // @Accept json
 // @Produce json
@@ -156,6 +158,7 @@ func (p *ConfigHandler) Set(c echo.Context) error {
 // Reload will reload the currently active configuration
 // @Summary Reload the currently active configuration
 // @Description Reload the currently active configuration. This will trigger a restart of the Restreamer.
+// @Tags v16.7.2
 // @ID config-3-reload
 // @Produce plain
 // @Success 200 {string} string "OK"

http/handler/api/diskfs.go

@@ -34,6 +34,7 @@ func NewDiskFS(fs fs.Filesystem, cache cache.Cacher) *DiskFSHandler {
 // GetFile returns the file at the given path
 // @Summary Fetch a file from the filesystem
 // @Description Fetch a file from the filesystem. The contents of that file are returned.
+// @Tags v16.7.2
 // @ID diskfs-3-get-file
 // @Produce application/data
 // @Produce json
@@ -86,6 +87,7 @@ func (h *DiskFSHandler) GetFile(c echo.Context) error {
 // PutFile adds or overwrites a file at the given path
 // @Summary Add a file to the filesystem
 // @Description Writes or overwrites a file on the filesystem
+// @Tags v16.7.2
 // @ID diskfs-3-put-file
 // @Accept application/data
 // @Produce text/plain
@@ -125,6 +127,7 @@ func (h *DiskFSHandler) PutFile(c echo.Context) error {
 // DeleteFile removes a file from the filesystem
 // @Summary Remove a file from the filesystem
 // @Description Remove a file from the filesystem
+// @Tags v16.7.2
 // @ID diskfs-3-delete-file
 // @Produce text/plain
 // @Param path path string true "Path to file"
@@ -153,6 +156,7 @@ func (h *DiskFSHandler) DeleteFile(c echo.Context) error {
 // ListFiles lists all files on the filesystem
 // @Summary List all files on the filesystem
 // @Description List all files on the filesystem. The listing can be ordered by name, size, or date of last modification in ascending or descending order.
+// @Tags v16.7.2
 // @ID diskfs-3-list-files
 // @Produce json
 // @Param glob query string false "glob pattern for file names"

http/handler/api/log.go

@@ -31,6 +31,7 @@ func NewLog(buffer log.BufferWriter) *LogHandler {
 // Log returns the last log lines of the Restreamer application
 // @Summary Application log
 // @Description Get the last log lines of the Restreamer application
+// @Tags v16.7.2
 // @ID log-3
 // @Param format query string false "Format of the list of log events (*console, raw)"
 // @Produce json

http/handler/api/memfs.go

@@ -31,6 +31,7 @@ func NewMemFS(fs fs.Filesystem) *MemFSHandler {
 // GetFileAPI returns the file at the given path
 // @Summary Fetch a file from the memory filesystem
 // @Description Fetch a file from the memory filesystem
+// @Tags v16.7.2
 // @ID memfs-3-get-file
 // @Produce application/data
 // @Produce json
@@ -47,6 +48,7 @@ func (h *MemFSHandler) GetFile(c echo.Context) error {
 // PutFileAPI adds or overwrites a file at the given path
 // @Summary Add a file to the memory filesystem
 // @Description Writes or overwrites a file on the memory filesystem
+// @Tags v16.7.2
 // @ID memfs-3-put-file
 // @Accept application/data
 // @Produce text/plain
@@ -65,6 +67,7 @@ func (h *MemFSHandler) PutFile(c echo.Context) error {
 // DeleteFileAPI removes a file from the filesystem
 // @Summary Remove a file from the memory filesystem
 // @Description Remove a file from the memory filesystem
+// @Tags v16.7.2
 // @ID memfs-3-delete-file
 // @Produce text/plain
 // @Param path path string true "Path to file"
@@ -79,6 +82,7 @@ func (h *MemFSHandler) DeleteFile(c echo.Context) error {
 // PatchFile creates a symbolic link to a file in the filesystem
 // @Summary Create a link to a file in the memory filesystem
 // @Description Create a link to a file in the memory filesystem. The file linked to has to exist.
+// @Tags v16.7.2
 // @ID memfs-3-patch
 // @Accept application/data
 // @Produce text/plain
@@ -118,6 +122,7 @@ func (h *MemFSHandler) PatchFile(c echo.Context) error {
 // ListFiles lists all files on the filesystem
 // @Summary List all files on the memory filesystem
 // @Description List all files on the memory filesystem. The listing can be ordered by name, size, or date of last modification in ascending or descending order.
+// @Tags v16.7.2
 // @ID memfs-3-list-files
 // @Produce json
 // @Param glob query string false "glob pattern for file names"

http/handler/api/metrics.go

@@ -32,6 +32,7 @@ func NewMetrics(config MetricsConfig) *MetricsHandler {
 // Describe the known metrics
 // @Summary List all known metrics with their description and labels
 // @Description List all known metrics with their description and labels
+// @Tags v16.10.0
 // @ID metrics-3-describe
 // @Produce json
 // @Success 200 {array} api.MetricsDescription
@@ -60,6 +61,7 @@ func (r *MetricsHandler) Describe(c echo.Context) error {
 // Query the collected metrics
 // @Summary Query the collected metrics
 // @Description Query the collected metrics
+// @Tags v16.7.2
 // @ID metrics-3-metrics
 // @Accept json
 // @Produce json

http/handler/api/playout.go

@@ -31,6 +31,7 @@ func NewPlayout(restream restream.Restreamer) *PlayoutHandler {
 // Status return the current playout status
 // @Summary Get the current playout status
 // @Description Get the current playout status of an input of a process
+// @Tags v16.7.2
 // @ID process-3-playout-status
 // @Produce json
 // @Param id path string true "Process ID"
@@ -84,6 +85,7 @@ func (h *PlayoutHandler) Status(c echo.Context) error {
 // Keyframe returns the last keyframe
 // @Summary Get the last keyframe
 // @Description Get the last keyframe of an input of a process. The extension of the name determines the return type.
+// @Tags v16.7.2
 // @ID process-3-playout-keyframe
 // @Produce image/jpeg
 // @Produce image/png
@@ -133,6 +135,7 @@ func (h *PlayoutHandler) Keyframe(c echo.Context) error {
 // EncodeErrorframe encodes the errorframe
 // @Summary Encode the errorframe
 // @Description Immediately encode the errorframe (if available and looping)
+// @Tags v16.7.2
 // @ID process-3-playout-errorframencode
 // @Produce text/plain
 // @Produce json
@@ -173,6 +176,7 @@ func (h *PlayoutHandler) EncodeErrorframe(c echo.Context) error {
 // SetErrorframe sets an errorframe
 // @Summary Upload an error frame
 // @Description Upload an error frame which will be encoded immediately
+// @Tags v16.7.2
 // @ID process-3-playout-errorframe
 // @Produce text/plain
 // @Produce json
@@ -221,6 +225,7 @@ func (h *PlayoutHandler) SetErrorframe(c echo.Context) error {
 // ReopenInput closes the current input stream
 // @Summary Close the current input stream
 // @Description Close the current input stream such that it will be automatically re-opened
+// @Tags v16.7.2
 // @ID process-3-playout-reopen-input
 // @Produce plain
 // @Param id path string true "Process ID"
@@ -260,6 +265,7 @@ func (h *PlayoutHandler) ReopenInput(c echo.Context) error {
 // SetStream replaces the current stream
 // @Summary Switch to a new stream
 // @Description Replace the current stream with the one from the given URL. The switch will only happen if the stream parameters match.
+// @Tags v16.7.2
 // @ID process-3-playout-stream
 // @Produce text/plain
 // @Produce json

http/handler/api/restream.go

@@ -27,6 +27,7 @@ func NewRestream(restream restream.Restreamer) *RestreamHandler {
 // Add adds a new process
 // @Summary Add a new process
 // @Description Add a new FFmpeg process
+// @Tags v16.7.2
 // @ID process-3-add
 // @Accept json
 // @Produce json
@@ -68,6 +69,7 @@ func (h *RestreamHandler) Add(c echo.Context) error {
 // GetAll returns all known processes
 // @Summary List all known processes
 // @Description List all known processes. Use the query parameter to filter the listed processes.
+// @Tags v16.7.2
 // @ID process-3-get-all
 // @Produce json
 // @Param filter query string false "Comma separated list of fields (config, state, report, metadata) that will be part of the output. If empty, all fields will be part of the output."
@@ -118,6 +120,7 @@ func (h *RestreamHandler) GetAll(c echo.Context) error {
 // Get returns the process with the given ID
 // @Summary List a process by its ID
 // @Description List a process by its ID. Use the filter parameter to specifiy the level of detail of the output.
+// @Tags v16.7.2
 // @ID process-3-get
 // @Produce json
 // @Param id path string true "Process ID"
@@ -141,6 +144,7 @@ func (h *RestreamHandler) Get(c echo.Context) error {
 // Delete deletes the process with the given ID
 // @Summary Delete a process by its ID
 // @Description Delete a process by its ID
+// @Tags v16.7.2
 // @ID process-3-delete
 // @Produce json
 // @Param id path string true "Process ID"
@@ -164,7 +168,8 @@ func (h *RestreamHandler) Delete(c echo.Context) error {
 
 // Update replaces an existing process
 // @Summary Replace an existing process
-// @Description Replace an existing process. This is a shortcut for DELETE+POST.
+// @Description Replace an existing process.
+// @Tags v16.7.2
 // @ID process-3-update
 // @Accept json
 // @Produce json
@@ -206,6 +211,7 @@ func (h *RestreamHandler) Update(c echo.Context) error {
 // Command issues a command to a process
 // @Summary Issue a command to a process
 // @Description Issue a command to a process: start, stop, reload, restart
+// @Tags v16.7.2
 // @ID process-3-command
 // @Accept json
 // @Produce json
@@ -248,6 +254,7 @@ func (h *RestreamHandler) Command(c echo.Context) error {
 // GetConfig returns the configuration of a process
 // @Summary Get the configuration of a process
 // @Description Get the configuration of a process. This is the configuration as provided by Add or Update.
+// @Tags v16.7.2
 // @ID process-3-get-config
 // @Produce json
 // @Param id path string true "Process ID"
@@ -272,7 +279,8 @@ func (h *RestreamHandler) GetConfig(c echo.Context) error {
 
 // GetState returns the current state of a process
 // @Summary Get the state of a process
-// @Description Get the state and progress data of a process
+// @Description Get the state and progress data of a process.
+// @Tags v16.7.2
 // @ID process-3-get-state
 // @Produce json
 // @Param id path string true "Process ID"
@@ -297,7 +305,8 @@ func (h *RestreamHandler) GetState(c echo.Context) error {
 
 // GetReport return the current log and the log history of a process
 // @Summary Get the logs of a process
-// @Description Get the logs and the log history of a process
+// @Description Get the logs and the log history of a process.
+// @Tags v16.7.2
 // @ID process-3-get-report
 // @Produce json
 // @Param id path string true "Process ID"
@@ -322,7 +331,8 @@ func (h *RestreamHandler) GetReport(c echo.Context) error {
 
 // Probe probes a process
 // @Summary Probe a process
-// @Description Probe an existing process to get a detailed stream information on the inputs
+// @Description Probe an existing process to get a detailed stream information on the inputs.
+// @Tags v16.7.2
 // @ID process-3-probe
 // @Produce json
 // @Param id path string true "Process ID"
@@ -342,7 +352,8 @@ func (h *RestreamHandler) Probe(c echo.Context) error {
 
 // Skills returns the detected FFmpeg capabilities
 // @Summary FFmpeg capabilities
-// @Description List all detected FFmpeg capabilities
+// @Description List all detected FFmpeg capabilities.
+// @Tags v16.7.2
 // @ID skills-3
 // @Produce json
 // @Success 200 {object} api.Skills
@@ -359,7 +370,8 @@ func (h *RestreamHandler) Skills(c echo.Context) error {
 
 // ReloadSkills will refresh the FFmpeg capabilities
 // @Summary Refresh FFmpeg capabilities
-// @Description Refresh the available FFmpeg capabilities
+// @Description Refresh the available FFmpeg capabilities.
+// @Tags v16.7.2
 // @ID skills-3-reload
 // @Produce json
 // @Success 200 {object} api.Skills
@@ -378,6 +390,7 @@ func (h *RestreamHandler) ReloadSkills(c echo.Context) error {
 // GetProcessMetadata returns the metadata stored with a process
 // @Summary Retrieve JSON metadata stored with a process under a key
 // @Description Retrieve the previously stored JSON metadata under the given key. If the key is empty, all metadata will be returned.
+// @Tags v16.7.2
 // @ID process-3-get-process-metadata
 // @Produce json
 // @Param id path string true "Process ID"
@@ -402,6 +415,7 @@ func (h *RestreamHandler) GetProcessMetadata(c echo.Context) error {
 // SetProcessMetadata stores metadata with a process
 // @Summary Add JSON metadata with a process under the given key
 // @Description Add arbitrary JSON metadata under the given key. If the key exists, all already stored metadata with this key will be overwritten. If the key doesn't exist, it will be created.
+// @Tags v16.7.2
 // @ID process-3-set-process-metadata
 // @Produce json
 // @Param id path string true "Process ID"
@@ -436,6 +450,7 @@ func (h *RestreamHandler) SetProcessMetadata(c echo.Context) error {
 // GetMetadata returns the metadata stored with the Restreamer
 // @Summary Retrieve JSON metadata from a key
 // @Description Retrieve the previously stored JSON metadata under the given key. If the key is empty, all metadata will be returned.
+// @Tags v16.7.2
 // @ID metadata-3-get
 // @Produce json
 // @Param key path string true "Key for data store"
@@ -458,6 +473,7 @@ func (h *RestreamHandler) GetMetadata(c echo.Context) error {
 // SetMetadata stores metadata with the Restreamer
 // @Summary Add JSON metadata under the given key
 // @Description Add arbitrary JSON metadata under the given key. If the key exists, all already stored metadata with this key will be overwritten. If the key doesn't exist, it will be created.
+// @Tags v16.7.2
 // @ID metadata-3-set
 // @Produce json
 // @Param key path string true "Key for data store"

http/handler/api/rtmp.go

@@ -23,7 +23,8 @@ func NewRTMP(rtmp rtmp.Server) *RTMPHandler {
 
 // ListChannels lists all currently publishing RTMP streams
 // @Summary List all publishing RTMP streams
-// @Description List all currently publishing RTMP streams
+// @Description List all currently publishing RTMP streams.
+// @Tags v16.7.2
 // @ID rtmp-3-list-channels
 // @Produce json
 // @Success 200 {array} api.RTMPChannel

http/handler/api/session.go

@@ -25,7 +25,8 @@ func NewSession(registry session.RegistryReader) *SessionHandler {
 
 // Summary returns a summary of all active and past sessions
 // @Summary Get a summary of all active and past sessions
-// @Description Get a summary of all active and past sessions of the given collector
+// @Description Get a summary of all active and past sessions of the given collector.
+// @Tags v16.7.2
 // @ID session-3-summary
 // @Produce json
 // @Security ApiKeyAuth
@@ -49,7 +50,8 @@ func (s *SessionHandler) Summary(c echo.Context) error {
 
 // Active returns a list of active sessions
 // @Summary Get a minimal summary of all active sessions
-// @Description Get a minimal summary of all active sessions (i.e. number of sessions, bandwidth)
+// @Description Get a minimal summary of all active sessions (i.e. number of sessions, bandwidth).
+// @Tags v16.7.2
 // @ID session-3-current
 // @Produce json
 // @Security ApiKeyAuth

http/handler/api/srt.go

@@ -24,6 +24,7 @@ func NewSRT(srt srt.Server) *SRTHandler {
 // ListChannels lists all currently publishing SRT streams
 // @Summary List all publishing SRT treams
 // @Description List all currently publishing SRT streams. This endpoint is EXPERIMENTAL and may change in future.
+// @Tags v16.9.0
 // @ID srt-3-list-channels
 // @Produce json
 // @Success 200 {array} api.SRTChannels

http/handler/api/widget.go

@@ -34,6 +34,7 @@ func NewWidget(config WidgetConfig) *WidgetHandler {
 // Get returns minimal public statistics about a process
 // @Summary Fetch minimal statistics about a process
 // @Description Fetch minimal statistics about a process, which is not protected by any auth.
+// @Tags v16.7.2
 // @ID widget-3-get
 // @Produce json
 // @Param id path string true "ID of a process"