fix(webapi): Set correct swagger return type for transmission list #1590
Conversation
📝 WalkthroughWalkthroughThe pull request introduces significant updates to the OpenAPI specification for the Dialogporten API, primarily in the Changes
Possibly related PRs
Suggested reviewers
📜 Recent review detailsConfiguration used: .coderabbit.yaml 📒 Files selected for processing (2)
🔇 Additional comments (5)src/Digdir.Domain.Dialogporten.WebApi/Endpoints/V1/ServiceOwner/DialogTransmissions/Search/SearchDialogTransmissionEndpoint.cs (2)
The change properly aligns the OpenAPI/Swagger documentation with the actual return type of the endpoint, which returns a list of transmissions.
Let's ensure the OpenAPI specification is consistently updated across all references to this endpoint. docs/schema/V1/swagger.verified.json (3)
The return type for transmission list has been properly updated to return an array of transmissions, which aligns with the actual API behavior.
The transmission schemas are properly defined with:
Let's verify that the array return type is consistently used across all transmission-related endpoints. ✅ Verification successfulReturn type is consistently defined across transmission endpoints Both endpoints (
🏁 Scripts executedThe following scripts were executed for the analysis: Script: #!/bin/bash
# Description: Check for consistency in transmission list return types
# Expected: All transmission list endpoints should return array types
# Search for transmission list endpoints and their return types
rg -A 5 "V1.*DialogTransmissionsSearch_SearchDialogTransmission"
Length of output: 938 Script: #!/bin/bash
# Let's check the response schema for both endpoints to verify array type consistency
# First, let's get the full context for V1EndUserDialogTransmissionsSearch_SearchDialogTransmission
rg -B 5 -A 15 "V1EndUserDialogTransmissionsSearch_SearchDialogTransmission.*responses" docs/schema/V1/swagger.verified.json
# Then, let's get the full context for V1ServiceOwnerDialogTransmissionsSearch_SearchDialogTransmission
rg -B 5 -A 15 "V1ServiceOwnerDialogTransmissionsSearch_SearchDialogTransmission.*responses" docs/schema/V1/swagger.verified.json
Length of output: 256 Script: #!/bin/bash
# Let's try a different approach to get the response schemas
# Search for the entire endpoint definitions including their responses
# For EndUser endpoint
rg -A 50 '"V1EndUserDialogTransmissionsSearch_SearchDialogTransmission"' docs/schema/V1/swagger.verified.json
# For ServiceOwner endpoint
rg -A 50 '"V1ServiceOwnerDialogTransmissionsSearch_SearchDialogTransmission"' docs/schema/V1/swagger.verified.json
Length of output: 3725 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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
Documentation and Community
|
|
oskogstad
deleted the
fix/set-correct-return-type-for-so-transmission-list
branch
🤖 I have created a release *beep* *boop* --- ## [1.41.2](v1.41.1...v1.41.2) (2024-12-12) ### Bug Fixes * **webapi:** Set correct swagger return type for transmission list ([#1590](#1590)) ([6e88e0c](6e88e0c)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).
Description
Related Issue(s)
Verification
Documentation
docs-directory, Altinnpedia or a separate linked PR in altinn-studio-docs., if applicable)