Skip to content

Plugin Support #80

@mertssmnoglu

Description

@mertssmnoglu

Make capture more extendable with 3rd party plugins.

[Draft] Plugin API Contract

StatusCode(Required) Body(Optional) Description
0 All system operational. Success 🟢
1 This feature will be deprecated soon. Warning ⚠️
2 Unable to retrieve data. Failure 🔴
3 I don't know. Unknown ⚫
[
    // SUCCESS
    {
        "status_code": 0,
        "body": "All system operational."
    },

    // WARNING
    {
        "status_code": 1,
        "body": "This feature will be deprecated soon."
    },

    // FAILURE
    {
        "status_code": 2,
        "body": "Unable to retrieve data."
    },

    // UNKNOWN
    {
        "status_code": 3,
        "body": "I don't know."
    }
]

How to store plugins?

Plugin Configuration

# YAML
plugins:
  - name: my_custom_plugin
    location: "./plugins/my_custom_plugin"
// JSON
{
    "plugins": [
        {
            "name": "my_custom_plugin",
            "location": "./plugins/my_custom_plugin"
        }
    ]
}

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    Status

    No status

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions