data.swagger.api-docs.marketplace.json Maven / Gradle / Ivy
The newest version!
{
"apiVersion" : "v3",
"swaggerVersion" : "1.2",
"basePath" : "/v3",
"resourcePath" : "/marketplace",
"apis" : [ {
"path" : "/marketplace/categories/{cat}",
"operations" : [ {
"method" : "GET",
"summary" : "Get a category basic data",
"notes" : "",
"type" : "void",
"nickname" : "get",
"authorizations" : { },
"parameters" : [ {
"name" : "cat",
"description" : "Name of plugins category to fetch",
"required" : true,
"type" : "string",
"paramType" : "path"
} ]
} ]
}, {
"path" : "/marketplace/categories",
"operations" : [ {
"method" : "GET",
"summary" : "Show the list of registered remote marketplace providers",
"notes" : "",
"type" : "void",
"nickname" : "list",
"authorizations" : { },
"parameters" : [ ]
} ]
}, {
"path" : "/marketplace/categories/{cat}/plugins/{id}",
"operations" : [ {
"method" : "GET",
"summary" : "Get a single plugin package metadata",
"notes" : "",
"type" : "void",
"nickname" : "get",
"authorizations" : { },
"parameters" : [ {
"name" : "cat",
"description" : "Name of plugins category to fetch",
"required" : true,
"type" : "string",
"paramType" : "path"
}, {
"name" : "id",
"description" : "Name of plugin to fetch",
"required" : true,
"type" : "string",
"paramType" : "path"
} ]
} ]
}, {
"path" : "/marketplace/categories/{cat}/plugins",
"operations" : [ {
"method" : "GET",
"summary" : "Show the list of registered remote marketplace providers",
"notes" : "",
"type" : "void",
"nickname" : "list",
"authorizations" : { },
"parameters" : [ {
"name" : "cat",
"description" : "Name of plugins category to fetch",
"required" : true,
"type" : "string",
"paramType" : "path"
} ]
} ]
}, {
"path" : "/marketplace/providers/{id}",
"operations" : [ {
"method" : "GET",
"summary" : "Show info about specific provider",
"notes" : "",
"type" : "void",
"nickname" : "get",
"produces" : [ "application/json" ],
"authorizations" : { },
"parameters" : [ {
"name" : "id",
"description" : "Index of marketplace provider",
"required" : true,
"type" : "string",
"paramType" : "path"
} ]
} ]
}, {
"path" : "/marketplace/providers",
"operations" : [ {
"method" : "GET",
"summary" : "Show the list of registered remote marketplace providers",
"notes" : "",
"type" : "void",
"nickname" : "list",
"produces" : [ "application/json" ],
"authorizations" : { },
"parameters" : [ ]
} ]
}, {
"path" : "/marketplace/providers/{id}/update",
"operations" : [ {
"method" : "POST",
"summary" : "Update provider's data - reload data from it",
"notes" : "",
"type" : "void",
"nickname" : "update",
"authorizations" : { },
"parameters" : [ {
"name" : "id",
"description" : "Index of marketplace provider",
"required" : true,
"type" : "integer",
"format" : "int32",
"paramType" : "path"
} ]
} ]
}, {
"path" : "/marketplace/providers/{id}/upgrade",
"operations" : [ {
"method" : "POST",
"summary" : "Upgrade plugins with most recent version available on a marketplace",
"notes" : "",
"type" : "void",
"nickname" : "upgrade",
"authorizations" : { },
"parameters" : [ {
"name" : "id",
"description" : "Index of marketplace provider",
"required" : true,
"type" : "integer",
"format" : "int32",
"paramType" : "path"
} ]
} ]
}, {
"path" : "/marketplace/providers/{id}/categories/{cat}",
"operations" : [ {
"method" : "GET",
"summary" : "Get a category basic data",
"notes" : "",
"type" : "void",
"nickname" : "get",
"authorizations" : { },
"parameters" : [ {
"name" : "id",
"description" : "Index of marketplace provider",
"required" : true,
"type" : "integer",
"format" : "int32",
"paramType" : "path"
}, {
"name" : "cat",
"description" : "Name of plugins category to fetch",
"required" : true,
"type" : "string",
"paramType" : "path"
} ]
} ]
}, {
"path" : "/marketplace/providers/{id}/categories",
"operations" : [ {
"method" : "GET",
"summary" : "Show the list of registered remote marketplace providers",
"notes" : "",
"type" : "void",
"nickname" : "list",
"authorizations" : { },
"parameters" : [ {
"name" : "id",
"description" : "Index of marketplace provider",
"required" : true,
"type" : "integer",
"format" : "int32",
"paramType" : "path"
} ]
} ]
}, {
"path" : "/marketplace/providers/{id}/categories/{cat}/plugins/{id}",
"operations" : [ {
"method" : "GET",
"summary" : "Get a single plugin package metadata",
"notes" : "",
"type" : "void",
"nickname" : "get",
"authorizations" : { },
"parameters" : [ {
"name" : "id",
"description" : "Index of marketplace provider",
"required" : true,
"type" : "integer",
"format" : "int32",
"paramType" : "path"
}, {
"name" : "cat",
"description" : "Name of plugins category to fetch",
"required" : true,
"type" : "string",
"paramType" : "path"
}, {
"name" : "id",
"description" : "Name of plugin to fetch",
"required" : true,
"type" : "string",
"paramType" : "path"
} ]
} ]
}, {
"path" : "/marketplace/providers/{id}/categories/{cat}/plugins",
"operations" : [ {
"method" : "GET",
"summary" : "Show the list of registered remote marketplace providers",
"notes" : "",
"type" : "void",
"nickname" : "list",
"authorizations" : { },
"parameters" : [ {
"name" : "id",
"description" : "Index of marketplace provider",
"required" : true,
"type" : "integer",
"format" : "int32",
"paramType" : "path"
}, {
"name" : "cat",
"description" : "Name of plugins category to fetch",
"required" : true,
"type" : "string",
"paramType" : "path"
} ]
} ]
}, {
"path" : "/marketplace/providers/{id}/plugins/{id}",
"operations" : [ {
"method" : "GET",
"summary" : "Get a single plugin package metadata",
"notes" : "",
"type" : "void",
"nickname" : "get",
"authorizations" : { },
"parameters" : [ {
"name" : "id",
"description" : "Index of marketplace provider",
"required" : true,
"type" : "integer",
"format" : "int32",
"paramType" : "path"
}, {
"name" : "id",
"description" : "Name of plugin to fetch",
"required" : true,
"type" : "string",
"paramType" : "path"
} ]
} ]
}, {
"path" : "/marketplace/providers/{id}/plugins",
"operations" : [ {
"method" : "GET",
"summary" : "Show the list of registered remote marketplace providers",
"notes" : "",
"type" : "void",
"nickname" : "list",
"authorizations" : { },
"parameters" : [ {
"name" : "id",
"description" : "Index of marketplace provider",
"required" : true,
"type" : "integer",
"format" : "int32",
"paramType" : "path"
} ]
} ]
}, {
"path" : "/marketplace/providers{id}/plugins/install/{nid}",
"operations" : [ {
"method" : "POST",
"summary" : "Download and install a plugin, given its node id",
"notes" : "",
"type" : "void",
"nickname" : "installPlugin",
"produces" : [ "application/json" ],
"authorizations" : { },
"parameters" : [ {
"name" : "id",
"description" : "Index of marketplace provider",
"required" : true,
"type" : "integer",
"format" : "int32",
"paramType" : "path"
}, {
"name" : "nid",
"description" : "Node id of plugin to install - this is a id relative to selected provider",
"required" : true,
"type" : "string",
"paramType" : "path"
} ],
"responseMessages" : [ {
"code" : 202,
"message" : "Plugin installation succeded"
} ]
} ]
}, {
"path" : "/marketplace/update",
"operations" : [ {
"method" : "POST",
"summary" : "Update providers' data - reload data from all of them",
"notes" : "",
"type" : "void",
"nickname" : "update",
"authorizations" : { },
"parameters" : [ ]
} ]
}, {
"path" : "/marketplace/plugins/{id}",
"operations" : [ {
"method" : "GET",
"summary" : "Get a single plugin package metadata",
"notes" : "",
"type" : "void",
"nickname" : "get",
"authorizations" : { },
"parameters" : [ {
"name" : "id",
"description" : "Name of plugin to fetch",
"required" : true,
"type" : "string",
"paramType" : "path"
} ]
} ]
}, {
"path" : "/marketplace/plugins",
"operations" : [ {
"method" : "GET",
"summary" : "Show the list of registered remote marketplace providers",
"notes" : "",
"type" : "void",
"nickname" : "list",
"authorizations" : { },
"parameters" : [ ]
} ]
}, {
"path" : "/marketplace/upgrade",
"operations" : [ {
"method" : "POST",
"summary" : "Upgrade plugins with most recent version available on marketplaces",
"notes" : "",
"type" : "void",
"nickname" : "upgrade",
"authorizations" : { },
"parameters" : [ ]
} ]
}, {
"path" : "/marketplace/plugins/install/{url}",
"operations" : [ {
"method" : "POST",
"summary" : "Download and install a plugin",
"notes" : "",
"type" : "void",
"nickname" : "installPlugin",
"produces" : [ "application/json" ],
"authorizations" : { },
"parameters" : [ {
"name" : "url",
"description" : "URL of plugin to download and install - this have to be url-encoded",
"required" : true,
"type" : "string",
"paramType" : "path"
} ],
"responseMessages" : [ {
"code" : 202,
"message" : "Plugin installation succeded"
} ]
} ]
} ]
}© 2015 - 2024 Weber Informatics LLC | Privacy Policy