@digdir/dialogporten-schema 1.118.0 → 1.118.2-0cd65dd

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@digdir/dialogporten-schema",
-  "version": "1.118.0",
+  "version": "1.118.2-0cd65dd",
   "description": "GraphQl schema and OpenAPI spec for Dialogporten",
   "engines": {
     "node": "24"

package/schema.verified.graphql

@@ -488,6 +488,10 @@ type SearchDialogContinuationTokenParsingError implements SearchDialogError {
   message: String!
 }
 
+type SearchDialogDomainError implements SearchDialogError {
+  message: String!
+}
+
 type SearchDialogForbidden implements SearchDialogError {
   message: String!
 }
@@ -706,19 +710,19 @@ input SearchDialogInput {
   systemLabel: [SystemLabel!]
   "Whether to exclude API-only dialogs from the results. Defaults to false."
   excludeApiOnly: Boolean
-  "Only return dialogs created after this date"
+  "Only return dialogs created after this date. For free text search this does not limit how much the search has to scan; use contentUpdatedAfter to narrow a broad search and avoid a 422 timeout."
   createdAfter: DateTime
-  "Only return dialogs created before this date"
+  "Only return dialogs created before this date. For free text search this does not limit how much the search has to scan; use contentUpdatedAfter to narrow a broad search and avoid a 422 timeout."
   createdBefore: DateTime
-  "Only return dialogs with content updated after this date"
+  "Only return dialogs with content updated after this date. Recommended for free text search: this is the only date filter that limits how much a broad search has to scan. A broad search term without a contentUpdatedAfter bound may exceed the server-side time limit and return 422 - narrow it with this filter (and/or fewer parties or a service resource)."
   contentUpdatedAfter: DateTime
-  "Only return dialogs with content updated before this date"
+  "Only return dialogs with content updated before this date. Unlike contentUpdatedAfter, this upper bound does not by itself limit how much a free text search has to scan."
   contentUpdatedBefore: DateTime
   "Only return dialogs that have content that has/hasn't been seen by the user. A dialog is considered seen if it has been retrieved by a user, since it's last content update, and there is no SystemLabel MarkedAsUnopened."
   isContentSeen: Boolean
-  "Only return dialogs updated after this date"
+  "Only return dialogs updated after this date. For free text search this does not limit how much the search has to scan; use contentUpdatedAfter to narrow a broad search and avoid a 422 timeout."
   updatedAfter: DateTime
-  "Only return dialogs updated before this date"
+  "Only return dialogs updated before this date. For free text search this does not limit how much the search has to scan; use contentUpdatedAfter to narrow a broad search and avoid a 422 timeout."
   updatedBefore: DateTime
   "Only return dialogs with due date after this date"
   dueAfter: DateTime
@@ -732,7 +736,7 @@ input SearchDialogInput {
   limit: Int
   "Continuation token for pagination"
   continuationToken: String
-  "Sort the results by one or more fields"
+  "Sort the results by one or more fields. Defaults to contentUpdatedAt descending. For free text search, keeping the default contentUpdatedAt ordering together with contentUpdatedAfter gives the fastest results."
   orderBy: [SearchDialogSortTypeInput!]
 }
 

package/src/index.js

@@ -488,6 +488,10 @@ type SearchDialogContinuationTokenParsingError implements SearchDialogError {
   message: String!
 }
 
+type SearchDialogDomainError implements SearchDialogError {
+  message: String!
+}
+
 type SearchDialogForbidden implements SearchDialogError {
   message: String!
 }
@@ -706,19 +710,19 @@ input SearchDialogInput {
   systemLabel: [SystemLabel!]
   "Whether to exclude API-only dialogs from the results. Defaults to false."
   excludeApiOnly: Boolean
-  "Only return dialogs created after this date"
+  "Only return dialogs created after this date. For free text search this does not limit how much the search has to scan; use contentUpdatedAfter to narrow a broad search and avoid a 422 timeout."
   createdAfter: DateTime
-  "Only return dialogs created before this date"
+  "Only return dialogs created before this date. For free text search this does not limit how much the search has to scan; use contentUpdatedAfter to narrow a broad search and avoid a 422 timeout."
   createdBefore: DateTime
-  "Only return dialogs with content updated after this date"
+  "Only return dialogs with content updated after this date. Recommended for free text search: this is the only date filter that limits how much a broad search has to scan. A broad search term without a contentUpdatedAfter bound may exceed the server-side time limit and return 422 - narrow it with this filter (and/or fewer parties or a service resource)."
   contentUpdatedAfter: DateTime
-  "Only return dialogs with content updated before this date"
+  "Only return dialogs with content updated before this date. Unlike contentUpdatedAfter, this upper bound does not by itself limit how much a free text search has to scan."
   contentUpdatedBefore: DateTime
   "Only return dialogs that have content that has/hasn't been seen by the user. A dialog is considered seen if it has been retrieved by a user, since it's last content update, and there is no SystemLabel MarkedAsUnopened."
   isContentSeen: Boolean
-  "Only return dialogs updated after this date"
+  "Only return dialogs updated after this date. For free text search this does not limit how much the search has to scan; use contentUpdatedAfter to narrow a broad search and avoid a 422 timeout."
   updatedAfter: DateTime
-  "Only return dialogs updated before this date"
+  "Only return dialogs updated before this date. For free text search this does not limit how much the search has to scan; use contentUpdatedAfter to narrow a broad search and avoid a 422 timeout."
   updatedBefore: DateTime
   "Only return dialogs with due date after this date"
   dueAfter: DateTime
@@ -732,7 +736,7 @@ input SearchDialogInput {
   limit: Int
   "Continuation token for pagination"
   continuationToken: String
-  "Sort the results by one or more fields"
+  "Sort the results by one or more fields. Defaults to contentUpdatedAt descending. For free text search, keeping the default contentUpdatedAt ordering together with contentUpdatedAfter gives the fastest results."
   orderBy: [SearchDialogSortTypeInput!]
 }
 

package/swagger.verified.json

@@ -7295,7 +7295,7 @@
             "style": "form"
           },
           {
-            "description": "Only return dialogs created after this date",
+            "description": "Only return dialogs created after this date. For free text search this does not limit how much the search has to scan; use \u0027contentUpdatedAfter\u0027 to narrow a broad search and avoid a 422 timeout.",
             "in": "query",
             "name": "createdAfter",
             "schema": {
@@ -7305,7 +7305,7 @@
             }
           },
           {
-            "description": "Only return dialogs created before this date",
+            "description": "Only return dialogs created before this date. For free text search this does not limit how much the search has to scan; use \u0027contentUpdatedAfter\u0027 to narrow a broad search and avoid a 422 timeout.",
             "in": "query",
             "name": "createdBefore",
             "schema": {
@@ -7315,7 +7315,7 @@
             }
           },
           {
-            "description": "Only return dialogs updated after this date",
+            "description": "Only return dialogs updated after this date. For free text search this does not limit how much the search has to scan; use \u0027contentUpdatedAfter\u0027 to narrow a broad search and avoid a 422 timeout.",
             "in": "query",
             "name": "updatedAfter",
             "schema": {
@@ -7325,7 +7325,7 @@
             }
           },
           {
-            "description": "Only return dialogs updated before this date",
+            "description": "Only return dialogs updated before this date. For free text search this does not limit how much the search has to scan; use \u0027contentUpdatedAfter\u0027 to narrow a broad search and avoid a 422 timeout.",
             "in": "query",
             "name": "updatedBefore",
             "schema": {
@@ -7335,7 +7335,7 @@
             }
           },
           {
-            "description": "Only return dialogs with content updated after this date",
+            "description": "Only return dialogs with content updated after this date. Recommended for free text search: this is the only date filter that limits how much a broad search has to scan. A broad search term without a \u0027contentUpdatedAfter\u0027 bound may exceed the server-side time limit and return 422 - narrow it with this filter (and/or fewer parties or a service resource).",
             "in": "query",
             "name": "contentUpdatedAfter",
             "schema": {
@@ -7345,7 +7345,7 @@
             }
           },
           {
-            "description": "Only return dialogs with content updated before this date",
+            "description": "Only return dialogs with content updated before this date. Unlike \u0027contentUpdatedAfter\u0027, this upper bound does not by itself limit how much a free text search has to scan.",
             "in": "query",
             "name": "contentUpdatedBefore",
             "schema": {
@@ -7434,6 +7434,7 @@
             }
           },
           {
+            "description": "Order the results by one or more fields. Defaults to \u0022contentUpdatedAt\u0022 descending. For free text search, keeping the default \u0022contentUpdatedAt\u0022 ordering together with \u0022contentUpdatedAfter\u0022 gives the fastest results.",
             "in": "query",
             "name": "orderBy",
             "schema": {
@@ -7487,6 +7488,19 @@
           "401": {
             "description": "Missing or invalid authentication token. Requires a Maskinporten-token with the scope \u0022digdir:dialogporten\u0022."
           },
+          "403": {
+            "description": "Forbidden"
+          },
+          "422": {
+            "content": {
+              "application/problem\u002Bjson": {
+                "schema": {
+                  "$ref": "#/components/schemas/ProblemDetails"
+                }
+              }
+            },
+            "description": "Domain error occurred. See problem details for a list of errors."
+          },
           "503": {
             "content": {
               "text/plain": {
@@ -11670,5 +11684,19 @@
         ]
       }
     }
-  }
-}
+  },
+  "tags": [
+    {
+      "description": "Endpoints for service owners to create and manage dialogs. Requires a Maskinporten token with the relevant \u0060digdir:dialogporten.serviceprovider\u0060 scope. The search endpoint additionally requires the \u0060digdir:dialogporten.serviceprovider.search\u0060 scope.\n\nA .NET client SDK is available: [Altinn.ApiClients.Dialogporten.ServiceOwner](https://www.nuget.org/packages/Altinn.ApiClients.Dialogporten.ServiceOwner/).",
+      "name": "Serviceowner"
+    },
+    {
+      "description": "Endpoints for end users to read and act on dialogs they are authorized to access. Used both by persons logged in via ID-porten and by Altinn system users authenticated via Maskinporten. Requires a token with the \u0060digdir:dialogporten\u0060 scope (or \u0060digdir:dialogporten.noconsent\u0060).\n\nA .NET client SDK is available: [Altinn.ApiClients.Dialogporten.EndUser](https://www.nuget.org/packages/Altinn.ApiClients.Dialogporten.EndUser/).",
+      "name": "Enduser"
+    },
+    {
+      "description": "Public, unauthenticated metadata endpoints such as health and configuration information.",
+      "name": "Metadata"
+    }
+  ]
+}