Skip to content

[csharp][generichost] Correct docs - #25023

Merged
wing328 merged 2 commits into
OpenAPITools:masterfrom
devhl-labs:devhl/correct-docs
Sep 28, 2026
Merged

wing328 merged 2 commits into
OpenAPITools:masterfrom
devhl-labs:devhl/correct-docs

Conversation

@devhl-labs

@devhl-labs devhl-labs commented Sep 27, 2026 •

Copy link
Copy Markdown
Contributor

Minor docs correction

PR checklist

  • Read the contribution guidelines.
  • Run the following to build the project and update samples:
    ./mvnw clean package || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (For Windows users, please run the script in WSL)
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

Summary by cubic

Corrects the XML docs in the C# generichost JsonConverter template by removing NotImplementedException from the Write and WriteProperties method comments, since those methods throw JsonException when a model has a null value for a non-nullable JSON property. No behavior changes; the affected samples were regenerated.

Written for commit 53c8dc4. Summary will update on new commits.

Review in cubic

@cubic-dev-ai cubic-dev-ai Bot left a comment •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1 issue found across 1821 files

Prompt for AI agents (unresolved issues)

Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.


<file name="samples/client/petstore/csharp/generichost/latest/UseDateTimeOffset/src/Org.OpenAPITools/Model/AppleReq.cs">

<violation number="1" location="samples/client/petstore/csharp/generichost/latest/UseDateTimeOffset/src/Org.OpenAPITools/Model/AppleReq.cs:172">
P3: This description implies the writer throws for null values in any non-nullable JSON property, but a null `Cultivar` is passed to `WriteString` without a guard. Document the explicit-null `mealy` condition on both methods instead.</violation>
</file>

Note: This PR contains a large number of files. cubic selects up to 200 of the highest-priority eligible files for this review, so some files may not have been reviewed.

Re-trigger cubic

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 1821 files

Note: This PR contains a large number of files. cubic selects up to 200 of the highest-priority eligible files for this review, so some files may not have been reviewed.

Re-trigger cubic

@wing328 wing328 added this to the 7.26.0 milestone Sep 28, 2026
@wing328
wing328 merged commit da04b93 into OpenAPITools:master Sep 28, 2026
76 checks passed
@devhl-labs
devhl-labs deleted the devhl/correct-docs branch September 28, 2026 06:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants