Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: Fix actor DTO summaries #1997

Merged
merged 1 commit into from
Mar 4, 2025
Merged

chore: Fix actor DTO summaries #1997

merged 1 commit into from
Mar 4, 2025

Conversation

elsand
Copy link
Member

@elsand elsand commented Mar 4, 2025

The summaries used on the common ActorDto was referring to transmissions, and including information only relevant for serviceowner POST. Reworded/simplified so that the summaries make sense in any context.

@elsand elsand requested a review from a team as a code owner March 4, 2025 07:55
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 4, 2025 •
edited
Loading

📝 Walkthrough

Walkthrough

This pull request updates the documentation for actor properties across multiple components. The JSON schema in the Swagger file and the XML comments in the ActorDto classes and a Web API client interface have been revised to offer clearer and more precise descriptions for actorId, actorName, and actorType. No functional behavior has been altered.

Changes

File(s) Change Summary
docs/schema/V1/swagger.verified.json Updated JSON schema descriptions for actorId, actorName, and actorType in both V1EndUserCommonActors_Actor and V1ServiceOwnerCommonActors_Actor.
src/.../Features/V1/{EndUser,ServiceOwner}/Common/Actors/ActorDto.cs Revised XML comments for ActorId, ActorName, and ActorType in the ActorDto classes to improve clarity in both end user and service owner contexts.
src/.../WebApiClient/Features/V1/RefitterInterface.cs Enhanced XML documentation for properties of V1ServiceOwnerCommonActors_Actor, clarifying the actor’s identifier and role descriptions.

Possibly related PRs

Suggested reviewers

  • oskogstad
  • MagnusSandgren
📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f60249a and 51e0163.

📒 Files selected for processing (4)
  • docs/schema/V1/swagger.verified.json (2 hunks)
  • src/Digdir.Domain.Dialogporten.Application/Features/V1/EndUser/Common/Actors/ActorDto.cs (1 hunks)
  • src/Digdir.Domain.Dialogporten.Application/Features/V1/ServiceOwner/Common/Actors/ActorDto.cs (1 hunks)
  • src/Digdir.Library.Dialogporten.WebApiClient/Features/V1/RefitterInterface.cs (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: build / build-and-test
🔇 Additional comments (15)
src/Digdir.Domain.Dialogporten.Application/Features/V1/ServiceOwner/Common/Actors/ActorDto.cs (3)

8-8: Improved documentation clarity for ActorType

The documentation now clearly explains that the actor can be either the service owner or a representative of the party, providing better context about possible values.

13-13: Simplified documentation for ActorName

The documentation has been appropriately simplified to clearly state the purpose of the property without unnecessary context that was specific to transmissions.

19-19: Enhanced documentation precision for ActorId

The documentation now specifically mentions that this identifier can be either a national identity number or an organization number, which provides developers with clearer guidance on what values to expect.

src/Digdir.Domain.Dialogporten.Application/Features/V1/EndUser/Common/Actors/ActorDto.cs (3)

8-8: Improved documentation clarity for ActorType

The documentation now clearly explains that the actor can be either the service owner or a representative of the party, providing better context about possible values.

13-13: Simplified documentation for ActorName

The documentation has been appropriately simplified to clearly state the purpose of the property without unnecessary context that was specific to transmissions.

19-19: Enhanced documentation precision for ActorId

The documentation now specifically mentions that this identifier can be either a national identity number or an organization number, which provides developers with clearer guidance on what values to expect.

src/Digdir.Library.Dialogporten.WebApiClient/Features/V1/RefitterInterface.cs (3)

997-997: Improved documentation clarity for ActorType

The documentation now clearly explains that the actor can be either the service owner or a representative of the party, providing better context about possible values.

1005-1005: Simplified documentation for ActorName

The documentation has been appropriately simplified to clearly state the purpose of the property without unnecessary context that was specific to transmissions.

1012-1012: Enhanced documentation precision for ActorId

The documentation now specifically mentions that this identifier can be either a national identity number or an organization number, which provides developers with clearer guidance on what values to expect.

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

380-381: Documentation improvement for actorId provides clearer description.

The updated description more accurately and concisely explains what the actorId represents without context-specific details.

386-387: Documentation improvement for actorName provides clearer description.

The updated description is more straightforward and universally applicable across all usage contexts.

392-394: Documentation improvement for actorType provides clearer description.

The updated description more accurately explains the purpose of the actorType property in a context-agnostic manner.

1879-1880: Documentation improvement for actorId matches EndUser counterpart.

The description is now consistent with the EndUser version and provides clear context-agnostic information.

1885-1886: Documentation improvement for actorName matches EndUser counterpart.

The description is now consistent with the EndUser version and provides clear context-agnostic information.

1891-1892: Documentation improvement for actorType matches EndUser counterpart.

The description is now consistent with the EndUser version and provides clear context-agnostic information.

✨ Finishing Touches
  • 📝 Generate Docstrings

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
🪧 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.
  • @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.

@elsand elsand merged commit de7b915 into main Mar 4, 2025
23 checks passed
@elsand elsand deleted the chore/fix-actor-dto-summaries branch March 4, 2025 08:58
@dialogporten-bot dialogporten-bot mentioned this pull request Mar 4, 2025
Merged
oskogstad pushed a commit that referenced this pull request Mar 5, 2025
@dialogporten-bot
chore(main): release 1.57.3 (#1998)
1b393aa 
🤖 I have created a release *beep* *boop*
---


##
[1.57.3](v1.57.2...v1.57.3)
(2025-03-05)


### Miscellaneous Chores

* **deps:** update dependency bogus to 35.6.2
([#2004](#2004))
([1161c9f](1161c9f))
* **deps:** update dependency htmlagilitypack to 1.11.73
([#2005](#2005))
([78a89fb](78a89fb))
* **deps:** update npgsql dependencies to 9.0.3
([#2006](#2006))
([d7938be](d7938be))
* **deps:** Update vitest to 3.0.7 and esbuild to 0.25.0
([#2009](#2009))
([96542a2](96542a2))
* Fix actor DTO summaries
([#1997](#1997))
([de7b915](de7b915))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@oskogstad oskogstad oskogstad approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@elsand @oskogstad