From 2edd3d89e6f875c9a62c49a4cfa65045e774f5b0 Mon Sep 17 00:00:00 2001 From: Roman Kolobov Date: Thu, 27 Jan 2022 01:21:14 +0300 Subject: [PATCH] update links to REST API documentation --- src/YouTrackSharp/ColorIndices.cs | 4 +-- src/YouTrackSharp/Issues/IIssuesService.cs | 36 +++++++++---------- src/YouTrackSharp/Issues/IssuesService.cs | 2 +- .../ITimeTrackingManagementService.cs | 8 ++--- .../Management/IUserManagementService.cs | 18 +++++----- .../TimeTrackingManagementService.cs | 2 +- .../Management/UserManagementService.cs | 2 +- .../Projects/IProjectCustomFieldsService.cs | 10 +++--- .../Projects/IProjectsService.cs | 2 +- .../Projects/ProjectCustomFieldsService.cs | 2 +- src/YouTrackSharp/Projects/ProjectsService.cs | 2 +- .../TimeTracking/ITimeTrackingService.cs | 10 +++--- .../TimeTracking/TimeTrackingService.cs | 2 +- src/YouTrackSharp/Users/IUserService.cs | 2 +- src/YouTrackSharp/Users/UserService.cs | 2 +- 15 files changed, 52 insertions(+), 52 deletions(-) diff --git a/src/YouTrackSharp/ColorIndices.cs b/src/YouTrackSharp/ColorIndices.cs index b8ea7858..1b28fb59 100644 --- a/src/YouTrackSharp/ColorIndices.cs +++ b/src/YouTrackSharp/ColorIndices.cs @@ -3,13 +3,13 @@ namespace YouTrackSharp { /// - /// Represents the color indices used by YouTrack, as explained on Color Indices List. + /// Represents the color indices used by YouTrack, as explained on Color Indices List. /// [PublicAPI] public static class ColorIndices { /// - /// Supported color indices. The array index corresponds to the documented color index. + /// Supported color indices. The array index corresponds to the documented color index. /// public static readonly YouTrackColor[] Colors = { new YouTrackColor { Foreground = "#444", Background = "#fff" }, diff --git a/src/YouTrackSharp/Issues/IIssuesService.cs b/src/YouTrackSharp/Issues/IIssuesService.cs index 264474fd..289a4b95 100644 --- a/src/YouTrackSharp/Issues/IIssuesService.cs +++ b/src/YouTrackSharp/Issues/IIssuesService.cs @@ -10,7 +10,7 @@ public interface IIssuesService /// /// Get a specific issue from the server. /// - /// Uses the REST API Get an Issue. + /// Uses the REST API Get an Issue. /// Id of an issue to get. /// If set to true, then issue description in the response will be formatted ("wikified"). Defaults to false. /// If set to true, then comments and issue text fields in the response will be formatted ("wikified"). Defaults to false./// The that matches the requested . @@ -21,7 +21,7 @@ public interface IIssuesService /// /// Checks whether an issue exists on the server. /// - /// Uses the REST API Check that an Issue Exists. + /// Uses the REST API Check that an Issue Exists. /// Id of an issue to check. /// True if the issue exists, otherwise false. /// When the is null or empty. @@ -31,7 +31,7 @@ public interface IIssuesService /// /// Creates an issue on the server in a specific project. /// - /// Uses the REST API Create New Issue. + /// Uses the REST API Create New Issue. /// Id of the project to create an issue in. /// The to create. At the minimum needs the Summary field populated. /// The newly created 's id on the server. @@ -43,7 +43,7 @@ public interface IIssuesService /// /// Updates an issue on the server in a specific project. /// - /// Uses the REST API Update an Issue. + /// Uses the REST API Update an Issue. /// Id of the issue to update. /// Updated summary of the issue. /// Updated description of the issue. @@ -56,7 +56,7 @@ public interface IIssuesService /// /// Applies a command to a specific issue on the server. /// - /// Uses the REST API Apply Command to an Issue. + /// Uses the REST API Apply Command to an Issue. /// Id of the issue to apply the command to. /// The command to apply. A command might contain a string of attributes and their values - you can change multiple fields with one complex command. /// A comment to add to an issue. @@ -70,7 +70,7 @@ public interface IIssuesService /// /// Deletes an issue from the server. /// - /// Uses the REST API Delete an Issue. + /// Uses the REST API Delete an Issue. /// Id of an issue to delete. /// When the is null or empty. /// When the call to the remote YouTrack server instance failed. @@ -79,7 +79,7 @@ public interface IIssuesService /// /// Get links for a specific issue from the server. /// - /// Uses the REST API Get Links of an Issue. + /// Uses the REST API Get Links of an Issue. /// Id of the issue to get links for. /// An of for the requested issue . /// When the is null or empty. @@ -89,7 +89,7 @@ public interface IIssuesService /// /// Get issues in a project from the server. /// - /// Uses the REST API Get Issues in a Project. + /// Uses the REST API Find Issues belonging to a Project. /// Id of a project to get issues from. /// Apply a filter to issues in a project. /// The number of issues to skip before getting a list of issues. @@ -106,7 +106,7 @@ Task> GetIssuesInProject(string projectId, string filter = nu /// /// Get issues from the server. /// - /// Uses the REST API Get the List of Issues. + /// Uses the REST API Get the List of Issues. /// Apply a filter to issues. /// The number of issues to skip before getting a list of issues. /// Maximum number of issues to be returned. Defaults to the server-side default of the YouTrack server instance. @@ -119,7 +119,7 @@ Task> GetIssues(string filter = null, int? skip = null, int? /// /// Get issue count from the server. This operation may be retried internally and take a while to complete. /// - /// Uses the REST API Get a Number of Issues. + /// Uses the REST API Get a Number of Issues. /// Apply a filter to issues. /// The number of that match the specified filter. /// When the call to the remote YouTrack server instance failed. @@ -128,7 +128,7 @@ Task> GetIssues(string filter = null, int? skip = null, int? /// /// Get change history for a specific issue from the server. /// - /// Uses the REST API Get Changes of an Issue. + /// Uses the REST API Get Changes of an Issue. /// Id of the issue to get change history for. /// An of for the requested issue . /// When the is null or empty. @@ -138,7 +138,7 @@ Task> GetIssues(string filter = null, int? skip = null, int? /// /// Get comments for a specific issue from the server. /// - /// Uses the REST API Get Comments of an Issue. + /// Uses the REST API Get Comments of an Issue. /// Id of the issue to get comments for. /// If set to true, then comments in the response will be formatted ("wikified"). Defaults to false. /// An of for the requested issue . @@ -149,7 +149,7 @@ Task> GetIssues(string filter = null, int? skip = null, int? /// /// Adds a comment for an issue on the server. /// - /// Uses the REST API Update a Comment. + /// Uses the REST API Create a Comment. /// Id of the issue to add comment to. /// The text of the new comment. /// When the or is null or empty. @@ -159,7 +159,7 @@ Task> GetIssues(string filter = null, int? skip = null, int? /// /// Updates a comment for an issue on the server. /// - /// Uses the REST API Update a Comment. + /// Uses the REST API Update a Comment. /// Id of the issue to which the comment belongs. /// Id of the comment to update. /// The new text of the comment. @@ -170,7 +170,7 @@ Task> GetIssues(string filter = null, int? skip = null, int? /// /// Deletes a comment for an issue from the server. /// - /// Uses the REST API Remove a Comment for an Issue. + /// Uses the REST API Remove a Comment for an Issue. /// Id of the issue to which the comment belongs. /// Id of the comment to delete. /// When true, the specified comment will be deleted permanently and can not be restored afterwards. Defaults to false. @@ -181,7 +181,7 @@ Task> GetIssues(string filter = null, int? skip = null, int? /// /// Attaches a file to an issue on the server. /// - /// Uses the REST API Attach File to an Issue. + /// Uses the REST API Attach File to an Issue. /// Id of the issue to attach the file to. /// Filename for the attachment. /// The to attach. @@ -195,7 +195,7 @@ Task> GetIssues(string filter = null, int? skip = null, int? /// /// Get attachments for a specific issue from the server. /// - /// Uses the REST API Get Attachments of an Issue. + /// Uses the REST API Get Attachments of an Issue. /// Id of the issue to get comments for. /// An of for the requested issue . /// When the is null or empty. @@ -214,7 +214,7 @@ Task> GetIssues(string filter = null, int? skip = null, int? /// /// Deletes an attachment for an issue from the server. /// - /// Uses the REST API Delete Attachment from an Issue. + /// Uses the REST API Delete Attachment from an Issue. /// Id of the issue to which the attachment belongs. /// Id of the attachment. /// When the or is null or empty. diff --git a/src/YouTrackSharp/Issues/IssuesService.cs b/src/YouTrackSharp/Issues/IssuesService.cs index 328e69e2..0c7734df 100644 --- a/src/YouTrackSharp/Issues/IssuesService.cs +++ b/src/YouTrackSharp/Issues/IssuesService.cs @@ -8,7 +8,7 @@ namespace YouTrackSharp.Issues { /// - /// A class that represents a REST API client for YouTrack Issues Related Methods. + /// A class that represents a REST API client for YouTrack Issues Related Methods. /// It uses a implementation to connect to the remote YouTrack server instance. /// public partial class IssuesService : IIssuesService diff --git a/src/YouTrackSharp/Management/ITimeTrackingManagementService.cs b/src/YouTrackSharp/Management/ITimeTrackingManagementService.cs index 7c2e239b..b7e73f1b 100644 --- a/src/YouTrackSharp/Management/ITimeTrackingManagementService.cs +++ b/src/YouTrackSharp/Management/ITimeTrackingManagementService.cs @@ -7,7 +7,7 @@ public interface ITimeTrackingManagementService /// /// Get the current system-wide time tracking settings. /// - /// Uses the REST API Get System-wide Time Tracking Settings. + /// Uses the REST API Get System-wide Time Tracking Settings. /// System-wide . /// When the call to the remote YouTrack server instance failed. Task GetSystemWideTimeTrackingSettings(); @@ -15,7 +15,7 @@ public interface ITimeTrackingManagementService /// /// Updates the system-wide time tracking settings. /// - /// Uses the REST API Set system-wide time tracking settings: a list of working days in a week, and a number of hours in a working day. + /// Uses the REST API Set system-wide time tracking settings: a list of working days in a week, and a number of hours in a working day. /// Parameter daysAWeek is ignored since Youtrack 5.1 /// When the call to the remote YouTrack server instance failed and YouTrack reported an error message. /// When the call to the remote YouTrack server instance failed. @@ -24,7 +24,7 @@ public interface ITimeTrackingManagementService /// /// Get the current time tracking settings for a specific project. /// - /// Uses the REST API Get Time Tracking Settings for a Project. + /// Uses the REST API Get Time Tracking Settings for a Project. /// Id of the project to get timetracking settings for. /// . /// When the is null or empty. @@ -34,7 +34,7 @@ public interface ITimeTrackingManagementService /// /// Updates the current time tracking settings for a specific project. /// - /// Uses the REST API Configure time tracking settings for a specific project. + /// Uses the REST API Configure time tracking settings for a specific project. /// Id of the project to update. /// Timetracking settings for this project. /// When the is null or empty. diff --git a/src/YouTrackSharp/Management/IUserManagementService.cs b/src/YouTrackSharp/Management/IUserManagementService.cs index f1775dbf..2df95125 100644 --- a/src/YouTrackSharp/Management/IUserManagementService.cs +++ b/src/YouTrackSharp/Management/IUserManagementService.cs @@ -8,7 +8,7 @@ public interface IUserManagementService /// /// Get user by login name. /// - /// Uses the REST API Get user by login name. + /// Uses the REST API Find user by login name. /// A instance that represents the user matching or null if the user does not exist. /// When the call to the remote YouTrack server instance failed. /// When the is null or empty. @@ -17,7 +17,7 @@ public interface IUserManagementService /// /// Get a list of available registered users, paged per 10. Use the parameter to get subsequent results. /// - /// Uses the REST API Get a list of all available registered users. + /// Uses the REST API Get a list of all available registered users. /// Search query (part of user login, name or email). /// Filter by group (groupID). /// Filter by role. @@ -34,7 +34,7 @@ Task> GetUsers(string filter = null, string group = null, stri /// /// Create a new user. /// - /// Uses the REST API Create a new user. + /// Uses the REST API Create a new user. /// Login name of the user to be created. /// Full name of a new user. /// E-mail address of the user. @@ -46,7 +46,7 @@ Task> GetUsers(string filter = null, string group = null, stri /// /// Updates a user. /// - /// Uses the REST API Update a user. + /// Uses the REST API Update a user. /// Login name of the user to be updated. /// Full name of a user. /// E-mail address of the user. @@ -58,7 +58,7 @@ Task> GetUsers(string filter = null, string group = null, stri /// /// Delete specific user account. /// - /// Uses the REST API Delete a user. + /// Uses the REST API Delete a user. /// Login name of the user to be deleted. /// Login name of the user to inherit all data from user being deleted. /// When the call to the remote YouTrack server instance failed. @@ -67,7 +67,7 @@ Task> GetUsers(string filter = null, string group = null, stri /// /// Merge users. /// - /// Uses the REST API Delete a user. + /// Uses the REST API Merge a user. /// Login name of the user to be merged. /// Login name of the user to merge into. /// If set to true, bans target user when source user is banned. Defaults to true @@ -77,7 +77,7 @@ Task> GetUsers(string filter = null, string group = null, stri /// /// Get all groups the specified user participates in. /// - /// Uses the REST API Get all groups the specified user participates in. + /// Uses the REST API Get all groups the specified user participates in. /// Login name of the user to retrieve information for. /// A of instances. /// When the call to the remote YouTrack server instance failed. @@ -86,7 +86,7 @@ Task> GetUsers(string filter = null, string group = null, stri /// /// Add user to group. /// - /// Uses the REST API Add user account to a group. + /// Uses the REST API Add user account to a group. /// Login name of the user to be updated. /// Name of the group to add the user to. /// When the call to the remote YouTrack server instance failed. @@ -95,7 +95,7 @@ Task> GetUsers(string filter = null, string group = null, stri /// /// Remove user from group. /// - /// Uses the REST API Remove user account from a group. + /// Uses the REST API Remove user account from a group. /// Login name of the user to be updated. /// Name of the group to remove the user from. /// When the call to the remote YouTrack server instance failed. diff --git a/src/YouTrackSharp/Management/TimeTrackingManagementService.cs b/src/YouTrackSharp/Management/TimeTrackingManagementService.cs index 664eae56..511ece29 100644 --- a/src/YouTrackSharp/Management/TimeTrackingManagementService.cs +++ b/src/YouTrackSharp/Management/TimeTrackingManagementService.cs @@ -7,7 +7,7 @@ namespace YouTrackSharp.Management { /// - /// A class that represents a REST API client for administering Time Tracking Settings in YouTrack. + /// A class that represents a REST API client for administering Time Tracking Settings in YouTrack. /// It uses a implementation to connect to the remote YouTrack server instance. /// public class TimeTrackingManagementService : ITimeTrackingManagementService diff --git a/src/YouTrackSharp/Management/UserManagementService.cs b/src/YouTrackSharp/Management/UserManagementService.cs index 66d33fa8..52e9cb86 100644 --- a/src/YouTrackSharp/Management/UserManagementService.cs +++ b/src/YouTrackSharp/Management/UserManagementService.cs @@ -8,7 +8,7 @@ namespace YouTrackSharp.Management { /// - /// A class that represents a REST API client for administering user accounts in YouTrack. + /// A class that represents a REST API client for administering user accounts in YouTrack. /// It uses a implementation to connect to the remote YouTrack server instance. /// public class UserManagementService : IUserManagementService diff --git a/src/YouTrackSharp/Projects/IProjectCustomFieldsService.cs b/src/YouTrackSharp/Projects/IProjectCustomFieldsService.cs index 4a5251a3..745095f5 100644 --- a/src/YouTrackSharp/Projects/IProjectCustomFieldsService.cs +++ b/src/YouTrackSharp/Projects/IProjectCustomFieldsService.cs @@ -8,7 +8,7 @@ public interface IProjectCustomFieldsService /// /// Get custom fields used in a project. /// - /// Uses the REST API Get Project Custom Fields. + /// Uses the REST API Get Project Custom Fields. /// Id of the project to get the custom fields for. /// A of that are accessible for currently logged in user. /// When the call to the remote YouTrack server instance failed. @@ -17,7 +17,7 @@ public interface IProjectCustomFieldsService /// /// Get a project's custom field by its name. /// - /// Uses the REST API Get Project Custom Field. + /// Uses the REST API Get Project Custom Field. /// Id of the project to get the custom field for. /// Name of the custom field to get. /// . @@ -27,7 +27,7 @@ public interface IProjectCustomFieldsService /// /// Remove specified custom field from a project. /// - /// Uses the REST API Delete a project custom field. + /// Uses the REST API Delete a project custom field. /// Id of the project to delete the custom field for. /// Name of the custom field to delete. /// When the is null or empty. @@ -38,7 +38,7 @@ public interface IProjectCustomFieldsService /// /// Adds an existing custom field to a specific project. /// - /// Uses the REST API Create a project custom field. + /// Uses the REST API Create a project custom field. /// Id of the project to add a custom field. /// to add to the project. /// When the is null or empty. @@ -50,7 +50,7 @@ public interface IProjectCustomFieldsService /// /// Updates a custom field to a specific project. /// - /// Uses the REST API Updates a project custom field. + /// Uses the REST API Updates a project custom field. /// Id of the project. /// to update in project. /// When the is null or empty. diff --git a/src/YouTrackSharp/Projects/IProjectsService.cs b/src/YouTrackSharp/Projects/IProjectsService.cs index e361ac49..f169c3bd 100644 --- a/src/YouTrackSharp/Projects/IProjectsService.cs +++ b/src/YouTrackSharp/Projects/IProjectsService.cs @@ -8,7 +8,7 @@ public interface IProjectsService /// /// Get a list of all accessible projects from the server. /// - /// Uses the REST API Get Accessible Projects. + /// Uses the REST API Get Accessible Projects. /// If full representation of projects is returned. If this parameter is false, only short names and id's are returned. /// A of that are accessible for currently logged in user. /// When the call to the remote YouTrack server instance failed. diff --git a/src/YouTrackSharp/Projects/ProjectCustomFieldsService.cs b/src/YouTrackSharp/Projects/ProjectCustomFieldsService.cs index 9f57dc15..aa926673 100644 --- a/src/YouTrackSharp/Projects/ProjectCustomFieldsService.cs +++ b/src/YouTrackSharp/Projects/ProjectCustomFieldsService.cs @@ -8,7 +8,7 @@ namespace YouTrackSharp.Projects { /// - /// A class that represents a REST API client for methods related to operations with custom fields of a project. + /// A class that represents a REST API client for methods related to operations with custom fields of a project. /// It uses a implementation to connect to the remote YouTrack server instance. /// public class ProjectCustomFieldsService : IProjectCustomFieldsService diff --git a/src/YouTrackSharp/Projects/ProjectsService.cs b/src/YouTrackSharp/Projects/ProjectsService.cs index 8764607d..bb9120ef 100644 --- a/src/YouTrackSharp/Projects/ProjectsService.cs +++ b/src/YouTrackSharp/Projects/ProjectsService.cs @@ -7,7 +7,7 @@ namespace YouTrackSharp.Projects { /// - /// A class that represents a REST API client for YouTrack Projects Related Methods. + /// A class that represents a REST API client for YouTrack Projects Related Methods. /// It uses a implementation to connect to the remote YouTrack server instance. /// public class ProjectsService : IProjectsService diff --git a/src/YouTrackSharp/TimeTracking/ITimeTrackingService.cs b/src/YouTrackSharp/TimeTracking/ITimeTrackingService.cs index 5bbfa7ba..4c1d5fe0 100644 --- a/src/YouTrackSharp/TimeTracking/ITimeTrackingService.cs +++ b/src/YouTrackSharp/TimeTracking/ITimeTrackingService.cs @@ -8,7 +8,7 @@ public interface ITimeTrackingService /// /// Get work types for a specific project from the server. /// - /// Uses the REST API GET Work Types for a Project. + /// Uses the REST API GET Work Types for a Project. /// Id of the project to get work items for. /// An of for the requested project . /// When the is null or empty. @@ -19,7 +19,7 @@ public interface ITimeTrackingService /// /// Get work items for a specific issue from the server. /// - /// Uses the REST API Get Available Work Items of Issue. + /// Uses the REST API Get Available Work Items of Issue. /// Id of the issue to get work items for. /// An of for the requested issue . /// When the is null or empty. @@ -30,7 +30,7 @@ public interface ITimeTrackingService /// /// Creates a work item for an issue on the server. /// - /// Uses the REST API Create New Work Item. + /// Uses the REST API Create New Work Item. /// Id of the issue to create the work item for. /// The to create. /// The newly created 's id on the server. @@ -42,7 +42,7 @@ public interface ITimeTrackingService /// /// Updates a work item for an issue on the server. /// - /// Uses the REST API Edit Existing Work Item. + /// Uses the REST API Edit Existing Work Item. /// Id of the issue to update the work item for. /// Id of the work item to update. /// The to update. @@ -54,7 +54,7 @@ public interface ITimeTrackingService /// /// Deletes a work item for an issue from the server. /// - /// Uses the REST API Delete Existing Work Item. + /// Uses the REST API Delete Existing Work Item. /// Id of the issue to delete the work item for. /// Id of the work item to delete. /// When the or is null or empty. diff --git a/src/YouTrackSharp/TimeTracking/TimeTrackingService.cs b/src/YouTrackSharp/TimeTracking/TimeTrackingService.cs index 9408afce..c895f1d1 100644 --- a/src/YouTrackSharp/TimeTracking/TimeTrackingService.cs +++ b/src/YouTrackSharp/TimeTracking/TimeTrackingService.cs @@ -8,7 +8,7 @@ namespace YouTrackSharp.TimeTracking { /// - /// A class that represents a REST API client for YouTrack Time Tracking User Methods. + /// A class that represents a REST API client for YouTrack Time Tracking User Methods. /// It uses a implementation to connect to the remote YouTrack server instance. /// public class TimeTrackingService : ITimeTrackingService diff --git a/src/YouTrackSharp/Users/IUserService.cs b/src/YouTrackSharp/Users/IUserService.cs index f3bbf2cb..c75f4691 100644 --- a/src/YouTrackSharp/Users/IUserService.cs +++ b/src/YouTrackSharp/Users/IUserService.cs @@ -9,7 +9,7 @@ public interface IUserService /// /// Get info about currently logged in user. /// - /// Uses the REST API Get Info For Current User. + /// Uses the REST API Get Info For Current User. /// A instance that represents the currently logged in user. /// When the call to the remote YouTrack server instance failed. Task GetCurrentUserInfo(); diff --git a/src/YouTrackSharp/Users/UserService.cs b/src/YouTrackSharp/Users/UserService.cs index 2c9233a1..5e6a1744 100644 --- a/src/YouTrackSharp/Users/UserService.cs +++ b/src/YouTrackSharp/Users/UserService.cs @@ -4,7 +4,7 @@ namespace YouTrackSharp.Users { /// - /// A class that represents a REST API client for YouTrack User Related Methods. + /// A class that represents a REST API client for YouTrack My User Profile Methods. /// It uses a implementation to connect to the remote YouTrack server instance. /// public class UserService : IUserService