API-scopes configuration for apps

[martinothamar]

Description

Lets custom API scopes be configured for an app

Related Issue(s)

• Check JWT token scopes #686
• Service owner controlled scope per application app-lib-dotnet#1288

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)
• All tests run green

Documentation

• User documentation is updated with a separate linked PR in altinn-studio-docs. (if applicable)

Summary by CodeRabbit

• New Features
  • Introduced support for custom API scopes in applications, allowing configuration of read and write access.
  • Applications can now specify custom API scopes directly within their settings.

[coderabbitai]

📝 Walkthrough

Walkthrough

A new class named ApiScopes was introduced to represent custom API scopes, featuring Read and Write string properties. Additionally, the Application class was updated to include a new ApiScopes property, enabling the specification of custom API scopes for application authorization.

Changes

Files	Change Summary
src/Storage.Interface/Models/ApiScopes.cs	Added new public class ApiScopes with Read and Write properties, including JSON and XML documentation.
src/Storage.Interface/Models/Application.cs	Added ApiScopes property of type ApiScopes to the Application class with appropriate documentation.

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate Unit Tests

• Create PR with Unit Tests
• Post Copyable Unit Tests in Comment
• Commit Unit Tests in branch feat/api-scopes-config

---

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

🪧 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai auto-generate unit tests to generate unit tests for this PR.
• @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.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

src/Storage.Interface/Models/Application.cs (1)

120-126: Add unit tests for ApiScopes serialization
Ensure that JSON (de)serialization of the new ApiScopes property within Application is covered by unit tests to prevent regressions.

Do you want me to help generate those tests?

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6cb828d and 4099bba.

📒 Files selected for processing (2)

• src/Storage.Interface/Models/ApiScopes.cs (1 hunks)
• src/Storage.Interface/Models/Application.cs (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (2)

• GitHub Check: Analyze (csharp)
• GitHub Check: Build, test & analyze

🔇 Additional comments (5)

src/Storage.Interface/Models/ApiScopes.cs (4)

1-3: Consistent namespace and dependencies
The file-scoped namespace and Newtonsoft.Json import align with existing patterns in the Storage.Interface.Models folder.

---

5-9: Clear class documentation
The XML summary succinctly describes the purpose of ApiScopes as a container for custom app scopes.

---

10-14: Correct JSON mapping for Read
The Read property is properly annotated to serialize as "read", matching the intended JSON contract.

---

16-20: Correct JSON mapping for Write
The Write property is properly annotated to serialize as "write", matching the intended JSON contract.

src/Storage.Interface/Models/Application.cs (1)

120-126: New ApiScopes property aligns with model
The addition follows the established JSON naming conventions and cleanly integrates the ApiScopes model into Application.

[sonarqubecloud]

Quality Gate failed

Failed conditions
0.0% Coverage on New Code (required ≥ 65%)

See analysis details on SonarQube Cloud