fix: Correct the SeenLog list endpoints OpenAPI description (#976)

digdir · Aug 8, 2024 · f6ebd19 · f6ebd19
1 parent 08c3be9
commit f6ebd19
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 14 deletions.
diff --git a/docs/schema/V1/swagger.verified.json b/docs/schema/V1/swagger.verified.json
@@ -265,8 +265,8 @@
         "tags": [
           "Serviceowner"
         ],
-        "summary": "Gets a single dialog seen log record",
-        "description": "Gets a single dialog seen log record. For more information see the documentation (link TBD).",
+        "summary": "Gets all seen log records for a dialog",
+        "description": "Gets all seen log records for a dialog. For more information see the documentation (link TBD).",
         "operationId": "SearchDialogSeenLogSO",
         "parameters": [
           {
@@ -287,7 +287,7 @@
             "description": "Forbidden"
           },
           "200": {
-            "description": "Successfully returned the dialog seen log record.",
+            "description": "Successfully returned the dialog seen log records.",
             "content": {
               "application/json": {
                 "schema": {
@@ -1548,8 +1548,8 @@
         "tags": [
           "Enduser"
         ],
-        "summary": "Gets a single dialog seen log record",
-        "description": "Gets a single dialog seen log record. For more information see the documentation (link TBD).",
+        "summary": "Gets all seen log records for a dialog",
+        "description": "Gets all seen log records for a dialog. For more information see the documentation (link TBD).",
         "operationId": "SearchDialogSeenLog",
         "parameters": [
           {
@@ -1570,7 +1570,7 @@
             "description": "Forbidden"
           },
           "200": {
-            "description": "Successfully returned the dialog seen log record.",
+            "description": "Successfully returned the dialog seen log records.",
             "content": {
               "application/json": {
                 "schema": {

diff --git a/...ten.WebApi/Endpoints/V1/EndUser/DialogSeenLogs/Search/SearchDialogSeenLogSwaggerConfig.cs b/...ten.WebApi/Endpoints/V1/EndUser/DialogSeenLogs/Search/SearchDialogSeenLogSwaggerConfig.cs
@@ -24,12 +24,13 @@ public sealed class SearchDialogSeenLogEndpointSummary : Summary<SearchDialogSee
 {
     public SearchDialogSeenLogEndpointSummary()
     {
-        Summary = "Gets a single dialog seen log record";
-        Description = """
-                      Gets a single dialog seen log record. For more information see the documentation (link TBD).
+        const string summary = "Gets all seen log records for a dialog";
+        Summary = summary;
+        Description = $"""
+                      {summary}. For more information see the documentation (link TBD).
                       """;
 
-        Responses[StatusCodes.Status200OK] = Constants.SwaggerSummary.ReturnedResult.FormatInvariant("seen log record");
+        Responses[StatusCodes.Status200OK] = Constants.SwaggerSummary.ReturnedResult.FormatInvariant("seen log records");
         Responses[StatusCodes.Status401Unauthorized] = Constants.SwaggerSummary.EndUserAuthenticationFailure;
     }
 }
diff --git a/...ebApi/Endpoints/V1/ServiceOwner/DialogSeenLogs/Search/SearchDialogSeenLogSwaggerConfig.cs b/...ebApi/Endpoints/V1/ServiceOwner/DialogSeenLogs/Search/SearchDialogSeenLogSwaggerConfig.cs
@@ -24,11 +24,12 @@ public sealed class SearchDialogSeenLogEndpointSummary : Summary<SearchDialogSee
 {
     public SearchDialogSeenLogEndpointSummary()
     {
-        Summary = "Gets a single dialog seen log record";
-        Description = """
-                      Gets a single dialog seen log record. For more information see the documentation (link TBD).
+        const string summary = "Gets all seen log records for a dialog";
+        Summary = summary;
+        Description = $"""
+                      {summary}. For more information see the documentation (link TBD).
                       """;
 
-        Responses[StatusCodes.Status200OK] = Constants.SwaggerSummary.ReturnedResult.FormatInvariant("seen log record");
+        Responses[StatusCodes.Status200OK] = Constants.SwaggerSummary.ReturnedResult.FormatInvariant("seen log records");
     }
 }