Skip to content

Commit

Permalink
update links to REST API documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
rekolobov committed Jan 26, 2022
1 parent 32475f3 commit 2edd3d8
Show file tree
Hide file tree
Showing 15 changed files with 52 additions and 52 deletions.
4 changes: 2 additions & 2 deletions src/YouTrackSharp/ColorIndices.cs
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@
namespace YouTrackSharp
{
/// <summary>
/// Represents the color indices used by YouTrack, as explained on <a href="https://www.jetbrains.com/help/youtrack/standalone/Color-Indices.html">Color Indices List</a>.
/// Represents the color indices used by YouTrack, as explained on <a href="https://www.jetbrains.com/help/youtrack/devportal/Color-Indices.html">Color Indices List</a>.
/// </summary>
[PublicAPI]
public static class ColorIndices
{
/// <summary>
/// Supported color indices. The array index corresponds to the documented <a href="https://www.jetbrains.com/help/youtrack/standalone/Color-Indices.html">color index</a>.
/// Supported color indices. The array index corresponds to the documented <a href="https://www.jetbrains.com/help/youtrack/devportal/Color-Indices.html">color index</a>.
/// </summary>
public static readonly YouTrackColor[] Colors = {
new YouTrackColor { Foreground = "#444", Background = "#fff" },
Expand Down
36 changes: 18 additions & 18 deletions src/YouTrackSharp/Issues/IIssuesService.cs
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ public interface IIssuesService
/// <summary>
/// Get a specific issue from the server.
/// </summary>
/// <remarks>Uses the REST API <a href="https://www.jetbrains.com/help/youtrack/standalone/Get-an-Issue.html">Get an Issue</a>.</remarks>
/// <remarks>Uses the REST API <a href="https://www.jetbrains.com/help/youtrack/devportal/operations-api-issues.html#get-Issue-method">Get an Issue</a>.</remarks>
/// <param name="issueId">Id of an issue to get.</param>
/// <param name="wikifyDescription">If set to <value>true</value>, then issue description in the response will be formatted ("wikified"). Defaults to <value>false</value>.</param>
/// <param name="wikifyContents">If set to <value>true</value>, then comments and issue text fields in the response will be formatted ("wikified"). Defaults to <value>false</value>.</param>/// <returns>The <see cref="Issue" /> that matches the requested <paramref name="issueId"/>.</returns>
Expand All @@ -21,7 +21,7 @@ public interface IIssuesService
/// <summary>
/// Checks whether an issue exists on the server.
/// </summary>
/// <remarks>Uses the REST API <a href="https://www.jetbrains.com/help/youtrack/standalone/Check-that-an-Issue-Exists.html">Check that an Issue Exists</a>.</remarks>
/// <remarks>Uses the REST API <a href="https://www.jetbrains.com/help/youtrack/devportal/operations-api-issues.html#get-Issue-method">Check that an Issue Exists</a>.</remarks>
/// <param name="issueId">Id of an issue to check.</param>
/// <returns><value>True</value> if the issue exists, otherwise <value>false</value>.</returns>
/// <exception cref="T:System.ArgumentNullException">When the <paramref name="issueId"/> is null or empty.</exception>
Expand All @@ -31,7 +31,7 @@ public interface IIssuesService
/// <summary>
/// Creates an issue on the server in a specific project.
/// </summary>
/// <remarks>Uses the REST API <a href="https://www.jetbrains.com/help/youtrack/standalone/Create-New-Issue.html">Create New Issue</a>.</remarks>
/// <remarks>Uses the REST API <a href="https://www.jetbrains.com/help/youtrack/devportal/resource-api-issues.html#create-Issue-method">Create New Issue</a>.</remarks>
/// <param name="projectId">Id of the project to create an issue in.</param>
/// <param name="issue">The <see cref="Issue" /> to create. At the minimum needs the Summary field populated.</param>
/// <returns>The newly created <see cref="Issue" />'s id on the server.</returns>
Expand All @@ -43,7 +43,7 @@ public interface IIssuesService
/// <summary>
/// Updates an issue on the server in a specific project.
/// </summary>
/// <remarks>Uses the REST API <a href="https://www.jetbrains.com/help/youtrack/standalone/Update-an-Issue.html">Update an Issue</a>.</remarks>
/// <remarks>Uses the REST API <a href="https://www.jetbrains.com/help/youtrack/devportal/operations-api-issues.html#update-Issue-method">Update an Issue</a>.</remarks>
/// <param name="issueId">Id of the issue to update.</param>
/// <param name="summary">Updated summary of the issue.</param>
/// <param name="description">Updated description of the issue.</param>
Expand All @@ -56,7 +56,7 @@ public interface IIssuesService
/// <summary>
/// Applies a command to a specific issue on the server.
/// </summary>
/// <remarks>Uses the REST API <a href="https://www.jetbrains.com/help/youtrack/standalone/Apply-Command-to-an-Issue.html">Apply Command to an Issue</a>.</remarks>
/// <remarks>Uses the REST API <a href="https://www.jetbrains.com/help/youtrack/devportal/resource-api-commands.html#create-CommandList-method">Apply Command to an Issue</a>.</remarks>
/// <param name="issueId">Id of the issue to apply the command to.</param>
/// <param name="command">The command to apply. A command might contain a string of attributes and their values - you can change multiple fields with one complex command.</param>
/// <param name="comment">A comment to add to an issue.</param>
Expand All @@ -70,7 +70,7 @@ public interface IIssuesService
/// <summary>
/// Deletes an issue from the server.
/// </summary>
/// <remarks>Uses the REST API <a href="https://www.jetbrains.com/help/youtrack/standalone/Delete-an-Issue.html">Delete an Issue</a>.</remarks>
/// <remarks>Uses the REST API <a href="https://www.jetbrains.com/help/youtrack/devportal/operations-api-issues.html#delete-Issue-method">Delete an Issue</a>.</remarks>
/// <param name="issueId">Id of an issue to delete.</param>
/// <exception cref="T:System.ArgumentNullException">When the <paramref name="issueId"/> is null or empty.</exception>
/// <exception cref="T:System.Net.HttpRequestException">When the call to the remote YouTrack server instance failed.</exception>
Expand All @@ -79,7 +79,7 @@ public interface IIssuesService
/// <summary>
/// Get links for a specific issue from the server.
/// </summary>
/// <remarks>Uses the REST API <a href="https://www.jetbrains.com/help/youtrack/standalone/Get-Links-of-an-Issue.html">Get Links of an Issue</a>.</remarks>
/// <remarks>Uses the REST API <a href="https://www.jetbrains.com/help/youtrack/devportal/resource-api-issues-issueID-links.html#get_all-IssueLink-method">Get Links of an Issue</a>.</remarks>
/// <param name="issueId">Id of the issue to get links for.</param>
/// <returns>An <see cref="T:System.Collections.Generic.IEnumerable`1" /> of <see cref="Link" /> for the requested issue <paramref name="issueId"/>.</returns>
/// <exception cref="T:System.ArgumentNullException">When the <paramref name="issueId"/> is null or empty.</exception>
Expand All @@ -89,7 +89,7 @@ public interface IIssuesService
/// <summary>
/// Get issues in a project from the server.
/// </summary>
/// <remarks>Uses the REST API <a href="https://www.jetbrains.com/help/youtrack/standalone/Get-Issues-in-a-Project.html">Get Issues in a Project</a>.</remarks>
/// <remarks>Uses the REST API <a href="https://www.jetbrains.com/help/youtrack/devportal/resource-api-issues.html#get_all-Issue-method">Find Issues belonging to a Project</a>.</remarks>
/// <param name="projectId">Id of a project to get issues from.</param>
/// <param name="filter">Apply a filter to issues in a project.</param>
/// <param name="skip">The number of issues to skip before getting a list of issues.</param>
Expand All @@ -106,7 +106,7 @@ Task<ICollection<Issue>> GetIssuesInProject(string projectId, string filter = nu
/// <summary>
/// Get issues from the server.
/// </summary>
/// <remarks>Uses the REST API <a href="https://www.jetbrains.com/help/youtrack/standalone/Get-the-List-of-Issues.html">Get the List of Issues</a>.</remarks>
/// <remarks>Uses the REST API <a href="https://www.jetbrains.com/help/youtrack/devportal/resource-api-issues.html#get_all-Issue-method">Get the List of Issues</a>.</remarks>
/// <param name="filter">Apply a filter to issues.</param>
/// <param name="skip">The number of issues to skip before getting a list of issues.</param>
/// <param name="take">Maximum number of issues to be returned. Defaults to the server-side default of the YouTrack server instance.</param>
Expand All @@ -119,7 +119,7 @@ Task<ICollection<Issue>> GetIssues(string filter = null, int? skip = null, int?
/// <summary>
/// Get issue count from the server. This operation may be retried internally and take a while to complete.
/// </summary>
/// <remarks>Uses the REST API <a href="https://www.jetbrains.com/help/youtrack/standalone/Get-a-Number-of-Issues.html">Get a Number of Issues</a>.</remarks>
/// <remarks>Uses the REST API <a href="https://www.jetbrains.com/help/youtrack/devportal/resource-api-issuesGetter-count.html">Get a Number of Issues</a>.</remarks>
/// <param name="filter">Apply a filter to issues.</param>
/// <returns>The number of <see cref="Issue" /> that match the specified filter.</returns>
/// <exception cref="T:System.Net.HttpRequestException">When the call to the remote YouTrack server instance failed.</exception>
Expand All @@ -128,7 +128,7 @@ Task<ICollection<Issue>> GetIssues(string filter = null, int? skip = null, int?
/// <summary>
/// Get change history for a specific issue from the server.
/// </summary>
/// <remarks>Uses the REST API <a href="https://www.jetbrains.com/help/youtrack/standalone/Get-Historical-Changes-of-an-Issue.html">Get Changes of an Issue</a>.</remarks>
/// <remarks>Uses the REST API <a href="https://www.jetbrains.com/help/youtrack/devportal/resource-api-issues-issueID-activities.html#get_all-ActivityItem-method">Get Changes of an Issue</a>.</remarks>
/// <param name="issueId">Id of the issue to get change history for.</param>
/// <returns>An <see cref="T:System.Collections.Generic.IEnumerable`1" /> of <see cref="Change" /> for the requested issue <paramref name="issueId"/>.</returns>
/// <exception cref="T:System.ArgumentNullException">When the <paramref name="issueId"/> is null or empty.</exception>
Expand All @@ -138,7 +138,7 @@ Task<ICollection<Issue>> GetIssues(string filter = null, int? skip = null, int?
/// <summary>
/// Get comments for a specific issue from the server.
/// </summary>
/// <remarks>Uses the REST API <a href="https://www.jetbrains.com/help/youtrack/standalone/Get-Comments-of-an-Issue.html">Get Comments of an Issue</a>.</remarks>
/// <remarks>Uses the REST API <a href="https://www.jetbrains.com/help/youtrack/devportal/resource-api-issues-issueID-comments.html#get_all-IssueComment-method">Get Comments of an Issue</a>.</remarks>
/// <param name="issueId">Id of the issue to get comments for.</param>
/// <param name="wikifyDescription">If set to <value>true</value>, then comments in the response will be formatted ("wikified"). Defaults to <value>false</value>.</param>
/// <returns>An <see cref="T:System.Collections.Generic.IEnumerable`1" /> of <see cref="Comment" /> for the requested issue <paramref name="issueId"/>.</returns>
Expand All @@ -149,7 +149,7 @@ Task<ICollection<Issue>> GetIssues(string filter = null, int? skip = null, int?
/// <summary>
/// Adds a comment for an issue on the server.
/// </summary>
/// <remarks>Uses the REST API <a href="https://www.jetbrains.com/help/youtrack/devportal/resource-api-issues-issueID-comments.html#create-IssueComment-method">Update a Comment</a>.</remarks>
/// <remarks>Uses the REST API <a href="https://www.jetbrains.com/help/youtrack/devportal/resource-api-issues-issueID-comments.html#create-IssueComment-method">Create a Comment</a>.</remarks>
/// <param name="issueId">Id of the issue to add comment to.</param>
/// <param name="text">The text of the new comment.</param>
/// <exception cref="T:System.ArgumentNullException">When the <paramref name="issueId"/> or <paramref name="text"/> is null or empty.</exception>
Expand All @@ -159,7 +159,7 @@ Task<ICollection<Issue>> GetIssues(string filter = null, int? skip = null, int?
/// <summary>
/// Updates a comment for an issue on the server.
/// </summary>
/// <remarks>Uses the REST API <a href="https://www.jetbrains.com/help/youtrack/standalone/Update-a-Comment.html">Update a Comment</a>.</remarks>
/// <remarks>Uses the REST API <a href="https://www.jetbrains.com/help/youtrack/devportal/operations-api-issues-issueID-comments.html#update-IssueComment-method">Update a Comment</a>.</remarks>
/// <param name="issueId">Id of the issue to which the comment belongs.</param>
/// <param name="commentId">Id of the comment to update.</param>
/// <param name="text">The new text of the comment.</param>
Expand All @@ -170,7 +170,7 @@ Task<ICollection<Issue>> GetIssues(string filter = null, int? skip = null, int?
/// <summary>
/// Deletes a comment for an issue from the server.
/// </summary>
/// <remarks>Uses the REST API <a href="https://www.jetbrains.com/help/youtrack/standalone/Remove-a-Comment-for-an-Issue.html">Remove a Comment for an Issue</a>.</remarks>
/// <remarks>Uses the REST API <a href="https://www.jetbrains.com/help/youtrack/devportal/operations-api-issues-issueID-comments.html#delete-IssueComment-method">Remove a Comment for an Issue</a>.</remarks>
/// <param name="issueId">Id of the issue to which the comment belongs.</param>
/// <param name="commentId">Id of the comment to delete.</param>
/// <param name="permanent">When <value>true</value>, the specified comment will be deleted permanently and can not be restored afterwards. Defaults to <value>false</value>.</param>
Expand All @@ -181,7 +181,7 @@ Task<ICollection<Issue>> GetIssues(string filter = null, int? skip = null, int?
/// <summary>
/// Attaches a file to an issue on the server.
/// </summary>
/// <remarks>Uses the REST API <a href="https://www.jetbrains.com/help/youtrack/standalone/Attach-File-to-an-Issue.html">Attach File to an Issue</a>.</remarks>
/// <remarks>Uses the REST API <a href="https://www.jetbrains.com/help/youtrack/devportal/resource-api-issues-issueID-attachments.html#create-IssueAttachment-method">Attach File to an Issue</a>.</remarks>
/// <param name="issueId">Id of the issue to attach the file to.</param>
/// <param name="attachmentName">Filename for the attachment.</param>
/// <param name="attachmentStream">The <see cref="T:System.IO.Stream"/> to attach.</param>
Expand All @@ -195,7 +195,7 @@ Task<ICollection<Issue>> GetIssues(string filter = null, int? skip = null, int?
/// <summary>
/// Get attachments for a specific issue from the server.
/// </summary>
/// <remarks>Uses the REST API <a href="https://www.jetbrains.com/help/youtrack/standalone/Get-Attachments-of-an-Issue.html">Get Attachments of an Issue</a>.</remarks>
/// <remarks>Uses the REST API <a href="https://www.jetbrains.com/help/youtrack/devportal/resource-api-issues-issueID-attachments.html#get_all-IssueAttachment-method">Get Attachments of an Issue</a>.</remarks>
/// <param name="issueId">Id of the issue to get comments for.</param>
/// <returns>An <see cref="T:System.Collections.Generic.IEnumerable`1" /> of <see cref="Attachment" /> for the requested issue <paramref name="issueId"/>.</returns>
/// <exception cref="T:System.ArgumentNullException">When the <paramref name="issueId"/> is null or empty.</exception>
Expand All @@ -214,7 +214,7 @@ Task<ICollection<Issue>> GetIssues(string filter = null, int? skip = null, int?
/// <summary>
/// Deletes an attachment for an issue from the server.
/// </summary>
/// <remarks>Uses the REST API <a href="https://www.jetbrains.com/help/youtrack/standalone/Delete-Attachment-from-an-Issue.html">Delete Attachment from an Issue</a>.</remarks>
/// <remarks>Uses the REST API <a href="https://www.jetbrains.com/help/youtrack/devportal/operations-api-issues-issueID-attachments.html#delete-IssueAttachment-method">Delete Attachment from an Issue</a>.</remarks>
/// <param name="issueId">Id of the issue to which the attachment belongs.</param>
/// <param name="attachmentId">Id of the attachment.</param>
/// <exception cref="T:System.ArgumentNullException">When the <paramref name="issueId"/> or <paramref name="attachmentId"/> is null or empty.</exception>
Expand Down
2 changes: 1 addition & 1 deletion src/YouTrackSharp/Issues/IssuesService.cs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
namespace YouTrackSharp.Issues
{
/// <summary>
/// A class that represents a REST API client for <a href="https://www.jetbrains.com/help/youtrack/standalone/Issues-Related-Methods.html">YouTrack Issues Related Methods</a>.
/// A class that represents a REST API client for <a href="https://www.jetbrains.com/help/youtrack/devportal/resource-api-issues.html">YouTrack Issues Related Methods</a>.
/// It uses a <see cref="Connection" /> implementation to connect to the remote YouTrack server instance.
/// </summary>
public partial class IssuesService : IIssuesService
Expand Down
Loading

0 comments on commit 2edd3d8

Please sign in to comment.