Skip to content

Commit

Permalink
update correspondence swagger (#1835)
Browse files Browse the repository at this point in the history
  • Loading branch information
@CelineTrammi
CelineTrammi authored Oct 21, 2024
1 parent 2015b20 commit 30dacea
Showing 1 changed file with 97 additions and 90 deletions.
187 changes: 97 additions & 90 deletions static/swagger/altinn-correspondence-v1.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,6 @@
"schema": {
"$ref": "#/components/schemas/InitializeAttachmentExt"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/InitializeAttachmentExt"
}
}
}
},
Expand Down Expand Up @@ -198,11 +193,6 @@
"schema": {
"$ref": "#/components/schemas/InitializeCorrespondencesExt"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/InitializeCorrespondencesExt"
}
}
}
},
Expand Down Expand Up @@ -286,11 +276,6 @@
"schema": {
"$ref": "#/components/schemas/CorrespondencesExt"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CorrespondencesExt"
}
}
}
}
Expand Down Expand Up @@ -894,6 +879,7 @@
"dataType",
"name",
"resourceId",
"restrictionName",
"sender",
"sendersReference",
"status",
Expand All @@ -913,6 +899,10 @@
"minLength": 1,
"type": "string"
},
"restrictionName": {
"minLength": 1,
"type": "string"
},
"isEncrypted": {
"type": "boolean"
},
Expand Down Expand Up @@ -962,10 +952,6 @@
},
"nullable": true
},
"restrictionName": {
"type": "string",
"nullable": true
},
"statusHistory": {
"type": "array",
"items": {
Expand All @@ -983,6 +969,7 @@
"dataType",
"name",
"resourceId",
"restrictionName",
"sender",
"sendersReference",
"status",
Expand All @@ -1002,6 +989,10 @@
"minLength": 1,
"type": "string"
},
"restrictionName": {
"minLength": 1,
"type": "string"
},
"isEncrypted": {
"type": "boolean"
},
Expand Down Expand Up @@ -1050,10 +1041,6 @@
"format": "uuid"
},
"nullable": true
},
"restrictionName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
Expand Down Expand Up @@ -1142,9 +1129,10 @@
"type": "boolean",
"nullable": true
},
"published": {
"Published": {
"type": "string",
"format": "date-time"
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
Expand Down Expand Up @@ -1255,6 +1243,33 @@
},
"additionalProperties": false
},
"CorrespondenceDetails": {
"required": [
"recipient"
],
"type": "object",
"properties": {
"correspondenceId": {
"type": "string",
"format": "uuid"
},
"status": {
"$ref": "#/components/schemas/CorrespondenceStatus"
},
"recipient": {
"type": "string",
"nullable": true
},
"notifications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotificationDetails"
},
"nullable": true
}
},
"additionalProperties": false
},
"CorrespondenceDetailsExt": {
"required": [
"correspondenceId",
Expand Down Expand Up @@ -1332,6 +1347,11 @@
"type": "boolean",
"nullable": true
},
"Published": {
"type": "string",
"format": "date-time",
"nullable": true
},
"recipient": {
"type": "string",
"nullable": true
Expand Down Expand Up @@ -1359,24 +1379,19 @@
"type": "string",
"format": "date-time"
},
"statusHistory": {
"notifications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CorrespondenceStatusEventExt"
"$ref": "#/components/schemas/NotificationExt"
},
"nullable": true
},
"notifications": {
"statusHistory": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotificationExt"
"$ref": "#/components/schemas/CorrespondenceStatusEventExt"
},
"nullable": true
},
"Published": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
Expand Down Expand Up @@ -1472,6 +1487,11 @@
"type": "boolean",
"nullable": true
},
"Published": {
"type": "string",
"format": "date-time",
"nullable": true
},
"recipient": {
"type": "string",
"nullable": true
Expand Down Expand Up @@ -1505,11 +1525,6 @@
"$ref": "#/components/schemas/CorrespondenceNotificationOverview"
},
"nullable": true
},
"published" : {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
Expand All @@ -1531,6 +1546,23 @@
},
"additionalProperties": false
},
"CorrespondenceStatus": {
"enum": [
"Initialized",
"ReadyForPublish",
"Published",
"Fetched",
"Read",
"Replied",
"Confirmed",
"PurgedByRecipient",
"PurgedByAltinn",
"Archived",
"Reserved",
"Failed"
],
"type": "string"
},
"CorrespondenceStatusEventExt": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -1860,79 +1892,46 @@
"type": "array",
"items": {
"$ref": "#/components/schemas/CorrespondenceDetails"
}
},
"nullable": true
},
"attachmentIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
},
"CorrespondenceDetails": {
"type": "object",
"properties": {
"CorrespondenceId": {
"type": "string",
"format": "uuid"
},
"Status": {
"$ref": "#/components/schemas/CorrespondenceStatusExt"
},
"Recipient": {
"type": "string"
},
"Notifications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotificationDetails"
}
},
"nullable": true
}
},
"required": [
"CorrespondenceId",
"Status",
"Recipient"
]
"additionalProperties": false
},
"NotificationChannelExt": {
"enum": [
"Email",
"Sms",
"EmailPreferred",
"SmsPreferred"
],
"type": "string"
},
"NotificationDetails": {
"type": "object",
"properties": {
"OrderId": {
"orderId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"IsReminder": {
"isReminder": {
"type": "boolean",
"nullable": true
},
"Status": {
"status": {
"$ref": "#/components/schemas/NotificationStatus"
}
},
"required": [
"Status"
]
},
"NotificationStatus": {
"type": "string",
"enum": [
"Success",
"MissingContact",
"Failure"
]
},
"NotificationChannelExt": {
"enum": [
"Email",
"Sms",
"EmailPreferred",
"SmsPreferred"
],
"type": "string"
"additionalProperties": false
},
"NotificationDetailsExt": {
"type": "object",
Expand Down Expand Up @@ -2043,6 +2042,14 @@
},
"additionalProperties": false
},
"NotificationStatus": {
"enum": [
"Success",
"MissingContact",
"Failure"
],
"type": "string"
},
"NotificationStatusDetailsExt": {
"type": "object",
"properties": {
Expand Down

0 comments on commit 30dacea

Please sign in to comment.