Update docs for OpenAPI parameter registration - #314
Merged
Conversation
Expanded and clarified XML docs for OpenAPI/Swagger parameter methods, added <seealso> tags, and improved summaries. Added links to related package documentation in README.md.
There was a problem hiding this comment.
Pull request overview
This PR updates developer-facing documentation around the OpenAPI/Swagger “shared parameter” registration flow, aiming to make the intended usage clearer and easier to discover.
Changes:
- Refined XML doc summaries for OpenAPI/Swagger parameter registration and application methods, adding
<seealso>cross-references. - Added a new “Other package documentation” section to the root README linking to package-specific READMEs.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| src/TinyHelpers.AspNetCore/OpenApi/OpenApiExtensions.cs | Updates XML docs and adds <seealso> links for OpenAPI parameter registration/application helpers. |
| src/TinyHelpers.AspNetCore.Swashbuckle/SwaggerExtensions.cs | Updates XML docs, adds <seealso> links, and adjusts wording for Swashbuckle parameter registration/application helpers. |
| README.md | Adds links to additional package-level documentation files. |
Comment on lines
59
to
+63
| /// <summary> | ||
| /// Adds custom query-parameter metadata rules when the default generated names are not sufficient. | ||
| /// Adds shared OpenAPI parameter definitions so they are automatically applied to every generated operation. | ||
| /// </summary> | ||
| /// <returns>The same <see cref="OpenApiOptions" /> for fluent configuration.</returns> | ||
| /// <seealso cref="AddOpenApiOperationParameters(IServiceCollection, Action{OpenApiOperationOptions})"/> |
Comment on lines
51
to
55
| /// <summary> | ||
| /// Adds a shared parameter definition pipeline to Swagger generation. | ||
| /// Adds shared OpenAPI parameter definitions so they are automatically applied to every generated operation. | ||
| /// </summary> | ||
| /// <seealso cref="AddSwaggerOperationParameters(IServiceCollection, Action{OpenApiOperationOptions})"/> | ||
| public void AddOperationParameters() |
Comment on lines
59
to
63
| /// <summary> | ||
| /// Registers a reusable set of OpenAPI parameters in the dependency injection container. | ||
| /// Registers OpenAPI parameter definitions that can be automatically applied to every operation. | ||
| /// </summary> | ||
| /// <remarks> | ||
| /// This lets applications define shared parameters once and then reuse them during Swagger | ||
| /// generation through <see cref="OpenApiParametersOperationFilter" />. | ||
| /// </remarks> | ||
| /// <param name="services">The service collection to extend.</param> | ||
| /// <param name="setupAction">The configuration callback used to populate shared parameters.</param> |
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
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.
Expanded and clarified XML docs for OpenAPI/Swagger parameter methods, added tags, and improved summaries. Added links to related package documentation in README.md.