IlyaSobolev/DocSpace-buildtools
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fixes

Browse Source
This commit is contained in:
Natalia Ovchinnikova 2023-03-28 18:29:50 +03:00
parent 9c7b1f7ce8
commit f882861bc6
15 changed files with 39 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
web/ASC.Web.Api/Api/AuthenticationController.cs
View File

@ -395,7 +395,7 @@ public class AuthenticationController : ControllerBase
}
/// <summary>
/// Opens a confirmation email URL to validate some action (employee invitation, portal removal, phone activation, etc.).
/// Opens a confirmation email URL to validate a certain action (employee invitation, portal removal, phone activation, etc.).
/// </summary>
/// <short>
/// Open confirmation email URL

4
web/ASC.Web.Api/Api/ConnectionsController.cs
View File

@ -139,7 +139,7 @@ public class ConnectionsController : ControllerBase
}
/// <summary>
/// Logs out from all the active connections for the current user and changes their password.
/// Logs out from all the active connections of the current user and changes their password.
/// </summary>
/// <short>
/// Log out and change password
@ -178,7 +178,7 @@ public class ConnectionsController : ControllerBase
}
/// <summary>
/// Logs out from all the active connections for the user with the ID specified in the request.
/// Logs out from all the active connections of the user with the ID specified in the request.
/// </summary>
/// <short>
/// Log out for the user by ID

2
web/ASC.Web.Api/Api/FeedController.cs
View File

@ -171,7 +171,7 @@ public class FeedController : ControllerBase
}
/// <summary>
/// Returns a number of fresh feeds.
/// Returns an integer representing the number of fresh feeds.
/// </summary>
/// <short>
/// Count fresh feeds

10
web/ASC.Web.Api/Api/PaymentsController.cs
View File

@ -119,7 +119,7 @@ public class PaymentController : ControllerBase
/// Update the payment quantity
/// </short>
/// <category>Payment</category>
/// <param type="ASC.Web.Api.Models.PaymentUrlRequestsDto, ASC.Web.Api.Models" name="inDto">Payment URL request parameters: Quantity (Dictionary&lt;string, int&gt;) - the quantity of payment</param>
/// <param type="ASC.Web.Api.Models.PaymentUrlRequestsDto, ASC.Web.Api.Models" name="inDto">Payment URL request parameters: <![CDATA[Quantity (Dictionary&lt;string, int&gt;) - the quantity of payment]]></param>
/// <returns>Boolean value: true if the operation is successful</returns>
/// <path>api/2.0/portal/payment/update</path>
/// <httpMethod>PUT</httpMethod>
@ -214,7 +214,7 @@ public class PaymentController : ControllerBase
/// <short>
/// Get quotas
/// </short>
/// <category>Payment</category>
/// <category>Quota</category>
/// <returns>List of available portal quotas</returns>
/// <path>api/2.0/portal/payment/quotas</path>
/// <httpMethod>GET</httpMethod>
@ -225,13 +225,13 @@ public class PaymentController : ControllerBase
}
/// <summary>
/// Returns the current portal quota.
/// Returns the payment information about the current portal quota.
/// </summary>
/// <short>
/// Get portal quota
/// Get quota payment information
/// </short>
/// <category>Payment</category>
/// <returns>Current portal quota</returns>
/// <returns>Payment information about the current portal quota: ID, title, price, nonprofit or not, free or not, trial or not, tenant quota features</returns>
/// <path>api/2.0/portal/payment/quota</path>
/// <httpMethod>GET</httpMethod>
[HttpGet("payment/quota")]

16
web/ASC.Web.Api/Api/PortalController.cs
View File

