Fix PR #897 review feedback and add comprehensive bearer auth tests

[christianhelle]

Summary

Addresses all review comments from PR #897 and adds comprehensive test coverage for the new authentication header features.

Code Fixes

Style & Conventions

• Fix AuthenticationHeaderStyle enum to use Allman brace style, matching other enums in the codebase
• Add [JsonConverter(typeof(JsonStringEnumConverter))] to AuthenticationHeaderStyle property in RefitGeneratorSettings for consistent serialization
• Remove trailing whitespace in RefitInterfaceGenerator.cs

Documentation

• Add XML documentation for SecurityScheme property in RefitGeneratorSettings.cs
• Add XML docs for new CLI properties in Settings.cs
• Fix grammatically unclear SecurityScheme description
• Update docs/json-schema.json with authenticationHeaderStyle and securityScheme properties
• Update README.md with new CLI options

Bug Fixes

• Remove trailing space in ParameterExtractor.cs bearer header string
• Make bearer scheme comparison case-insensitive (StringComparison.OrdinalIgnoreCase) in both ParameterExtractor.cs and RefitInterfaceGenerator.cs

New Tests

Added 16 new test methods covering the previously untested AuthenticationHeaderStyle.Method code path and SecurityScheme filter:

• Method style generates [Headers("Authorization: Bearer")] attribute
• Parameter style generates [Header("Authorization: Bearer")] string bearerToken
• Build verification for both Method and Parameter styles
• Method style does NOT add bearer parameter or ApiKey method headers
• SecurityScheme filter correctly isolates bearer vs ApiKey schemes

New test resource files:

• V3/SwaggerPetstoreWithBearerAuthenticationHeaders.json/yaml
• V3/SwaggerPetstoreWithMixedAuthenticationHeaders.json

Verification

• Build: dotnet build -c Release succeeded (0 errors)
• Tests: 1258 passed, 0 failed
• Format: dotnet format --verify-no-changes passed

Summary by CodeRabbit

• New Features

  • Added --generate-authentication-header CLI option to control authentication code generation with None, Parameter, or Method styles.
  • Added --security-scheme CLI option to generate Authorization headers for specific security schemes.
  • Enhanced Bearer authentication header handling with support for multiple generation styles and case-insensitive scheme matching.

• Documentation

  • Updated CLI help text with new authentication-related options.
  • Enhanced JSON schema with new configuration properties.

• Tests

  • Added comprehensive test coverage for Bearer authentication header generation with different styles and security scheme filtering scenarios.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 30a163ec-53ec-4418-94b8-d5a5d34a885b

📥 Commits

Reviewing files that changed from the base of the PR and between 86eab90 and 14101a4.

📒 Files selected for processing (14)

• README.md
• docs/json-schema.json
• src/Refitter.Core/ParameterExtractor.cs
• src/Refitter.Core/RefitInterfaceGenerator.cs
• src/Refitter.Core/Settings/AuthenticationHeaderStyle.cs
• src/Refitter.Core/Settings/RefitGeneratorSettings.cs
• src/Refitter.Tests/Resources/EmbeddedResources.cs
• src/Refitter.Tests/Resources/SampleOpenSpecifications.cs
• src/Refitter.Tests/Resources/V3/SwaggerPetstoreWithBearerAuthenticationHeaders.json
• src/Refitter.Tests/Resources/V3/SwaggerPetstoreWithBearerAuthenticationHeaders.yaml
• src/Refitter.Tests/Resources/V3/SwaggerPetstoreWithMixedAuthenticationHeaders.json
• src/Refitter.Tests/SwaggerPetstoreApizrTests.cs
• src/Refitter.Tests/SwaggerPetstoreTests.cs
• src/Refitter/Settings.cs

---

📝 Walkthrough

Walkthrough

This PR adds support for generating HTTP authentication headers in multiple styles (Method, Parameter, None) and filtering by security scheme. Changes include new CLI options, configuration settings, bearer token detection improvements, three OpenAPI test specification files, and comprehensive test coverage for authentication header generation scenarios.

Changes

