CHANGELOG.adoc

Changelog: Submission API

• The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

• If available, include a ticket number in format (planning#XXXX).

[Unreleased]

Changed

• [NO_PUBLIC] The Submission API Specification is now bundled by redocly-cli instead of swagger-cli, which was discontinued. This should not affect the specification semantically but has changed the bundled document structure in certain aspects. (planning#1409)

• [NO_PUBLIC] Updated RapiDoc to 9.3.4

• Commits auf dem main Branch werden nun auf latest-dev released.

• Releases werden nun zusätzlich zum Pfad mit der Versionsnummer auch auf latest released.

[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)

• The Submission API grew by two endpoints to retrieve a case / list all cases (planning#460):

  • http get /v1/cases/<caseId>

  • http get /v1/cases

• The Submission API grew by several endpoints to manage / create / handle replies, a new top-level entity (planning#460):

  • http get /v1/replies to list replies

  • http post /v1/replies to create a reply

  • http get /v1/replies/<replyId> to get a specific reply

  • http put /v1/replies/<replyId> to submit a reply

  • http put /v1/replies/<replyId>/accept to accept a reply (as an online service)

  • http put /v1/replies/<replyId>/reject to reject a reply (as an online service)

  • http get /v1/replies/<replyId>/attachments/<attachmentId> to get a reply attachment

  • http put /v1/replies/<replyId>/attachments/<attachmentId> to upload a reply attachment

• Similar to the NewSubmissions callback, the Submission API now has a NewReplies callback that gets called every time a new reply is added to a case. (planning#460)

• To enable bidirectional communication, an additional reply channel was added: fitConnect. If a destination supports the fitConnect reply channel, an online service may select it via the Metadata replyChannel → fitConnect. For more details, check the official FIT-Connect documentation. (planning#460)

Changed

• The Submission API now uses OpenAPI 3.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.

• The NewEvents callback may now include a list of replies in the field replies. (planning#460)

Fixed

• Only CORS requests receive CORS headers. (planning#501)

[1.2.1]

• Baseline changelog. Check GIT history for a changelog of this and earlier versions.