Skip to content

Commit

Permalink
Add XMLDOC generation (#21)
Browse files Browse the repository at this point in the history
Looks like we missed adding the XMLDOC to the automated GitHub SDK build process, so context sensitive help wasn't showing on each build.  Let's fix.
  • Loading branch information
tspence authored Jan 26, 2024
1 parent 2c30b98 commit e23b423
Show file tree
Hide file tree
Showing 11 changed files with 72 additions and 11 deletions.
6 changes: 5 additions & 1 deletion ProjectManagerClient.nuspec
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<package >
<metadata>
<id>ProjectManager.SDK</id>
<version>102.0.2886</version>
<version>102.0.2887</version>
<title>ProjectManager.SDK</title>
<authors>ProjectManager.com</authors>
<owners>ProjectManager.com, Inc.</owners>
Expand All @@ -14,6 +14,10 @@
<readme>docs/README.md</readme>
<summary>ProjectManager API for DotNet</summary>
<releaseNotes>
# Patch notes for 102.0.2887

Added XMLDOC to the automated SDK build-and-publish process.

# Patch notes for 102.0.2886

These patch notes summarize the changes from version 99.0.2550.
Expand Down
3 changes: 3 additions & 0 deletions src/AstroError.cs
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@

namespace ProjectManager.SDK
{
/// <summary>
/// Information about an API error received from ProjectManager.com
/// </summary>
public class AstroError
{

Expand Down
7 changes: 7 additions & 0 deletions src/Clients/TaskMetadataClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,13 @@ public async Task<AstroResult<string>> AddMetadata(Guid taskId, TaskMetadataUpda
return await _client.Request<string>(HttpMethod.Put, url, options, body, null);
}

/// <summary>
/// Retrieve metadata about tasks for a project
/// </summary>
/// <param name="projectId">The unique ID of the project</param>
/// <param name="foreignKey">The foreign key of the project</param>
/// <param name="isSystem">A flag indicating whether this is a system call</param>
/// <returns></returns>
public async Task<AstroResult<TaskMetadataSearchDto[]>> GetTasksByProjectIdAndForeignKeyId(Guid projectId, string foreignKey = null, bool? isSystem = null)
{
var url = $"/api/data/projects/{projectId}/tasks/metadata";
Expand Down
37 changes: 37 additions & 0 deletions src/Enums.cs
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,14 @@ namespace ProjectManager.SDK
/// </summary>
public static class DashboardTypeValues
{
/// <summary>
/// The "My Summary" dashboard
/// </summary>
public const string MySummary = "MySummary";

/// <summary>
/// The portfolio summary dashboard
/// </summary>
public const string PortfolioSummary = "PortfolioSummary";
}

Expand All @@ -30,9 +37,24 @@ public static class DashboardTypeValues
/// </summary>
public static class ProjectPermissionValues
{
/// <summary>
/// Represents a guest user within the project
/// </summary>
public const string Guest = "Guest";

/// <summary>
/// Represents a collaborator who can make some changes to a project
/// </summary>
public const string Collaborate = "Collaborate";

/// <summary>
/// Represents an editor who can make most changes to a project
/// </summary>
public const string Editor = "Editor";

/// <summary>
/// Represents a manager who can make all changes to a project
/// </summary>
public const string Manager = "Manager";
}

Expand All @@ -41,9 +63,24 @@ public static class ProjectPermissionValues
/// </summary>
public static class StateValues
{
/// <summary>
/// Indicates that work has not yet started
/// </summary>
public const string NotStarted = "NotStarted";

/// <summary>
/// Some work has started, but it is not yet completed
/// </summary>
public const string InProgress = "InProgress";

/// <summary>
/// Completed successfully
/// </summary>
public const string Success = "Success";

/// <summary>
/// Failed
/// </summary>
public const string Fail = "Fail";
}
}
7 changes: 7 additions & 0 deletions src/Interfaces/ITaskMetadataClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,13 @@ public interface ITaskMetadataClient
/// <param name="body">The metadata</param>
Task<AstroResult<string>> AddMetadata(Guid taskId, TaskMetadataUpdateDto body, bool? isSystem = null, bool? isOverride = null);

/// <summary>
/// Retrieve metadata about tasks for a project
/// </summary>
/// <param name="projectId">The unique ID of the project</param>
/// <param name="foreignKey">The foreign key of the project</param>
/// <param name="isSystem">A flag indicating whether this is a system call</param>
/// <returns></returns>
Task<AstroResult<TaskMetadataSearchDto[]>> GetTasksByProjectIdAndForeignKeyId(Guid projectId, string foreignKey = null, bool? isSystem = null);
}
}
3 changes: 3 additions & 0 deletions src/Models/DiscussionCommentFileDto.cs
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@
namespace ProjectManager.SDK.Models
{

/// <summary>
/// Discussion comment file
/// </summary>
public class DiscussionCommentFileDto : ApiModel
{

Expand Down
3 changes: 3 additions & 0 deletions src/Models/ProjectFileDto.cs
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@
namespace ProjectManager.SDK.Models
{

/// <summary>
/// Project File
/// </summary>
public class ProjectFileDto : ApiModel
{

Expand Down
3 changes: 3 additions & 0 deletions src/Models/ProjectFileTaskDto.cs
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@
namespace ProjectManager.SDK.Models
{

/// <summary>
/// A file attached to a project and task
/// </summary>
public class ProjectFileTaskDto : ApiModel
{

Expand Down
3 changes: 3 additions & 0 deletions src/Models/TimesheetFileDto.cs
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@
namespace ProjectManager.SDK.Models
{

/// <summary>
/// A file attached to a timesheet
/// </summary>
public class TimesheetFileDto : ApiModel
{

Expand Down
1 change: 1 addition & 0 deletions src/ProjectManager.SDK.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
<TargetFramework>netstandard2.0</TargetFramework>
<ImplicitUsings>disable</ImplicitUsings>
<Nullable>disable</Nullable>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
</PropertyGroup>

<ItemGroup>
Expand Down
10 changes: 0 additions & 10 deletions src/State.cs

This file was deleted.

0 comments on commit e23b423

Please sign in to comment.