plugins Package

plugins Package

views Module

class lemur.plugins.views.Plugins

Bases: lemur.auth.service.AuthenticatedResource

Defines the ‘plugins’ endpoint

endpoint = 'pluginName'
get(name)
GET /plugins/<name>

The current plugin list

Example request:

GET /plugins HTTP/1.1
Host: example.com
Accept: application/json, text/javascript

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: text/javascript

{
    "accountNumber": 222222222,
    "label": "account2",
    "description": "this is a thing"
}
Request Headers:
 
Status Codes:
mediatypes()
methods = ['GET']
class lemur.plugins.views.PluginsList

Bases: lemur.auth.service.AuthenticatedResource

Defines the ‘plugins’ endpoint

endpoint = 'plugins'
get()
GET /plugins

The current plugin list

Example request:

GET /plugins HTTP/1.1
Host: example.com
Accept: application/json, text/javascript

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: text/javascript

{
  "items": [
      {
        "id": 2,
        "accountNumber": 222222222,
        "label": "account2",
        "description": "this is a thing"
      },
      {
        "id": 1,
        "accountNumber": 11111111111,
        "label": "account1",
        "description": "this is a thing"
      },
    ]
  "total": 2
}
Request Headers:
 
Status Codes:
mediatypes()
methods = ['GET']