Table of Contents

Class MarketplacePluginsController

Namespace
Builvero.Api.Controllers
Assembly
Builvero.Api.dll

Provides API endpoints for the plugin marketplace (browse, install, uninstall, configure).

[ApiController]
[Route("api/marketplace/plugins")]
[Authorize]
public class MarketplacePluginsController : ControllerBase
Inheritance
MarketplacePluginsController
Inherited Members

Constructors

MarketplacePluginsController(IPluginMarketplaceService, ILogger<MarketplacePluginsController>) 

public MarketplacePluginsController(IPluginMarketplaceService marketplaceService, ILogger<MarketplacePluginsController> logger)

Parameters

marketplaceService IPluginMarketplaceService
Provides API endpoints for the plugin marketplace (browse, install, uninstall, configure).
logger ILogger<MarketplacePluginsController>
Provides API endpoints for the plugin marketplace (browse, install, uninstall, configure).

Methods

ConnectOAuth(Guid, ConnectOAuthRequest)

Connects OAuth credentials for a plugin installation.

[HttpPost("{pluginId}/oauth/connect")]
public Task<ActionResult> ConnectOAuth(Guid pluginId, ConnectOAuthRequest request)

Parameters

pluginId Guid
Provides API endpoints for the plugin marketplace (browse, install, uninstall, configure).
request ConnectOAuthRequest
Provides API endpoints for the plugin marketplace (browse, install, uninstall, configure).

Returns

Task<ActionResult>
Provides API endpoints for the plugin marketplace (browse, install, uninstall, configure).

GetMarketplacePlugins(string?)

Gets approved plugins for marketplace listing.

[HttpGet]
public Task<ActionResult<List<PluginDto>>> GetMarketplacePlugins(string? search)

Parameters

search string
Provides API endpoints for the plugin marketplace (browse, install, uninstall, configure).

Returns

Task<ActionResult<List<PluginDto>>>
Provides API endpoints for the plugin marketplace (browse, install, uninstall, configure).

GetPluginDetails(Guid)

Gets plugin details by ID.

[HttpGet("{pluginId}")]
public Task<ActionResult<PluginDto>> GetPluginDetails(Guid pluginId)

Parameters

pluginId Guid
Provides API endpoints for the plugin marketplace (browse, install, uninstall, configure).

Returns

Task<ActionResult<PluginDto>>
Provides API endpoints for the plugin marketplace (browse, install, uninstall, configure).

InstallPlugin(Guid, InstallPluginRequest)

Installs a plugin (user-level or project-level).

[HttpPost("{pluginId}/install")]
public Task<ActionResult<PluginInstallationDto>> InstallPlugin(Guid pluginId, InstallPluginRequest request)

Parameters

pluginId Guid
Provides API endpoints for the plugin marketplace (browse, install, uninstall, configure).
request InstallPluginRequest
Provides API endpoints for the plugin marketplace (browse, install, uninstall, configure).

Returns

Task<ActionResult<PluginInstallationDto>>
Provides API endpoints for the plugin marketplace (browse, install, uninstall, configure).

PinPluginVersion(Guid, PinPluginVersionRequest)

Pins a specific version for an installation.

[HttpPost("{pluginId}/pin-version")]
public Task<ActionResult> PinPluginVersion(Guid pluginId, PinPluginVersionRequest request)

Parameters

pluginId Guid
Provides API endpoints for the plugin marketplace (browse, install, uninstall, configure).
request PinPluginVersionRequest
Provides API endpoints for the plugin marketplace (browse, install, uninstall, configure).

Returns

Task<ActionResult>
Provides API endpoints for the plugin marketplace (browse, install, uninstall, configure).

UninstallPlugin(Guid, UninstallPluginRequest)

Uninstalls a plugin.

[HttpPost("{pluginId}/uninstall")]
public Task<ActionResult> UninstallPlugin(Guid pluginId, UninstallPluginRequest request)

Parameters

pluginId Guid
Provides API endpoints for the plugin marketplace (browse, install, uninstall, configure).
request UninstallPluginRequest
Provides API endpoints for the plugin marketplace (browse, install, uninstall, configure).

Returns

Task<ActionResult>
Provides API endpoints for the plugin marketplace (browse, install, uninstall, configure).

UpdatePluginConfig(Guid, UpdatePluginConfigRequest)

Updates plugin installation configuration.

[HttpPost("{pluginId}/config")]
public Task<ActionResult> UpdatePluginConfig(Guid pluginId, UpdatePluginConfigRequest request)

Parameters

pluginId Guid
Provides API endpoints for the plugin marketplace (browse, install, uninstall, configure).
request UpdatePluginConfigRequest
Provides API endpoints for the plugin marketplace (browse, install, uninstall, configure).

Returns

Task<ActionResult>
Provides API endpoints for the plugin marketplace (browse, install, uninstall, configure).
Edit this page