@digdir/dialogporten-schema 1.54.0-8f382cd → 1.55.1-c9e10db

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@digdir/dialogporten-schema",
-  "version": "1.54.0-8f382cd",
+  "version": "1.55.1-c9e10db",
   "description": "GraphQl schema and OpenAPI spec for Dialogporten",
   "engines": {
     "node": "22"

package/swagger.verified.json

@@ -1810,33 +1810,46 @@
         "additionalProperties": false,
         "properties": {
           "hasKeyRole": {
+            "description": "Whether the authenticated user has a key role in the party.\n            \nRead more about key roles (norwegian) at https://docs.altinn.studio/nb/altinn-studio/reference/configuration/authorization/guidelines_authorization/roles_and_rights/roles_er/#n\u00F8kkelroller",
             "type": "boolean"
           },
           "hasOnlyAccessToSubParties": {
+            "description": "If the authenticated user has only access to sub parties of this party, and not this party itself.",
             "type": "boolean"
           },
           "isAccessManager": {
+            "description": "Whether the authenticated user is an access manager of the party.\n            \nRead more about access managers (norwegian) at https://docs.altinn.studio/nb/altinn-studio/reference/configuration/authorization/guidelines_authorization/roles_and_rights/roles_altinn/altinn_roles_administration/#tilgangsstrying",
             "type": "boolean"
           },
           "isCurrentEndUser": {
+            "description": "Whether this party represents the authenticated user.",
             "type": "boolean"
           },
           "isDeleted": {
+            "description": "Whether the party is deleted or not",
             "type": "boolean"
           },
           "isMainAdministrator": {
+            "description": "Whether the authenticated user is the main administrator of the party\n            \nRead more about main administrator (norwegian) at https://docs.altinn.studio/nb/altinn-studio/reference/configuration/authorization/guidelines_authorization/roles_and_rights/roles_altinn/altinn_roles_administration/#hovedadministrator",
             "type": "boolean"
           },
           "name": {
+            "description": "The name of the party (verbatim from CCR, usually in all caps)",
+            "example": "CONTOSO REAL ESTATE AS",
             "type": "string"
           },
           "party": {
+            "description": "The party identifier in URN format",
+            "example": "urn:altinn:organization:identifier-no:912345678",
             "type": "string"
           },
           "partyType": {
+            "description": "The type of the party, either \u0022Organization\u0022 or \u0022Person\u0022.",
+            "example": "Organization",
             "type": "string"
           },
           "subParties": {
+            "description": "The sub parties of this party, if any. The sub party uses the same data model.",
             "items": {
               "$ref": "#/components/schemas/V1EndUserPartiesQueriesGet_AuthorizedParty"
             },
@@ -4846,6 +4859,7 @@
     }
   },
   "info": {
+    "description": "Dialogporten API description for both enduser and serviceowner users, as well as open metadata information for public key material.\u003Cbr\u003E\u003Cbr\u003EAll operations* described within this document require authentication and authorization. Read more at \u003Ca href=\u0022https://docs.altinn.studio/dialogporten/user-guides/authenticating/\u0022\u003Ehttps://docs.altinn.studio/dialogporten/user-guides/authenticating/\u003C/a\u003E\u003Cbr\u003E\u003Cbr\u003E\u003Cstrong\u003EAll GET operations* and POST operations may return or contain, respectively, personal identifiable information (national identity numbers and names).\u003C/strong\u003E\u003Cbr\u003E\u003Cbr\u003EFor more information about this product, see \u003Ca href=\u0022https://docs.altinn.studio/dialogporten\u0022\u003Ehttps://docs.altinn.studio/dialogporten\u003C/a\u003E\u003Cbr\u003E\u003Cbr\u003E\u003Cem\u003E* Except the metadata APIs",
     "title": "Dialogporten",
     "version": "v1"
   },
@@ -4897,7 +4911,7 @@
     },
     "/api/v1/enduser/dialogs": {
       "get": {
-        "description": "Performs a search for dialogs, returning a paginated list of dialogs. For more information see the documentation (link TBD).\n\n* All date parameters must contain explicit time zone. Example: 2023-10-27T10:00:00Z or 2023-10-27T10:00:00\u002B01:00\n* See \u0022continuationToken\u0022 in the response for how to get the next page of results.\n* hasNextPage will be set to true if there are more items to get.",
+        "description": "Performs a search for dialogs, returning a paginated list of dialogs. \n\n* All date parameters must contain explicit time zone. Example: 2023-10-27T10:00:00Z or 2023-10-27T10:00:00\u002B01:00\n* See \u0022continuationToken\u0022 in the response for how to get the next page of results.\n* hasNextPage will be set to true if there are more items to get.",
         "operationId": "V1EndUserDialogsSearch_SearchDialog",
         "parameters": [
           {
@@ -5133,7 +5147,9 @@
         },
         "security": [
           {
-            "JWTBearerAuth": []
+            "JWTBearerAuth": [
+              "digdir:dialogporten"
+            ]
           }
         ],
         "summary": "Gets a list of dialogs",
@@ -5144,7 +5160,7 @@
     },
     "/api/v1/enduser/dialogs/{dialogId}": {
       "get": {
-        "description": "Gets a single dialog aggregate. For more information see the documentation (link TBD).",
+        "description": "Gets a single dialog aggregate. ",
         "operationId": "V1EndUserDialogsGet_GetDialog",
         "parameters": [
           {
@@ -5187,7 +5203,9 @@
         },
         "security": [
           {
-            "JWTBearerAuth": []
+            "JWTBearerAuth": [
+              "digdir:dialogporten"
+            ]
           }
         ],
         "summary": "Gets a single dialog",
@@ -5244,7 +5262,9 @@
         },
         "security": [
           {
-            "JWTBearerAuth": []
+            "JWTBearerAuth": [
+              "digdir:dialogporten"
+            ]
           }
         ],
         "summary": "Gets a list of dialog activities",
@@ -5255,7 +5275,7 @@
     },
     "/api/v1/enduser/dialogs/{dialogId}/activities/{activityId}": {
       "get": {
-        "description": "Gets a single activity belonging to a dialog. For more information see the documentation (link TBD).",
+        "description": "Gets a single activity belonging to a dialog.",
         "operationId": "V1EndUserDialogActivitiesGet_GetDialogActivity",
         "parameters": [
           {
@@ -5307,7 +5327,9 @@
         },
         "security": [
           {
-            "JWTBearerAuth": []
+            "JWTBearerAuth": [
+              "digdir:dialogporten"
+            ]
           }
         ],
         "summary": "Gets a single dialog activity",
@@ -5366,7 +5388,9 @@
         },
         "security": [
           {
-            "JWTBearerAuth": []
+            "JWTBearerAuth": [
+              "digdir:dialogporten"
+            ]
           }
         ],
         "tags": [
@@ -5376,7 +5400,7 @@
     },
     "/api/v1/enduser/dialogs/{dialogId}/seenlog": {
       "get": {
-        "description": "Gets all seen log records for a dialog. For more information see the documentation (link TBD).",
+        "description": "Gets all seen log records for a dialog.",
         "operationId": "V1EndUserDialogSeenLogsSearch_SearchDialogSeenLog",
         "parameters": [
           {
@@ -5422,7 +5446,9 @@
         },
         "security": [
           {
-            "JWTBearerAuth": []
+            "JWTBearerAuth": [
+              "digdir:dialogporten"
+            ]
           }
         ],
         "summary": "Gets all seen log records for a dialog",
@@ -5433,7 +5459,7 @@
     },
     "/api/v1/enduser/dialogs/{dialogId}/seenlog/{seenLogId}": {
       "get": {
-        "description": "Gets a single dialog seen log record. For more information see the documentation (link TBD).",
+        "description": "Gets a single dialog seen log record.",
         "operationId": "V1EndUserDialogSeenLogsGet_GetDialogSeenLog",
         "parameters": [
           {
@@ -5485,7 +5511,9 @@
         },
         "security": [
           {
-            "JWTBearerAuth": []
+            "JWTBearerAuth": [
+              "digdir:dialogporten"
+            ]
           }
         ],
         "summary": "Gets a single dialog seen log record",
@@ -5577,7 +5605,9 @@
         },
         "security": [
           {
-            "JWTBearerAuth": []
+            "JWTBearerAuth": [
+              "digdir:dialogporten"
+            ]
           }
         ],
         "tags": [
@@ -5619,11 +5649,26 @@
           },
           "403": {
             "description": "Unauthorized to get the supplied dialog (not owned by authenticated organization or has additional scope requirements defined in policy)."
+          },
+          "404": {
+            "content": {
+              "application/problem\u002Bjson": {
+                "schema": {
+                  "$ref": "#/components/schemas/ProblemDetails"
+                }
+              }
+            },
+            "description": "The given dialog ID was not found."
+          },
+          "410": {
+            "description": "Entity with the given key(s) is removed."
           }
         },
         "security": [
           {
-            "JWTBearerAuth": []
+            "JWTBearerAuth": [
+              "digdir:dialogporten"
+            ]
           }
         ],
         "summary": "Gets a list of dialog transmissions",
@@ -5634,7 +5679,7 @@
     },
     "/api/v1/enduser/dialogs/{dialogId}/transmissions/{transmissionId}": {
       "get": {
-        "description": "Gets a single transmission belonging to a dialog. For more information see the documentation (link TBD).",
+        "description": "Gets a single transmission belonging to a dialog.",
         "operationId": "V1EndUserDialogTransmissionsGet_GetDialogTransmission",
         "parameters": [
           {
@@ -5681,12 +5726,17 @@
                 }
               }
             },
-            "description": "The given dialog ID was not found or was deleted, or the given transmission ID was not found."
+            "description": "The specified dialog ID or transmission ID was not found."
+          },
+          "410": {
+            "description": "Entity with the given key(s) is removed."
           }
         },
         "security": [
           {
-            "JWTBearerAuth": []
+            "JWTBearerAuth": [
+              "digdir:dialogporten"
+            ]
           }
         ],
         "summary": "Gets a single dialog transmission",
@@ -5697,7 +5747,7 @@
     },
     "/api/v1/enduser/parties": {
       "get": {
-        "description": "Gets the list of authorized parties for the end user. For more information see the documentation (link TBD).",
+        "description": "Gets the list of authorized parties for the end user.",
         "operationId": "V1EndUserPartiesGet_GetParties",
         "responses": {
           "200": {
@@ -5722,7 +5772,9 @@
         },
         "security": [
           {
-            "JWTBearerAuth": []
+            "JWTBearerAuth": [
+              "digdir:dialogporten"
+            ]
           }
         ],
         "summary": "Gets the list of authorized parties for the end user",
@@ -5733,7 +5785,7 @@
     },
     "/api/v1/serviceowner/dialogs": {
       "get": {
-        "description": "Performs a search for dialogs, returning a paginated list of dialogs. For more information see the documentation (link TBD).\n\n* All date parameters must contain explicit time zone. Example: 2023-10-27T10:00:00Z or 2023-10-27T10:00:00\u002B01:00\n* See \u0022continuationToken\u0022 in the response for how to get the next page of results.\n* hasNextPage will be set to true if there are more items to get.",
+        "description": "Performs a search for dialogs, returning a paginated list of dialogs.\n\n* All date parameters must contain explicit time zone. Example: 2023-10-27T10:00:00Z or 2023-10-27T10:00:00\u002B01:00\n* See \u0022continuationToken\u0022 in the response for how to get the next page of results.\n* hasNextPage will be set to true if there are more items to get.",
         "operationId": "V1ServiceOwnerDialogsSearch_SearchDialog",
         "parameters": [
           {
@@ -5997,7 +6049,10 @@
         },
         "security": [
           {
-            "JWTBearerAuth": []
+            "JWTBearerAuth": [
+              "digdir:dialogporten.serviceprovider",
+              "digdir:dialogporten.serviceprovider.search"
+            ]
           }
         ],
         "summary": "Gets a list of dialogs",
@@ -6006,7 +6061,7 @@
         ]
       },
       "post": {
-        "description": "The dialog is created with the given configuration. For more information see the documentation (link TBD).\n\nFor detailed information on validation rules, see [the source for CreateDialogCommandValidator](https://github.com/altinn/dialogporten/blob/main/src/Digdir.Domain.Dialogporten.Application/Features/V1/ServiceOwner/Dialogs/Commands/Create/CreateDialogCommandValidator.cs)",
+        "description": "The dialog is created with the given configuration.\n\nFor detailed information on validation rules, see [the source for CreateDialogCommandValidator](https://github.com/altinn/dialogporten/blob/main/src/Digdir.Domain.Dialogporten.Application/Features/V1/ServiceOwner/Dialogs/Commands/Create/CreateDialogCommandValidator.cs)",
         "operationId": "V1ServiceOwnerDialogsCreate_Dialog",
         "requestBody": {
           "content": {
@@ -6075,7 +6130,9 @@
         },
         "security": [
           {
-            "JWTBearerAuth": []
+            "JWTBearerAuth": [
+              "digdir:dialogporten.serviceprovider"
+            ]
           }
         ],
         "summary": "Creates a new dialog",
@@ -6086,7 +6143,7 @@
     },
     "/api/v1/serviceowner/dialogs/{dialogId}": {
       "delete": {
-        "description": "Deletes a given dialog (soft delete). For more information see the documentation (link TBD).\n\nNote that the dialog will still be available on the single details endpoint, but will have a deleted status. It will not appear on the list endpoint for either service owners nor end users.\nIf end users attempt to access the dialog via the details endpoint, they will get a 410 Gone response.\n\nOptimistic concurrency control is implemented using the If-Match header. Supply the Revision value from the GetDialog endpoint to ensure that the dialog is not deleted by another request in the meantime.",
+        "description": "Deletes a given dialog (soft delete).\n\nNote that the dialog will still be available on the single details endpoint, but will have a deleted status. It will not appear on the list endpoint for either service owners nor end users.\nIf end users attempt to access the dialog via the details endpoint, they will get a 410 Gone response.\n\nOptimistic concurrency control is implemented using the If-Match header. Supply the Revision value from the GetDialog endpoint to ensure that the dialog is not deleted by another request in the meantime.",
         "operationId": "V1ServiceOwnerDialogsDelete_Dialog",
         "parameters": [
           {
@@ -6163,7 +6220,9 @@
         },
         "security": [
           {
-            "JWTBearerAuth": []
+            "JWTBearerAuth": [
+              "digdir:dialogporten.serviceprovider"
+            ]
           }
         ],
         "summary": "Deletes a dialog",
@@ -6172,7 +6231,7 @@
         ]
       },
       "get": {
-        "description": "Gets a single dialog aggregate. For more information see the documentation (link TBD).\n\nNote that this operation may return deleted dialogs (see the field \u0060DeletedAt\u0060).",
+        "description": "Gets a single dialog aggregate.\n\nNote that this operation may return deleted dialogs (see the field \u0060DeletedAt\u0060).",
         "operationId": "V1ServiceOwnerDialogsGet_GetDialog",
         "parameters": [
           {
@@ -6224,7 +6283,9 @@
         },
         "security": [
           {
-            "JWTBearerAuth": []
+            "JWTBearerAuth": [
+              "digdir:dialogporten.serviceprovider"
+            ]
           }
         ],
         "summary": "Gets a single dialog",
@@ -6345,7 +6406,9 @@
         },
         "security": [
           {
-            "JWTBearerAuth": []
+            "JWTBearerAuth": [
+              "digdir:dialogporten.serviceprovider"
+            ]
           }
         ],
         "summary": "Patch a single dialog",
@@ -6354,7 +6417,7 @@
         ]
       },
       "put": {
-        "description": "Replaces a given dialog with the supplied model. For more information see the documentation (link TBD).\n\nOptimistic concurrency control is implemented using the If-Match header. Supply the Revision value from the GetDialog endpoint to ensure that the dialog is not modified/deleted by another request in the meantime.",
+        "description": "Replaces a given dialog with the supplied model.\n\nOptimistic concurrency control is implemented using the If-Match header. Supply the Revision value from the GetDialog endpoint to ensure that the dialog is not modified/deleted by another request in the meantime.",
         "operationId": "V1ServiceOwnerDialogsUpdate_Dialog",
         "parameters": [
           {
@@ -6452,7 +6515,9 @@
         },
         "security": [
           {
-            "JWTBearerAuth": []
+            "JWTBearerAuth": [
+              "digdir:dialogporten.serviceprovider"
+            ]
           }
         ],
         "summary": "Replaces a dialog",
@@ -6463,7 +6528,7 @@
     },
     "/api/v1/serviceowner/dialogs/{dialogId}/actions/purge": {
       "post": {
-        "description": "Deletes a given dialog (hard delete). For more information see the documentation (link TBD).\n\nOptimistic concurrency control is implemented using the If-Match header. Supply the Revision value from the GetDialog endpoint to ensure that the dialog is not deleted by another request in the meantime.",
+        "description": "Deletes a given dialog (hard delete).\n\nOptimistic concurrency control is implemented using the If-Match header. Supply the Revision value from the GetDialog endpoint to ensure that the dialog is not deleted by another request in the meantime.",
         "operationId": "V1ServiceOwnerDialogsPurge_PurgeDialog",
         "parameters": [
           {
@@ -6518,7 +6583,9 @@
         },
         "security": [
           {
-            "JWTBearerAuth": []
+            "JWTBearerAuth": [
+              "digdir:dialogporten.serviceprovider"
+            ]
           }
         ],
         "summary": "Permanently deletes a dialog",
@@ -6529,7 +6596,7 @@
     },
     "/api/v1/serviceowner/dialogs/{dialogId}/actions/restore": {
       "post": {
-        "description": "Restore a dialog. For more information see the documentation (link TBD). ",
+        "description": "Restore a dialog. ",
         "operationId": "V1ServiceOwnerDialogsRestore_RestoreDialog",
         "parameters": [
           {
@@ -6584,7 +6651,9 @@
         },
         "security": [
           {
-            "JWTBearerAuth": []
+            "JWTBearerAuth": [
+              "digdir:dialogporten.serviceprovider"
+            ]
           }
         ],
         "summary": "Restore a dialog",
@@ -6661,7 +6730,9 @@
         },
         "security": [
           {
-            "JWTBearerAuth": []
+            "JWTBearerAuth": [
+              "digdir:dialogporten.serviceprovider"
+            ]
           }
         ],
         "summary": "Returns a boolean value based on conditions used to determine if a notification is to be sent",
@@ -6718,7 +6789,9 @@
         },
         "security": [
           {
-            "JWTBearerAuth": []
+            "JWTBearerAuth": [
+              "digdir:dialogporten.serviceprovider"
+            ]
           }
         ],
         "summary": "Gets a list of dialog activities",
@@ -6727,7 +6800,7 @@
         ]
       },
       "post": {
-        "description": "The activity is created with the given configuration. For more information see the documentation (link TBD).\n\nOptimistic concurrency control is implemented using the If-Match header. Supply the Revision value from the GetDialog endpoint to ensure that the dialog is not modified/deleted by another request in the meantime.",
+        "description": "The activity is created with the given configuration.\n\nOptimistic concurrency control is implemented using the If-Match header. Supply the Revision value from the GetDialog endpoint to ensure that the dialog is not modified/deleted by another request in the meantime.",
         "operationId": "V1ServiceOwnerDialogActivitiesCreate_DialogActivity",
         "parameters": [
           {
@@ -6838,7 +6911,9 @@
         },
         "security": [
           {
-            "JWTBearerAuth": []
+            "JWTBearerAuth": [
+              "digdir:dialogporten.serviceprovider"
+            ]
           }
         ],
         "summary": "Adds a activity to a dialogs activity history",
@@ -6849,7 +6924,7 @@
     },
     "/api/v1/serviceowner/dialogs/{dialogId}/activities/{activityId}": {
       "get": {
-        "description": "Gets a single activity belonging to a dialog. For more information see the documentation (link TBD).",
+        "description": "Gets a single activity belonging to a dialog.",
         "operationId": "V1ServiceOwnerDialogActivitiesGet_GetDialogActivity",
         "parameters": [
           {
@@ -6904,7 +6979,9 @@
         },
         "security": [
           {
-            "JWTBearerAuth": []
+            "JWTBearerAuth": [
+              "digdir:dialogporten.serviceprovider"
+            ]
           }
         ],
         "summary": "Gets a single dialog activity",
@@ -6915,7 +6992,7 @@
     },
     "/api/v1/serviceowner/dialogs/{dialogId}/seenlog": {
       "get": {
-        "description": "Gets all seen log records for a dialog. For more information see the documentation (link TBD).",
+        "description": "Gets all seen log records for a dialog.",
         "operationId": "V1ServiceOwnerDialogSeenLogsSearch_SearchDialogSeenLog",
         "parameters": [
           {
@@ -6964,7 +7041,9 @@
         },
         "security": [
           {
-            "JWTBearerAuth": []
+            "JWTBearerAuth": [
+              "digdir:dialogporten.serviceprovider"
+            ]
           }
         ],
         "summary": "Gets all seen log records for a dialog",
@@ -6975,7 +7054,7 @@
     },
     "/api/v1/serviceowner/dialogs/{dialogId}/seenlog/{seenLogId}": {
       "get": {
-        "description": "Gets a single dialog seen log record. For more information see the documentation (link TBD).",
+        "description": "Gets a single dialog seen log record.",
         "operationId": "V1ServiceOwnerDialogSeenLogsGet_GetDialogSeenLog",
         "parameters": [
           {
@@ -7030,7 +7109,9 @@
         },
         "security": [
           {
-            "JWTBearerAuth": []
+            "JWTBearerAuth": [
+              "digdir:dialogporten.serviceprovider"
+            ]
           }
         ],
         "summary": "Gets a single dialog seen log record",
@@ -7090,7 +7171,9 @@
         },
         "security": [
           {
-            "JWTBearerAuth": []
+            "JWTBearerAuth": [
+              "digdir:dialogporten.serviceprovider"
+            ]
           }
         ],
         "summary": "Gets a list of dialog transmissions",
@@ -7099,7 +7182,7 @@
         ]
       },
       "post": {
-        "description": "The transmission is created with the given configuration. For more information see the documentation (link TBD).\n\nOptimistic concurrency control is implemented using the If-Match header. Supply the Revision value from the GetDialog endpoint to ensure that the dialog is not modified/deleted by another request in the meantime.",
+        "description": "The transmission is created with the given configuration.\n\nOptimistic concurrency control is implemented using the If-Match header. Supply the Revision value from the GetDialog endpoint to ensure that the dialog is not modified/deleted by another request in the meantime.",
         "operationId": "V1ServiceOwnerDialogTransmissionsCreate_DialogTransmission",
         "parameters": [
           {
@@ -7210,7 +7293,9 @@
         },
         "security": [
           {
-            "JWTBearerAuth": []
+            "JWTBearerAuth": [
+              "digdir:dialogporten.serviceprovider"
+            ]
           }
         ],
         "summary": "Adds a transmission to a dialog",
@@ -7221,7 +7306,7 @@
     },
     "/api/v1/serviceowner/dialogs/{dialogId}/transmissions/{transmissionId}": {
       "get": {
-        "description": "Gets a single transmission belonging to a dialog. For more information see the documentation (link TBD).",
+        "description": "Gets a single transmission belonging to a dialog.",
         "operationId": "V1ServiceOwnerDialogTransmissionsGet_GetDialogTransmission",
         "parameters": [
           {
@@ -7268,7 +7353,7 @@
                 }
               }
             },
-            "description": "The given dialog ID was not found or was deleted, or the given transmission ID was not found."
+            "description": "The specified dialog ID or transmission ID was not found."
           },
           "410": {
             "description": "Entity with the given key(s) is removed."
@@ -7276,7 +7361,9 @@
         },
         "security": [
           {
-            "JWTBearerAuth": []
+            "JWTBearerAuth": [
+              "digdir:dialogporten.serviceprovider"
+            ]
           }
         ],
         "summary": "Gets a single dialog transmission",