github
/
nocodb
mirror of https://github.com/nocodb/nocodb
1
0
Fork 0
Code Issues Releases Wiki Activity
Browse Source

refactor(nocodb): plugin model in swagger.json

pull/5222/head
Wing-Kam Wong 2 years ago
parent
91a63f76dd
commit
19d9849341
1 changed files with 82 additions and 51 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 133
      packages/nocodb/src/schema/swagger.json

133
packages/nocodb/src/schema/swagger.json
Unescape View File

@ -10865,47 +10865,58 @@
"description": "Model for Plugin", "description": "Model for Plugin",
"examples": [ "examples": [
{ {
"id": "nc_tljibbzcyjrhcc",
"title": "S3",
"description": "Amazon Simple Storage Service (Amazon S3) is an object storage service that offers industry-leading scalability, data availability, security, and performance.",
"active": true, "active": true,
"category": "string", "rating": null,
"creator": "string", "version": "0.0.1",
"creator_website": "string", "docs": null,
"description": "string", "status": "install",
"docs": "string", "status_details": null,
"icon": "string", "logo": "plugins/s3.png",
"id": "string", "icon": null,
"input": 0, "tags": "Storage",
"input_schema": "string", "category": "Storage",
"logo": "string", "input_schema": "{\"title\":\"Configure Amazon S3\",\"items\":[{\"key\":\"bucket\",\"label\":\"Bucket Name\",\"placeholder\":\"Bucket Name\",\"type\":\"SingleLineText\",\"required\":true},{\"key\":\"region\",\"label\":\"Region\",\"placeholder\":\"Region\",\"type\":\"SingleLineText\",\"required\":true},{\"key\":\"access_key\",\"label\":\"Access Key\",\"placeholder\":\"Access Key\",\"type\":\"SingleLineText\",\"required\":true},{\"key\":\"access_secret\",\"label\":\"Access Secret\",\"placeholder\":\"Access Secret\",\"type\":\"Password\",\"required\":true}],\"actions\":[{\"label\":\"Test\",\"placeholder\":\"Test\",\"key\":\"test\",\"actionType\":\"TEST\",\"type\":\"Button\"},{\"label\":\"Save\",\"placeholder\":\"Save\",\"key\":\"save\",\"actionType\":\"SUBMIT\",\"type\":\"Button\"}],\"msgOnInstall\":\"Successfully installed and attachment will be stored in AWS S3\",\"msgOnUninstall\":\"\"}",
"price": "string", "input": "{\"bucket\":\"my-bucket\",\"region\":\"us-west-004\",\"access_key\":\"redacted\",\"access_secret\":\"redacted\"}",
"rating": 0, "creator": null,
"status": "string", "creator_website": null,
"status_details": "string", "price": null
"tags": "string",
"title": "string",
"version": "string"
} }
], ],
"title": "Plugin Model",
"type": "object",
"properties": { "properties": {
"active": { "active": {
"$ref": "#/components/schemas/Bool" "$ref": "#/components/schemas/Bool",
"description": "Is plguin active?"
}, },
"category": { "category": {
"type": "string" "type": "string",
"description": "Plugin Category",
"example": "Storage"
}, },
"creator": { "creator": {
"type": "string" "type": "string",
"description": "Plugin Creator (Not in use)"
}, },
"creator_website": { "creator_website": {
"type": "string" "type": "string",
"description": "Plugin Creator website (Not in use)"
}, },
"description": { "description": {
"type": "string" "type": "string",
"description": "Plugin Description",
"example": "Amazon Simple Storage Service (Amazon S3) is an object storage service that offers industry-leading scalability, data availability, security, and performance."
}, },
"docs": { "docs": {
"type": "string" "type": "string",
"description": "Documentation of plugin (Not in use)"
}, },
"icon": { "icon": {
"type": "string" "type": "string",
"description": "Plugin Icon (Not in use)"
}, },
"id": { "id": {
"$ref": "#/components/schemas/Id", "$ref": "#/components/schemas/Id",
@ -10919,74 +10930,94 @@
{ {
"type": "integer" "type": "integer"
} }
] ],
"description": "Plugin Input"
}, },
"input_schema": { "input_schema": {
"type": "string" "type": "string",
"description": "Plugin Input Schema\n"
}, },
"logo": { "logo": {
"type": "string" "type": "string",
"description": "Plugin logo",
"example": "plugins/s3.png"
}, },
"price": { "price": {
"type": "string" "type": "string",
"description": "Plugin Price (Not in use)"
}, },
"rating": { "rating": {
"type": "number" "type": "number",
"description": "Plugin Rating (Not in use)"
}, },
"status": { "status": {
"type": "string" "type": "string",
"description": "Plugin Status",
"example": "install"
}, },
"status_details": { "status_details": {
"type": "string" "type": "string",
"description": "Not in use"
}, },
"tags": { "tags": {
"type": "string" "type": "string",
"description": "Plugin tags",
"example": "Storage"
}, },
"title": { "title": {
"type": "string" "type": "string",
"description": "Plugin Title"
}, },
"version": { "version": {
"type": "string" "type": "string",
"description": "Plugin Version",
"example": "0.0.1"
} }
}, }
"title": "Plugin Model",
"type": "object"
}, },
"PluginReq": { "PluginReq": {
"description": "Model for Plugin Request", "description": "Model for Plugin Request",
"examples": [ "examples": [
{ {
"active": true, "active": 0,
"input": null "input": "{\"bucket\":\"my-bucket\",\"region\":\"us-west-004\",\"access_key\":\"redacted\",\"access_secret\":\"redacted\"}"
} }
], ],
"title": "Plugin Reqeust",
"type": "object",
"properties": { "properties": {
"active": { "active": {
"$ref": "#/components/schemas/Bool" "$ref": "#/components/schemas/Bool",
"description": "Is Plugin Active?"
}, },
"input": {} "input": {
}, "type": "string",
"title": "Plugin Reqeust", "description": "Plugin Input"
"type": "object" }
}
}, },
"PluginTestReq": { "PluginTestReq": {
"description": "Model for Plugin Test Request", "description": "Model for Plugin Test Request",
"examples": [ "examples": [
{ {
"input": null, "title": "Plugin Foo",
"title": "string" "input": "{\"bucket\":\"my-bucket\",\"region\":\"us-west-004\",\"access_key\":\"redacted\",\"access_secret\":\"redacted\"}"
} }
], ],
"title": "Plugin Test Request Model",
"type": "object",
"properties": { "properties": {
"input": {},
"title": { "title": {
"maxLength": 45, "maxLength": 45,
"type": "string" "type": "string",
"description": "Plugin Title"
},
"input": {
"type": "string",
"description": "Plugin Input"
} }
}, },
"required": ["input", "title"], "required": ["title", "input"]
"title": "Plugin Test Request Model",
"type": "object"
}, },
"Project": { "Project": {
"description": "Model for Project", "description": "Model for Project",

Write Preview
Loading…
Cancel
Save