From 07275ecfabb8bef8feed41fe3899131263cbe0ec Mon Sep 17 00:00:00 2001 From: Jonas Groeger <jonas.groeger_extern@fjd.de> Date: Fri, 16 Feb 2024 19:29:07 +0100 Subject: [PATCH] feat: add titles to all objects --- CHANGELOG.adoc | 4 ++++ spec/set-payload.schema.json | 16 +++++++++++++++- 2 files changed, 19 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.adoc b/CHANGELOG.adoc index edca2a0..0a5d29d 100644 --- a/CHANGELOG.adoc +++ b/CHANGELOG.adoc @@ -22,6 +22,10 @@ Don't forget to tag @ https://git.fitko.de/fit-connect/event-payload/-/tags === [Unreleased] - YYYY-MM-DD +==== Fixed + +* All objects now have a sensible `title` element. This is useful in code generation. + === [1.2.1] - 2024-01-08 ==== Added diff --git a/spec/set-payload.schema.json b/spec/set-payload.schema.json index 6da77a8..de7e4c4 100644 --- a/spec/set-payload.schema.json +++ b/spec/set-payload.schema.json @@ -1,7 +1,7 @@ { "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://schema.fitko.de/fit-connect/set-payload/SCHEMA_VERSION/set-payload.schema.json", - "title": "Security Event Token (SET)", + "title": "Security Event Token", "description": "Security Event Token (SET) nach RFC 8417", "type": "object", "properties": { @@ -35,14 +35,17 @@ "pattern": "^case:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "events": { + "title": "Events", "description": "Enthält genau eines der spezifizierten Events als Unterobjekt.", "type": "object", "properties": { "https://schema.fitko.de/fit-connect/events/create-submission": { + "title": "Create Submission Event", "description": "Mit diesem Event dokumentiert der Zustelldienst, dass eine Einreichung angelegt wurde.", "type": "object" }, "https://schema.fitko.de/fit-connect/events/submit-submission": { + "title": "Submit Submission Event", "description": "Mit diesem Event dokumentiert der Zustelldienst, dass die Einreichung abgesendet wurde.", "type": "object", "properties": { @@ -55,6 +58,7 @@ ] }, "https://schema.fitko.de/fit-connect/events/notify-submission": { + "title": "Notify Submission Event", "description": "Mit diesem Event dokumentiert der Zustelldienst, dass das empfangende System Kenntnis von der Einreichung erlangt hat. Wie dies erfolgt ist, wird mit dem Eintrag `notifyType` dokumentiert.", "type": "object", "properties": { @@ -71,11 +75,13 @@ ] }, "https://schema.fitko.de/fit-connect/events/forward-submission": { + "title": "Forward Submission Event", "description": "Mit diesem Event dokumentiert ein nachgelagertes System, dass es die Einreichung zur Weiterleitung übernommen hat.", "type": "object", "deprecated": true }, "https://schema.fitko.de/fit-connect/events/reject-submission": { + "title": "Reject Submission Event", "description": "Mit diesem Event dokumentiert das empfangende System, dass die Einreichung zurückgewiesen wird.", "type": "object", "properties": { @@ -88,6 +94,7 @@ ] }, "https://schema.fitko.de/fit-connect/events/accept-submission": { + "title": "Accept Submission Event", "description": "Mit diesem Event dokumentiert das empfangende System, dass die Einreichung akzeptiert wurde.", "type": "object", "properties": { @@ -103,14 +110,17 @@ ] }, "https://schema.fitko.de/fit-connect/events/delete-submission": { + "title": "Delete Submission Event", "description": "Mit diesem Event dokumentiert der Zustelldienst, dass die Einreichung gelöscht wurde.", "type": "object" }, "https://schema.fitko.de/fit-connect/events/create-reply": { + "title": "Create Reply Event", "description": "Mit diesem Event dokumentiert der Zustelldienst, dass eine Antwort angelegt wurde.", "type": "object" }, "https://schema.fitko.de/fit-connect/events/submit-reply": { + "title": "Submit Reply Event", "description": "Mit diesem Event dokumentiert der Zustelldienst, dass die Antwort abgesendet wurde.", "type": "object", "properties": { @@ -123,6 +133,7 @@ ] }, "https://schema.fitko.de/fit-connect/events/notify-reply": { + "title": "Notify Reply Event", "description": "Mit diesem Event dokumentiert der Zustelldienst, dass das sendende System Kenntnis von der Antwort erlangt hat. Wie dies erfolgt ist, wird mit dem Eintrag `notifyType` dokumentiert.", "type": "object", "properties": { @@ -139,6 +150,7 @@ ] }, "https://schema.fitko.de/fit-connect/events/reject-reply": { + "title": "Reject Reply Event", "description": "Mit diesem Event dokumentiert der Zustelldienst, dass die Antwort zurückgewiesen wird.", "type": "object", "properties": { @@ -151,6 +163,7 @@ ] }, "https://schema.fitko.de/fit-connect/events/accept-reply": { + "title": "Accept Reply Event", "description": "Mit diesem Event dokumentiert der Zustelldienst, dass die Antwort akzeptiert wurde.", "type": "object", "properties": { @@ -166,6 +179,7 @@ ] }, "https://schema.fitko.de/fit-connect/events/delete-reply": { + "title": "Delete Reply Event", "description": "Mit diesem Event dokumentiert der Zustelldienst, dass die Antwort gelöscht wurde.", "type": "object" } -- GitLab