zgaetano/datarhei-dragonfork-core
1
0
Fork 0
Code Issues 2 Pull requests Projects Releases 4 Packages Wiki Activity Actions

Use better naming for storage endpoint documentation

Browse source
This commit is contained in:
Ingo Oppermann 2023-03-17 13:55:19 +01:00
parent f345707c63
commit 562b7aed92
No known key found for this signature in database
GPG key ID: 2AB32426E9DD229E
4 changed files with 84 additions and 40 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

36
docs/docs.go
View file

@ -1,5 +1,4 @@
// Package docs GENERATED BY SWAG; DO NOT EDIT // Code generated by swaggo/swag. DO NOT EDIT
// This file was generated by swaggo/swag
package docs package docs
import "github.com/swaggo/swag" import "github.com/swaggo/swag"
@ -322,6 +321,9 @@ const docTemplate = `{
"produces": [ "produces": [
"application/json" "application/json"
], ],
"tags": [
"v16.12.0"
],
"summary": "List all registered filesystems", "summary": "List all registered filesystems",
"operationId": "filesystem-3-list", "operationId": "filesystem-3-list",
"responses": { "responses": {
@ -337,7 +339,7 @@ const docTemplate = `{
} }
} }
}, },
"/api/v3/fs/{name}": { "/api/v3/fs/{storage}": {
"get": { "get": {
"security": [ "security": [
{ {
@ -348,13 +350,16 @@ const docTemplate = `{
"produces": [ "produces": [
"application/json" "application/json"
], ],
"tags": [
"v16.7.2"
],
"summary": "List all files on a filesystem", "summary": "List all files on a filesystem",
"operationId": "filesystem-3-list-files", "operationId": "filesystem-3-list-files",
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
"description": "Name of the filesystem", "description": "Name of the filesystem",
"name": "name", "name": "storage",
"in": "path", "in": "path",
"required": true "required": true
}, },
@ -390,7 +395,7 @@ const docTemplate = `{
} }
} }
}, },
"/api/v3/fs/{name}/{path}": { "/api/v3/fs/{storage}/{filepath}": {
"get": { "get": {
"security": [ "security": [
{ {
@ -402,20 +407,23 @@ const docTemplate = `{
"application/data", "application/data",
"application/json" "application/json"
], ],
"tags": [
"v16.7.2"
],
"summary": "Fetch a file from a filesystem", "summary": "Fetch a file from a filesystem",
"operationId": "filesystem-3-get-file", "operationId": "filesystem-3-get-file",
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
"description": "Name of the filesystem", "description": "Name of the filesystem",
"name": "name", "name": "storage",
"in": "path", "in": "path",
"required": true "required": true
}, },
{ {
"type": "string", "type": "string",
"description": "Path to file", "description": "Path to file",
"name": "path", "name": "filepath",
"in": "path", "in": "path",
"required": true "required": true
} }
@ -455,20 +463,23 @@ const docTemplate = `{
"text/plain", "text/plain",
"application/json" "application/json"
], ],
"tags": [
"v16.7.2"
],
"summary": "Add a file to a filesystem", "summary": "Add a file to a filesystem",
"operationId": "filesystem-3-put-file", "operationId": "filesystem-3-put-file",
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
"description": "Name of the filesystem", "description": "Name of the filesystem",
"name": "name", "name": "storage",
"in": "path", "in": "path",
"required": true "required": true
}, },
{ {
"type": "string", "type": "string",
"description": "Path to file", "description": "Path to file",
"name": "path", "name": "filepath",
"in": "path", "in": "path",
"required": true "required": true
}, },
@ -516,20 +527,23 @@ const docTemplate = `{
"produces": [ "produces": [
"text/plain" "text/plain"
], ],
"tags": [
"v16.7.2"
],
"summary": "Remove a file from a filesystem", "summary": "Remove a file from a filesystem",
"operationId": "filesystem-3-delete-file", "operationId": "filesystem-3-delete-file",
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
"description": "Name of the filesystem", "description": "Name of the filesystem",
"name": "name", "name": "storage",
"in": "path", "in": "path",
"required": true "required": true
}, },
{ {
"type": "string", "type": "string",
"description": "Path to file", "description": "Path to file",
"name": "path", "name": "filepath",
"in": "path", "in": "path",
"required": true "required": true
} }

33
docs/swagger.json
View file

@ -314,6 +314,9 @@
"produces": [ "produces": [
"application/json" "application/json"
], ],
"tags": [
"v16.12.0"
],
"summary": "List all registered filesystems", "summary": "List all registered filesystems",
"operationId": "filesystem-3-list", "operationId": "filesystem-3-list",
"responses": { "responses": {
@ -329,7 +332,7 @@
} }
} }
}, },
"/api/v3/fs/{name}": { "/api/v3/fs/{storage}": {
"get": { "get": {
"security": [ "security": [
{ {
@ -340,13 +343,16 @@
"produces": [ "produces": [
"application/json" "application/json"
], ],
"tags": [
"v16.7.2"
],
"summary": "List all files on a filesystem", "summary": "List all files on a filesystem",
"operationId": "filesystem-3-list-files", "operationId": "filesystem-3-list-files",
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
"description": "Name of the filesystem", "description": "Name of the filesystem",
"name": "name", "name": "storage",
"in": "path", "in": "path",
"required": true "required": true
}, },
@ -382,7 +388,7 @@
} }
} }
}, },
"/api/v3/fs/{name}/{path}": { "/api/v3/fs/{storage}/{filepath}": {
"get": { "get": {
"security": [ "security": [
{ {
@ -394,20 +400,23 @@
"application/data", "application/data",
"application/json" "application/json"
], ],
"tags": [
"v16.7.2"
],
"summary": "Fetch a file from a filesystem", "summary": "Fetch a file from a filesystem",
"operationId": "filesystem-3-get-file", "operationId": "filesystem-3-get-file",
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
"description": "Name of the filesystem", "description": "Name of the filesystem",
"name": "name", "name": "storage",
"in": "path", "in": "path",
"required": true "required": true
}, },
{ {
"type": "string", "type": "string",
"description": "Path to file", "description": "Path to file",
"name": "path", "name": "filepath",
"in": "path", "in": "path",
"required": true "required": true
} }
@ -447,20 +456,23 @@
"text/plain", "text/plain",
"application/json" "application/json"
], ],
"tags": [
"v16.7.2"
],
"summary": "Add a file to a filesystem", "summary": "Add a file to a filesystem",
"operationId": "filesystem-3-put-file", "operationId": "filesystem-3-put-file",
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
"description": "Name of the filesystem", "description": "Name of the filesystem",
"name": "name", "name": "storage",
"in": "path", "in": "path",
"required": true "required": true
}, },
{ {
"type": "string", "type": "string",
"description": "Path to file", "description": "Path to file",
"name": "path", "name": "filepath",
"in": "path", "in": "path",
"required": true "required": true
}, },
@ -508,20 +520,23 @@
"produces": [ "produces": [
"text/plain" "text/plain"
], ],
"tags": [
"v16.7.2"
],
"summary": "Remove a file from a filesystem", "summary": "Remove a file from a filesystem",
"operationId": "filesystem-3-delete-file", "operationId": "filesystem-3-delete-file",
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
"description": "Name of the filesystem", "description": "Name of the filesystem",
"name": "name", "name": "storage",
"in": "path", "in": "path",
"required": true "required": true
}, },
{ {
"type": "string", "type": "string",
"description": "Path to file", "description": "Path to file",
"name": "path", "name": "filepath",
"in": "path", "in": "path",
"required": true "required": true
} }

28
docs/swagger.yaml
View file

@ -2126,7 +2126,9 @@ paths:
security: security:
- ApiKeyAuth: [] - ApiKeyAuth: []
summary: List all registered filesystems summary: List all registered filesystems
/api/v3/fs/{name}: tags:
- v16.12.0
/api/v3/fs/{storage}:
get: get:
description: List all files on a filesystem. The listing can be ordered by name, description: List all files on a filesystem. The listing can be ordered by name,
size, or date of last modification in ascending or descending order. size, or date of last modification in ascending or descending order.
@ -2134,7 +2136,7 @@ paths:
parameters: parameters:
- description: Name of the filesystem - description: Name of the filesystem
in: path in: path
name: name name: storage
required: true required: true
type: string type: string
- description: glob pattern for file names - description: glob pattern for file names
@ -2161,19 +2163,21 @@ paths:
security: security:
- ApiKeyAuth: [] - ApiKeyAuth: []
summary: List all files on a filesystem summary: List all files on a filesystem
/api/v3/fs/{name}/{path}: tags:
- v16.7.2
/api/v3/fs/{storage}/{filepath}:
delete: delete:
description: Remove a file from a filesystem description: Remove a file from a filesystem
operationId: filesystem-3-delete-file operationId: filesystem-3-delete-file
parameters: parameters:
- description: Name of the filesystem - description: Name of the filesystem
in: path in: path
name: name name: storage
required: true required: true
type: string type: string
- description: Path to file - description: Path to file
in: path in: path
name: path name: filepath
required: true required: true
type: string type: string
produces: produces:
@ -2190,18 +2194,20 @@ paths:
security: security:
- ApiKeyAuth: [] - ApiKeyAuth: []
summary: Remove a file from a filesystem summary: Remove a file from a filesystem
tags:
- v16.7.2
get: get:
description: Fetch a file from a filesystem description: Fetch a file from a filesystem
operationId: filesystem-3-get-file operationId: filesystem-3-get-file
parameters: parameters:
- description: Name of the filesystem - description: Name of the filesystem
in: path in: path
name: name name: storage
required: true required: true
type: string type: string
- description: Path to file - description: Path to file
in: path in: path
name: path name: filepath
required: true required: true
type: string type: string
produces: produces:
@ -2223,6 +2229,8 @@ paths:
security: security:
- ApiKeyAuth: [] - ApiKeyAuth: []
summary: Fetch a file from a filesystem summary: Fetch a file from a filesystem
tags:
- v16.7.2
put: put:
consumes: consumes:
- application/data - application/data
@ -2231,12 +2239,12 @@ paths:
parameters: parameters:
- description: Name of the filesystem - description: Name of the filesystem
in: path in: path
name: name name: storage
required: true required: true
type: string type: string
- description: Path to file - description: Path to file
in: path in: path
name: path name: filepath
required: true required: true
type: string type: string
- description: File data - description: File data
@ -2266,6 +2274,8 @@ paths:
security: security:
- ApiKeyAuth: [] - ApiKeyAuth: []
summary: Add a file to a filesystem summary: Add a file to a filesystem
tags:
- v16.7.2
/api/v3/log: /api/v3/log:
get: get:
description: Get the last log lines of the Restreamer application description: Get the last log lines of the Restreamer application

27
http/handler/api/filesystems.go
View file

@ -31,16 +31,17 @@ func NewFS(filesystems map[string]FSConfig) *FSHandler {
// GetFileAPI returns the file at the given path // GetFileAPI returns the file at the given path
// @Summary Fetch a file from a filesystem // @Summary Fetch a file from a filesystem
// @Description Fetch a file from a filesystem // @Description Fetch a file from a filesystem
// @Tags v16.7.2
// @ID filesystem-3-get-file // @ID filesystem-3-get-file
// @Produce application/data // @Produce application/data
// @Produce json // @Produce json
// @Param name path string true "Name of the filesystem" // @Param storage path string true "Name of the filesystem"
// @Param path path string true "Path to file" // @Param filepath path string true "Path to file"
// @Success 200 {file} byte // @Success 200 {file} byte
// @Success 301 {string} string // @Success 301 {string} string
// @Failure 404 {object} api.Error // @Failure 404 {object} api.Error
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Router /api/v3/fs/{name}/{path} [get] // @Router /api/v3/fs/{storage}/{filepath} [get]
func (h *FSHandler) GetFile(c echo.Context) error { func (h *FSHandler) GetFile(c echo.Context) error {
name := util.PathParam(c, "name") name := util.PathParam(c, "name")
@ -55,18 +56,19 @@ func (h *FSHandler) GetFile(c echo.Context) error {
// PutFileAPI adds or overwrites a file at the given path // PutFileAPI adds or overwrites a file at the given path
// @Summary Add a file to a filesystem // @Summary Add a file to a filesystem
// @Description Writes or overwrites a file on a filesystem // @Description Writes or overwrites a file on a filesystem
// @Tags v16.7.2
// @ID filesystem-3-put-file // @ID filesystem-3-put-file
// @Accept application/data // @Accept application/data
// @Produce text/plain // @Produce text/plain
// @Produce json // @Produce json
// @Param name path string true "Name of the filesystem" // @Param storage path string true "Name of the filesystem"
// @Param path path string true "Path to file" // @Param filepath path string true "Path to file"
// @Param data body []byte true "File data" // @Param data body []byte true "File data"
// @Success 201 {string} string // @Success 201 {string} string
// @Success 204 {string} string // @Success 204 {string} string
// @Failure 507 {object} api.Error // @Failure 507 {object} api.Error
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Router /api/v3/fs/{name}/{path} [put] // @Router /api/v3/fs/{storage}/{filepath} [put]
func (h *FSHandler) PutFile(c echo.Context) error { func (h *FSHandler) PutFile(c echo.Context) error {
name := util.PathParam(c, "name") name := util.PathParam(c, "name")
@ -81,14 +83,15 @@ func (h *FSHandler) PutFile(c echo.Context) error {
// DeleteFileAPI removes a file from a filesystem // DeleteFileAPI removes a file from a filesystem
// @Summary Remove a file from a filesystem // @Summary Remove a file from a filesystem
// @Description Remove a file from a filesystem // @Description Remove a file from a filesystem
// @Tags v16.7.2
// @ID filesystem-3-delete-file // @ID filesystem-3-delete-file
// @Produce text/plain // @Produce text/plain
// @Param name path string true "Name of the filesystem" // @Param storage path string true "Name of the filesystem"
// @Param path path string true "Path to file" // @Param filepath path string true "Path to file"
// @Success 200 {string} string // @Success 200 {string} string
// @Failure 404 {object} api.Error // @Failure 404 {object} api.Error
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Router /api/v3/fs/{name}/{path} [delete] // @Router /api/v3/fs/{storage}/{filepath} [delete]
func (h *FSHandler) DeleteFile(c echo.Context) error { func (h *FSHandler) DeleteFile(c echo.Context) error {
name := util.PathParam(c, "name") name := util.PathParam(c, "name")
@ -103,15 +106,16 @@ func (h *FSHandler) DeleteFile(c echo.Context) error {
// ListFiles lists all files on a filesystem // ListFiles lists all files on a filesystem
// @Summary List all files on a filesystem // @Summary List all files on a filesystem
// @Description List all files on a filesystem. The listing can be ordered by name, size, or date of last modification in ascending or descending order. // @Description List all files on a filesystem. The listing can be ordered by name, size, or date of last modification in ascending or descending order.
// @Tags v16.7.2
// @ID filesystem-3-list-files // @ID filesystem-3-list-files
// @Produce json // @Produce json
// @Param name path string true "Name of the filesystem" // @Param storage path string true "Name of the filesystem"
// @Param glob query string false "glob pattern for file names" // @Param glob query string false "glob pattern for file names"
// @Param sort query string false "none, name, size, lastmod" // @Param sort query string false "none, name, size, lastmod"
// @Param order query string false "asc, desc" // @Param order query string false "asc, desc"
// @Success 200 {array} api.FileInfo // @Success 200 {array} api.FileInfo
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Router /api/v3/fs/{name} [get] // @Router /api/v3/fs/{storage} [get]
func (h *FSHandler) ListFiles(c echo.Context) error { func (h *FSHandler) ListFiles(c echo.Context) error {
name := util.PathParam(c, "name") name := util.PathParam(c, "name")
@ -126,6 +130,7 @@ func (h *FSHandler) ListFiles(c echo.Context) error {
// List lists all registered filesystems // List lists all registered filesystems
// @Summary List all registered filesystems // @Summary List all registered filesystems
// @Description Listall registered filesystems // @Description Listall registered filesystems
// @Tags v16.12.0
// @ID filesystem-3-list // @ID filesystem-3-list
// @Produce json // @Produce json
// @Success 200 {array} api.FilesystemInfo // @Success 200 {array} api.FilesystemInfo