apps/core
1
0
Fork 0
mirror of https://github.com/datarhei/core.git synced 2025-09-26 20:11:29 +08:00
Code Issues Packages Projects Releases Wiki Activity

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

33
docs/swagger.json
View File

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

28
docs/swagger.yaml
View File

@@ -2126,7 +2126,9 @@ paths:
security:
- ApiKeyAuth: []
summary: List all registered filesystems
/api/v3/fs/{name}:
tags:
- v16.12.0
/api/v3/fs/{storage}:
get:
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.
@@ -2134,7 +2136,7 @@ paths:
parameters:
- description: Name of the filesystem
in: path
name: name
name: storage
required: true
type: string
- description: glob pattern for file names
@@ -2161,19 +2163,21 @@ paths:
security:
- ApiKeyAuth: []
summary: List all files on a filesystem
/api/v3/fs/{name}/{path}:
tags:
- v16.7.2
/api/v3/fs/{storage}/{filepath}:
delete:
description: Remove a file from a filesystem
operationId: filesystem-3-delete-file
parameters:
- description: Name of the filesystem
in: path
name: name
name: storage
required: true
type: string
- description: Path to file
in: path
name: path
name: filepath
required: true
type: string
produces:
@@ -2190,18 +2194,20 @@ paths:
security:
- ApiKeyAuth: []
summary: Remove a file from a filesystem
tags:
- v16.7.2
get:
description: Fetch a file from a filesystem
operationId: filesystem-3-get-file
parameters:
- description: Name of the filesystem
in: path
name: name
name: storage
required: true
type: string
- description: Path to file
in: path
name: path
name: filepath
required: true
type: string
produces:
@@ -2223,6 +2229,8 @@ paths:
security:
- ApiKeyAuth: []
summary: Fetch a file from a filesystem
tags:
- v16.7.2
put:
consumes:
- application/data
@@ -2231,12 +2239,12 @@ paths:
parameters:
- description: Name of the filesystem
in: path
name: name
name: storage
required: true
type: string
- description: Path to file
in: path
name: path
name: filepath
required: true
type: string
- description: File data
@@ -2266,6 +2274,8 @@ paths:
security:
- ApiKeyAuth: []
summary: Add a file to a filesystem
tags:
- v16.7.2
/api/v3/log:
get:
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
// @Summary Fetch a file from a filesystem
// @Description Fetch a file from a filesystem
// @Tags v16.7.2
// @ID filesystem-3-get-file
// @Produce application/data
// @Produce json
// @Param name path string true "Name of the filesystem"
// @Param path path string true "Path to file"
// @Param storage path string true "Name of the filesystem"
// @Param filepath path string true "Path to file"
// @Success 200 {file} byte
// @Success 301 {string} string
// @Failure 404 {object} api.Error
// @Security ApiKeyAuth
// @Router /api/v3/fs/{name}/{path} [get]
// @Router /api/v3/fs/{storage}/{filepath} [get]
func (h *FSHandler) GetFile(c echo.Context) error {
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
// @Summary Add a file to a filesystem
// @Description Writes or overwrites a file on a filesystem
// @Tags v16.7.2
// @ID filesystem-3-put-file
// @Accept application/data
// @Produce text/plain
// @Produce json
// @Param name path string true "Name of the filesystem"
// @Param path path string true "Path to file"
// @Param storage path string true "Name of the filesystem"
// @Param filepath path string true "Path to file"
// @Param data body []byte true "File data"
// @Success 201 {string} string
// @Success 204 {string} string
// @Failure 507 {object} api.Error
// @Security ApiKeyAuth
// @Router /api/v3/fs/{name}/{path} [put]
// @Router /api/v3/fs/{storage}/{filepath} [put]
func (h *FSHandler) PutFile(c echo.Context) error {
name := util.PathParam(c, "name")
@@ -81,14 +83,15 @@ func (h *FSHandler) PutFile(c echo.Context) error {
// DeleteFileAPI removes a file from a filesystem
// @Summary Remove a file from a filesystem
// @Description Remove a file from a filesystem
// @Tags v16.7.2
// @ID filesystem-3-delete-file
// @Produce text/plain
// @Param name path string true "Name of the filesystem"
// @Param path path string true "Path to file"
// @Param storage path string true "Name of the filesystem"
// @Param filepath path string true "Path to file"
// @Success 200 {string} string
// @Failure 404 {object} api.Error
// @Security ApiKeyAuth
// @Router /api/v3/fs/{name}/{path} [delete]
// @Router /api/v3/fs/{storage}/{filepath} [delete]
func (h *FSHandler) DeleteFile(c echo.Context) error {
name := util.PathParam(c, "name")
@@ -103,15 +106,16 @@ func (h *FSHandler) DeleteFile(c echo.Context) error {
// ListFiles lists 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.
// @Tags v16.7.2
// @ID filesystem-3-list-files
// @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 sort query string false "none, name, size, lastmod"
// @Param order query string false "asc, desc"
// @Success 200 {array} api.FileInfo
// @Security ApiKeyAuth
// @Router /api/v3/fs/{name} [get]
// @Router /api/v3/fs/{storage} [get]
func (h *FSHandler) ListFiles(c echo.Context) error {
name := util.PathParam(c, "name")
@@ -126,6 +130,7 @@ func (h *FSHandler) ListFiles(c echo.Context) error {
// List lists all registered filesystems
// @Summary List all registered filesystems
// @Description Listall registered filesystems
// @Tags v16.12.0
// @ID filesystem-3-list
// @Produce json
// @Success 200 {array} api.FilesystemInfo