digdir / dialogporten

Dialogporten - common API and and metadata state store for digital dialogs
https://docs.altinn.studio/dialogporten
MIT License
1 stars 3 forks source link

chore(webapi): Remove old UpdateDialog Swagger config #1470

Closed oskogstad closed 1 week ago

oskogstad commented 1 week ago
coderabbitai[bot] commented 1 week ago
📝 Walkthrough ## Walkthrough The pull request encompasses significant modifications to the OpenAPI specification for the Dialogporten API, particularly in the `swagger.verified.json` file. It introduces new schemas and endpoints, updates existing schemas with additional properties, and enhances documentation. Notable changes include the addition of new endpoints for dialog management and the definition of security schemes using JWT for authorization. Additionally, the request example handling in the Swagger generation process has been simplified, and new classes have been created to summarize endpoint responses. ## Changes | File | Change Summary | |----------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------| | `docs/schema/V1/swagger.verified.json` | - New schemas added: `V1ServiceOwnerDialogsCommandsUpdate_Dialog`, `V1ServiceOwnerDialogsCommandsCreate_DialogCommand`, `V1ServiceOwnerDialogTransmissionsCreate_TransmissionRequest`.
- Existing schemas updated with additional properties.
- New endpoints added for dialog activities and management. | | `src/Digdir.Domain.Dialogporten.WebApi/Endpoints/V1/ServiceOwner/Dialogs/Update/UpdateDialogEndpointSummary.cs` | - Class `UpdateDialogEndpointSummary` added to provide structured summaries for the `UpdateDialogEndpoint`. | | `src/Digdir.Domain.Dialogporten.WebApi/Endpoints/V1/ServiceOwner/Dialogs/Update/UpdateDialogSwaggerConfig.cs` | - Class `UpdateDialogSwaggerConfig` and its methods removed, including example data for the update dialog endpoint. | | `src/Digdir.Domain.Dialogporten.WebApi/OpenApiDocumentExtensions.cs` | - Methods `ReplaceRequestExampleBodies` and `ReplaceRequestExampleBody` removed from `OpenApiDocumentExtensions`. | | `src/Digdir.Domain.Dialogporten.WebApi/Program.cs` | - Updated Swagger generation process with new method `IgnoreEmptyCollections` to modify serialization behavior for collections. | ## Possibly related PRs - **#1124**: Introduces a requirement for a valid DialogToken in GraphQL subscriptions, related to security enhancements in the main PR. - **#1163**: Updates the GraphQL schema to replace the `dialogUpdated` subscription with `dialogEvents`, aligning with new schemas and endpoints for dialog management. - **#1244**: Adds missing return types for Transmissions and Activities in the OpenAPI spec, directly related to modifications in the main PR. - **#1359**: Modifies serialization behavior for collections in the OpenAPI schema, complementing changes in the main PR. - **#1387**: Enhances API response behavior for deleted dialogs, relevant to new endpoints and schemas introduced in the main PR. ## 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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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 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](https://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
sonarcloud[bot] commented 1 week ago

Quality Gate Passed 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