apps/core
1
0
Fork 0
mirror of https://github.com/datarhei/core.git synced 2025-10-05 16:07:07 +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

44
docs/docs.go
View File

@@ -302,7 +302,7 @@ const docTemplate = `{
} }
} }
}, },
"/api/v3/fs/disk/": { "/api/v3/fs/disk": {
"get": { "get": {
"security": [ "security": [
{ {
@@ -487,7 +487,7 @@ const docTemplate = `{
} }
} }
}, },
"/api/v3/fs/mem/": { "/api/v3/fs/mem": {
"get": { "get": {
"security": [ "security": [
{ {
@@ -897,21 +897,33 @@ const docTemplate = `{
"parameters": [ "parameters": [
{ {
"type": "string", "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", "name": "filter",
"in": "query" "in": "query"
}, },
{ {
"type": "string", "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", "name": "reference",
"in": "query" "in": "query"
}, },
{ {
"type": "string", "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", "name": "id",
"in": "query" "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": { "responses": {
@@ -2733,10 +2745,21 @@ const docTemplate = `{
"type": "integer" "type": "integer"
}, },
"types": { "types": {
"type": "object",
"properties": {
"allow": {
"type": "array", "type": "array",
"items": { "items": {
"type": "string" "type": "string"
} }
},
"block": {
"type": "array",
"items": {
"type": "string"
}
}
}
} }
} }
}, },
@@ -4330,10 +4353,21 @@ const docTemplate = `{
"type": "integer" "type": "integer"
}, },
"types": { "types": {
"type": "object",
"properties": {
"allow": {
"type": "array", "type": "array",
"items": { "items": {
"type": "string" "type": "string"
} }
},
"block": {
"type": "array",
"items": {
"type": "string"
}
}
}
} }
} }
}, },

44
docs/swagger.json
View File

@@ -294,7 +294,7 @@
} }
} }
}, },
"/api/v3/fs/disk/": { "/api/v3/fs/disk": {
"get": { "get": {
"security": [ "security": [
{ {
@@ -479,7 +479,7 @@
} }
} }
}, },
"/api/v3/fs/mem/": { "/api/v3/fs/mem": {
"get": { "get": {
"security": [ "security": [
{ {
@@ -889,21 +889,33 @@
"parameters": [ "parameters": [
{ {
"type": "string", "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", "name": "filter",
"in": "query" "in": "query"
}, },
{ {
"type": "string", "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", "name": "reference",
"in": "query" "in": "query"
}, },
{ {
"type": "string", "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", "name": "id",
"in": "query" "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": { "responses": {
@@ -2725,10 +2737,21 @@
"type": "integer" "type": "integer"
}, },
"types": { "types": {
"type": "object",
"properties": {
"allow": {
"type": "array", "type": "array",
"items": { "items": {
"type": "string" "type": "string"
} }
},
"block": {
"type": "array",
"items": {
"type": "string"
}
}
}
} }
} }
}, },
@@ -4322,10 +4345,21 @@
"type": "integer" "type": "integer"
}, },
"types": { "types": {
"type": "object",
"properties": {
"allow": {
"type": "array", "type": "array",
"items": { "items": {
"type": "string" "type": "string"
} }
},
"block": {
"type": "array",
"items": {
"type": "string"
}
}
}
} }
} }
}, },

37
docs/swagger.yaml
View File

@@ -345,9 +345,16 @@ definitions:
ttl_seconds: ttl_seconds:
type: integer type: integer
types: types:
properties:
allow:
items: items:
type: string type: string
type: array type: array
block:
items:
type: string
type: array
type: object
type: object type: object
dir: dir:
type: string type: string
@@ -1450,9 +1457,16 @@ definitions:
ttl_seconds: ttl_seconds:
type: integer type: integer
types: types:
properties:
allow:
items: items:
type: string type: string
type: array type: array
block:
items:
type: string
type: array
type: object
type: object type: object
dir: dir:
type: string type: string
@@ -1897,7 +1911,7 @@ paths:
security: security:
- ApiKeyAuth: [] - ApiKeyAuth: []
summary: Reload the currently active configuration summary: Reload the currently active configuration
/api/v3/fs/disk/: /api/v3/fs/disk:
get: get:
description: List all files on the filesystem. The listing can be ordered by 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. name, size, or date of last modification in ascending or descending order.
@@ -2018,7 +2032,7 @@ paths:
security: security:
- ApiKeyAuth: [] - ApiKeyAuth: []
summary: Add a file to the filesystem summary: Add a file to the filesystem
/api/v3/fs/mem/: /api/v3/fs/mem:
get: get:
description: List all files on the memory filesystem. The listing can be ordered 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. by name, size, or date of last modification in ascending or descending order.
@@ -2284,19 +2298,30 @@ paths:
parameters: parameters:
- description: Comma separated list of fields (config, state, report, metadata) - 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 that will be part of the output. If empty, all fields will be part of the
output output.
in: query in: query
name: filter name: filter
type: string type: string
- description: Return only these process that have this reference value. Overrides - description: Return only these process that have this reference value. If
a list of IDs. If empty, the reference will be ignored empty, the reference will be ignored.
in: query in: query
name: reference name: reference
type: string 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 in: query
name: id name: id
type: string 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: produces:
- application/json - application/json
responses: 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" // @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/disk/ [get] // @Router /api/v3/fs/disk [get]
func (h *DiskFSHandler) ListFiles(c echo.Context) error { func (h *DiskFSHandler) ListFiles(c echo.Context) error {
pattern := util.DefaultQuery(c, "glob", "") pattern := util.DefaultQuery(c, "glob", "")
sortby := util.DefaultQuery(c, "sort", "none") 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" // @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/mem/ [get] // @Router /api/v3/fs/mem [get]
func (h *MemFSHandler) ListFiles(c echo.Context) error { func (h *MemFSHandler) ListFiles(c echo.Context) error {
pattern := util.DefaultQuery(c, "glob", "") pattern := util.DefaultQuery(c, "glob", "")
sortby := util.DefaultQuery(c, "sort", "none") sortby := util.DefaultQuery(c, "sort", "none")