Newer
Older
<!--
Types of changes:
* Added: for new features.
* Changed: for changes in existing functionality.
* Deprecated: for soon-to-be removed features.
* Dependencies: for changed / updated dependencies.
* Removed: for now removed features.
* Fixed: for any bug fixes.
* Security: in case of vulnerabilities.
Don’t forget to tag @ https://git.fitko.de/fit-connect/submission-api/-/tags
-->
# Submission API: Changelog
* The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
* If available, include a ticket number in format `(planning#XXXX)`.
## [Unreleased]
### Changed
Jonas Gröger
committed
* Die Scopes `manage:destination:<id>` und `subscribe:destination:<id>` wurden umbenannt.
* `manage:destination:<id>` ➡ `https://schema.fitko.de/fit-connect/oauth/scopes/manage:destinations`
* `subscribe:destination:<id>` ➡ `https://schema.fitko.de/fit-connect/oauth/scopes/subscribe:destinations`
Die Autorisierungsprüfung wird nun nicht mehr über die IDs der Destinations im Token erledigt.
Für API-Clients ist diese Änderung transparent.
Die veränderten Scopes bei bestehenden API-Clients werden migriert.
* [NO\_PUBLIC] Updated @redocly/cli to 1.10.x
* [NO\_PUBLIC] Use FITKO GitLab docker registry. [(planning#1754)](https://git.fitko.de/fit-connect/planning/-/issues/1754)
Jonas Gröger
committed
* [NO\_PUBLIC] The Submission API Specification is now bundled by [redocly-cli](https://redocly.com/docs/cli/) instead of swagger-cli (discontinued).
This should not affect the specification semantically but has changed the bundled document structure in certain aspects. [(planning#1409)](https://git.fitko.de/fit-connect/planning/-/issues/1409)
* [NO\_PUBLIC] Updated RapiDoc to 9.3.4
* Commits auf dem `main` Branch werden nun auf [latest-dev](https://schema.fitko.de/fit-connect/submission-api/latest-dev/) released. ([planning#1746](https://git.fitko.de/fit-connect/planning/-/issues/1746))
* Releases werden nun, zusätzlich zum Pfad mit der Versionsnummer, auch auf [latest](https://schema.fitko.de/fit-connect/submission-api/latest) released. ([planning#1746](https://git.fitko.de/fit-connect/planning/-/issues/1746))
* Duplizierte Schemadefinitionen wurden entfernt und sind jetzt im Format _dash-case_, also `create-reply` statt `CreateReply`.
Für API-Clients ist diese Änderung transparent, da sich das Verhalten der API sonst nicht ändert.
Codegeneratoren müssen eventuell angepasst werden.
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
## [1.3.0]
### Added
* The Submission API now has a new case management section since the bidirectional communication feature
adds more focus on cases. [(planning#460)](https://git.fitko.de/fit-connect/planning/-/issues/460)
* The Submission API grew by two endpoints to retrieve a case / list all cases [(planning#460)](https://git.fitko.de/fit-connect/planning/-/issues/460):
* [`http get /v1/cases/<caseId>`](https://docs.fitko.de/fit-connect/docs/apis/submission-api?version=1.3.0#get-/v1/cases/-caseId-)
* [`http get /v1/cases`](https://docs.fitko.de/fit-connect/docs/apis/submission-api?version=1.3.0#get-/v1/cases)
* The Submission API grew by several endpoints to manage / create / handle replies, a new top-level entity [(planning#460)](https://git.fitko.de/fit-connect/planning/-/issues/460):
* [`http get /v1/replies`](https://docs.fitko.de/fit-connect/docs/apis/submission-api?version=1.3.0#get-/v1/replies) to list replies
* [`http post /v1/replies`](https://docs.fitko.de/fit-connect/docs/apis/submission-api?version=1.3.0#post-/v1/replies) to create a reply
* [`http get /v1/replies/<replyId>`](https://docs.fitko.de/fit-connect/docs/apis/submission-api?version=1.3.0#get-/v1/replies/-replyId-) to get a specific reply
* [`http put /v1/replies/<replyId>`](https://docs.fitko.de/fit-connect/docs/apis/submission-api?version=1.3.0#put-/v1/replies/-replyId-) to submit a reply
* [`http put /v1/replies/<replyId>/accept`](https://docs.fitko.de/fit-connect/docs/apis/submission-api?version=1.3.0#put-/v1/replies/-replyId-/accept) to accept a reply (as an online service)
* [`http put /v1/replies/<replyId>/reject`](https://docs.fitko.de/fit-connect/docs/apis/submission-api?version=1.3.0#put-/v1/replies/-replyId-/reject) to reject a reply (as an online service)
* [`http get /v1/replies/<replyId>/attachments/<attachmentId>`](https://docs.fitko.de/fit-connect/docs/apis/submission-api?version=1.3.0#get-/v1/replies/-replyId-/attachments/-attachmentId-) to get a reply attachment
* [`http put /v1/replies/<replyId>/attachments/<attachmentId>`](https://docs.fitko.de/fit-connect/docs/apis/submission-api?version=1.3.0#put-/v1/replies/-replyId-/attachments/-attachmentId-) to upload a reply attachment
* Similar to the [NewSubmissions callback](https://docs.fitko.de/fit-connect/docs/apis/submission-api?version=1.3.0#post-/v1/destinations),
the Submission API now has a [NewReplies callback](https://docs.fitko.de/fit-connect/docs/apis/submission-api?version=1.3.0#post-/v1/submissions) that gets called
every time a new reply is added to a case. [(planning#460)](https://git.fitko.de/fit-connect/planning/-/issues/460)
* To enable bidirectional communication, an additional reply channel was added: `fitConnect`.
If a [destination supports](https://docs.fitko.de/fit-connect/docs/apis/submission-api?version=1.3.0#post-/v1/destinations) the `fitConnect` reply channel,
an [online service may select it via the Metadata `replyChannel -> fitConnect`](https://docs.fitko.de/fit-connect/docs/metadata/overview/).
For more details, check the [official FIT-Connect documentation](https://docs.fitko.de/fit-connect/docs/). [(planning#460)](https://git.fitko.de/fit-connect/planning/-/issues/460)
### Changed
* The Submission API now uses [OpenAPI 3.1.0](https://spec.openapis.org/oas/v3.1.0).
* Consolidated Attachment and CreateAttachment entities to a common type JWE.
This might be relevant for code generation tools.
The content stays the same though.
* Updated lots of descriptions and examples.
If you find more errors, please report them to [OpenCode](https://gitlab.opencode.de/fitko/feedback/-/issues).
* The [NewEvents callback](https://docs.fitko.de/fit-connect/docs/apis/submission-api?version=1.3.0#post-/v1/destinations) may now include
a list of replies in the field `replies`. [(planning#460)](https://git.fitko.de/fit-connect/planning/-/issues/460)
### Fixed
* Only CORS requests receive CORS headers. [(planning#501)](https://git.fitko.de/fit-connect/planning/-/issues/501)
## [1.2.1]
* Baseline changelog.
Check GIT history for a changelog of this and earlier versions.