apps/core
1
0
Fork 0
mirror of https://github.com/datarhei/core.git synced 2025-10-05 07:57:13 +08:00
Code Issues Packages Projects Releases Wiki Activity

Fix wrong path for swagger definition

Browse Source
This commit is contained in:
Ingo Oppermann
2022-08-18 10:13:00 +03:00
parent 1ab09adc69
commit 5bd04817cc
5 changed files with 129 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
docs/docs.go
View File

@@ -302,7 +302,7 @@ const docTemplate = `{
}
}
},
"/api/v3/fs/disk/": {
"/api/v3/fs/disk": {
"get": {
"security": [
{
@@ -487,7 +487,7 @@ const docTemplate = `{
}
}
},
"/api/v3/fs/mem/": {
"/api/v3/fs/mem": {
"get": {
"security": [
{
@@ -897,21 +897,33 @@ const docTemplate = `{
"parameters": [
{
"type": "string",
"description": "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",
"description": "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.",
"name": "filter",
"in": "query"
},
{
"type": "string",
"description": "Return only these process that have this reference value. Overrides a list of IDs. If empty, the reference will be ignored",
"description": "Return only these process that have this reference value. If empty, the reference will be ignored.",
"name": "reference",
"in": "query"
},
{
"type": "string",
"description": "Comma separated list of process ids to list",
"description": "Comma separated list of process ids to list. Overrides the reference. If empty all IDs will be returned.",
"name": "id",
"in": "query"
},
{
"type": "string",
"description": "Glob pattern for process IDs. If empty all IDs will be returned. Intersected with results from refpattern.",
"name": "idpattern",
"in": "query"
},
{
"type": "string",
"description": "Glob pattern for process references. If empty all IDs will be returned. Intersected with results from idpattern.",
"name": "refpattern",
"in": "query"
}
],
"responses": {
@@ -2733,9 +2745,20 @@ const docTemplate = `{
"type": "integer"
},
"types": {
"type": "array",
"items": {
"type": "string"
"type": "object",
"properties": {
"allow": {
"type": "array",
"items": {
"type": "string"
}
},
"block": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
@@ -4330,9 +4353,20 @@ const docTemplate = `{
"type": "integer"
},
"types": {
"type": "array",
"items": {
"type": "string"
"type": "object",
"properties": {
"allow": {
"type": "array",
"items": {
"type": "string"
}
},
"block": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}

56
docs/swagger.json
View File

@@ -294,7 +294,7 @@
}
}
},
"/api/v3/fs/disk/": {
"/api/v3/fs/disk": {
"get": {
"security": [
{
@@ -479,7 +479,7 @@
}
}
},
"/api/v3/fs/mem/": {
"/api/v3/fs/mem": {
"get": {
"security": [
{
@@ -889,21 +889,33 @@
"parameters": [
{
"type": "string",
"description": "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",
"description": "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.",
"name": "filter",
"in": "query"
},
{
"type": "string",
"description": "Return only these process that have this reference value. Overrides a list of IDs. If empty, the reference will be ignored",
"description": "Return only these process that have this reference value. If empty, the reference will be ignored.",
"name": "reference",
"in": "query"
},
{
"type": "string",
"description": "Comma separated list of process ids to list",
"description": "Comma separated list of process ids to list. Overrides the reference. If empty all IDs will be returned.",
"name": "id",
"in": "query"
},
{
"type": "string",
"description": "Glob pattern for process IDs. If empty all IDs will be returned. Intersected with results from refpattern.",
"name": "idpattern",
"in": "query"
},
{
"type": "string",
"description": "Glob pattern for process references. If empty all IDs will be returned. Intersected with results from idpattern.",
"name": "refpattern",
"in": "query"
}
],
"responses": {
@@ -2725,9 +2737,20 @@
"type": "integer"
},
"types": {
"type": "array",
"items": {
"type": "string"
"type": "object",
"properties": {
"allow": {
"type": "array",
"items": {
"type": "string"
}
},
"block": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
@@ -4322,9 +4345,20 @@
"type": "integer"
},
"types": {
"type": "array",
"items": {
"type": "string"
"type": "object",
"properties": {
"allow": {
"type": "array",
"items": {
"type": "string"
}
},
"block": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}

49
docs/swagger.yaml
View File

@@ -345,9 +345,16 @@ definitions:
ttl_seconds:
type: integer
types:
items:
type: string
type: array
properties:
allow:
items:
type: string
type: array
block:
items:
type: string
type: array
type: object
type: object
dir:
type: string
@@ -1450,9 +1457,16 @@ definitions:
ttl_seconds:
type: integer
types:
items:
type: string
type: array
properties:
allow:
items:
type: string
type: array
block:
items:
type: string
type: array
type: object
type: object
dir:
type: string
@@ -1897,7 +1911,7 @@ paths:
security:
- ApiKeyAuth: []
summary: Reload the currently active configuration
/api/v3/fs/disk/:
/api/v3/fs/disk:
get:
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.
@@ -2018,7 +2032,7 @@ paths:
security:
- ApiKeyAuth: []
summary: Add a file to the filesystem
/api/v3/fs/mem/:
/api/v3/fs/mem:
get:
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.
@@ -2284,19 +2298,30 @@ paths:
parameters:
- description: 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
output.
in: query
name: filter
type: string
- description: Return only these process that have this reference value. Overrides
a list of IDs. If empty, the reference will be ignored
- description: Return only these process that have this reference value. If
empty, the reference will be ignored.
in: query
name: reference
type: string
- description: Comma separated list of process ids to list
- description: Comma separated list of process ids to list. Overrides the reference.
If empty all IDs will be returned.
in: query
name: id
type: string
- description: Glob pattern for process IDs. If empty all IDs will be returned.
Intersected with results from refpattern.
in: query
name: idpattern
type: string
- description: Glob pattern for process references. If empty all IDs will be
returned. Intersected with results from idpattern.
in: query
name: refpattern
type: string
produces:
- application/json
responses:

2
http/handler/api/diskfs.go
View File

@@ -160,7 +160,7 @@ func (h *DiskFSHandler) DeleteFile(c echo.Context) error {
// @Param order query string false "asc, desc"
// @Success 200 {array} api.FileInfo
// @Security ApiKeyAuth
// @Router /api/v3/fs/disk/ [get]
// @Router /api/v3/fs/disk [get]
func (h *DiskFSHandler) ListFiles(c echo.Context) error {
pattern := util.DefaultQuery(c, "glob", "")
sortby := util.DefaultQuery(c, "sort", "none")

2
http/handler/api/memfs.go
View File

@@ -125,7 +125,7 @@ func (h *MemFSHandler) PatchFile(c echo.Context) error {
// @Param order query string false "asc, desc"
// @Success 200 {array} api.FileInfo
// @Security ApiKeyAuth
// @Router /api/v3/fs/mem/ [get]
// @Router /api/v3/fs/mem [get]
func (h *MemFSHandler) ListFiles(c echo.Context) error {
pattern := util.DefaultQuery(c, "glob", "")
sortby := util.DefaultQuery(c, "sort", "none")