Skip to content

Add GenerateDocumentationFile to make summaries show up in IDEs #365

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Sep 24, 2024
Merged

Add GenerateDocumentationFile to make summaries show up in IDEs #365

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
5b971b4
Add GenerateDocumentationFile to make summaries show up in IDEs
NielsPilgaard Sep 22, 2024
96a8e8a
Merge branch 'master' into patch-1
NielsPilgaard Sep 23, 2024
f7a20db
Ignore warning CS1591
NielsPilgaard Sep 23, 2024
f38070d
Fix warnings
NielsPilgaard Sep 23, 2024
390775f
Merge branch 'master' into patch-1
NielsPilgaard Sep 23, 2024
83ab52a
Remember the CS prefix
NielsPilgaard Sep 23, 2024
c69dd7b
More summary warning fixes
NielsPilgaard Sep 23, 2024
70b72cc
Merge branch 'patch-1' of https://github.com/NielsPilgaard/consuldotn…
NielsPilgaard Sep 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions Consul/ACL.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,7 @@ private class ACLCreationResult
/// [Deprecated] Create is used to generate a new token with the given parameters
/// </summary>
/// <param name="acl">The ACL entry to create</param>
/// <param name="ct">The cancellation token</param>
/// <returns>A write result containing the newly created ACL token</returns>
[Obsolete("The Legacy ACL system has been deprecated, please use Token, Role and Policy instead.")]
public Task<WriteResult<string>> Create(ACLEntry acl, CancellationToken ct = default)
Expand All @@ -214,6 +215,7 @@ public Task<WriteResult<string>> Create(ACLEntry acl, CancellationToken ct = def
/// </summary>
/// <param name="acl">The ACL entry to create</param>
/// <param name="q">Customized write options</param>
/// <param name="ct">The cancellation token</param>
/// <returns>A write result containing the newly created ACL token</returns>
[Obsolete("The Legacy ACL system has been deprecated, please use Token, Role and Policy instead.")]
public async Task<WriteResult<string>> Create(ACLEntry acl, WriteOptions q, CancellationToken ct = default)
Expand All @@ -226,6 +228,7 @@ public async Task<WriteResult<string>> Create(ACLEntry acl, WriteOptions q, Canc
/// [Deprecated] Update is used to update the rules of an existing token
/// </summary>
/// <param name="acl">The ACL entry to update</param>
/// <param name="ct">The cancellation token</param>
/// <returns>An empty write result</returns>
[Obsolete("The Legacy ACL system has been deprecated, please use Token, Role and Policy instead.")]
public Task<WriteResult> Update(ACLEntry acl, CancellationToken ct = default)
Expand All @@ -238,6 +241,7 @@ public Task<WriteResult> Update(ACLEntry acl, CancellationToken ct = default)
/// </summary>
/// <param name="acl">The ACL entry to update</param>
/// <param name="q">Customized write options</param>
/// <param name="ct">The cancellation token</param>
/// <returns>An empty write result</returns>
[Obsolete("The Legacy ACL system has been deprecated, please use Token, Role and Policy instead.")]
public Task<WriteResult> Update(ACLEntry acl, WriteOptions q, CancellationToken ct = default)
Expand All @@ -249,6 +253,7 @@ public Task<WriteResult> Update(ACLEntry acl, WriteOptions q, CancellationToken
/// [Deprecated] Destroy is used to destroy a given ACL token ID
/// </summary>
/// <param name="id">The ACL ID to destroy</param>
/// <param name="ct">The cancellation token</param>
/// <returns>An empty write result</returns>
[Obsolete("The Legacy ACL system has been deprecated, please use Token, Role and Policy instead.")]
public Task<WriteResult<bool>> Destroy(string id, CancellationToken ct = default)
Expand All @@ -261,6 +266,7 @@ public Task<WriteResult<bool>> Destroy(string id, CancellationToken ct = default
/// </summary>
/// <param name="id">The ACL ID to destroy</param>
/// <param name="q">Customized write options</param>
/// <param name="ct">The cancellation token</param>
/// <returns>An empty write result</returns>
[Obsolete("The Legacy ACL system has been deprecated, please use Token, Role and Policy instead.")]
public Task<WriteResult<bool>> Destroy(string id, WriteOptions q, CancellationToken ct = default)
Expand All @@ -272,6 +278,7 @@ public Task<WriteResult<bool>> Destroy(string id, WriteOptions q, CancellationTo
/// [Deprecated] Clone is used to return a new token cloned from an existing one
/// </summary>
/// <param name="id">The ACL ID to clone</param>
/// <param name="ct">The cancellation token</param>
/// <returns>A write result containing the newly created ACL token</returns>
[Obsolete("The Legacy ACL system has been deprecated, please use Token, Role and Policy instead.")]
public Task<WriteResult<string>> Clone(string id, CancellationToken ct = default)
Expand All @@ -284,6 +291,7 @@ public Task<WriteResult<string>> Clone(string id, CancellationToken ct = default
/// </summary>
/// <param name="id">The ACL ID to clone</param>
/// <param name="q">Customized write options</param>
/// <param name="ct">The cancellation token</param>
/// <returns>A write result containing the newly created ACL token</returns>
[Obsolete("The Legacy ACL system has been deprecated, please use Token, Role and Policy instead.")]
public async Task<WriteResult<string>> Clone(string id, WriteOptions q, CancellationToken ct = default)
Expand All @@ -296,6 +304,7 @@ public async Task<WriteResult<string>> Clone(string id, WriteOptions q, Cancella
/// [Deprecated] Info is used to query for information about an ACL token
/// </summary>
/// <param name="id">The ACL ID to request information about</param>
/// <param name="ct">The cancellation token</param>
/// <returns>A query result containing the ACL entry matching the provided ID, or a query result with a null response if no token matched the provided ID</returns>
[Obsolete("The Legacy ACL system has been deprecated, please use Token, Role and Policy instead.")]
public Task<QueryResult<ACLEntry>> Info(string id, CancellationToken ct = default)
Expand Down
33 changes: 30 additions & 3 deletions Consul/Agent.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -794,6 +794,7 @@ public Task<QueryResult<Dictionary<string, AgentCheck>>> Checks(CancellationToke
/// Checks returns the locally registered checks
/// </summary>
/// <param name="filter">Specifies the expression used to filter the queries results prior to returning the data</param>
/// <param name="ct">The cancellation token</param>
/// <returns>A map of the registered check names and check data</returns>
public Task<QueryResult<Dictionary<string, AgentCheck>>> Checks(Filter filter, CancellationToken ct = default)
{
Expand All @@ -813,6 +814,7 @@ public async Task<QueryResult<Dictionary<string, AgentService>>> Services(Cancel
/// Services returns the locally registered services
/// </summary>
/// <param name="filter">Specifies the expression used to filter the queries results prior to returning the data</param>
/// <param name="ct">The cancellation token</param>
/// <returns>A map of the registered services and service data</returns>
public async Task<QueryResult<Dictionary<string, AgentService>>> Services(Filter filter, CancellationToken ct = default)
{
Expand All @@ -837,6 +839,7 @@ public Task<QueryResult<AgentMember[]>> Members(bool wan, CancellationToken ct =
/// ServiceRegister is used to register a new service with the local agent
/// </summary>
/// <param name="service">A service registration object</param>
/// <param name="ct">The cancellation token</param>
/// <returns>An empty write result</returns>
public Task<WriteResult> ServiceRegister(AgentServiceRegistration service, CancellationToken ct = default)
{
Expand All @@ -848,6 +851,7 @@ public Task<WriteResult> ServiceRegister(AgentServiceRegistration service, Cance
/// </summary>
/// <param name="service">A service registration object</param>
/// <param name="replaceExistingChecks">Missing health checks from the request will be deleted from the agent.</param>
/// <param name="ct">The cancellation token</param>
/// <returns>An empty write result</returns>
public Task<WriteResult> ServiceRegister(AgentServiceRegistration service, bool replaceExistingChecks, CancellationToken ct = default)
{
Expand All @@ -863,6 +867,7 @@ public Task<WriteResult> ServiceRegister(AgentServiceRegistration service, bool
/// ServiceRegister is used to register a new service with the local agent
/// </summary>
/// <param name="serviceID">The service ID</param>
/// <param name="ct">The cancellation token</param>
/// <returns>An empty write result</returns>
public Task<WriteResult> ServiceDeregister(string serviceID, CancellationToken ct = default)
{
Expand All @@ -874,6 +879,7 @@ public Task<WriteResult> ServiceDeregister(string serviceID, CancellationToken c
/// </summary>
/// <param name="checkID">The check ID</param>
/// <param name="note">An optional, arbitrary string to write to the check status</param>
/// <param name="ct">The cancellation token</param>
public Task PassTTL(string checkID, string note, CancellationToken ct = default)
{
return LegacyUpdateTTL(checkID, note, TTLStatus.Pass, ct);
Expand All @@ -884,6 +890,7 @@ public Task PassTTL(string checkID, string note, CancellationToken ct = default)
/// </summary>
/// <param name="checkID">The check ID</param>
/// <param name="note">An optional, arbitrary string to write to the check status</param>
/// <param name="ct">The cancellation token</param>
public Task WarnTTL(string checkID, string note, CancellationToken ct = default)
{
return LegacyUpdateTTL(checkID, note, TTLStatus.Warn, ct);
Expand All @@ -894,6 +901,7 @@ public Task WarnTTL(string checkID, string note, CancellationToken ct = default)
/// </summary>
/// <param name="checkID">The check ID</param>
/// <param name="note">An optional, arbitrary string to write to the check status</param>
/// <param name="ct">The cancellation token</param>
public Task FailTTL(string checkID, string note, CancellationToken ct = default)
{
return LegacyUpdateTTL(checkID, note, TTLStatus.Critical, ct);
Expand All @@ -905,6 +913,7 @@ public Task FailTTL(string checkID, string note, CancellationToken ct = default)
/// <param name="checkID">The check ID</param>
/// <param name="output">An optional, arbitrary string to write to the check status</param>
/// <param name="status">The state to set the check to</param>
/// <param name="ct">The cancellation token</param>
/// <returns>An empty write result</returns>
public Task<WriteResult> UpdateTTL(string checkID, string output, TTLStatus status, CancellationToken ct = default)
{
Expand All @@ -922,6 +931,7 @@ public Task<WriteResult> UpdateTTL(string checkID, string output, TTLStatus stat
/// <param name="checkID">The check ID</param>
/// <param name="note">An optional, arbitrary string to note on the check status</param>
/// <param name="status">The state to set the check to</param>
/// <param name="ct">The cancellation token</param>
/// <returns>An empty write result</returns>
private Task<WriteResult> LegacyUpdateTTL(string checkID, string note, TTLStatus status, CancellationToken ct = default)
{
Expand All @@ -937,6 +947,7 @@ private Task<WriteResult> LegacyUpdateTTL(string checkID, string note, TTLStatus
/// CheckRegister is used to register a new check with the local agent
/// </summary>
/// <param name="check">A check registration object</param>
/// <param name="ct">The cancellation token</param>
/// <returns>An empty write result</returns>
public Task<WriteResult> CheckRegister(AgentCheckRegistration check, CancellationToken ct = default)
{
Expand All @@ -947,6 +958,7 @@ public Task<WriteResult> CheckRegister(AgentCheckRegistration check, Cancellatio
/// CheckDeregister is used to deregister a check with the local agent
/// </summary>
/// <param name="checkID">The check ID to deregister</param>
/// <param name="ct">The cancellation token</param>
/// <returns>An empty write result</returns>
public Task<WriteResult> CheckDeregister(string checkID, CancellationToken ct = default)
{
Expand All @@ -958,6 +970,7 @@ public Task<WriteResult> CheckDeregister(string checkID, CancellationToken ct =
/// </summary>
/// <param name="addr">The address to join to</param>
/// <param name="wan">Join the WAN pool</param>
/// <param name="ct">The cancellation token</param>
/// <returns>An empty write result</returns>
public Task<WriteResult> Join(string addr, bool wan, CancellationToken ct = default)
{
Expand All @@ -973,6 +986,7 @@ public Task<WriteResult> Join(string addr, bool wan, CancellationToken ct = defa
/// ForceLeave is used to have the agent eject a failed node
/// </summary>
/// <param name="node">The node name to remove</param>
/// <param name="ct">The cancellation token</param>
/// <returns>An empty write result</returns>
public Task<WriteResult> ForceLeave(string node, CancellationToken ct = default)
{
Expand Down Expand Up @@ -1001,6 +1015,7 @@ public Task<WriteResult> Reload(CancellationToken ct = default)
/// Reload triggers a configuration reload for the agent we are connected to.
/// </summary>
/// <param name="node">The node name to reload</param>
/// <param name="ct">The cancellation token</param>
/// <returns>An empty write result</returns>
[Obsolete]
public Task<WriteResult> Reload(string node, CancellationToken ct = default)
Expand All @@ -1013,6 +1028,7 @@ public Task<WriteResult> Reload(string node, CancellationToken ct = default)
/// </summary>
/// <param name="serviceID">The service ID</param>
/// <param name="reason">An optional reason</param>
/// <param name="ct">The cancellation token</param>
/// <returns>An empty write result</returns>
public Task<WriteResult> EnableServiceMaintenance(string serviceID, string reason, CancellationToken ct = default)
{
Expand All @@ -1026,6 +1042,7 @@ public Task<WriteResult> EnableServiceMaintenance(string serviceID, string reaso
/// DisableServiceMaintenance toggles service maintenance mode off for the given service ID
/// </summary>
/// <param name="serviceID">The service ID</param>
/// <param name="ct">The cancellation token</param>
/// <returns>An empty write result</returns>
public Task<WriteResult> DisableServiceMaintenance(string serviceID, CancellationToken ct = default)
{
Expand All @@ -1038,6 +1055,7 @@ public Task<WriteResult> DisableServiceMaintenance(string serviceID, Cancellatio
/// EnableNodeMaintenance toggles node maintenance mode on for the agent we are connected to
/// </summary>
/// <param name="reason">An optional reason</param>
/// <param name="ct">The cancellation token</param>
/// <returns>An empty write result</returns>
public Task<WriteResult> EnableNodeMaintenance(string reason, CancellationToken ct = default)
{
Expand Down Expand Up @@ -1089,6 +1107,8 @@ public async Task<LogStream> MonitorJSON(LogLevel level = default, CancellationT
/// GetLocalServiceHealth returns the health info of a service registered on the local agent
/// </summary>
/// <param name="serviceName">Name of service</param>
/// <param name="q"></param>
/// <param name="ct">The cancellation token</param>
/// <returns>An array containing the details of each passing, warning, or critical service</returns>
public async Task<QueryResult<LocalServiceHealth[]>> GetLocalServiceHealth(string serviceName, QueryOptions q, CancellationToken ct = default)
{
Expand All @@ -1099,6 +1119,7 @@ public async Task<QueryResult<LocalServiceHealth[]>> GetLocalServiceHealth(strin
/// GetLocalServiceHealth returns the health info of a service registered on the local agent
/// </summary>
/// <param name="serviceName">Name of service</param>
/// <param name="ct">The cancellation token</param>
/// <returns>An array containing the details of each passing, warning, or critical service</returns>
public async Task<QueryResult<LocalServiceHealth[]>> GetLocalServiceHealth(string serviceName, CancellationToken ct = default)
{
Expand All @@ -1109,6 +1130,8 @@ public async Task<QueryResult<LocalServiceHealth[]>> GetLocalServiceHealth(strin
/// GetWorstLocalServiceHealth returns the worst aggregated status of a service registered on the local agent
/// </summary>
/// <param name="serviceName">Name of service</param>
/// <param name="q"></param>
/// <param name="ct">The cancellation token</param>
/// <returns>passing, warning, or critical</returns>
public async Task<QueryResult<string>> GetWorstLocalServiceHealth(string serviceName, QueryOptions q, CancellationToken ct = default)
{
Expand All @@ -1121,6 +1144,7 @@ public async Task<QueryResult<string>> GetWorstLocalServiceHealth(string service
/// GetWorstLocalServiceHealth returns the worst aggregated status of a service registered on the local agent
/// </summary>
/// <param name="serviceName">Name of service</param>
/// <param name="ct">The cancellation token</param>
/// <returns>passing, warning, or critical</returns>
public async Task<QueryResult<string>> GetWorstLocalServiceHealth(string serviceName, CancellationToken ct = default)
{
Expand All @@ -1131,6 +1155,8 @@ public async Task<QueryResult<string>> GetWorstLocalServiceHealth(string service
/// GetLocalServiceHealthByID returns the health info of a service registered on the local agent by ID
/// </summary>
/// <param name="serviceID">ID of the service</param>
/// <param name="q"></param>
/// <param name="ct">The cancellation token</param>
/// <returns>An array containing the details of each passing, warning, or critical service</returns>
public async Task<QueryResult<LocalServiceHealth>> GetLocalServiceHealthByID(string serviceID, QueryOptions q, CancellationToken ct = default)
{
Expand All @@ -1141,6 +1167,7 @@ public async Task<QueryResult<LocalServiceHealth>> GetLocalServiceHealthByID(str
/// GetLocalServiceHealthByID returns the health info of a service registered on the local agent by ID
/// </summary>
/// <param name="serviceID">ID of the service</param>
/// <param name="ct">The cancellation token</param>
/// <returns>An array containing the details of each passing, warning, or critical service</returns>
public async Task<QueryResult<LocalServiceHealth>> GetLocalServiceHealthByID(string serviceID, CancellationToken ct = default)
{
Expand All @@ -1150,7 +1177,7 @@ public async Task<QueryResult<LocalServiceHealth>> GetLocalServiceHealthByID(str
/// <summary>
/// GetAgentHostInfo returns the host info of the agent
/// </summary>
/// <param name="ct"></param>
/// <param name="ct">The cancellation token</param>
/// <returns>Agent Host Information</returns>
public async Task<QueryResult<AgentHostInfo>> GetAgentHostInfo(CancellationToken ct = default)
{
Expand All @@ -1160,7 +1187,7 @@ public async Task<QueryResult<AgentHostInfo>> GetAgentHostInfo(CancellationToken
/// <summary>
/// GetAgentVersion returns the version of the agent
/// </summary>
/// <param name="ct"></param>
/// <param name="ct">The cancellation token</param>
/// <returns>Version of the agent</returns>
public async Task<QueryResult<AgentVersion>> GetAgentVersion(CancellationToken ct = default)
{
Expand Down Expand Up @@ -1301,7 +1328,7 @@ IEnumerator IEnumerable.GetEnumerator()
/// <summary>
/// GetAgentMetrics returns the metrics of the local agent
/// </summary>
/// <param name="ct"></param>
/// <param name="ct">The cancellation token</param>
/// <returns>Metrics of the local agent</returns>
public async Task<QueryResult<Metrics>> GetAgentMetrics(CancellationToken ct = default)
{
Expand Down
Loading