Class AppsController
- Namespace
- OpenSettings.AspNetCore.Controllers.v1
- Assembly
- OpenSettings.AspNetCore.dll
[Route("v1/apps")]
public class AppsController : ControllerBase
- Inheritance
-
AppsController
- Inherited Members
-
Constructors
AppsController(IAppService, ISettingsService, IInstanceService, IAppIdentifierMappingService, IConfigurationService)
public AppsController(IAppService appsService, ISettingsService settingService, IInstanceService instancesService, IAppIdentifierMappingService appIdentifierMappingsService, IConfigurationService configurationsService)
Parameters
appsService IAppServicesettingService ISettingsServiceinstancesService IInstanceServiceappIdentifierMappingsService IAppIdentifierMappingServiceconfigurationsService IConfigurationService
Methods
CreateApp(CreateAppRequest, CancellationToken)
[HttpPost]
public Task<IActionResult> CreateApp(CreateAppRequest request, CancellationToken cancellationToken = default)
Parameters
request CreateAppRequestcancellationToken CancellationToken
Returns
- Task<IActionResult>
CreateAppIdentifierMapping(CreateAppIdentifierMappingRequest, CancellationToken)
[HttpPost("{AppId}/identifiers")]
public Task<IActionResult> CreateAppIdentifierMapping(CreateAppIdentifierMappingRequest request, CancellationToken cancellationToken = default)
Parameters
request CreateAppIdentifierMappingRequestcancellationToken CancellationToken
Returns
- Task<IActionResult>
CreateInstance(CreateInstanceRequest)
[HttpPost("{ClientId:guid}/instances")]
public Task<IActionResult> CreateInstance(CreateInstanceRequest request)
Parameters
request CreateInstanceRequest
Returns
- Task<IActionResult>
DeleteApp(DeleteAppRequest, CancellationToken)
[HttpDelete("{AppId}")]
public Task<IActionResult> DeleteApp(DeleteAppRequest request, CancellationToken cancellationToken = default)
Parameters
request DeleteAppRequestcancellationToken CancellationToken
Returns
- Task<IActionResult>
DeleteAppIdentifierMapping(DeleteAppIdentifierMappingRequest, CancellationToken)
[HttpDelete("{AppId}/identifiers/{IdentifierId}")]
public Task<IActionResult> DeleteAppIdentifierMapping(DeleteAppIdentifierMappingRequest request, CancellationToken cancellationToken = default)
Parameters
request DeleteAppIdentifierMappingRequestcancellationToken CancellationToken
Returns
- Task<IActionResult>
FetchAppData(FetchAppDataRequest, CancellationToken)
[HttpPost("{ClientId:guid}/identifiers/{IdentifierName}/fetch-data")]
public Task<IActionResult> FetchAppData(FetchAppDataRequest request, CancellationToken cancellationToken = default)
Parameters
request FetchAppDataRequestcancellationToken CancellationToken
Returns
- Task<IActionResult>
GetAppById(GetAppRequest, CancellationToken)
[HttpGet("{AppIdOrSlug}")]
public Task<IActionResult> GetAppById(GetAppRequest request, CancellationToken cancellationToken = default)
Parameters
request GetAppRequestcancellationToken CancellationToken
Returns
- Task<IActionResult>
GetAppBySlug(GetAppRequest, CancellationToken)
[HttpGet("slug/{AppIdOrSlug}")]
public Task<IActionResult> GetAppBySlug(GetAppRequest request, CancellationToken cancellationToken = default)
Parameters
request GetAppRequestcancellationToken CancellationToken
Returns
- Task<IActionResult>
GetAppIdentifierMappingByAppIdAndIdentifierId(GetAppIdentifierMappingByAppAndIdentifierRequest, CancellationToken)
[HttpGet("{AppIdOrSlug}/identifiers/{IdentifierIdOrSlug}")]
public Task<IActionResult> GetAppIdentifierMappingByAppIdAndIdentifierId(GetAppIdentifierMappingByAppAndIdentifierRequest request, CancellationToken cancellationToken = default)
Parameters
request GetAppIdentifierMappingByAppAndIdentifierRequestcancellationToken CancellationToken
Returns
- Task<IActionResult>
GetAppIdentifierMappingByAppSlugAndIdentifierSlug(GetAppIdentifierMappingByAppAndIdentifierRequest, CancellationToken)
[HttpGet("slug/{AppIdOrSlug}/identifiers/{IdentifierIdOrSlug}")]
public Task<IActionResult> GetAppIdentifierMappingByAppSlugAndIdentifierSlug(GetAppIdentifierMappingByAppAndIdentifierRequest request, CancellationToken cancellationToken = default)
Parameters
request GetAppIdentifierMappingByAppAndIdentifierRequestcancellationToken CancellationToken
Returns
- Task<IActionResult>
GetAppIdentifierMappingsByAppId(GetAppIdentifierMappingsRequest, CancellationToken)
[HttpGet("{AppIdOrSlug}/identifiers")]
public Task<IActionResult> GetAppIdentifierMappingsByAppId(GetAppIdentifierMappingsRequest request, CancellationToken cancellationToken = default)
Parameters
request GetAppIdentifierMappingsRequestcancellationToken CancellationToken
Returns
- Task<IActionResult>
GetAppIdentifierMappingsByAppSlugAsync(GetAppIdentifierMappingsRequest, CancellationToken)
[HttpGet("slug/{AppIdOrSlug}/identifiers")]
public Task<IActionResult> GetAppIdentifierMappingsByAppSlugAsync(GetAppIdentifierMappingsRequest request, CancellationToken cancellationToken = default)
Parameters
request GetAppIdentifierMappingsRequestcancellationToken CancellationToken
Returns
- Task<IActionResult>
GetApps(GetAppsRequest, CancellationToken)
[HttpGet]
public Task<IActionResult> GetApps(GetAppsRequest request, CancellationToken cancellationToken = default)
Parameters
request GetAppsRequestcancellationToken CancellationToken
Returns
- Task<IActionResult>
GetConfigurationByAppIdAndIdentifierId(GetConfigurationByAppAndIdentifierRequest, CancellationToken)
[HttpGet("{AppIdOrSlug}/identifiers/{IdentifierIdOrSlug}/configuration")]
public Task<IActionResult> GetConfigurationByAppIdAndIdentifierId(GetConfigurationByAppAndIdentifierRequest request, CancellationToken cancellationToken = default)
Parameters
request GetConfigurationByAppAndIdentifierRequestcancellationToken CancellationToken
Returns
- Task<IActionResult>
GetGroupedAppDataByAppId(GetGroupedAppDataByAppRequest, CancellationToken)
[HttpGet("{AppIdOrSlug}/grouped")]
public Task<IActionResult> GetGroupedAppDataByAppId(GetGroupedAppDataByAppRequest request, CancellationToken cancellationToken = default)
Parameters
request GetGroupedAppDataByAppRequestcancellationToken CancellationToken
Returns
- Task<IActionResult>
GetGroupedAppDataByAppIdAndIdentifierId(GetGroupedAppDataByAppAndIdentifierRequest, CancellationToken)
[HttpGet("{AppIdOrSlug}/identifiers/{IdentifierIdOrSlug}/grouped")]
public Task<IActionResult> GetGroupedAppDataByAppIdAndIdentifierId(GetGroupedAppDataByAppAndIdentifierRequest request, CancellationToken cancellationToken = default)
Parameters
request GetGroupedAppDataByAppAndIdentifierRequestcancellationToken CancellationToken
Returns
- Task<IActionResult>
GetGroupedAppDataByAppSlug(GetGroupedAppDataByAppRequest, CancellationToken)
[HttpGet("slug/{AppIdOrSlug}/grouped")]
public Task<IActionResult> GetGroupedAppDataByAppSlug(GetGroupedAppDataByAppRequest request, CancellationToken cancellationToken = default)
Parameters
request GetGroupedAppDataByAppRequestcancellationToken CancellationToken
Returns
- Task<IActionResult>
GetGroupedAppDataByAppSlugAndIdentifierSlug(GetGroupedAppDataByAppAndIdentifierRequest, CancellationToken)
[HttpGet("slug/{AppIdOrSlug}/identifiers/{IdentifierIdOrSlug}/grouped")]
public Task<IActionResult> GetGroupedAppDataByAppSlugAndIdentifierSlug(GetGroupedAppDataByAppAndIdentifierRequest request, CancellationToken cancellationToken = default)
Parameters
request GetGroupedAppDataByAppAndIdentifierRequestcancellationToken CancellationToken
Returns
- Task<IActionResult>
GetGroupedApps(GetGroupedAppsRequest, CancellationToken)
[HttpGet("grouped")]
public Task<IActionResult> GetGroupedApps(GetGroupedAppsRequest request, CancellationToken cancellationToken = default)
Parameters
request GetGroupedAppsRequestcancellationToken CancellationToken
Returns
- Task<IActionResult>
GetInstancesByAppId(GetInstancesByAppRequest, CancellationToken)
[HttpGet("{AppIdOrAppSlug}/instances")]
public Task<IActionResult> GetInstancesByAppId(GetInstancesByAppRequest request, CancellationToken cancellationToken = default)
Parameters
request GetInstancesByAppRequestcancellationToken CancellationToken
Returns
- Task<IActionResult>
GetInstancesByAppIdAndIdentifierId(GetInstancesByAppAndIdentifierRequest, CancellationToken)
[HttpGet("{AppIdOrSlug}/identifiers/{IdentifierIdOrSlug}/instances")]
public Task<IActionResult> GetInstancesByAppIdAndIdentifierId(GetInstancesByAppAndIdentifierRequest request, CancellationToken cancellationToken = default)
Parameters
request GetInstancesByAppAndIdentifierRequestcancellationToken CancellationToken
Returns
- Task<IActionResult>
GetInstancesByAppSlug(GetInstancesByAppRequest, CancellationToken)
[HttpGet("slug/{AppIdOrAppSlug}/instances")]
public Task<IActionResult> GetInstancesByAppSlug(GetInstancesByAppRequest request, CancellationToken cancellationToken = default)
Parameters
request GetInstancesByAppRequestcancellationToken CancellationToken
Returns
- Task<IActionResult>
GetInstancesByAppSlugAndIdentifierSlug(GetInstancesByAppAndIdentifierRequest, CancellationToken)
[HttpGet("slug/{AppIdOrSlug}/identifiers/{IdentifierIdOrSlug}/instances")]
public Task<IActionResult> GetInstancesByAppSlugAndIdentifierSlug(GetInstancesByAppAndIdentifierRequest request, CancellationToken cancellationToken = default)
Parameters
request GetInstancesByAppAndIdentifierRequestcancellationToken CancellationToken
Returns
- Task<IActionResult>
GetRegisteredApp(GetRegisteredAppRequest, CancellationToken)
[HttpPost("{ClientId:guid}/registered")]
public Task<IActionResult> GetRegisteredApp(GetRegisteredAppRequest request, CancellationToken cancellationToken = default)
Parameters
request GetRegisteredAppRequestcancellationToken CancellationToken
Returns
- Task<IActionResult>
GetSettingsByAppIdAndIdentifierId(GetSettingsByAppAndIdentifierRequest, CancellationToken)
[HttpGet("{AppIdOrAppSlug}/identifiers/{IdentifierIdOrSlug}/settings")]
public Task<IActionResult> GetSettingsByAppIdAndIdentifierId(GetSettingsByAppAndIdentifierRequest request, CancellationToken cancellationToken = default)
Parameters
request GetSettingsByAppAndIdentifierRequestcancellationToken CancellationToken
Returns
- Task<IActionResult>
GetSettingsByAppSlugAndIdentifierSlug(GetSettingsByAppAndIdentifierRequest, CancellationToken)
[HttpGet("slug/{AppIdOrAppSlug}/identifiers/{IdentifierIdOrSlug}/settings")]
public Task<IActionResult> GetSettingsByAppSlugAndIdentifierSlug(GetSettingsByAppAndIdentifierRequest request, CancellationToken cancellationToken = default)
Parameters
request GetSettingsByAppAndIdentifierRequestcancellationToken CancellationToken
Returns
- Task<IActionResult>
GetSettingsData(GetSettingsDataRequest, CancellationToken)
[HttpGet("{AppId}/settings/data")]
public Task<IActionResult> GetSettingsData(GetSettingsDataRequest request, CancellationToken cancellationToken = default)
Parameters
request GetSettingsDataRequestcancellationToken CancellationToken
Returns
- Task<IActionResult>
PatchConfiguration(PatchConfigurationRequest, CancellationToken)
[HttpPatch("{AppId}/identifiers/{IdentifierId}/configuration")]
public Task<IActionResult> PatchConfiguration(PatchConfigurationRequest request, CancellationToken cancellationToken = default)
Parameters
request PatchConfigurationRequestcancellationToken CancellationToken
Returns
- Task<IActionResult>
SyncAppData(SyncAppDataRequest, CancellationToken)
[HttpPost("{ClientId:guid}/identifiers/{IdentifierName}/sync-data")]
[Authorize(AuthenticationSchemes = "OpenSettingsBasicAuth")]
public Task<IActionResult> SyncAppData(SyncAppDataRequest request, CancellationToken cancellationToken = default)
Parameters
request SyncAppDataRequestcancellationToken CancellationToken
Returns
- Task<IActionResult>
UpdateApp(UpdateAppRequest, CancellationToken)
[HttpPut("{AppId}")]
public Task<IActionResult> UpdateApp(UpdateAppRequest request, CancellationToken cancellationToken = default)
Parameters
request UpdateAppRequestcancellationToken CancellationToken
Returns
- Task<IActionResult>
UpdateAppIdentifierMappingSortOrder(UpdateAppIdentifierMappingSortOrderRequest, CancellationToken)
[HttpPut("{AppId}/identifiers/{IdentifierId}/sort-order")]
public Task<IActionResult> UpdateAppIdentifierMappingSortOrder(UpdateAppIdentifierMappingSortOrderRequest request, CancellationToken cancellationToken = default)
Parameters
request UpdateAppIdentifierMappingSortOrderRequestcancellationToken CancellationToken
Returns
- Task<IActionResult>
UpdateInstance(UpdateInstanceRequest)
[HttpPut("{ClientId:guid}/instances")]
public Task<IActionResult> UpdateInstance(UpdateInstanceRequest request)
Parameters
request UpdateInstanceRequest
Returns
- Task<IActionResult>