Cohort / File(s)	Summary
Documentation & Schema README.md, docs/json-schema.json, src/Refitter/Settings.cs	Added new CLI options for authentication header generation style and security scheme filtering, along with corresponding JSON schema properties and XML documentation.
Core Authentication Logic src/Refitter.Core/ParameterExtractor.cs, src/Refitter.Core/RefitInterfaceGenerator.cs	Refined bearer token detection with null-safe pattern checks and case-insensitive scheme comparison; adjusted header attribute formatting.
Settings & Configuration src/Refitter.Core/Settings/AuthenticationHeaderStyle.cs, src/Refitter.Core/Settings/RefitGeneratorSettings.cs	Added new AuthenticationHeaderStyle enum and SecurityScheme property to RefitGeneratorSettings with JsonConverter attribute for serialization.
Test Resources src/Refitter.Tests/Resources/EmbeddedResources.cs, src/Refitter.Tests/Resources/SampleOpenSpecifications.cs, src/Refitter.Tests/Resources/V3/*	Introduced three new OpenAPI specification files (Bearer auth JSON/YAML and mixed auth JSON) and updated resource accessors to support them.
Test Coverage src/Refitter.Tests/SwaggerPetstoreTests.cs, src/Refitter.Tests/SwaggerPetstoreApizrTests.cs	Added 10+ test methods validating Bearer authentication header generation with different styles, security scheme filtering, and code compilation.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

• #897 — Directly related; both add AuthenticationHeaderStyle enum, update RefitGeneratorSettings/Settings with SecurityScheme, and refine bearer token detection logic.
• #663 — Related; both modify ParameterExtractor.cs to adjust header parameter handling logic.
• #830 — Related; both modify SwaggerPetstoreTests and SwaggerPetstoreApizrTests test files for authentication-related testing.

Suggested labels

enhancement, .NET

Poem

🐰 Headers hop with Bearer's grace,
Method, Parameter find their place,
Schemes now filter, logic refined,
Auth flows smoothly, well-designed!
Tests proliferate, all secure—
The burrow's authentication, pure! 🔐

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The pull request title accurately describes the main focus of the changeset: addressing review feedback from PR #897 and adding comprehensive bearer authentication tests.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

• 📝 Generate docstrings (stacked PR)
• 📝 Generate docstrings (commit on current branch)

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch fix/pr897-review-feedback

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[Copilot]

Pull request overview

This PR addresses review feedback from PR #897 and adds comprehensive test coverage for bearer authentication header generation. It fixes code style issues, improves documentation, and validates both Method and Parameter authentication header styles along with the SecurityScheme filter.

Changes:

• Style/bug fixes: Allman brace style for AuthenticationHeaderStyle enum, case-insensitive bearer scheme comparison, trailing whitespace/space removals, JsonConverter attribute added
• Documentation: XML docs for new properties, updated README and JSON schema
• New tests: 16 test methods covering bearer auth header styles, build verification, and SecurityScheme filtering, with new JSON/YAML test resource files

Reviewed changes

Copilot reviewed 14 out of 14 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
src/Refitter.Core/Settings/AuthenticationHeaderStyle.cs	Fixed Allman brace style for enum
src/Refitter.Core/Settings/RefitGeneratorSettings.cs	Added JsonConverter attribute to AuthenticationHeaderStyle and XML docs for SecurityScheme
src/Refitter.Core/RefitInterfaceGenerator.cs	Removed trailing whitespace; case-insensitive bearer scheme comparison
src/Refitter.Core/ParameterExtractor.cs	Removed trailing space in bearer header string; case-insensitive bearer scheme comparison
src/Refitter/Settings.cs	Added XML docs and improved [Description] text for auth properties
src/Refitter.Tests/SwaggerPetstoreTests.cs	Added 11 new test methods for bearer/mixed auth scenarios
src/Refitter.Tests/SwaggerPetstoreApizrTests.cs	Added 5 new test methods for bearer/mixed auth scenarios (Apizr variant)
src/Refitter.Tests/Resources/SampleOpenSpecifications.cs	Added 3 new enum values for bearer/mixed auth spec variants
src/Refitter.Tests/Resources/EmbeddedResources.cs	Added accessors and switch cases for the 3 new spec resources
src/Refitter.Tests/Resources/V3/SwaggerPetstoreWithBearerAuthenticationHeaders.json	New test resource: petstore spec with bearer-only security
src/Refitter.Tests/Resources/V3/SwaggerPetstoreWithBearerAuthenticationHeaders.yaml	New test resource: YAML variant of bearer-only petstore spec
src/Refitter.Tests/Resources/V3/SwaggerPetstoreWithMixedAuthenticationHeaders.json	New test resource: petstore spec with both bearer and API key security
docs/json-schema.json	Added authenticationHeaderStyle and securityScheme schema properties
README.md	Added CLI documentation for --generate-authentication-header and --security-scheme

---

You can also share your feedback on Copilot code review. Take the survey.

[Copilot]

Typo in the description field: 'toekn' should be 'token'.

Suggested change

	"description": "date in UTC when toekn expires",
	"description": "date in UTC when token expires",

[Copilot]

Typo in the description field: 'toekn' should be 'token'.

Suggested change

	description: date in UTC when toekn expires
	description: date in UTC when token expires

[Copilot]

Typo in the description field: 'toekn' should be 'token'.

Suggested change

	"description": "date in UTC when toekn expires",
	"description": "date in UTC when token expires",

[Copilot]

The assertion BeLessThanOrEqualTo(1) also passes if auth_key header appears zero times, which would not validate the expected behavior described in the comment (that it appears exactly once as a regular operation parameter). Consider using Be(1) to make the assertion more precise and to ensure the test actually detects the expected single occurrence.

Suggested change

	Regex.Matches(generatedCode, @"\[Header\(""auth_key""\)\]").Count.Should().BeLessThanOrEqualTo(1);
	Regex.Matches(generatedCode, @"\[Header\(""auth_key""\)\]").Count.Should().Be(1);

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 89.41%. Comparing base (86eab90) to head (14101a4).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #936      +/-   ##
==========================================
+ Coverage   88.80%   89.41%   +0.61%     
==========================================
  Files          26       26              
  Lines        1509     1511       +2     
==========================================
+ Hits         1340     1351      +11     
+ Misses         91       85       -6     
+ Partials       78       75       -3     

Flag	Coverage Δ
unittests	89.41% <100.00%> (+0.61%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.