@ -136,7 +136,7 @@ public class PortalController : ControllerBase
/// Returns the current portal.
/// </summary>
/// <short>
/// Get the current portal
/// Get a portal
/// </short>
/// <category>Settings</category>
/// <returns>Current portal information</returns>
@ -303,7 +303,7 @@ public class PortalController : ControllerBase
/// Get a portal quota
/// </short>
/// <category>Quota</category>
/// <returns>Current portal quota</returns>
/// <returns>Current portal quota: tenant, name, price, product ID, visible or not, tenant quota features</returns>
/// <path>api/2.0/portal/quota</path>
/// <httpMethod>GET</httpMethod>
[AllowNotPayment]
@ -354,7 +354,7 @@ public class PortalController : ControllerBase
}
/// <summary>
/// Returns a thumbnail for the bookmark URL specified in the request.
/// Returns a thumbnail of the bookmark URL specified in the request.
/// </summary>
/// <short>
/// Get a bookmark thumbnail
@ -543,7 +543,7 @@ public class PortalController : ControllerBase
/// <summary>
/// Deletes the current portal immediately.
/// </summary>
/// <short>Delete the current portal immediately</short>
/// <short>Delete a portal immediately</short>
/// <category>Settings</category>
/// <returns>Task awaiter</returns>
/// <path>api/2.0/portal/deleteportalimmediately</path>
@ -609,7 +609,7 @@ public class PortalController : ControllerBase
}
/// <summary>
/// Sends the instructions to delete the current portal.
/// Sends the instructions to remove the current portal.
/// </summary>
/// <short>Send removal instructions</short>
/// <category>Settings</category>
@ -641,7 +641,7 @@ public class PortalController : ControllerBase
/// <summary>
/// Restores the current portal.
/// </summary>
/// <short>Restore the current portal</short>
/// <short>Restore a portal</short>
/// <category>Settings</category>
/// <returns></returns>
/// <path>api/2.0/portal/continue</path>
@ -658,7 +658,7 @@ public class PortalController : ControllerBase
/// <summary>
/// Deactivates the current portal.
/// </summary>
/// <short>Deactivate the current portal</short>
/// <short>Deactivate a portal</short>
/// <category>Settings</category>
/// <returns></returns>
/// <path>api/2.0/portal/suspend</path>
@ -675,7 +675,7 @@ public class PortalController : ControllerBase
/// <summary>
/// Deletes the current portal.
/// </summary>
/// <short>Delete the current portal</short>
/// <short>Delete a portal</short>
/// <category>Settings</category>
/// <returns>URL to the feedback form about removing a portal</returns>
/// <path>api/2.0/portal/delete</path>

2
web/ASC.Web.Api/Api/SecurityController.cs
View File

@ -77,7 +77,7 @@ public class SecurityController : ControllerBase
}
/// <summary>
/// Returns all the latest user login activity including successful logins and failed attempts with an indication of reasons.
/// Returns all the latest user login activity, including successful logins and error logs.
/// </summary>
/// <short>
/// Get login history

2
web/ASC.Web.Api/Api/Settings/CustomSchemasController.cs
View File

@ -50,7 +50,7 @@ public class CustomSchemasController : BaseSettingsController
}
/// <summary>
/// Returns all the portal team templates which allow you to name the organization (or group), its members and their activities within your portal.
/// Returns all portal team templates that allow users to name their organization (or group), add members, and define their activities within the portal.
/// </summary>
/// <short>Get team templates</short>
/// <category>Team templates</category>

4
web/ASC.Web.Api/Api/Settings/GreetingSettingsController.cs
View File

@ -66,11 +66,11 @@ public class GreetingSettingsController : BaseSettingsController
}
/// <summary>
/// Checks if the greeting settings of the current portal is default or not.
/// Checks if the greeting settings of the current portal are set to default or not.
/// </summary>
/// <short>Check the default greeting settings</short>
/// <category>Greeting settings</category>
/// <returns>Boolean value: true if the greeting settings of the current portal is default</returns>
/// <returns>Boolean value: true if the greeting settings of the current portal are set to default</returns>
/// <path>api/2.0/settings/greetingsettings/isdefault</path>
/// <httpMethod>GET</httpMethod>
[HttpGet("greetingsettings/isdefault")]

2
web/ASC.Web.Api/Api/Settings/IpRestrictionsController.cs
View File

@ -68,7 +68,7 @@ public class IpRestrictionsController : BaseSettingsController
/// </summary>
/// <short>Save the IP restrictions</short>
/// <category>IP restrictions</category>
/// <param type="ASC.Web.Api.ApiModel.RequestsDto.IpRestrictionsRequestsDto, ASC.Web.Api.ApiModel.RequestsDto" name="inDto">IP restrictions request parameters: IpRestrictions (IEnumerable&lt;IpRestrictionBase&gt;) - list of IP addresses</param>
/// <param type="ASC.Web.Api.ApiModel.RequestsDto.IpRestrictionsRequestsDto, ASC.Web.Api.ApiModel.RequestsDto" name="inDto">IP restrictions request parameters: <![CDATA[IpRestrictions (IEnumerable&lt;IpRestrictionBase&gt;) - list of IP addresses]]></param>
/// <returns>List of updated IP restrictions: IP addresses, for admin users only or not</returns>
/// <path>api/2.0/settings/iprestrictions</path>
/// <httpMethod>PUT</httpMethod>

