@digdir/dialogporten-schema 1.108.0 → 1.110.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@digdir/dialogporten-schema",
3
- "version": "1.108.0",
3
+ "version": "1.110.0",
4
4
  "description": "GraphQl schema and OpenAPI spec for Dialogporten",
5
5
  "engines": {
6
6
  "node": "24"
@@ -4491,6 +4491,212 @@
4491
4491
  },
4492
4492
  "type": "object"
4493
4493
  },
4494
+ "V1ServiceOwnerDialogsCommandsUpdateTransmission_TransmissionAttachment": {
4495
+ "additionalProperties": false,
4496
+ "properties": {
4497
+ "displayName": {
4498
+ "description": "The display name of the attachment that should be used in GUIs.",
4499
+ "items": {
4500
+ "$ref": "#/components/schemas/V1CommonLocalizations_Localization"
4501
+ },
4502
+ "nullable": true,
4503
+ "type": "array"
4504
+ },
4505
+ "expiresAt": {
4506
+ "description": "The UTC timestamp when the attachment expires and is no longer available.",
4507
+ "format": "date-time",
4508
+ "nullable": true,
4509
+ "type": "string"
4510
+ },
4511
+ "id": {
4512
+ "description": "A self-defined UUIDv7 may be provided to support idempotent additions of transmission attachments. If not provided, a new UUIDv7 will be generated.",
4513
+ "example": "01913cd5-784f-7d3b-abef-4c77b1f0972d",
4514
+ "format": "guid",
4515
+ "nullable": true,
4516
+ "type": "string"
4517
+ },
4518
+ "name": {
4519
+ "description": "The logical name of the attachment.",
4520
+ "example": "receipt",
4521
+ "nullable": true,
4522
+ "type": "string"
4523
+ },
4524
+ "urls": {
4525
+ "description": "The URLs associated with the attachment, each referring to a different representation of the attachment.",
4526
+ "items": {
4527
+ "$ref": "#/components/schemas/V1ServiceOwnerDialogsCommandsUpdateTransmission_TransmissionAttachmentUrl"
4528
+ },
4529
+ "nullable": true,
4530
+ "type": "array"
4531
+ }
4532
+ },
4533
+ "type": "object"
4534
+ },
4535
+ "V1ServiceOwnerDialogsCommandsUpdateTransmission_TransmissionAttachmentUrl": {
4536
+ "additionalProperties": false,
4537
+ "properties": {
4538
+ "consumerType": {
4539
+ "description": "The type of consumer the URL is intended for.",
4540
+ "oneOf": [
4541
+ {
4542
+ "$ref": "#/components/schemas/Attachments_AttachmentUrlConsumerType"
4543
+ }
4544
+ ]
4545
+ },
4546
+ "mediaType": {
4547
+ "description": "The media type of the attachment.",
4548
+ "example": "application/pdf\napplication/zip",
4549
+ "nullable": true,
4550
+ "type": "string"
4551
+ },
4552
+ "url": {
4553
+ "description": "The fully qualified URL of the attachment.",
4554
+ "format": "uri",
4555
+ "type": "string"
4556
+ }
4557
+ },
4558
+ "type": "object"
4559
+ },
4560
+ "V1ServiceOwnerDialogsCommandsUpdateTransmission_TransmissionContent": {
4561
+ "additionalProperties": false,
4562
+ "properties": {
4563
+ "contentReference": {
4564
+ "description": "Front-channel embedded content. Used to dynamically embed content in the frontend from an external URL. Must be HTTPS.",
4565
+ "nullable": true,
4566
+ "oneOf": [
4567
+ {
4568
+ "$ref": "#/components/schemas/V1CommonContent_ContentValue"
4569
+ }
4570
+ ]
4571
+ },
4572
+ "summary": {
4573
+ "description": "The transmission summary.",
4574
+ "nullable": true,
4575
+ "oneOf": [
4576
+ {
4577
+ "$ref": "#/components/schemas/V1CommonContent_ContentValue"
4578
+ }
4579
+ ]
4580
+ },
4581
+ "title": {
4582
+ "description": "The transmission title. Must be text/plain.",
4583
+ "oneOf": [
4584
+ {
4585
+ "$ref": "#/components/schemas/V1CommonContent_ContentValue"
4586
+ }
4587
+ ]
4588
+ }
4589
+ },
4590
+ "type": "object"
4591
+ },
4592
+ "V1ServiceOwnerDialogsCommandsUpdateTransmission_TransmissionNavigationalAction": {
4593
+ "additionalProperties": false,
4594
+ "properties": {
4595
+ "expiresAt": {
4596
+ "description": "The UTC timestamp when the navigational action expires and is no longer available.",
4597
+ "format": "date-time",
4598
+ "nullable": true,
4599
+ "type": "string"
4600
+ },
4601
+ "title": {
4602
+ "description": "The title of the navigational action.",
4603
+ "items": {
4604
+ "$ref": "#/components/schemas/V1CommonLocalizations_Localization"
4605
+ },
4606
+ "nullable": true,
4607
+ "type": "array"
4608
+ },
4609
+ "url": {
4610
+ "description": "The fully qualified URL of the navigational action.",
4611
+ "format": "uri",
4612
+ "type": "string"
4613
+ }
4614
+ },
4615
+ "type": "object"
4616
+ },
4617
+ "V1ServiceOwnerDialogsCommandsUpdateTransmission_TransmissionRequest": {
4618
+ "additionalProperties": false,
4619
+ "properties": {
4620
+ "attachments": {
4621
+ "description": "The transmission-level attachments.",
4622
+ "items": {
4623
+ "$ref": "#/components/schemas/V1ServiceOwnerDialogsCommandsUpdateTransmission_TransmissionAttachment"
4624
+ },
4625
+ "nullable": true,
4626
+ "type": "array"
4627
+ },
4628
+ "authorizationAttribute": {
4629
+ "description": "Contains an authorization resource attributeId, that can used in custom authorization rules in the XACML service\npolicy, which by default is the policy belonging to the service referred to by \u0022serviceResource\u0022 in the dialog.\n \nCan also be used to refer to other service policies.",
4630
+ "example": "mycustomresource\n/* equivalent to the above */\nurn:altinn:subresource:mycustomresource\nurn:altinn:task:Task_1\n/* refer to another service */\nurn:altinn:resource:some-other-service-identifier",
4631
+ "nullable": true,
4632
+ "type": "string"
4633
+ },
4634
+ "content": {
4635
+ "description": "The transmission unstructured text content.",
4636
+ "nullable": true,
4637
+ "oneOf": [
4638
+ {
4639
+ "$ref": "#/components/schemas/V1ServiceOwnerDialogsCommandsUpdateTransmission_TransmissionContent"
4640
+ }
4641
+ ]
4642
+ },
4643
+ "createdAt": {
4644
+ "description": "Overrides the creating date and time for the transmission.",
4645
+ "format": "date-time",
4646
+ "type": "string"
4647
+ },
4648
+ "extendedType": {
4649
+ "description": "Arbitrary URI/URN describing a service-specific transmission type.\n \nRefer to the service-specific documentation provided by the service owner for details (if in use).",
4650
+ "format": "uri",
4651
+ "nullable": true,
4652
+ "type": "string"
4653
+ },
4654
+ "externalReference": {
4655
+ "description": "Arbitrary string with a service-specific reference to an external system or service.",
4656
+ "nullable": true,
4657
+ "type": "string"
4658
+ },
4659
+ "idempotentKey": {
4660
+ "description": "An optional key to ensure idempotency in transmission creation. If provided, it must be unique within the dialog; reusing the same key for the same dialog results in Conflict and the transmission is not updated.",
4661
+ "nullable": true,
4662
+ "type": "string"
4663
+ },
4664
+ "isSilentUpdate": {
4665
+ "type": "boolean"
4666
+ },
4667
+ "navigationalActions": {
4668
+ "description": "The transmission-level navigational actions.",
4669
+ "items": {
4670
+ "$ref": "#/components/schemas/V1ServiceOwnerDialogsCommandsUpdateTransmission_TransmissionNavigationalAction"
4671
+ },
4672
+ "nullable": true,
4673
+ "type": "array"
4674
+ },
4675
+ "relatedTransmissionId": {
4676
+ "description": "Reference to any other transmission that this transmission is related to.",
4677
+ "format": "guid",
4678
+ "nullable": true,
4679
+ "type": "string"
4680
+ },
4681
+ "sender": {
4682
+ "description": "The actor that sent the transmission.",
4683
+ "oneOf": [
4684
+ {
4685
+ "$ref": "#/components/schemas/V1ServiceOwnerCommonActors_Actor"
4686
+ }
4687
+ ]
4688
+ },
4689
+ "type": {
4690
+ "description": "The type of transmission.",
4691
+ "oneOf": [
4692
+ {
4693
+ "$ref": "#/components/schemas/DialogsEntitiesTransmissions_DialogTransmissionType"
4694
+ }
4695
+ ]
4696
+ }
4697
+ },
4698
+ "type": "object"
4699
+ },
4494
4700
  "V1ServiceOwnerDialogsQueriesGet_Content": {
4495
4701
  "additionalProperties": false,
4496
4702
  "properties": {
@@ -10727,6 +10933,148 @@
10727
10933
  "tags": [
10728
10934
  "Serviceowner"
10729
10935
  ]
10936
+ },
10937
+ "put": {
10938
+ "description": "Replaces a given transmission 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.",
10939
+ "operationId": "V1ServiceOwnerDialogsCommandsUpdateTransmission_DialogTransmission",
10940
+ "parameters": [
10941
+ {
10942
+ "in": "path",
10943
+ "name": "dialogId",
10944
+ "required": true,
10945
+ "schema": {
10946
+ "format": "guid",
10947
+ "type": "string"
10948
+ }
10949
+ },
10950
+ {
10951
+ "in": "path",
10952
+ "name": "transmissionId",
10953
+ "required": true,
10954
+ "schema": {
10955
+ "format": "guid",
10956
+ "type": "string"
10957
+ }
10958
+ },
10959
+ {
10960
+ "in": "header",
10961
+ "name": "if-Match",
10962
+ "schema": {
10963
+ "format": "guid",
10964
+ "nullable": true,
10965
+ "type": "string"
10966
+ }
10967
+ }
10968
+ ],
10969
+ "requestBody": {
10970
+ "content": {
10971
+ "application/json": {
10972
+ "schema": {
10973
+ "$ref": "#/components/schemas/V1ServiceOwnerDialogsCommandsUpdateTransmission_TransmissionRequest"
10974
+ }
10975
+ }
10976
+ },
10977
+ "description": "",
10978
+ "required": true,
10979
+ "x-name": "UpdateTransmissionRequest",
10980
+ "x-position": 1
10981
+ },
10982
+ "responses": {
10983
+ "204": {
10984
+ "description": "The dialog transmission was updated successfully.",
10985
+ "headers": {
10986
+ "Etag": {
10987
+ "description": "The new UUID ETag of the dialog",
10988
+ "example": "123e4567-e89b-12d3-a456-426614174000",
10989
+ "schema": {
10990
+ "type": "string"
10991
+ }
10992
+ }
10993
+ }
10994
+ },
10995
+ "400": {
10996
+ "content": {
10997
+ "application/problem\u002Bjson": {
10998
+ "schema": {
10999
+ "$ref": "#/components/schemas/ProblemDetails"
11000
+ }
11001
+ }
11002
+ },
11003
+ "description": "Validation error occurred. See problem details for a list of errors."
11004
+ },
11005
+ "401": {
11006
+ "description": "Missing or invalid authentication token. Requires a Maskinporten-token with the scope \u0022digdir:dialogporten.serviceprovider.changetransmissions\u0022."
11007
+ },
11008
+ "403": {
11009
+ "description": "Unauthorized to update child entity for the given dialog (dialog not owned by authenticated organization or has additional scope requirements defined in service identifiers policy)."
11010
+ },
11011
+ "404": {
11012
+ "content": {
11013
+ "application/problem\u002Bjson": {
11014
+ "schema": {
11015
+ "$ref": "#/components/schemas/ProblemDetails"
11016
+ }
11017
+ }
11018
+ },
11019
+ "description": "The specified dialog ID or transmission ID was not found."
11020
+ },
11021
+ "409": {
11022
+ "description": "Conflict occurred while processing the request."
11023
+ },
11024
+ "410": {
11025
+ "description": "Entity with the given key(s) is removed."
11026
+ },
11027
+ "412": {
11028
+ "content": {
11029
+ "application/problem\u002Bjson": {
11030
+ "schema": {
11031
+ "$ref": "#/components/schemas/ProblemDetails"
11032
+ }
11033
+ }
11034
+ },
11035
+ "description": "The supplied If-Match header did not match the current Revision value for the dialog. The request was not applied."
11036
+ },
11037
+ "422": {
11038
+ "content": {
11039
+ "application/problem\u002Bjson": {
11040
+ "schema": {
11041
+ "$ref": "#/components/schemas/ProblemDetails"
11042
+ }
11043
+ }
11044
+ },
11045
+ "description": "Domain error occurred. See problem details for a list of errors."
11046
+ },
11047
+ "503": {
11048
+ "content": {
11049
+ "text/plain": {
11050
+ "schema": {
11051
+ "example": "Service Unavailable",
11052
+ "type": "string"
11053
+ }
11054
+ }
11055
+ },
11056
+ "description": "Service Unavailable, used when Dialogporten is in maintenance mode",
11057
+ "headers": {
11058
+ "Retry-After": {
11059
+ "description": "Delay before retrying the request. Datetime format RFC1123",
11060
+ "schema": {
11061
+ "type": "string"
11062
+ }
11063
+ }
11064
+ }
11065
+ }
11066
+ },
11067
+ "security": [
11068
+ {
11069
+ "JWTBearerAuth": [
11070
+ "digdir:dialogporten.serviceprovider"
11071
+ ]
11072
+ }
11073
+ ],
11074
+ "summary": "Replaces a transmission",
11075
+ "tags": [
11076
+ "Serviceowner"
11077
+ ]
10730
11078
  }
10731
11079
  },
10732
11080
  "/api/v1/serviceowner/dialogs/endusercontext": {