From e413dc3fc90b0648060ab2c81c4d454c1286841d Mon Sep 17 00:00:00 2001
From: Andreas Huber <anh@fjd.de>
Date: Mon, 18 May 2020 16:44:05 +0200
Subject: [PATCH] =?UTF-8?q?CR-5:=20Zus=C3=A4tzliche=20Properties=20verbiet?=
=?UTF-8?q?en?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
docs/Release Notes/Version_0.5.md | 29 ++--
.../application/applicant-contact-info.json | 8 +-
.../application/applicant-organization.json | 7 +-
models/application/document.json | 33 +----
models/application/metadata-no-id.json | 136 +-----------------
models/common/authentification-info.json | 6 +-
models/common/eID-org-acting-person.json | 3 +-
models/common/identifier.json | 18 +--
models/common/individual.json | 23 +--
models/destination-no-id.json | 32 +----
models/error-body.json | 6 +-
reference/callback.json | 13 +-
reference/sender.json | 10 +-
reference/subscriber.json | 2 +
14 files changed, 76 insertions(+), 250 deletions(-)
diff --git a/docs/Release Notes/Version_0.5.md b/docs/Release Notes/Version_0.5.md
index d76af23c..8e6309ab 100644
--- a/docs/Release Notes/Version_0.5.md
+++ b/docs/Release Notes/Version_0.5.md
@@ -1,18 +1,12 @@
# Nächste Version (0.5)
-<!-- theme: warning -->
-> ### Hinweis
-> Die Basis-URLs für diese Version sind:
-> - https://sender.fiep-poc.de/beta5/
-> - https://subscriber.fiep-poc.de/beta5/
+## Übergreifende Änderungen
-## Dokumentation
-- Release Notes mit aufgenommen
-- Dokumentation zu OAuth integriert
-- Token URL eingetragen
-- Postman Collection & Environment integriert
-
-## Modelle
+### Basis-URLs
+Die Basis-URLs werden ab sofort mit jeder neuen Version geändert, damit ein paralleler Betrieb mehrerer API-Versionen möglich ist.
+Die Basis-URLs für diese Version sind:
+- https://sender.fiep-poc.de/beta5/
+- https://subscriber.fiep-poc.de/beta5/
### CR-1: Diversen Modellen den Discriminator "type" hinzugefügt:
- models/application/applicant-contact-info.json
@@ -25,6 +19,17 @@
- models/common/individual.json
- models/destination-no-id.json
+### CR-5: Zusätzliche Properties verbieten
+Wo möglich wurde `"additionalProperties": false` gesetzt um weitere Properties zu verbieten.
+
+## Dokumentation
+- Release Notes mit aufgenommen
+- Dokumentation zu OAuth integriert
+- Token URL eingetragen
+- Postman Collection & Environment integriert
+
+## Modelle
+
### Destination
models/destination-no-id.json
diff --git a/models/application/applicant-contact-info.json b/models/application/applicant-contact-info.json
index 90278b9e..15f55a4b 100644
--- a/models/application/applicant-contact-info.json
+++ b/models/application/applicant-contact-info.json
@@ -1,7 +1,8 @@
{
- "title": "Applicant Contact Info",
"type": "object",
+ "title": "Applicant Contact Info",
"description": "Kontaktdaten des Antragstellers",
+ "additionalProperties": false,
"properties": {
"physicalAddress": {
"oneOf": [
@@ -15,6 +16,7 @@
"$ref": "../common/address-international.json"
}
],
+ "description": "Physikalische (Post-)Adresse",
"discriminator": {
"propertyName": "type",
"mapping": {
@@ -22,8 +24,7 @@
"postbox": "../common/address-postbox.json",
"international": "../common/address-international.json"
}
- },
- "description": "Physikalische (Post-)Adresse"
+ }
},
"telephone": {
"type": "array",
@@ -38,6 +39,7 @@
"items": {
"type": "object",
"description": "",
+ "additionalProperties": false,
"properties": {
"channelType": {
"type": "string",
diff --git a/models/application/applicant-organization.json b/models/application/applicant-organization.json
index 125cd3fb..41a56c6b 100644
--- a/models/application/applicant-organization.json
+++ b/models/application/applicant-organization.json
@@ -19,6 +19,7 @@
"description": "Im Namen der Organisation auftretende natürliche Personen, wie z.B. Geschäftsführer, Vorstände oder Prokuristen",
"items": {
"type": "object",
+ "additionalProperties": false,
"properties": {
"identityInfo": {
"$ref": "../common/eID-natural-person.json"
@@ -32,6 +33,7 @@
"organizationInfo": {
"type": "object",
"description": "Informationen über die Organisation",
+ "additionalProperties": false,
"properties": {
"legalName": {
"type": "string",
@@ -65,6 +67,7 @@
"$ref": "../common/address-international.json"
}
],
+ "description": "Offizielle Adresse",
"discriminator": {
"propertyName": "type",
"mapping": {
@@ -72,8 +75,7 @@
"postbox": "../common/address-postbox.json",
"international": "../common/address-international.json"
}
- },
- "description": "Offizielle Adresse"
+ }
},
"legalRepresentatives": {
"type": "array",
@@ -87,6 +89,7 @@
"orgValidation": {
"type": "object",
"description": "Informationen, ob diese Organisation vom sendenden System identifiziert wurde",
+ "additionalProperties": false,
"properties": {
"method": {
"type": "string",
diff --git a/models/application/document.json b/models/application/document.json
index fcab2fed..22e8312c 100644
--- a/models/application/document.json
+++ b/models/application/document.json
@@ -1,37 +1,8 @@
{
- "title": "Application Document",
"type": "object",
+ "title": "Application Document",
"description": "Ein im Antrag (Application) enthaltenes Dokument (z.B. Antragsformular oder hochgeladene Anlage)",
- "x-examples": {
- "example-1": {
- "docId": "1",
- "purpose": "form",
- "size": 39273,
- "mimeType": "application/pdf",
- "filename": "antrag.pdf",
- "description": "Das Antragsformular",
- "lang": {
- "lang": "de",
- "region": "DE"
- },
- "hash": {
- "algorithm": "SHA-256",
- "digest": "03ba204e50d126e4674c005e04d82e84c21366780af1f43bd54a37816b6ab340"
- }
- },
- "example-2": {
- "docId": "2",
- "purpose": "attachment",
- "size": 894834874,
- "mimeType": "image/jpeg",
- "filename": "scan.jpg",
- "description": "Scan der Bescheinigung",
- "hash": {
- "algorithm": "SHA-256",
- "digest": "e1762f14d9924e37b32f1c81dfd256410af462f5136415c96877efa8c80345d0"
- }
- }
- },
+ "additionalProperties": false,
"properties": {
"purpose": {
"type": "string",
diff --git a/models/application/metadata-no-id.json b/models/application/metadata-no-id.json
index e133c27e..3a787339 100644
--- a/models/application/metadata-no-id.json
+++ b/models/application/metadata-no-id.json
@@ -1,137 +1,8 @@
{
- "title": "Application Metadata without ID",
"type": "object",
+ "title": "Application Metadata without ID",
"description": "Metadaten eines Antrags noch ohne ID, zum Anlegen eines neuen Antrags. Nach dem Zuweisen der `application-id` wird das Modell [Application Metadata](metadata.json) verwendet.",
- "x-examples": {
- "example-1": {
- "additionalReferenceInfo": {
- "subject": "Anmeldung eines Gewerbes in Musterstadt",
- "caseId": "DF/8923"
- },
- "contentStructure": {
- "data": {
- "size": 9438,
- "schema": {
- "mimeType": "json",
- "schemaSource": "none"
- }
- },
- "docs": [
- {
- "docId": "1",
- "purpose": "form",
- "size": 39273,
- "mimeType": "application/pdf",
- "filename": "antrag.pdf",
- "description": "Das Antragsformular",
- "lang": {
- "lang": "de",
- "region": "DE"
- },
- "hash": {
- "algorithm": "SHA-256",
- "digest": "03ba204e50d126e4674c005e04d82e84c21366780af1f43bd54a37816b6ab340"
- }
- },
- {
- "docId": "2",
- "purpose": "attachment",
- "size": 894834874,
- "mimeType": "image/jpeg",
- "filename": "scan.jpg",
- "description": "Scan der Bescheinigung",
- "hash": {
- "algorithm": "SHA-256",
- "digest": "e1762f14d9924e37b32f1c81dfd256410af462f5136415c96877efa8c80345d0"
- }
- }
- ]
- },
- "publicServiceType": {
- "name": "Gewerbeanmeldung",
- "description": "Eine Gewerbeanmeldung ist immer dann notwendig, wenn Sie einen stehenden Gewerbebetrieb beginnen.",
- "leikaId": "99050012104000",
- "otherIdentifiers": [
- {
- "id": "8664844",
- "schemeURI": "service.niedersachsen.de",
- "schemeName": "Serviceportal Niedersachsen"
- },
- {
- "id": "354824",
- "schemeURI": "buerger.thueringen.de",
- "schemeName": "Zuständigkeitsfinder Thüringen"
- }
- ]
- },
- "applicants": [
- {
- "identifier": [
- {
- "id": "918",
- "schemeName": "Antragsportal",
- "schemeId": "urn:com:example:antragsportal:user"
- }
- ],
- "contactInfo": {
- "physicalAddress": {
- "street": "Kurzer Weg",
- "houseNumber": 7,
- "postalCode": "12345",
- "city": "string",
- "addressSupplement": "string"
- },
- "telephone": [
- {
- "number": "+49 89 32168-42",
- "mobile": true,
- "description": "string"
- }
- ],
- "electronicAddresses": [
- {
- "channelType": "Service-Account-Mailbox",
- "address": "string"
- }
- ]
- },
- "identityInfo": {
- "gender": "m",
- "nationality": "string",
- "familyName": "string",
- "givenName": "string",
- "birthName": "string",
- "doctoralDegrees": "string",
- "artisticName": "string",
- "dateOfBirth": "2020-04-16",
- "placeOfBirth": "string",
- "placeOfResidence": {
- "street": "string",
- "houseNumber": null,
- "houseNumberSuffix": "st",
- "postalCode": "strin",
- "city": "string",
- "addressSupplement": "string"
- }
- },
- "authentificationInfo": {
- "timestamp": "2020-04-16T06:50:39Z",
- "authentificationToken": {},
- "authentificationMethod": "string",
- "assuranceLevel": "low"
- }
- }
- ],
- "payment-info": {
- "reference": "TP/93/GDP",
- "usage": "Gewerbeanmeldung",
- "amount": 17.3,
- "timestamp": "2020-03-03T12:38:23Z",
- "status": "success",
- "transaction": "1f77c5f9b759db9cdce59988b24974d465c7be5e462a6185485559ff6e2dea82"
- }
- }
- },
+ "additionalProperties": false,
"properties": {
"applicants": {
"type": "array",
@@ -151,12 +22,14 @@
"data",
"docs"
],
+ "additionalProperties": false,
"properties": {
"data": {
"type": "object",
"required": [
"schema"
],
+ "additionalProperties": false,
"properties": {
"size": {
"type": "integer",
@@ -177,6 +50,7 @@
},
"additionalReferenceInfo": {
"type": "object",
+ "additionalProperties": false,
"properties": {
"subject": {
"type": "string"
diff --git a/models/common/authentification-info.json b/models/common/authentification-info.json
index 69665660..440b551d 100644
--- a/models/common/authentification-info.json
+++ b/models/common/authentification-info.json
@@ -1,6 +1,7 @@
{
- "title": "authentification-info",
"type": "object",
+ "title": "Authentifikation",
+ "additionalProperties": false,
"properties": {
"assuranceLevel": {
"type": "string",
@@ -24,5 +25,6 @@
"required": [
"assuranceLevel",
"authentificationMethod"
- ]
+ ],
+ "description": "Informationen über die Authentifikation der Person."
}
\ No newline at end of file
diff --git a/models/common/eID-org-acting-person.json b/models/common/eID-org-acting-person.json
index ce254555..1cd49884 100644
--- a/models/common/eID-org-acting-person.json
+++ b/models/common/eID-org-acting-person.json
@@ -1,6 +1,7 @@
{
- "title": "Identity Information without Address",
"type": "object",
+ "title": "Identity Information without Address",
+ "additionalProperties": false,
"properties": {
"placeOfBirth": {
"type": "string",
diff --git a/models/common/identifier.json b/models/common/identifier.json
index 25caf8da..bf243273 100644
--- a/models/common/identifier.json
+++ b/models/common/identifier.json
@@ -1,22 +1,8 @@
{
- "title": "Identifier",
"type": "object",
+ "title": "Identifier",
"description": "Identifiers are keys that are owned by either the sender, receiver or a third party. If the keys used are owned by either sender or receiver, no meta data has to be specified by means of attributes. The table below specifies the use of attributes for the identifier types when they are owned by a third party.",
- "x-examples": {
- "example-1": {
- "id": "978-1-894049-23-8",
- "schemeId": "ISBN"
- },
- "example-2": {
- "id": "99050012104000",
- "schemeURI": "https://www.xrepository.de/details/urn:de:gkleika:leika:leistung",
- "schemeDataURI": "https://www.xrepository.de/details/urn:de:gkleika:leika:leistung_20180705#version",
- "schemeVersionId": "urn:de:gkleika:leika:leistung_20180705",
- "schemeAgencyName": "Geschäfts- und Koordinierungsstelle LeiKa beim Ministerium der Finanzen des Landes Sachsen-Anhalt (GK_LEIKA)",
- "schemeName": "Leistungen des LeiKa",
- "schemeId": "urn:de:gkleika:leika:leistung"
- }
- },
+ "additionalProperties": false,
"properties": {
"id": {
"type": "string",
diff --git a/models/common/individual.json b/models/common/individual.json
index 10231231..404bbe9d 100644
--- a/models/common/individual.json
+++ b/models/common/individual.json
@@ -1,24 +1,8 @@
{
- "title": "Individual",
"type": "object",
+ "title": "Individual",
"description": "Natürliche Person",
- "x-examples": {
- "example-1": {
- "formOfAddress": "Herr",
- "academicTitle": "Dr.",
- "firstName": "Werner",
- "lastName": "Mustermann",
- "contact": {
- "telephone": [
- {
- "number": "+49 89 32168-42",
- "mobile": false,
- "description": "Dienstliche Telefonnummer"
- }
- ]
- }
- }
- },
+ "additionalProperties": false,
"properties": {
"formOfAddress": {
"type": "string",
@@ -66,8 +50,9 @@
}
},
"contact": {
- "description": "Kontaktmöglichkeiten einer Person (natürliche Person oder Organisation)",
"type": "object",
+ "description": "Kontaktmöglichkeiten einer Person (natürliche Person oder Organisation)",
+ "additionalProperties": false,
"properties": {
"telephone": {
"type": "array",
diff --git a/models/destination-no-id.json b/models/destination-no-id.json
index d00068c5..7871291d 100644
--- a/models/destination-no-id.json
+++ b/models/destination-no-id.json
@@ -1,32 +1,8 @@
{
- "title": "Destination without ID",
"type": "object",
+ "title": "Destination without ID",
"description": "Daten eines technischen Ãœbergabepunkts (Ziel der Ãœbertragung - z.B. ein Fachverfahren) noch ohne ID, zum Anlegen eines neuen Ãœbergabepunkts. Nach dem Zuweisen der `destination-id` wird das Modell [Destination](destination.json) verwendet.",
- "x-examples": {
- "example-1": {
- "public-organization": {
- "organizationName": "Gewerbeamt Musterhausen"
- },
- "technicalContact": [
- {
- "firstName": "Werner",
- "lastName": "Mustermann",
- "contact": {
- "telephone": [
- {
- "number": "+49 89 32168-42",
- "mobile": false,
- "description": "Dienstliches Festnetz"
- }
- ]
- }
- }
- ],
- "callback": {
- "callbackURI": "https://www.example.com/callback"
- }
- }
- },
+ "additionalProperties": false,
"properties": {
"publicOrganization": {
"type": "object",
@@ -51,8 +27,8 @@
"propertyName": "type",
"mapping": {
"national": "./common/address-national.json",
- "postbox": "./common/address-postbox.json",
- "international": "./common/address-international.json"
+ "international": "./common/address-international.json",
+ "postbox": "./common/address-postbox.json"
}
}
},
diff --git a/models/error-body.json b/models/error-body.json
index fef50dd9..f284cfc4 100644
--- a/models/error-body.json
+++ b/models/error-body.json
@@ -1,11 +1,13 @@
{
- "title": "Error Body",
"type": "array",
+ "title": "Error Body",
"description": "Der Inhalt (Body) von HTTP Responses bei Fehlern.",
+ "minItems": 1,
"items": {
- "title": "Error",
"type": "object",
+ "title": "Error",
"description": "Rückmeldung zu einer nicht erfolgreichen Operation",
+ "additionalProperties": false,
"properties": {
"code": {
"type": "integer",
diff --git a/reference/callback.json b/reference/callback.json
index a5fba3c1..85d7d65f 100644
--- a/reference/callback.json
+++ b/reference/callback.json
@@ -44,6 +44,7 @@
"application/json": {
"schema": {
"type": "object",
+ "additionalProperties": false,
"properties": {
"destinationId": {
"type": "string"
@@ -52,14 +53,22 @@
"type": "array",
"items": {
"type": "object",
+ "additionalProperties": false,
"properties": {
"applicationId": {
"type": "string"
}
- }
+ },
+ "required": [
+ "applicationId"
+ ]
}
}
- }
+ },
+ "required": [
+ "destinationId",
+ "applications"
+ ]
},
"examples": {
"example-1": {
diff --git a/reference/sender.json b/reference/sender.json
index 548650b5..3ef181b0 100644
--- a/reference/sender.json
+++ b/reference/sender.json
@@ -167,11 +167,15 @@
"application/json": {
"schema": {
"type": "object",
+ "additionalProperties": false,
"properties": {
"applicationId": {
"type": "string"
}
- }
+ },
+ "required": [
+ "applicationId"
+ ]
},
"examples": {
"example-1": {
@@ -769,6 +773,7 @@
"application/json": {
"schema": {
"type": "object",
+ "additionalProperties": false,
"properties": {
"current": {
"$ref": "../models/status-overview.json"
@@ -873,9 +878,11 @@
"application/json": {
"schema": {
"type": "object",
+ "additionalProperties": false,
"properties": {
"data": {
"type": "object",
+ "additionalProperties": false,
"properties": {
"status": {
"type": "string",
@@ -899,6 +906,7 @@
"type": "array",
"items": {
"type": "object",
+ "additionalProperties": false,
"properties": {
"docId": {
"type": "string",
diff --git a/reference/subscriber.json b/reference/subscriber.json
index b2d7f2bc..96533e38 100644
--- a/reference/subscriber.json
+++ b/reference/subscriber.json
@@ -133,6 +133,7 @@
"application/json": {
"schema": {
"type": "object",
+ "additionalProperties": false,
"properties": {
"destinationId": {
"type": "string"
@@ -750,6 +751,7 @@
"application/json": {
"schema": {
"type": "object",
+ "additionalProperties": false,
"properties": {
"finalDelivery": {
"type": "boolean",
--
GitLab