2
web/ASC.Web.Api/Api/Settings/LicenseController.cs
View File

@ -233,7 +233,7 @@ public class LicenseController : BaseSettingsController
/// <short>
/// Upload a license
/// </short>
/// <param type="ASC.Web.Api.ApiModel.RequestsDto.UploadLicenseRequestsDto, ASC.Web.Api.ApiModel.RequestsDto" name="inDto">Request parameters to upload a license: Files (IEnumerable&lt;IFormFile&lt;) - license attachments</param>
/// <param type="ASC.Web.Api.ApiModel.RequestsDto.UploadLicenseRequestsDto, ASC.Web.Api.ApiModel.RequestsDto" name="inDto">Request parameters to upload a license: <![CDATA[Files (IEnumerable&lt;IFormFile&gt;) - license attachments]]></param>
/// <category>License</category>
/// <returns>License</returns>
/// <path>api/2.0/settings/license</path>

4
web/ASC.Web.Api/Api/Settings/MessageSettingsController.cs
View File

@ -78,7 +78,7 @@ public class MessageSettingsController : BaseSettingsController
}
/// <summary>
/// Displays the contact form on the "Sign In" page so that people can send a message to the DocSpace administrator in case they have troubles while accessing DocSpace.
/// Displays the contact form on the "Sign In" page, allowing users to send a message to the DocSpace administrator in case they encounter any issues while accessing DocSpace.
/// </summary>
/// <short>
/// Enable the administrator message settings
@ -145,7 +145,7 @@ public class MessageSettingsController : BaseSettingsController
}
/// <summary>
/// Sends a message to the administrator email from the unauthorized users when they have troubles while accessing DocSpace.
/// Sends a message to the administrator email when unauthorized users encounter issues accessing DocSpace.
/// </summary>
/// <short>
/// Send a message to the administrator

16
web/ASC.Web.Api/Api/Settings/SecurityController.cs
View File

@ -284,7 +284,7 @@ public class SecurityController : BaseSettingsController
/// Set the access settings to products
/// </short>
/// <category>Security</category>
/// <param type="ASC.Web.Api.ApiModel.RequestsDto.WebItemSecurityRequestsDto, ASC.Web.Api.ApiModel.RequestsDto" name="inDto">Module request parameters: Items (IEnumerable&lt;ItemKeyValuePair&lt;string, bool&gt;&gt;) - products with security information</param>
/// <param type="ASC.Web.Api.ApiModel.RequestsDto.WebItemSecurityRequestsDto, ASC.Web.Api.ApiModel.RequestsDto" name="inDto">Module request parameters: <![CDATA[Items (IEnumerable&lt;ItemKeyValuePair&lt;string, bool&gt;&gt;) - products with security information]]></param>
/// <path>api/2.0/settings/security/access</path>
/// <httpMethod>PUT</httpMethod>
/// <returns>Security settings: module ID, list of users with the access to the module, list of groups with the access to the module, security settings are enabled or not, subitem or not</returns>
@ -338,7 +338,7 @@ public class SecurityController : BaseSettingsController
}
/// <summary>
/// Returns a list of all the administrators of the product with the ID specified in the request.
/// Returns a list of all the product administrators with the ID specified in the request.
/// </summary>
/// <short>
/// Get the product administrators
@ -360,10 +360,10 @@ public class SecurityController : BaseSettingsController
}
/// <summary>
/// Checks if the selected user is an administrator of a product with the ID specified in the request.
/// Checks if the selected user is a product administrator with the ID specified in the request.
/// </summary>
/// <short>
/// Check the product administrator
/// Check a product administrator
/// </short>
/// <category>Security</category>
/// <param type="System.Guid, System" name="productid">Product ID</param>
@ -379,10 +379,10 @@ public class SecurityController : BaseSettingsController
}
/// <summary>
/// Sets the selected user as an administrator of a product with the ID specified in the request.
/// Sets the selected user as a product administrator with the ID specified in the request.
/// </summary>
/// <short>
/// Set the product administrator
/// Set a product administrator
/// </short>
/// <category>Security</category>
/// <param type="ASC.Web.Api.ApiModel.RequestsDto.SecurityRequestsDto, ASC.Web.Api.ApiModel.RequestsDto" name="inDto">Security request parameters: <![CDATA[
@ -434,8 +434,8 @@ public class SecurityController : BaseSettingsController
/// <param type="ASC.Web.Api.ApiModels.RequestsDto.LoginSettingsRequestDto, ASC.Web.Api.ApiModels.RequestsDto" name="loginSettingsRequestDto">Login settings request parameters: <![CDATA[
/// <ul>
/// <li><b>AttemptCount</b> (integer) - maximum number of the user attempts to log in,</li>
/// <li><b>BlockTime</b> (integer) - the time for which the user will be blocked after unsuccessful login attempts,</li>
/// <li><b>CheckPeriod</b> (integer) - the time to wait for a response from the server.</li>
/// <li><b>BlockTime</b> (integer) - the duration of the account suspension for unsuccessful login attempts,</li>
/// <li><b>CheckPeriod</b> (integer) - expected server response time.</li>
/// </ul>
/// ]]></param>
/// <returns>Updated login settings: maximum number of the user attempts to log in, the time for which the user will be blocked after unsuccessful login attempts, the time to wait for a response from the server</returns>

