@digdir/dialogporten-schema 1.62.2 → 1.63.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@digdir/dialogporten-schema",
-  "version": "1.62.2",
+  "version": "1.63.0",
   "description": "GraphQl schema and OpenAPI spec for Dialogporten",
   "engines": {
     "node": "22"

package/schema.verified.graphql

@@ -124,6 +124,8 @@ type Dialog {
   dialogToken: String
   systemLabel: SystemLabel!
   status: DialogStatus!
+  "Indicates if this dialog is intended for API consumption only and should not be shown in frontends aimed at humans"
+  isApiOnly: Boolean!
   content: Content!
   attachments: [Attachment!]!
   guiActions: [GuiAction!]!
@@ -210,6 +212,8 @@ type SearchDialog {
   dueAt: DateTime
   status: DialogStatus!
   systemLabel: SystemLabel!
+  "Indicates if this dialog is intended for API consumption only and should not be shown in frontends aimed at humans"
+  isApiOnly: Boolean!
   latestActivity: Activity
   content: SearchContent!
   seenSinceLastUpdate: [SeenLog!]!
@@ -302,6 +306,8 @@ input SearchDialogInput {
   status: [DialogStatus!]
   "Filter by system label"
   systemLabel: [SystemLabel!]
+  "Whether to exclude API-only dialogs from the results. Defaults to false."
+  excludeApiOnly: Boolean
   "Only return dialogs created after this date"
   createdAfter: DateTime
   "Only return dialogs created before this date"

package/src/index.js

@@ -124,6 +124,8 @@ type Dialog {
   dialogToken: String
   systemLabel: SystemLabel!
   status: DialogStatus!
+  "Indicates if this dialog is intended for API consumption only and should not be shown in frontends aimed at humans"
+  isApiOnly: Boolean!
   content: Content!
   attachments: [Attachment!]!
   guiActions: [GuiAction!]!
@@ -210,6 +212,8 @@ type SearchDialog {
   dueAt: DateTime
   status: DialogStatus!
   systemLabel: SystemLabel!
+  "Indicates if this dialog is intended for API consumption only and should not be shown in frontends aimed at humans"
+  isApiOnly: Boolean!
   latestActivity: Activity
   content: SearchContent!
   seenSinceLastUpdate: [SeenLog!]!
@@ -302,6 +306,8 @@ input SearchDialogInput {
   status: [DialogStatus!]
   "Filter by system label"
   systemLabel: [SystemLabel!]
+  "Whether to exclude API-only dialogs from the results. Defaults to false."
+  excludeApiOnly: Boolean
   "Only return dialogs created after this date"
   createdAfter: DateTime
   "Only return dialogs created before this date"

package/swagger.verified.json

@@ -680,6 +680,10 @@
             "format": "guid",
             "type": "string"
           },
+          "isApiOnly": {
+            "description": "Indicates if this dialog is intended for API consumption only and should not be shown in frontends aimed at humans.",
+            "type": "boolean"
+          },
           "org": {
             "description": "The service owner code representing the organization (service owner) related to this dialog.",
             "example": "ske",
@@ -1311,6 +1315,10 @@
             "format": "guid",
             "type": "string"
           },
+          "isApiOnly": {
+            "description": "Indicates if this dialog is intended for API consumption only and should not be shown in frontends aimed at humans.\nWhen true, human-readable content like title and summary are not required.",
+            "type": "boolean"
+          },
           "latestActivity": {
             "description": "The latest entry in the dialog\u0027s activity log.",
             "nullable": true,
@@ -2362,6 +2370,7 @@
           },
           "content": {
             "description": "The dialog unstructured text content.",
+            "nullable": true,
             "oneOf": [
               {
                 "$ref": "#/components/schemas/V1ServiceOwnerDialogsCommandsCreate_Content"
@@ -2419,6 +2428,10 @@
             "nullable": true,
             "type": "string"
           },
+          "isApiOnly": {
+            "description": "Indicates if this dialog is intended for API consumption only and should not be displayed in user interfaces.\nWhen true, the dialog will not be visible in portals designed for human users, but will remain accessible via API.",
+            "type": "boolean"
+          },
           "party": {
             "description": "The party code representing the organization or person that the dialog belongs to in URN format.",
             "example": "urn:altinn:person:identifier-no:01125512345\nurn:altinn:organization:identifier-no:912345678",
@@ -2590,6 +2603,7 @@
           },
           "content": {
             "description": "The transmission unstructured text content.",
+            "nullable": true,
             "oneOf": [
               {
                 "$ref": "#/components/schemas/V1ServiceOwnerDialogsCommandsCreate_TransmissionContent"
@@ -3042,6 +3056,7 @@
           },
           "content": {
             "description": "The dialog unstructured text content.",
+            "nullable": true,
             "oneOf": [
               {
                 "$ref": "#/components/schemas/V1ServiceOwnerDialogsCommandsUpdate_Content"
@@ -3225,6 +3240,7 @@
           },
           "content": {
             "description": "The transmission unstructured text content.",
+            "nullable": true,
             "oneOf": [
               {
                 "$ref": "#/components/schemas/V1ServiceOwnerDialogsCommandsUpdate_TransmissionContent"
@@ -3515,6 +3531,7 @@
           },
           "content": {
             "description": "The dialog unstructured text content.",
+            "nullable": true,
             "oneOf": [
               {
                 "$ref": "#/components/schemas/V1ServiceOwnerDialogsQueriesGet_Content"
@@ -3576,6 +3593,10 @@
             "nullable": true,
             "type": "string"
           },
+          "isApiOnly": {
+            "description": "Indicates if this dialog is intended for API consumption only and should not be shown in frontends aimed at humans.",
+            "type": "boolean"
+          },
           "org": {
             "description": "The service owner code representing the organization (service owner) related to this dialog.",
             "example": "ske",
@@ -4210,6 +4231,7 @@
         "properties": {
           "content": {
             "description": "The content of the dialog in search results.",
+            "nullable": true,
             "oneOf": [
               {
                 "$ref": "#/components/schemas/V1ServiceOwnerDialogsQueriesSearch_Content"
@@ -4257,6 +4279,10 @@
             "format": "guid",
             "type": "string"
           },
+          "isApiOnly": {
+            "description": "Indicates if this dialog is intended for API consumption only and should not be shown in frontends aimed at humans.",
+            "type": "boolean"
+          },
           "latestActivity": {
             "description": "The latest entry in the dialog\u0027s activity log.",
             "nullable": true,
@@ -4460,6 +4486,7 @@
           },
           "content": {
             "description": "The transmission unstructured text content.",
+            "nullable": true,
             "oneOf": [
               {
                 "$ref": "#/components/schemas/V1ServiceOwnerDialogsCommandsUpdate_TransmissionContent"
@@ -5106,6 +5133,15 @@
             },
             "style": "form"
           },
+          {
+            "description": "Whether to exclude API-only dialogs from the results. Defaults to false.",
+            "in": "query",
+            "name": "excludeApiOnly",
+            "schema": {
+              "nullable": true,
+              "type": "boolean"
+            }
+          },
           {
             "description": "Search string for free text search. Will attempt to fuzzily match in all free text fields in the aggregate",
             "in": "query",
@@ -6008,6 +6044,15 @@
             },
             "style": "form"
           },
+          {
+            "description": "Whether to exclude API-only dialogs from the results. Defaults to false.",
+            "in": "query",
+            "name": "excludeApiOnly",
+            "schema": {
+              "nullable": true,
+              "type": "boolean"
+            }
+          },
           {
             "description": "Search string for free text search. Will attempt to fuzzily match in all free text fields in the aggregate",
             "in": "query",