-
Notifications
You must be signed in to change notification settings - Fork 0
Code documentation
Extension class to help work with the Fields property of Microsoft DevOps models
TryGet the value of the corresponding key. If the value is present, a cast is applied, and the value is returned.
- T - Type of the corresponding value
System.ArgumentNullException:
System.InvalidCastException:
TryGet the value of the corresponding key. If the value is present, a cast is applied, and the value is returned.
- T - Type of the corresponding value
System.ArgumentNullException:
System.InvalidCastException:
Get the value of a corresponding key. If the value is present, ToString is called on the object and System.Json.Text deserialization will be executed on this value.
System.ArgumentNullException:
System.Text.Json.JsonException:
System.NotSupportedException:
Get the value of a corresponding key or null of the dictionary does not contain the key.
System.ArgumentNullException:
Extension to help to work with JSON data
Transform a string a formatted JSON string
Newtonsoft.Json.JsonReaderException:
The object used to deserialize list response from the Azure DevOps REST API.
- T - Type of the resource
The quantity of element
The list of resource
An object containing a link
Href or link
System.UriFormatException:
Uri instance of the Href property
The descriptor field in the REST response
MemberVelocity is the model used to display stat about the velocity of a member.
The capacity saved. Normally based on the response of the Capacity REST API.
Comparer MemberVelocity by HoursOfWorkDone
The name of the member
The hours of work done. Normally calculated from the History according to the member.
Estimated calculation of the real capacity of a member.
List of WorkItemUpdate associate to this member
Representation of the sprint resource of the Azure DevOps API
The attributes of the sprint. Such as Start Date, Finish Date, and TimeFrame
Calculate the number of total days between the Start Date and the FinishDate
Get total working days of a sprint.
Ensure to pass non-null reference for each parameter. It will allow the function to do the right calculation. Since each parameter ar consider if they are not null.
| Name | Description |
|---|---|
| workingDays |
System.DayOfWeek[] List of working days |
| teamDaysOff |
Microsoft.TeamFoundation.Work.WebApi.TeamSettingsDaysOff TeamDaysOff information |
GetTotalDays() - days off
Id of the sprint
Links related to the sprint
Name of the sprint
The Path of the sprint
The Url of the sprint
The attributes of a sprint
Finish date
Start date
TimeFrame, current, past.
Links related to a sprint
Link to get capacity information of the sprint
The classification node of the sprint
Link of the project of the sprint
Link of the sprint itself
Link of the team
Link to get days off of the sprint
The link of the iterations
The team settings link
Link to get related work item
Work item links object
The work item Fields URL
The work item Html URL
The work item URL
The work comments URL
The work item revisions URL
The work item Type URL
The work item updates URL
A work item graph
Work item URL
List of related work item
Compare a WorkItemUpdate base on the RelatedTaskTitle and if the save the RevisedDate
The title of the associate WorkItem.
Must be managed by the program logic. This data is not in the response of Azure DevOps REST API.
ErrorModel code generated by the dotnet new command
The OnGet Method of the page
ResquestId associate with the error
Indicated if RequestId can be shown. (If not NullOrEmpty)
The entry point of the program. It also contains settings to use for System.Text.Json serialization.
Create the host builder with some default settings
| Name | Description |
|---|---|
| args |
System.String[] Main method args |
A new HostBuilder
The entry point of the program
| Name | Description |
|---|---|
| args |
System.String[] |
System.Text.Json SerializerOptions to use in serialization in the app.
DevOpsProxy class is used to call Azure DevOps REST API. Implement rate-limiting and ensure URL validation.
Constructor with dependencies
| Name | Description |
|---|---|
| client |
System.Net.Http.HttpClient HttpClient to used |
| appSettings |
AzureDevOpsTeamMembersVelocity.TeamMembersVelocitySettings App settings, to acces AuthenticationHeader |
| logger |
Microsoft.Extensions.Logging.ILogger{AzureDevOpsTeamMembersVelocity.Proxy.DevOpsProxy} Logger to log information and critical error |
Get the body content of a response according to a fullUrl
| Name | Description |
|---|---|
| fullUrl |
System.String Complete URL of the resource to fetch. Must start with https://dev.azure.com/ |
The response body as a string
Get the body content of a response according to a fullUrl
- T - Type used in deserialization
| Name | Description |
|---|---|
| fullUrl |
System.String Complete URL of the resource to fetch. Must start with https://dev.azure.com/ |
The response body Deserialized as T
Classed used to call and deserialize resource from the Azure DevOps REST API
Constructor with dependencies
| Name | Description |
|---|---|
| proxy |
AzureDevOpsTeamMembersVelocity.Proxy.DevOpsProxy The proxy used to call the REST API |
Get the capacity of a sprint given a full URL
api-version 6.0 is used
| Name | Description |
|---|---|
| capacityUrl |
System.String The full URL of the capacity information. |
The list of capacities
Get the list of projects list of an organization.
| Name | Description |
|---|---|
| organization |
System.String Name of the organization. https://dev.azure.com/{organization} |
List of TeamProject
Get the sprint given a full URL
api-version 6.0 is used
| Name | Description |
|---|---|
| sprintUrl |
System.String The full URL of the sprint. |
The instance of the sprint
Get the list of sprints of a team.
| Name | Description |
|---|---|
| organization |
System.String Name of the organisation. https://dev.azure.com/{organisation} |
| project |
System.String |
| team |
System.String |
Get team days off from the teamIterationDaysOffUrl passed and deserialize the response.
The api-version used is 6.0, and the caller is not expected to specify the version in the URL.
| Name | Description |
|---|---|
| teamIterationDaysOffUrl |
System.String URL of team days off to fetch |
Return the list of Teams of an organization TeamProject
| Name | Description |
|---|---|
| organization |
System.String Name of the organization. https://dev.azure.com/{organization} |
| teamProjectId |
System.Guid Id of the organization team project selected |
List of teams
Get Team Settings given a team settings URL
api-version 6.0 is used
| Name | Description |
|---|---|
| teamSettingsUrl |
System.String The teamSettings full URL without the api-version |
The teamSetting instance
Get the list of updates from the updatesUrl passed and deserialize the response.
The api-version used is 6.0, and the caller is not expected to specify the version in the URL.
| Name | Description |
|---|---|
| updatesUrl |
System.String URL of updates to fetch |
Get a workItem given a workItemUrl
| Name | Description |
|---|---|
| workItemUrl |
System.String workItem fullUrl |
The WorkItem deserialized
Get the list of work item links given the URL of the sprint.
| Name | Description |
|---|---|
| sprintUrl |
System.String The URL of the sprint has returned by the DevOpsService.Sprints(System.String,System.String,System.String) method/> |
A work item with details
Service use to aggregate and group history of a sprint
Constructor with dependencies
| Name | Description |
|---|---|
| devOpsService |
AzureDevOpsTeamMembersVelocity.Services.DevOpsService Instance of DevOpsService use to fetch data needed |
Group the list of updates into the MemberVelocity object associate with the person name
| Name | Description |
|---|---|
| groupByPerson |
System.Collections.Generic.Dictionary{System.String,AzureDevOpsTeamMembersVelocity.Model.MemberVelocity} Dictionary used to to the group by, can be pre-populated |
| workItem |
AzureDevOpsTeamMembersVelocity.Model.WorkItem Work item |
| workItemUpdates |
System.Collections.Generic.List{AzureDevOpsTeamMembersVelocity.Model.WorkItemUpdate} List of updates to group |
Asynchronously enumerate each member's velocity. Previously return member also updates if needed at each iteration.
| Name | Description |
|---|---|
| sprintUrl |
System.String Sprint to analyse |
| capacities |
System.Collections.Generic.List{AzureDevOpsTeamMembersVelocity.Model.Capacity} Capacities informations to enhance result |
| sprint |
AzureDevOpsTeamMembersVelocity.Model.Sprint Sprint information is use to enhance result |
| teamDaysOff |
Microsoft.TeamFoundation.Work.WebApi.TeamSettingsDaysOff Team days off is use to enhance result and do the right calculation |
| teamSettings |
Microsoft.TeamFoundation.Work.WebApi.TeamSetting Team settings is use to enhance result and do the right calculation |
The startup class uses to build the application.
Configure(Microsoft.AspNetCore.Builder.IApplicationBuilder,Microsoft.AspNetCore.Hosting.IWebHostEnvironment)
This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
This method gets called by the runtime. Use this method to add services to the container. For more information on how to configure your application, visit https://go.microsoft.com/fwlink/?LinkID=398940
| Name | Description |
|---|---|
| services |
Microsoft.Extensions.DependencyInjection.IServiceCollection |
This is the main configuration of the app. Those settings can be saved on disk using the persist button on the index.html page.
The ApiKey of the user
Return the Authentication header object that can be used by assigned this property to the Authorization property of System.Net.Http.HttpClient.DefaultRequestHeaders the Azure DevOps REST API
Organization selected
Team selected
Team project selected
Team project resource of the Azure DevOps REST API
Id of the TeamProject
Last time updated
Name of the team project
Revision of the TeamProject
State of the TeamProject
Url of the TeamProject
Visibility of the team project