6
web/ASC.Web.Api/Api/Settings/SettingsController.cs
View File

@ -419,7 +419,7 @@ public class SettingsController : BaseSettingsController
}
/// <summary>
/// Starts the process of recalculating quota.
/// Starts the process of quota recalculation.
/// </summary>
/// <short>
/// Recalculate quota
@ -436,7 +436,7 @@ public class SettingsController : BaseSettingsController
}
/// <summary>
/// Checks the process of recalculating quota.
/// Checks the process of quota recalculation.
/// </summary>
/// <short>
/// Check quota recalculation
@ -472,7 +472,7 @@ public class SettingsController : BaseSettingsController
/// Completes the Wizard settings.
/// </summary>
/// <short>Complete the Wizard settings</short>
/// <category>Wizard</category>
/// <category>Common settings</category>
/// <param type="ASC.Web.Api.ApiModel.RequestsDto.WizardRequestsDto, ASC.Web.Api.ApiModel.RequestsDto" name="inDto">Wizard settings request parameters: <![CDATA[
/// <ul>
/// <li><b>Email</b> (string) - email,</li>

4
web/ASC.Web.Api/Api/Settings/StorageController.cs
View File

@ -457,8 +457,8 @@ public class StorageController : BaseSettingsController
/// Updates the CDN storage with the parameters specified in the request.
/// </summary>
/// <category>Storage</category>
/// <short>Update the CDN storage: module, properties</short>
/// <returns>Updated CDN storage</returns>
/// <short>Update the CDN storage</short>
/// <returns>Updated CDN storage: module, properties</returns>
/// <param type="ASC.Web.Api.ApiModel.RequestsDto.StorageRequestsDto, AASC.Web.Api.ApiModel.RequestsDto" name="inDto">CDN storage settings request parameters: <![CDATA[
/// <ul>
/// <li><b>Module</b> (string) - CDN storage name,</li>

2
web/ASC.Web.Api/Api/Settings/WebhooksController.cs
View File

@ -228,7 +228,7 @@ public class WebhooksController : BaseSettingsController
/// Retry webhooks
/// </short>
/// <category>Webhooks</category>
/// <param type="ASC.Web.Api.ApiModels.RequestsDto.WebhookRetryRequestsDto, ASC.Web.Api.ApiModels.RequestsDto" name="model">Request parameters to retry webhooks: Ids (List&lt;int&lt;) - list of webhook IDs</param>
/// <param type="ASC.Web.Api.ApiModels.RequestsDto.WebhookRetryRequestsDto, ASC.Web.Api.ApiModels.RequestsDto" name="model">Request parameters to retry webhooks: <![CDATA[Ids (List&lt;int&gt;) - list of webhook IDs]]></param>
/// <path>api/2.0/settings/webhook/retry</path>
/// <httpMethod>PUT</httpMethod>
/// <returns>Logs of the webhook activities: ID, config name, creation time, method, route, request headers, request payload, response headers, response payload, status, delivery time</returns>