chore(webapi): Fix JWTBearerAuth scheme name casing

[oskogstad]

Description

Related Issue(s)

• Setup of BlackDuck Polaris for security testing #1577

Verification

• Your code builds clean without any errors or warnings
• Manual testing done (required)
• Relevant automated test added (if you find this hard, leave it and we'll help out)

Documentation

• Documentation is updated (either in docs-directory, Altinnpedia or a separate linked PR in altinn-studio-docs., if applicable)

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request introduces significant updates to the OpenAPI specification for the Dialogporten API, including the addition of multiple data schemas and modifications to existing paths and security schemes. A new method for standardizing JWT bearer token casing is added in the OpenApiDocumentExtensions class, enhancing the API's compliance with validation requirements. Additionally, the Program.cs file is updated to incorporate the new method and improve logging, Swagger configuration, and health check setups, while maintaining existing error handling mechanisms.

Changes

File Path	Change Summary
docs/schema/V1/swagger.verified.json	Added multiple schemas related to dialogs, activities, and attachments. Updated security scheme casing.
src/Digdir.Domain.Dialogporten.WebApi/OpenApiDocumentExtensions.cs	Added method FixJwtBearerCasing to standardize JWT bearer token casing in security definitions.
src/Digdir.Domain.Dialogporten.WebApi/Program.cs	Updated Swagger configuration to include FixJwtBearerCasing. Enhanced logging and health check setups.

Possibly related PRs

• fix: Add missing return types for Transmissions and Activities in OpenAPI spec #1244: Adds missing return types for Transmissions and Activities in the OpenAPI spec, directly related to this PR's modifications.
• chore: Manually set operationId of Patch #1410: Updates the operationId for the PATCH operation in the OpenAPI spec, aligning with the focus on enhancing API documentation.
• chore(webapi): Remove old UpdateDialog Swagger config #1470: Removes old UpdateDialog Swagger config, relevant to the OpenAPI specification changes in this PR.
• fix(webapi): Repeat delete requests should return 400 BAD REQUEST #1542: Modifies the web API behavior for delete requests, relating to overall API behavior and documentation updates.

Suggested reviewers

• MagnusSandgren

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Experiment)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[sonarqubecloud]

Quality Gate passed

Issues
1 New issue
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

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 7bed6c1 and 80fd8f1.

📒 Files selected for processing (3)

• docs/schema/V1/swagger.verified.json (1 hunks)
• src/Digdir.Domain.Dialogporten.WebApi/OpenApiDocumentExtensions.cs (1 hunks)
• src/Digdir.Domain.Dialogporten.WebApi/Program.cs (1 hunks)

🔇 Additional comments (3)

src/Digdir.Domain.Dialogporten.WebApi/OpenApiDocumentExtensions.cs (1)

9-15: Documentation is clear and helpful

The XML documentation clearly explains the purpose of the method and includes the specific error message from BlackDuck that this fix addresses.

src/Digdir.Domain.Dialogporten.WebApi/Program.cs (1)

204-204: LGTM!

The JWT bearer casing fix is correctly integrated into the Swagger document post-processing pipeline.

docs/schema/V1/swagger.verified.json (1)

4686-4686: LGTM!

The JWT bearer scheme is correctly set to lowercase "bearer" as required by BlackDuck validation.