Skip to content

extension.md

Latest commit

 

History

History
76 lines (60 loc) · 1.64 KB

extension.md

File metadata and controls

76 lines (60 loc) · 1.64 KB
Raw

API: Extension

Navigation

APIs

GET /api/extensions

Get all extensions.

Response

[
    {
        "id": "e4eaaaf3-3c3b-11e8-b467-0ed5f89f718b",
        "name": "Example Extension",
        "description": "This is an example extension.",
        "version": "1.0.0",
        "author": "Example Author",
        "url": "https://example.com",
        "authorUrl": "https://example.com",
        "urls":{
            "static": "localhost:3000/extensions/e4eaaaf3-3c3b-11e8-b467-0ed5f89f718b/static/",
            "api": "localhost:3000/extensions/e4eaaaf3-3c3b-11e8-b467-0ed5f89f718b/api/",
        }
    }
]

GET /api/extensions/:id

Get an extension.

Response

{
    "id": "e4eaaaf3-3c3b-11e8-b467-0ed5f89f718b",
    "name": "Example Extension",
    "description": "This is an example extension.",
    "version": "1.0.0",
    "author": "Example Author",
    "url": "https://example.com",
    "authorUrl": "https://example.com",
    "urls":{
        "static": "localhost:3000/extensions/e4eaaaf3-3c3b-11e8-b467-0ed5f89f718b/static/",
        "api": "localhost:3000/extensions/e4eaaaf3-3c3b-11e8-b467-0ed5f89f718b/api/",
    }
}

GET /api/extensions/:id/events

Get all events of an extension.

Response

[
    {
        "name": "some-event",
        "description": "This is an example event.",
    }
]