From de6acf0029da26edf83b209481e06b035bc6440d Mon Sep 17 00:00:00 2001 From: ijungleboy Date: Fri, 21 May 2021 18:29:06 +0200 Subject: [PATCH] Tell all concrete implementations to be private / not show in the docs --- Oqtane.Client/Services/AliasService.cs | 12 ++++++++++++ Oqtane.Client/Services/DatabaseService.cs | 2 ++ Oqtane.Client/Services/FileService.cs | 2 ++ Oqtane.Client/Services/FolderService.cs | 2 ++ Oqtane.Client/Services/InstallationService.cs | 2 ++ Oqtane.Client/Services/JobLogService.cs | 2 ++ Oqtane.Client/Services/JobService.cs | 2 ++ Oqtane.Client/Services/LanguageService.cs | 2 ++ Oqtane.Client/Services/LocalizationService.cs | 2 ++ Oqtane.Client/Services/LogService.cs | 2 ++ Oqtane.Client/Services/ModuleDefinitionService.cs | 2 ++ Oqtane.Client/Services/ModuleService.cs | 2 ++ Oqtane.Client/Services/NotificationService.cs | 2 ++ Oqtane.Client/Services/PackageService.cs | 2 ++ Oqtane.Client/Services/PageModuleService.cs | 2 ++ Oqtane.Client/Services/PageService.cs | 2 ++ Oqtane.Client/Services/ProfileService.cs | 2 ++ Oqtane.Client/Services/RoleService.cs | 2 ++ Oqtane.Client/Services/ServiceBase.cs | 2 ++ Oqtane.Client/Services/SettingService.cs | 2 ++ Oqtane.Client/Services/SiteService.cs | 2 ++ Oqtane.Client/Services/SiteTemplateService.cs | 2 ++ Oqtane.Client/Services/SqlService.cs | 2 ++ Oqtane.Client/Services/SystemService.cs | 2 ++ Oqtane.Client/Services/TenantService.cs | 2 ++ Oqtane.Client/Services/ThemeService.cs | 2 ++ Oqtane.Client/Services/UserRoleService.cs | 2 ++ Oqtane.Client/Services/UserService.cs | 2 ++ 28 files changed, 66 insertions(+) diff --git a/Oqtane.Client/Services/AliasService.cs b/Oqtane.Client/Services/AliasService.cs index 55aee8c9..5a72e4bb 100644 --- a/Oqtane.Client/Services/AliasService.cs +++ b/Oqtane.Client/Services/AliasService.cs @@ -5,15 +5,21 @@ using System.Linq; using System.Collections.Generic; using System.Net; using System; +using Oqtane.Documentation; using Oqtane.Shared; namespace Oqtane.Services { + /// + [PrivateApi("Don't show in the documentation, as everything should use the Interface")] public class AliasService : ServiceBase, IAliasService { private readonly SiteState _siteState; + /// + /// Constructor - should only be used by Dependency Injection + /// public AliasService(HttpClient http, SiteState siteState) : base(http) { _siteState = siteState; @@ -21,32 +27,38 @@ namespace Oqtane.Services private string ApiUrl => CreateApiUrl("Alias", _siteState.Alias); + /// public async Task> GetAliasesAsync() { List aliases = await GetJsonAsync>(ApiUrl); return aliases.OrderBy(item => item.Name).ToList(); } + /// public async Task GetAliasAsync(int aliasId) { return await GetJsonAsync($"{ApiUrl}/{aliasId}"); } + /// public async Task GetAliasAsync(string path, DateTime lastSyncDate) { // tenant agnostic as SiteState does not exist return await GetJsonAsync($"{CreateApiUrl("Alias", null)}/name/?path={WebUtility.UrlEncode(path)}&sync={lastSyncDate.ToString("yyyyMMddHHmmssfff")}"); } + /// public async Task AddAliasAsync(Alias alias) { return await PostJsonAsync(ApiUrl, alias); } + /// public async Task UpdateAliasAsync(Alias alias) { return await PutJsonAsync($"{ApiUrl}/{alias.AliasId}", alias); } + /// public async Task DeleteAliasAsync(int aliasId) { await DeleteAsync($"{ApiUrl}/{aliasId}"); diff --git a/Oqtane.Client/Services/DatabaseService.cs b/Oqtane.Client/Services/DatabaseService.cs index db108d74..5f9aa925 100644 --- a/Oqtane.Client/Services/DatabaseService.cs +++ b/Oqtane.Client/Services/DatabaseService.cs @@ -3,10 +3,12 @@ using System.Threading.Tasks; using System.Net.Http; using System.Linq; using System.Collections.Generic; +using Oqtane.Documentation; using Oqtane.Shared; namespace Oqtane.Services { + [PrivateApi("Don't show in the documentation, as everything should use the Interface")] public class DatabaseService : ServiceBase, IDatabaseService { diff --git a/Oqtane.Client/Services/FileService.cs b/Oqtane.Client/Services/FileService.cs index 3bcf4b20..9848e792 100644 --- a/Oqtane.Client/Services/FileService.cs +++ b/Oqtane.Client/Services/FileService.cs @@ -4,12 +4,14 @@ using System.Net.Http; using System.Threading; using System.Threading.Tasks; using Microsoft.JSInterop; +using Oqtane.Documentation; using Oqtane.Models; using Oqtane.Shared; using Oqtane.UI; namespace Oqtane.Services { + [PrivateApi("Don't show in the documentation, as everything should use the Interface")] public class FileService : ServiceBase, IFileService { private readonly SiteState _siteState; diff --git a/Oqtane.Client/Services/FolderService.cs b/Oqtane.Client/Services/FolderService.cs index ffb05c8e..653fab23 100644 --- a/Oqtane.Client/Services/FolderService.cs +++ b/Oqtane.Client/Services/FolderService.cs @@ -7,9 +7,11 @@ using Oqtane.Shared; using System; using System.Diagnostics.CodeAnalysis; using System.Net; +using Oqtane.Documentation; namespace Oqtane.Services { + [PrivateApi("Don't show in the documentation, as everything should use the Interface")] public class FolderService : ServiceBase, IFolderService { private readonly SiteState _siteState; diff --git a/Oqtane.Client/Services/InstallationService.cs b/Oqtane.Client/Services/InstallationService.cs index 0874ed42..6b63ba60 100644 --- a/Oqtane.Client/Services/InstallationService.cs +++ b/Oqtane.Client/Services/InstallationService.cs @@ -1,10 +1,12 @@ using Oqtane.Models; using System.Threading.Tasks; using System.Net.Http; +using Oqtane.Documentation; using Oqtane.Shared; namespace Oqtane.Services { + [PrivateApi("Don't show in the documentation, as everything should use the Interface")] public class InstallationService : ServiceBase, IInstallationService { private readonly SiteState _siteState; diff --git a/Oqtane.Client/Services/JobLogService.cs b/Oqtane.Client/Services/JobLogService.cs index 260d77eb..6d9a3e56 100644 --- a/Oqtane.Client/Services/JobLogService.cs +++ b/Oqtane.Client/Services/JobLogService.cs @@ -3,10 +3,12 @@ using System.Threading.Tasks; using System.Net.Http; using System.Linq; using System.Collections.Generic; +using Oqtane.Documentation; using Oqtane.Shared; namespace Oqtane.Services { + [PrivateApi("Don't show in the documentation, as everything should use the Interface")] public class JobLogService : ServiceBase, IJobLogService { private readonly SiteState _siteState; diff --git a/Oqtane.Client/Services/JobService.cs b/Oqtane.Client/Services/JobService.cs index 40a23339..f4fdc281 100644 --- a/Oqtane.Client/Services/JobService.cs +++ b/Oqtane.Client/Services/JobService.cs @@ -3,10 +3,12 @@ using System.Threading.Tasks; using System.Net.Http; using System.Linq; using System.Collections.Generic; +using Oqtane.Documentation; using Oqtane.Shared; namespace Oqtane.Services { + [PrivateApi("Don't show in the documentation, as everything should use the Interface")] public class JobService : ServiceBase, IJobService { private readonly SiteState _siteState; diff --git a/Oqtane.Client/Services/LanguageService.cs b/Oqtane.Client/Services/LanguageService.cs index 77286be5..dc8ff89b 100644 --- a/Oqtane.Client/Services/LanguageService.cs +++ b/Oqtane.Client/Services/LanguageService.cs @@ -2,11 +2,13 @@ using System.Collections.Generic; using System.Linq; using System.Net.Http; using System.Threading.Tasks; +using Oqtane.Documentation; using Oqtane.Models; using Oqtane.Shared; namespace Oqtane.Services { + [PrivateApi("Don't show in the documentation, as everything should use the Interface")] public class LanguageService : ServiceBase, ILanguageService { diff --git a/Oqtane.Client/Services/LocalizationService.cs b/Oqtane.Client/Services/LocalizationService.cs index 9b1b4b61..d0603997 100644 --- a/Oqtane.Client/Services/LocalizationService.cs +++ b/Oqtane.Client/Services/LocalizationService.cs @@ -1,11 +1,13 @@ using System.Collections.Generic; using System.Net.Http; using System.Threading.Tasks; +using Oqtane.Documentation; using Oqtane.Models; using Oqtane.Shared; namespace Oqtane.Services { + [PrivateApi("Don't show in the documentation, as everything should use the Interface")] public class LocalizationService : ServiceBase, ILocalizationService { private readonly SiteState _siteState; diff --git a/Oqtane.Client/Services/LogService.cs b/Oqtane.Client/Services/LogService.cs index 6d787341..8b158cb2 100644 --- a/Oqtane.Client/Services/LogService.cs +++ b/Oqtane.Client/Services/LogService.cs @@ -4,12 +4,14 @@ using System.Net.Http; using System.Text.Json; using System.Threading.Tasks; using Microsoft.AspNetCore.Components; +using Oqtane.Documentation; using Oqtane.Enums; using Oqtane.Models; using Oqtane.Shared; namespace Oqtane.Services { + [PrivateApi("Don't show in the documentation, as everything should use the Interface")] public class LogService : ServiceBase, ILogService { diff --git a/Oqtane.Client/Services/ModuleDefinitionService.cs b/Oqtane.Client/Services/ModuleDefinitionService.cs index a097c6ff..67a6b4ca 100644 --- a/Oqtane.Client/Services/ModuleDefinitionService.cs +++ b/Oqtane.Client/Services/ModuleDefinitionService.cs @@ -5,11 +5,13 @@ using System.Net.Http; using System.Threading.Tasks; using System; using System.Reflection; +using Oqtane.Documentation; using Oqtane.Shared; using Oqtane.UI; namespace Oqtane.Services { + [PrivateApi("Don't show in the documentation, as everything should use the Interface")] public class ModuleDefinitionService : ServiceBase, IModuleDefinitionService { private readonly HttpClient _http; diff --git a/Oqtane.Client/Services/ModuleService.cs b/Oqtane.Client/Services/ModuleService.cs index 00b88a82..01ec03c5 100644 --- a/Oqtane.Client/Services/ModuleService.cs +++ b/Oqtane.Client/Services/ModuleService.cs @@ -3,10 +3,12 @@ using System.Collections.Generic; using System.Linq; using System.Net.Http; using System.Threading.Tasks; +using Oqtane.Documentation; using Oqtane.Shared; namespace Oqtane.Services { + [PrivateApi("Don't show in the documentation, as everything should use the Interface")] public class ModuleService : ServiceBase, IModuleService { diff --git a/Oqtane.Client/Services/NotificationService.cs b/Oqtane.Client/Services/NotificationService.cs index 5bbd8606..ce710da5 100644 --- a/Oqtane.Client/Services/NotificationService.cs +++ b/Oqtane.Client/Services/NotificationService.cs @@ -4,9 +4,11 @@ using System.Net.Http; using Oqtane.Shared; using System.Collections.Generic; using System.Linq; +using Oqtane.Documentation; namespace Oqtane.Services { + [PrivateApi("Don't show in the documentation, as everything should use the Interface")] public class NotificationService : ServiceBase, INotificationService { private readonly SiteState _siteState; diff --git a/Oqtane.Client/Services/PackageService.cs b/Oqtane.Client/Services/PackageService.cs index c101b5f3..59e049f4 100644 --- a/Oqtane.Client/Services/PackageService.cs +++ b/Oqtane.Client/Services/PackageService.cs @@ -3,10 +3,12 @@ using System.Collections.Generic; using System.Net.Http; using System.Threading.Tasks; using System.Linq; +using Oqtane.Documentation; using Oqtane.Shared; namespace Oqtane.Services { + [PrivateApi("Don't show in the documentation, as everything should use the Interface")] public class PackageService : ServiceBase, IPackageService { private readonly SiteState _siteState; diff --git a/Oqtane.Client/Services/PageModuleService.cs b/Oqtane.Client/Services/PageModuleService.cs index 63e871d4..4ed4fa1a 100644 --- a/Oqtane.Client/Services/PageModuleService.cs +++ b/Oqtane.Client/Services/PageModuleService.cs @@ -1,10 +1,12 @@ using Oqtane.Models; using System.Net.Http; using System.Threading.Tasks; +using Oqtane.Documentation; using Oqtane.Shared; namespace Oqtane.Services { + [PrivateApi("Don't show in the documentation, as everything should use the Interface")] public class PageModuleService : ServiceBase, IPageModuleService { diff --git a/Oqtane.Client/Services/PageService.cs b/Oqtane.Client/Services/PageService.cs index a4922d0a..a1030848 100644 --- a/Oqtane.Client/Services/PageService.cs +++ b/Oqtane.Client/Services/PageService.cs @@ -6,9 +6,11 @@ using System.Collections.Generic; using Oqtane.Shared; using System; using System.Net; +using Oqtane.Documentation; namespace Oqtane.Services { + [PrivateApi("Don't show in the documentation, as everything should use the Interface")] public class PageService : ServiceBase, IPageService { diff --git a/Oqtane.Client/Services/ProfileService.cs b/Oqtane.Client/Services/ProfileService.cs index b4a80b89..e19069f7 100644 --- a/Oqtane.Client/Services/ProfileService.cs +++ b/Oqtane.Client/Services/ProfileService.cs @@ -3,10 +3,12 @@ using System.Threading.Tasks; using System.Net.Http; using System.Linq; using System.Collections.Generic; +using Oqtane.Documentation; using Oqtane.Shared; namespace Oqtane.Services { + [PrivateApi("Don't show in the documentation, as everything should use the Interface")] public class ProfileService : ServiceBase, IProfileService { diff --git a/Oqtane.Client/Services/RoleService.cs b/Oqtane.Client/Services/RoleService.cs index 83b34d68..35bf8980 100644 --- a/Oqtane.Client/Services/RoleService.cs +++ b/Oqtane.Client/Services/RoleService.cs @@ -3,10 +3,12 @@ using System.Threading.Tasks; using System.Net.Http; using System.Linq; using System.Collections.Generic; +using Oqtane.Documentation; using Oqtane.Shared; namespace Oqtane.Services { + [PrivateApi("Don't show in the documentation, as everything should use the Interface")] public class RoleService : ServiceBase, IRoleService { diff --git a/Oqtane.Client/Services/ServiceBase.cs b/Oqtane.Client/Services/ServiceBase.cs index f4ca76f5..14a4fea7 100644 --- a/Oqtane.Client/Services/ServiceBase.cs +++ b/Oqtane.Client/Services/ServiceBase.cs @@ -4,11 +4,13 @@ using System.Net.Http; using System.Net.Http.Json; using System.Threading; using System.Threading.Tasks; +using Oqtane.Documentation; using Oqtane.Models; using Oqtane.Shared; namespace Oqtane.Services { + [PrivateApi("Don't show in the documentation, as everything should use the Interface")] public class ServiceBase { private readonly HttpClient _http; diff --git a/Oqtane.Client/Services/SettingService.cs b/Oqtane.Client/Services/SettingService.cs index e252c3ea..7ac1eff3 100644 --- a/Oqtane.Client/Services/SettingService.cs +++ b/Oqtane.Client/Services/SettingService.cs @@ -4,10 +4,12 @@ using System.Threading.Tasks; using System.Net.Http; using System.Linq; using System.Collections.Generic; +using Oqtane.Documentation; using Oqtane.Shared; namespace Oqtane.Services { + [PrivateApi("Don't show in the documentation, as everything should use the Interface")] public class SettingService : ServiceBase, ISettingService { diff --git a/Oqtane.Client/Services/SiteService.cs b/Oqtane.Client/Services/SiteService.cs index b4116312..56ba5b16 100644 --- a/Oqtane.Client/Services/SiteService.cs +++ b/Oqtane.Client/Services/SiteService.cs @@ -5,9 +5,11 @@ using System.Linq; using System.Collections.Generic; using Oqtane.Shared; using System; +using Oqtane.Documentation; namespace Oqtane.Services { + [PrivateApi("Don't show in the documentation, as everything should use the Interface")] public class SiteService : ServiceBase, ISiteService { diff --git a/Oqtane.Client/Services/SiteTemplateService.cs b/Oqtane.Client/Services/SiteTemplateService.cs index 383fb6f6..300fa1c2 100644 --- a/Oqtane.Client/Services/SiteTemplateService.cs +++ b/Oqtane.Client/Services/SiteTemplateService.cs @@ -4,9 +4,11 @@ using System.Collections.Generic; using System.Linq; using System.Net.Http; using System.Threading.Tasks; +using Oqtane.Documentation; namespace Oqtane.Services { + [PrivateApi("Don't show in the documentation, as everything should use the Interface")] public class SiteTemplateService : ServiceBase, ISiteTemplateService { private readonly SiteState _siteState; diff --git a/Oqtane.Client/Services/SqlService.cs b/Oqtane.Client/Services/SqlService.cs index d43a8198..00319953 100644 --- a/Oqtane.Client/Services/SqlService.cs +++ b/Oqtane.Client/Services/SqlService.cs @@ -2,9 +2,11 @@ using Oqtane.Models; using Oqtane.Shared; using System.Net.Http; using System.Threading.Tasks; +using Oqtane.Documentation; namespace Oqtane.Services { + [PrivateApi("Don't show in the documentation, as everything should use the Interface")] public class SqlService : ServiceBase, ISqlService { private readonly SiteState _siteState; diff --git a/Oqtane.Client/Services/SystemService.cs b/Oqtane.Client/Services/SystemService.cs index cade0ed0..97112ca1 100644 --- a/Oqtane.Client/Services/SystemService.cs +++ b/Oqtane.Client/Services/SystemService.cs @@ -1,10 +1,12 @@ using System.Net.Http; using System.Threading.Tasks; using System.Collections.Generic; +using Oqtane.Documentation; using Oqtane.Shared; namespace Oqtane.Services { + [PrivateApi("Don't show in the documentation, as everything should use the Interface")] public class SystemService : ServiceBase, ISystemService { private readonly SiteState _siteState; diff --git a/Oqtane.Client/Services/TenantService.cs b/Oqtane.Client/Services/TenantService.cs index f09d91d2..52b3d345 100644 --- a/Oqtane.Client/Services/TenantService.cs +++ b/Oqtane.Client/Services/TenantService.cs @@ -3,10 +3,12 @@ using System.Net.Http; using System.Threading.Tasks; using System.Collections.Generic; using System.Linq; +using Oqtane.Documentation; using Oqtane.Shared; namespace Oqtane.Services { + [PrivateApi("Don't show in the documentation, as everything should use the Interface")] public class TenantService : ServiceBase, ITenantService { private readonly SiteState _siteState; diff --git a/Oqtane.Client/Services/ThemeService.cs b/Oqtane.Client/Services/ThemeService.cs index 529c1a3b..b36828fd 100644 --- a/Oqtane.Client/Services/ThemeService.cs +++ b/Oqtane.Client/Services/ThemeService.cs @@ -2,11 +2,13 @@ using System.Collections.Generic; using System.Linq; using System.Net.Http; using System.Threading.Tasks; +using Oqtane.Documentation; using Oqtane.Models; using Oqtane.Shared; namespace Oqtane.Services { + [PrivateApi("Don't show in the documentation, as everything should use the Interface")] public class ThemeService : ServiceBase, IThemeService { private readonly SiteState _siteState; diff --git a/Oqtane.Client/Services/UserRoleService.cs b/Oqtane.Client/Services/UserRoleService.cs index a69eaa10..1bb35450 100644 --- a/Oqtane.Client/Services/UserRoleService.cs +++ b/Oqtane.Client/Services/UserRoleService.cs @@ -2,10 +2,12 @@ using Oqtane.Models; using System.Collections.Generic; using System.Net.Http; using System.Threading.Tasks; +using Oqtane.Documentation; using Oqtane.Shared; namespace Oqtane.Services { + [PrivateApi("Don't show in the documentation, as everything should use the Interface")] public class UserRoleService : ServiceBase, IUserRoleService { diff --git a/Oqtane.Client/Services/UserService.cs b/Oqtane.Client/Services/UserService.cs index 3fb73cc5..6a981e54 100644 --- a/Oqtane.Client/Services/UserService.cs +++ b/Oqtane.Client/Services/UserService.cs @@ -2,9 +2,11 @@ using Oqtane.Shared; using Oqtane.Models; using System.Net.Http; using System.Threading.Tasks; +using Oqtane.Documentation; namespace Oqtane.Services { + [PrivateApi("Don't show in the documentation, as everything should use the Interface")] public class UserService : ServiceBase, IUserService { private readonly SiteState _siteState;