78 lines
1.6 KiB
JSON
78 lines
1.6 KiB
JSON
{
|
|
"Title": "Settings",
|
|
"Interface": "Settings",
|
|
"Struct": [
|
|
{
|
|
"imports": [
|
|
"github.com/cortezaproject/corteza-server/pkg/settings"
|
|
]
|
|
}
|
|
],
|
|
"Parameters": null,
|
|
"Protocol": "",
|
|
"Authentication": [],
|
|
"Path": "/settings",
|
|
"APIs": [
|
|
{
|
|
"Name": "list",
|
|
"Method": "GET",
|
|
"Title": "List settings",
|
|
"Path": "/",
|
|
"Parameters": {
|
|
"get": [
|
|
{
|
|
"name": "prefix",
|
|
"title": "Key prefix",
|
|
"type": "string"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"Name": "update",
|
|
"Method": "PATCH",
|
|
"Title": "Update settings",
|
|
"Path": "/",
|
|
"Parameters": {
|
|
"post": [
|
|
{
|
|
"name": "values",
|
|
"required": true,
|
|
"title": "Array of new settings: `[{ name: ..., value: ... }]`. Omit value to remove setting",
|
|
"type": "settings.ValueSet"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"Name": "get",
|
|
"Method": "GET",
|
|
"Title": "Get a value for a key",
|
|
"Path": "/{key}",
|
|
"Parameters": {
|
|
"get": [
|
|
{
|
|
"name": "ownerID",
|
|
"title": "Owner ID",
|
|
"type": "uint64"
|
|
}
|
|
],
|
|
"path": [
|
|
{
|
|
"name": "key",
|
|
"required": true,
|
|
"title": "Setting key",
|
|
"type": "string"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"Name": "current",
|
|
"Method": "GET",
|
|
"Title": "Current compose settings",
|
|
"Path": "/current",
|
|
"Parameters": null
|
|
}
|
|
]
|
|
} |