docs(dotnet): API reference main#28
Closed
WomB0ComB0 wants to merge 1 commit intomainfrom
Closed
Conversation
|
Important Review skippedToo many files! This PR contains 300 files, which is 150 over the limit of 150. ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (300)
You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the auto-generated API documentation for the .NET SDKs, primarily refining link paths and expanding the scope of documented members. Feedback highlights that several private implementation details, such as ExtractIncidentId and BuildResiliencePipeline, are incorrectly being exported to the public API reference. Additionally, the use of the # character in filenames and anchor tags for constructors was identified as a potential cause for broken links. It is recommended to address these issues within the documentation generator configuration or source-level XML comments to ensure the fixes persist across future regeneration cycles.
Comment on lines
+42
to
+43
| | [ExtractIncidentId\(string\)](ResQ.Blockchain.MockNeoClient.ExtractIncidentId(string).md 'ResQ\.Blockchain\.MockNeoClient\.ExtractIncidentId\(string\)') | Extracts an incident ID from a JSON payload string\. | | ||
| | [GenerateTxHash\(\)](ResQ.Blockchain.MockNeoClient.GenerateTxHash().md 'ResQ\.Blockchain\.MockNeoClient\.GenerateTxHash\(\)') | Generates a random transaction hash for mock purposes\. | |
There was a problem hiding this comment.
The documentation now includes private methods such as ExtractIncidentId and GenerateTxHash. Private members are implementation details and should generally be excluded from the public API reference. Please update the documentation generator configuration or the source-level XML doc comments to filter out non-public members, ensuring the fix persists across regeneration cycles.
References
- When fixing errors in auto-generated documentation, apply the changes to the source-level documentation (e.g., XML doc comments) instead of the generated files to ensure the fixes persist across regeneration cycles.
| | [Dispose\(\)](./ResQ.Clients.BaseServiceClient.Dispose().md 'ResQ\.Clients\.BaseServiceClient\.Dispose\(\)') | Disposes the HTTP client\. | | ||
| | [ExecuteWithResilienceAsync\(HttpMethod, Func<CancellationToken,Task<HttpResponseMessage>>, CancellationToken\)](./ResQ.Clients.BaseServiceClient.ExecuteWithResilienceAsync(System.Net.Http.HttpMethod,System.Func_System.Threading.CancellationToken,System.Threading.Tasks.Task_System.Net.Http.HttpResponseMessage__,System.Threading.CancellationToken).md 'ResQ\.Clients\.BaseServiceClient\.ExecuteWithResilienceAsync\(System\.Net\.Http\.HttpMethod, System\.Func\<System\.Threading\.CancellationToken,System\.Threading\.Tasks\.Task\<System\.Net\.Http\.HttpResponseMessage\>\>, System\.Threading\.CancellationToken\)') | Executes an HTTP request with a resilience policy appropriate for the HTTP method\. | | ||
| | [SendAsync\(HttpMethod, string, HttpContent, CancellationToken, bool\)](./ResQ.Clients.BaseServiceClient.SendAsync(System.Net.Http.HttpMethod,string,System.Net.Http.HttpContent,System.Threading.CancellationToken,bool).md 'ResQ\.Clients\.BaseServiceClient\.SendAsync\(System\.Net\.Http\.HttpMethod, string, System\.Net\.Http\.HttpContent, System\.Threading\.CancellationToken, bool\)') | Sends an HTTP request, applying authorization from the current async flow when present\. | | ||
| | [BuildResiliencePipeline\(bool\)](ResQ.Clients.BaseServiceClient.BuildResiliencePipeline(bool).md 'ResQ\.Clients\.BaseServiceClient\.BuildResiliencePipeline\(bool\)') | Builds the resilience pipeline with circuit breaker, timeout, and optional retries\. | |
There was a problem hiding this comment.
The private method BuildResiliencePipeline is being exported in the documentation. Implementation details should be excluded from the public API reference. Please apply this change to the source-level documentation (e.g., XML doc comments) or the generator logic to ensure it persists.
References
- When fixing errors in auto-generated documentation, apply the changes to the source-level documentation (e.g., XML doc comments) instead of the generated files to ensure the fixes persist across regeneration cycles.
| @@ -1,17 +1,17 @@ | |||
| ### [ResQ\.Simulation](./ResQ.Simulation.md 'ResQ\.Simulation').[ScenarioRunner](./ResQ.Simulation.ScenarioRunner.md 'ResQ\.Simulation\.ScenarioRunner') | |||
| ### [ResQ\.Simulation](ResQ.Simulation.md 'ResQ\.Simulation').[ScenarioRunner](ResQ.Simulation.ScenarioRunner.md 'ResQ\.Simulation\.ScenarioRunner') | |||
There was a problem hiding this comment.
The filename ResQ.Simulation.ScenarioRunner.#ctor.md uses a # character, which is reserved for URL fragments. This will likely cause broken links. Please update the documentation generator logic to use a safer naming convention like ctor.md or _ctor.md at the source level to ensure the fix persists.
References
- When fixing errors in auto-generated documentation, apply the changes to the source-level documentation (e.g., XML doc comments) instead of the generated files to ensure the fixes persist across regeneration cycles.
| | [ScenarioRunner\(string, string\)](./ResQ.Simulation.ScenarioRunner.#ctor.md#ResQ.Simulation.ScenarioRunner.ScenarioRunner(string,string) 'ResQ\.Simulation\.ScenarioRunner\.ScenarioRunner\(string, string\)') | Initializes a new instance of the [ScenarioRunner](ResQ.Simulation.ScenarioRunner.md 'ResQ\.Simulation\.ScenarioRunner') class using service URLs\. | | ||
|
|
||
| <a name='ResQ.Simulation.ScenarioRunner.ScenarioRunner(ResQ.Clients.CoordinationHceClient,ResQ.Clients.InfrastructureApiClient)'></a> | ||
| <a name='ctor.md#ResQ.Simulation.ScenarioRunner.ScenarioRunner(ResQ.Clients.CoordinationHceClient,ResQ.Clients.InfrastructureApiClient)'></a> |
There was a problem hiding this comment.
The generated anchor name includes the filename and a fragment separator (#), which breaks internal page navigation. Instead of modifying this generated file, please update the source-level documentation or the generator logic to produce valid anchor names.
References
- When fixing errors in auto-generated documentation, apply the changes to the source-level documentation (e.g., XML doc comments) instead of the generated files to ensure the fixes persist across regeneration cycles.
Comment on lines
+25
to
+26
| | [ValidateDroneCount\(int, string\)](ResQ.Simulation.ScenarioRunner.ValidateDroneCount(int,string).md 'ResQ\.Simulation\.ScenarioRunner\.ValidateDroneCount\(int, string\)') | Validates drone count parameter is within safe bounds\. | | ||
| | [ValidateLocation\(Location, string\)](ResQ.Simulation.ScenarioRunner.ValidateLocation(ResQ.Core.Location,string).md 'ResQ\.Simulation\.ScenarioRunner\.ValidateLocation\(ResQ\.Core\.Location, string\)') | Validates location coordinates are within valid GPS bounds\. | |
There was a problem hiding this comment.
Private methods ValidateDroneCount and ValidateLocation are being included in the public API reference. These should be filtered out by updating the documentation generator or the source-level XML doc comments to ensure the fix persists across regeneration cycles.
References
- When fixing errors in auto-generated documentation, apply the changes to the source-level documentation (e.g., XML doc comments) instead of the generated files to ensure the fixes persist across regeneration cycles.
Comment on lines
+63
to
+69
| | [BuildResiliencePipeline\(\)](ResQ.Storage.PinataClient.BuildResiliencePipeline().md 'ResQ\.Storage\.PinataClient\.BuildResiliencePipeline\(\)') | Builds the resilience pipeline with circuit breaker and timeout policies\. | | ||
| | [ConfigureHttpClient\(\)](ResQ.Storage.PinataClient.ConfigureHttpClient().md 'ResQ\.Storage\.PinataClient\.ConfigureHttpClient\(\)') | Configures the HTTP client with base address, timeout, and authentication\. | | ||
| | [GetAsync\(string, CancellationToken\)](ResQ.Storage.PinataClient.GetAsync(string,System.Threading.CancellationToken).md 'ResQ\.Storage\.PinataClient\.GetAsync\(string, System\.Threading\.CancellationToken\)') | Retrieves file content by its IPFS CID\. | | ||
| | [GetGatewayUrl\(string\)](ResQ.Storage.PinataClient.GetGatewayUrl(string).md 'ResQ\.Storage\.PinataClient\.GetGatewayUrl\(string\)') | Gets the gateway URL for accessing content by CID\. | | ||
| | [IsPinnedAsync\(string, CancellationToken\)](ResQ.Storage.PinataClient.IsPinnedAsync(string,System.Threading.CancellationToken).md 'ResQ\.Storage\.PinataClient\.IsPinnedAsync\(string, System\.Threading\.CancellationToken\)') | Checks if a CID is currently pinned\. | | ||
| | [ListPinsAsync\(string, int, CancellationToken\)](ResQ.Storage.PinataClient.ListPinsAsync(string,int,System.Threading.CancellationToken).md 'ResQ\.Storage\.PinataClient\.ListPinsAsync\(string, int, System\.Threading\.CancellationToken\)') | Lists pinned files with optional name prefix filtering\. | | ||
| | [MockUploadAsync\(Stream, string, string, Dictionary<string,string>\)](ResQ.Storage.PinataClient.MockUploadAsync(System.IO.Stream,string,string,System.Collections.Generic.Dictionary_string,string_).md 'ResQ\.Storage\.PinataClient\.MockUploadAsync\(System\.IO\.Stream, string, string, System\.Collections\.Generic\.Dictionary\<string,string\>\)') | Generates a mock upload result with a fake CID for testing purposes\. | |
There was a problem hiding this comment.
Private methods BuildResiliencePipeline, ConfigureHttpClient, and MockUploadAsync are being exported. These implementation details should be excluded from the public API documentation by applying changes to the source-level documentation or generator configuration.
References
- When fixing errors in auto-generated documentation, apply the changes to the source-level documentation (e.g., XML doc comments) instead of the generated files to ensure the fixes persist across regeneration cycles.
WomB0ComB0
added a commit
to resq-software/dotnet-sdk
that referenced
this pull request
May 9, 2026
resq-software/docs#28 hit 995 broken-link errors because sed regex did not match DefaultDocumentation's ](path.md 'title') / ](Foo(string,int).md) forms. Switch to a Python walker that paren-balances URLs and handles both shapes. Sync from resq-software/docs#fix/dotnet-template-paren-walker.
WomB0ComB0
added a commit
that referenced
this pull request
May 9, 2026
…alker (#29) 995 broken-link errors on #28 because the sed regex did not match DefaultDocumentation's link forms: ](ResQ.Blockchain.md 'qualified.Type') The trailing space + 'title' before `)` falls outside the `[^)/]*` URL character class, so the regex skipped these links entirely and they kept their bare-filename form. Mintlify rejected all 995 of them. Replace the sed step with a paren-balanced Python walker (same shape used elsewhere in this template family). It correctly handles: - bare `(path.md)` - `(path.md#anchor)` - `(path.md 'title')` and double-quoted variants - method-overload pages with parens in the filename, e.g. `Foo.Bar(string,int).md` Sync PR will reapply the same fix to dotnet-sdk:main. Co-authored-by: Mike Odnis <engineer@resq.software>
WomB0ComB0
added a commit
to resq-software/dotnet-sdk
that referenced
this pull request
May 9, 2026
resq-software/docs#28 hit 995 broken-link errors because sed regex did not match DefaultDocumentation's ](path.md 'title') / ](Foo(string,int).md) forms. Switch to a Python walker that paren-balances URLs and handles both shapes. Sync from resq-software/docs#fix/dotnet-template-paren-walker.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Auto-generated by
api-docsinresq-software/dotnet-sdkfor refmain(run: 25606323050).
Regenerated files under
sdks/dotnet/api/. Review thediff for unintended exports and merge to publish.