Skip to content
Snippets Groups Projects
Commit c40b8af7 authored by Andreas Huber's avatar Andreas Huber
Browse files

Release Notes v0.7 hinzugefügt

parent 1d814f70
No related branches found
No related tags found
No related merge requests found
# Release Notes # Release Notes
## Version 0.7
### Umgesetzte Change Requests
#### #13 API Specification: Method of Acknowledge Application endpoint of Subscriber API should be PUT instead of POST
Die Operationen "Send Application" und "Acknowledge Application" wurden auf PUT umgestellt.
Bitte beachten Sie, dass die PUT-Operationen jetzt auf die Status-Resource wirken.
#### #19 contentStructure.data.size entfernen
Aufgrund verschiedener Codierungen kann die Größe der Fachdaten (JSON oder XML) in Bytes nicht einfach und verlässlich vorhergesagt werden. Daher wurde die Angabe der Größe der Fachdaten aus den Metadaten entfernt.
#### #23 Pattern nicht referenzieren
Im Dokument (document.json) wurde bei der Property "signature" als Pattern eine Referenz auf base64url.json gesetzt:
```json
"signature": {
"pattern": {
"$ref": "../common/base64url.json#/pattern"
},
"type": "string",
"description": "Sofern der Antragstellers dieses Dokument signiert hat, wird die Signatur hier base64url-encoded eingebettet"
}
```
Dies führt beim Swagger-Codegen und dem OpenAPI-Generator zu Fehlern. Um die Codegenerierung zu erleichtern wurde das Pattern dorthin kopiert.
```json
"signature": {
"type": "string",
"description": "Sofern der Antragstellers dieses Dokument signiert hat, wird die Signatur hier base64url-encoded eingebettet",
"pattern": "^[a-zA-Z0-9-_=]+$"
}
```
#### #24 Keine mehrfachen Typen
Im Modell address-national.json wurde für die Hausnummer (houseNumber) die Typen `integer` und `string` definiert. Die Hausnummer sollte eigentlich vom Typ `integer` sein und Zusätze in den Hausnummerzusatz (houseNumberSuffix) kommen. Um etwas flexibler zu sein, wurde aber alternativ auch ein `string` für die Hausnummer zugelassen. In FIM wurde die Hausnummer auch als Text-Feld definiert (F00000016).
```json
"houseNumber": {
"type": [
"string",
"integer"
],
"description": "Hausnummer",
"maxLength": 9,
"pattern": "^[1-9][0-9]{0,3}(-[1-9][0-9]{0,3})?$",
"minimum": 1
}
```
Die Verwendung von mehr als einem Typen führt bei Codegeneratoren zu Problemen. Daher wird nur noch der Typ `string` verwendet.
```json
"houseNumber": {
"type": "string",
"description": "Hausnummer",
"maxLength": 9,
"pattern": "^[1-9][0-9]{0,3}(-[1-9][0-9]{0,3})?$"
}
```
#### #25 Rechtsgrundlage der Verwaltungsleistung
Das Modell "Public Service Type" (public-service-type.json) wurde in "Verwaltungsleistung" umbenannt und hat ein zusätzliches Feld "Rechtsgrundlage" (legalBasis) erhalten.
#### #33 Antragsdatum
Unter `additionalReferenceInfo` wurde eine optionale Property `applicationDate` (Antragsdatum) hinzugefügt.
#### #34 Status History und aktuellen Status verschieben
Die Pfade für den aktuellen Status und die Statushistorie sind jetzt:
- `/destinations/{destinationId}/applications/{applicationId}/status` - aktueller Status
- `/destinations/{destinationId}/applications/{applicationId}/status/history` - Statushistorie
#### #35 Info/Test Resource hinzufügen
Es wurde in beiden APIs eine Resource `/info` hinzugefügt, die aktuell die API-Version ausgibt. Dies kann genutzt werden, um die Grundsätzliche Erreichbarkeit der API zu testen und um sicherzustellen, dass eine kompatible Version der API verwendet wird.
## Version 0.6 ## Version 0.6
### Dokumentation ### Dokumentation
...@@ -7,6 +79,7 @@ ...@@ -7,6 +79,7 @@
- [Erste Schritte](../1_Getting_Started.md) überarbeitet - [Erste Schritte](../1_Getting_Started.md) überarbeitet
### Umgesetzte Change Requests ### Umgesetzte Change Requests
#### #3 Sematic error of the OAS in editor.swagger.io #### #3 Sematic error of the OAS in editor.swagger.io
Das Security Schema darf keine Leerzeichen enthalten und wurde deswegen von "OAuth 2.0" in "OAuth20" umbenannt. Das Security Schema darf keine Leerzeichen enthalten und wurde deswegen von "OAuth 2.0" in "OAuth20" umbenannt.
......
{ {
"type": "object", "type": "object",
"title": "Public Service Type", "title": "Verwaltungsleistung",
"description": "Leistung\n\nThis represents the Type of a Public Service. For the indicating the Type, we are referring to the functions of government to indicate the purpose of a government activity, which the public service is intended for.", "description": "Leistung\n\nThis represents the Type of a Public Service. For the indicating the Type, we are referring to the functions of government to indicate the purpose of a government activity, which the public service is intended for.",
"additionalProperties": false, "additionalProperties": false,
"x-examples": { "x-examples": {
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment