Merge c633f478c29280e2000d78bd8e7704759835c3bf into 59a0bd87cdc5fc62083aa34d5987803639837808

Add support for marking audio attachments as voice notes when sending
messages. Voice notes are displayed inline with a play button in Signal
clients, rather than as file attachments.

This addresses a longstanding TODO in AttachmentUtils.java and resolves
the feature request in #1601.

Changes:
- Add 'voiceNote' field to Message record
- Pass voiceNote flag through AttachmentHelper to AttachmentUtils
- Add .withVoiceNote() to SignalServiceAttachmentStream builder
- Add --voice-note CLI argument to SendCommand
- Support voiceNote parameter in JSON-RPC mode

Usage:
  signal-cli send -a audio.m4a --voice-note +1234567890

JSON-RPC:
  {"method":"send","params":{"attachment":"audio.m4a","voiceNote":true,...}}

Closes #1601

README.md

@@ -148,6 +148,16 @@ version installed, you can replace `./gradlew` with `gradle` in the following st
       ./gradlew run --args="--help"
       ```
 
+### JSON Schemas for the JSON-RPC mode
+
+1. Generate [JSON Schema](https://json-schema.org/) files for all the JSON-RPC data classes (`src/main/java/org/asamk/signal/json`):
+
+    ```sh
+    ./gradlew jsonSchemas
+    ```
+
+2. The generated files can be found in the `build/generated/META-INF/schemas` folder.
+
 ### Building a native binary with GraalVM (EXPERIMENTAL)
 
 It is possible to build a native binary with [GraalVM](https://www.graalvm.org). This is still experimental and will not

build.gradle.kts

@@ -1,3 +1,5 @@
+import groovy.json.JsonOutput
+
 plugins {
     java
     application
@@ -72,6 +74,11 @@ val excludePatterns = mapOf(
     )
 )
 
+val schemaAnnotationProcessor by configurations.creating {
+    isCanBeConsumed = false
+    isCanBeResolved = true
+}
+
 dependencies {
     registerTransform(JarFileExcluder::class) {
         from.attribute(minified, false).attribute(artifactType, "jar")
@@ -82,6 +89,8 @@ dependencies {
         }
     }
 
+    schemaAnnotationProcessor(libs.micronaut.json.schema.processor)
+    schemaAnnotationProcessor(libs.micronaut.inject.java)
     implementation(libs.bouncycastle)
     implementation(libs.jackson.databind)
     implementation(libs.argparse4j)
@@ -90,6 +99,10 @@ dependencies {
     implementation(libs.slf4j.jul)
     implementation(libs.logback)
     implementation(libs.zxing)
+    implementation(libs.micronaut.json.schema.annotations)
+    if (gradle.startParameter.taskNames.any { it.contains("jsonSchemas") }) {
+        implementation(libs.micronaut.json.schema.generator)
+    }    
     implementation(project(":libsignal-cli"))
 }
 
@@ -138,3 +151,30 @@ tasks.register("fatJar", type = Jar::class) {
     }
     with(tasks.jar.get())
 }
+
+tasks.register<JavaCompile>("jsonSchemas") {
+    dependsOn(tasks.compileJava)
+    val schemaBaseUri = "http://localhost:8080/schemas/"
+    source = sourceSets.main.get().java
+    include("org/asamk/signal/json/**/*.java")
+    classpath = sourceSets.main.get().compileClasspath + files(sourceSets.main.get().java.destinationDirectory)
+    destinationDirectory.set(layout.buildDirectory.dir("generated"))
+    options.annotationProcessorPath = schemaAnnotationProcessor
+    options.compilerArgs.addAll(
+        listOf(
+            "-Amicronaut.processing.group=org.asamk",
+            "-Amicronaut.processing.module=signal-cli",
+            "-Amicronaut.processing.annotations=org.asamk.signal.json.*",
+            "-Amicronaut.jsonschema.baseUri=$schemaBaseUri",
+        )
+    )
+    doLast {
+        fileTree(destinationDirectory.get().dir("META-INF/schemas").asFile) {
+            include("*.schema.json")
+        }.forEach { schemaFile ->
+            val normalized = schemaFile.readText().replace("\"$schemaBaseUri/", "\"")
+            val prettyJson = JsonOutput.prettyPrint(normalized)
+            schemaFile.writeText("$prettyJson\n")
+        }
+    }
+}

gradle/libs.versions.toml

@@ -1,6 +1,8 @@
 [versions]
 slf4j = "2.0.17"
 junit = "6.0.2"
+micronaut-json-schema = "2.0.0-M6"
+micronaut-core = "4.9.3"
 
 [libraries]
 bouncycastle = "org.bouncycastle:bcprov-jdk18on:1.83"
@@ -8,6 +10,10 @@ jackson-databind = "com.fasterxml.jackson.core:jackson-databind:2.20.2"
 argparse4j = "net.sourceforge.argparse4j:argparse4j:0.9.0"
 dbusjava = "com.github.hypfvieh:dbus-java-transport-native-unixsocket:5.0.0"
 zxing = "com.google.zxing:core:3.5.4"
+micronaut-json-schema-annotations = { module = "io.micronaut.jsonschema:micronaut-json-schema-annotations", version.ref = "micronaut-json-schema" }
+micronaut-json-schema-processor = { module = "io.micronaut.jsonschema:micronaut-json-schema-processor", version.ref = "micronaut-json-schema" }
+micronaut-json-schema-generator = { module = "io.micronaut.jsonschema:micronaut-json-schema-generator", version.ref = "micronaut-json-schema" }
+micronaut-inject-java = { module = "io.micronaut:micronaut-inject-java", version.ref = "micronaut-core" }
 slf4j-api = { module = "org.slf4j:slf4j-api", version.ref = "slf4j" }
 slf4j-jul = { module = "org.slf4j:jul-to-slf4j", version.ref = "slf4j" }
 logback = "ch.qos.logback:logback-classic:1.5.32"

lib/src/main/java/org/asamk/signal/manager/api/Message.java

@@ -7,6 +7,7 @@ public record Message(
         String messageText,
         List<String> attachments,
         boolean viewOnce,
+        boolean voiceNote,
         List<Mention> mentions,
         Optional<Quote> quote,
         Optional<Sticker> sticker,

lib/src/main/java/org/asamk/signal/manager/helper/AttachmentHelper.java

@@ -44,8 +44,8 @@ public class AttachmentHelper {
         return attachmentStore.retrieveAttachment(id);
     }
 
-    public List<SignalServiceAttachment> uploadAttachments(final List<String> attachments) throws AttachmentInvalidException, IOException {
-        final var attachmentStreams = createAttachmentStreams(attachments);
+    public List<SignalServiceAttachment> uploadAttachments(final List<String> attachments, boolean voiceNote) throws AttachmentInvalidException, IOException {
+        final var attachmentStreams = createAttachmentStreams(attachments, voiceNote);
 
         try {
             // Upload attachments here, so we only upload once even for multiple recipients
@@ -61,14 +61,18 @@ public class AttachmentHelper {
         }
     }
 
-    private List<SignalServiceAttachmentStream> createAttachmentStreams(List<String> attachments) throws AttachmentInvalidException, IOException {
+    public List<SignalServiceAttachment> uploadAttachments(final List<String> attachments) throws AttachmentInvalidException, IOException {
+        return uploadAttachments(attachments, false);
+    }
+
+    private List<SignalServiceAttachmentStream> createAttachmentStreams(List<String> attachments, boolean voiceNote) throws AttachmentInvalidException, IOException {
         if (attachments == null) {
             return null;
         }
         final var signalServiceAttachments = new ArrayList<SignalServiceAttachmentStream>(attachments.size());
         for (var attachment : attachments) {
             final var uploadSpec = dependencies.getMessageSender().getResumableUploadSpec();
-            signalServiceAttachments.add(AttachmentUtils.createAttachmentStream(attachment, uploadSpec));
+            signalServiceAttachments.add(AttachmentUtils.createAttachmentStream(attachment, voiceNote, uploadSpec));
         }
         return signalServiceAttachments;
     }

lib/src/main/java/org/asamk/signal/manager/internal/ManagerImpl.java

@@ -843,7 +843,7 @@ public class ManagerImpl implements Manager {
             messageBuilder.withBody(message.messageText());
         }
         if (!message.attachments().isEmpty()) {
-            final var uploadedAttachments = context.getAttachmentHelper().uploadAttachments(message.attachments());
+            final var uploadedAttachments = context.getAttachmentHelper().uploadAttachments(message.attachments(), message.voiceNote());
             if (!additionalAttachments.isEmpty()) {
                 additionalAttachments.addAll(uploadedAttachments);
                 messageBuilder.withAttachments(additionalAttachments);

lib/src/main/java/org/asamk/signal/manager/util/AttachmentUtils.java

@@ -14,32 +14,49 @@ public class AttachmentUtils {
 
     public static SignalServiceAttachmentStream createAttachmentStream(
             String attachment,
+            boolean voiceNote,
             ResumableUploadSpec resumableUploadSpec
     ) throws AttachmentInvalidException {
         try {
             final var streamDetails = Utils.createStreamDetails(attachment);
 
-            return createAttachmentStream(streamDetails.first(), streamDetails.second(), resumableUploadSpec);
+            return createAttachmentStream(streamDetails.first(), streamDetails.second(), voiceNote, resumableUploadSpec);
         } catch (IOException e) {
             throw new AttachmentInvalidException(attachment, e);
         }
     }
 
+    public static SignalServiceAttachmentStream createAttachmentStream(
+            String attachment,
+            ResumableUploadSpec resumableUploadSpec
+    ) throws AttachmentInvalidException {
+        return createAttachmentStream(attachment, false, resumableUploadSpec);
+    }
+
+    public static SignalServiceAttachmentStream createAttachmentStream(
+            StreamDetails streamDetails,
+            Optional<String> name,
+            boolean voiceNote,
+            ResumableUploadSpec resumableUploadSpec
+    ) throws ResumeLocationInvalidException {
+        final var uploadTimestamp = System.currentTimeMillis();
+        return SignalServiceAttachmentStream.newStreamBuilder()
+                .withStream(streamDetails.getStream())
+                .withContentType(streamDetails.getContentType())
+                .withLength(streamDetails.getLength())
+                .withFileName(name.orElse(null))
+                .withVoiceNote(voiceNote)
+                .withUploadTimestamp(uploadTimestamp)
+                .withResumableUploadSpec(resumableUploadSpec)
+                .withUuid(UUID.randomUUID())
+                .build();
+    }
+
     public static SignalServiceAttachmentStream createAttachmentStream(
             StreamDetails streamDetails,
             Optional<String> name,
             ResumableUploadSpec resumableUploadSpec
     ) throws ResumeLocationInvalidException {
-        // TODO maybe add a parameter to set the voiceNote, borderless, preview, width, height and caption option
-        final var uploadTimestamp = System.currentTimeMillis();
-        return SignalServiceAttachmentStream.newStreamBuilder()
-                .withStream(streamDetails.getStream())
-                .withContentType(streamDetails.getContentType())
-                .withLength(streamDetails.getLength())
-                .withFileName(name.orElse(null))
-                .withUploadTimestamp(uploadTimestamp)
-                .withResumableUploadSpec(resumableUploadSpec)
-                .withUuid(UUID.randomUUID())
-                .build();
+        return createAttachmentStream(streamDetails, name, false, resumableUploadSpec);
     }
 }

src/main/java/org/asamk/signal/commands/SendCommand.java

@@ -109,6 +109,9 @@ public class SendCommand implements JsonRpcLocalCommand {
                 .action(Arguments.storeTrue())
                 .help("Send the message without the urgent flag, so no push notification is triggered for the recipient. "
                         + "The message will still be delivered in real-time if the recipient's app is active.");
+        subparser.addArgument("--voice-note")
+                .action(Arguments.storeTrue())
+                .help("Mark audio attachments as voice notes. Voice notes are displayed inline in Signal clients.");
     }
 
     @Override
@@ -171,6 +174,7 @@ public class SendCommand implements JsonRpcLocalCommand {
             attachments = List.of();
         }
         final var viewOnce = Boolean.TRUE.equals(ns.getBoolean("view-once"));
+        final var voiceNote = Boolean.TRUE.equals(ns.getBoolean("voice-note"));
 
         final var selfNumber = m.getSelfNumber();
 
@@ -247,6 +251,7 @@ public class SendCommand implements JsonRpcLocalCommand {
             final var message = new Message(messageText,
                     attachments,
                     viewOnce,
+                    voiceNote,
                     mentions,
                     Optional.ofNullable(quote),
                     Optional.ofNullable(sticker),

src/main/java/org/asamk/signal/dbus/DbusSignalImpl.java

@@ -238,6 +238,7 @@ public class DbusSignalImpl implements Signal, AutoCloseable {
             final var message = new Message(messageText,
                     attachments,
                     false,
+                    false,
                     List.of(),
                     Optional.empty(),
                     Optional.empty(),
@@ -404,6 +405,7 @@ public class DbusSignalImpl implements Signal, AutoCloseable {
             final var message = new Message(messageText,
                     attachments,
                     false,
+                    false,
                     List.of(),
                     Optional.empty(),
                     Optional.empty(),
@@ -451,6 +453,7 @@ public class DbusSignalImpl implements Signal, AutoCloseable {
             final var message = new Message(messageText,
                     attachments,
                     false,
+                    false,
                     List.of(),
                     Optional.empty(),
                     Optional.empty(),

src/main/java/org/asamk/signal/json/JsonAdminDelete.java

@@ -1,9 +1,11 @@
 package org.asamk.signal.json;
 
+import io.micronaut.jsonschema.JsonSchema;
 import org.asamk.signal.manager.api.MessageEnvelope;
 
 import java.util.UUID;
 
+@JsonSchema(title = "AdminDelete")
 public record JsonAdminDelete(
         @Deprecated String targetAuthor, String targetAuthorNumber, String targetAuthorUuid, long targetSentTimestamp
 ) {

src/main/java/org/asamk/signal/json/JsonAttachment.java

@@ -1,7 +1,10 @@
 package org.asamk.signal.json;
 
+import io.micronaut.jsonschema.JsonSchema;
+
 import org.asamk.signal.manager.api.MessageEnvelope;
 
+@JsonSchema(title = "Attachment")
 record JsonAttachment(
         String contentType,
         String filename,

src/main/java/org/asamk/signal/json/JsonAttachmentData.java

@@ -1,5 +1,8 @@
 package org.asamk.signal.json;
 
+import io.micronaut.jsonschema.JsonSchema;
+
+@JsonSchema(title = "AttachmentData")
 public record JsonAttachmentData(
         String data
 ) {}

src/main/java/org/asamk/signal/json/JsonCallMessage.java

@@ -1,12 +1,14 @@
 package org.asamk.signal.json;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
+import io.micronaut.jsonschema.JsonSchema;
 
 import org.asamk.signal.manager.api.MessageEnvelope;
 
 import java.util.Base64;
 import java.util.List;
 
+@JsonSchema(title = "CallMessage")
 record JsonCallMessage(
         @JsonInclude(JsonInclude.Include.NON_NULL) Offer offerMessage,
         @JsonInclude(JsonInclude.Include.NON_NULL) Answer answerMessage,

src/main/java/org/asamk/signal/json/JsonContact.java

@@ -1,9 +1,11 @@
 package org.asamk.signal.json;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
+import io.micronaut.jsonschema.JsonSchema;
 
 import java.util.List;
 
+@JsonSchema(title = "Contact")
 public record JsonContact(
         String number,
         String uuid,
@@ -26,6 +28,7 @@ public record JsonContact(
         @JsonInclude(JsonInclude.Include.NON_NULL) JsonInternal internal
 ) {
 
+    @JsonSchema(title = "Profile")
     public record JsonProfile(
             long lastUpdateTimestamp,
             String givenName,
@@ -36,6 +39,7 @@ public record JsonContact(
             String mobileCoinAddress
     ) {}
 
+    @JsonSchema(title = "Internal")
     public record JsonInternal(
             List<String> capabilities,
             String unidentifiedAccessMode,

src/main/java/org/asamk/signal/json/JsonContactAddress.java

@@ -1,8 +1,11 @@
 package org.asamk.signal.json;
 
+import io.micronaut.jsonschema.JsonSchema;
+
 import org.asamk.signal.manager.api.MessageEnvelope;
 import org.asamk.signal.util.Util;
 
+@JsonSchema(title = "ContactAddress")
 public record JsonContactAddress(
         String type,
         String label,

src/main/java/org/asamk/signal/json/JsonContactAvatar.java

@@ -1,7 +1,10 @@
 package org.asamk.signal.json;
 
+import io.micronaut.jsonschema.JsonSchema;
+
 import org.asamk.signal.manager.api.MessageEnvelope;
 
+@JsonSchema(title = "ContactAvatar")
 public record JsonContactAvatar(JsonAttachment attachment, boolean isProfile) {
 
     static JsonContactAvatar from(MessageEnvelope.Data.SharedContact.Avatar avatar) {

src/main/java/org/asamk/signal/json/JsonContactEmail.java

@@ -1,8 +1,11 @@
 package org.asamk.signal.json;
 
+import io.micronaut.jsonschema.JsonSchema;
+
 import org.asamk.signal.manager.api.MessageEnvelope;
 import org.asamk.signal.util.Util;
 
+@JsonSchema(title = "ContactEmail")
 public record JsonContactEmail(String value, String type, String label) {
 
     static JsonContactEmail from(MessageEnvelope.Data.SharedContact.Email email) {

src/main/java/org/asamk/signal/json/JsonContactName.java

@@ -1,8 +1,11 @@
 package org.asamk.signal.json;
 
+import io.micronaut.jsonschema.JsonSchema;
+
 import org.asamk.signal.manager.api.MessageEnvelope;
 import org.asamk.signal.util.Util;
 
+@JsonSchema(title = "ContactName")
 public record JsonContactName(
         String nickname, String given, String family, String prefix, String suffix, String middle
 ) {

src/main/java/org/asamk/signal/json/JsonContactPhone.java

@@ -1,8 +1,11 @@
 package org.asamk.signal.json;
 
+import io.micronaut.jsonschema.JsonSchema;
+
 import org.asamk.signal.manager.api.MessageEnvelope;
 import org.asamk.signal.util.Util;
 
+@JsonSchema(title = "ContactPhone")
 public record JsonContactPhone(String value, String type, String label) {
 
     static JsonContactPhone from(MessageEnvelope.Data.SharedContact.Phone phone) {

src/main/java/org/asamk/signal/json/JsonDataMessage.java

@@ -1,12 +1,14 @@
 package org.asamk.signal.json;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
+import io.micronaut.jsonschema.JsonSchema;
 
 import org.asamk.signal.manager.Manager;
 import org.asamk.signal.manager.api.MessageEnvelope;
 
 import java.util.List;
 
+@JsonSchema(title = "DataMessage")
 record JsonDataMessage(
         long timestamp,
         String message,

src/main/java/org/asamk/signal/json/JsonEditMessage.java

@@ -1,8 +1,11 @@
 package org.asamk.signal.json;
 
+import io.micronaut.jsonschema.JsonSchema;
+
 import org.asamk.signal.manager.Manager;
 import org.asamk.signal.manager.api.MessageEnvelope;
 
+@JsonSchema(title = "EditMessage")
 record JsonEditMessage(long targetSentTimestamp, JsonDataMessage dataMessage) {
 
     static JsonEditMessage from(MessageEnvelope.Edit editMessage, Manager m) {

src/main/java/org/asamk/signal/json/JsonError.java

@@ -1,5 +1,8 @@
 package org.asamk.signal.json;
 
+import io.micronaut.jsonschema.JsonSchema;
+
+@JsonSchema(title = "Error")
 public record JsonError(String message, String type) {
 
     public static JsonError from(Throwable exception) {

src/main/java/org/asamk/signal/json/JsonGroupInfo.java

@@ -1,8 +1,11 @@
 package org.asamk.signal.json;
 
+import io.micronaut.jsonschema.JsonSchema;
+
 import org.asamk.signal.manager.Manager;
 import org.asamk.signal.manager.api.MessageEnvelope;
 
+@JsonSchema(title = "GroupInfo")
 record JsonGroupInfo(String groupId, String groupName, int revision, String type) {
 
     static JsonGroupInfo from(MessageEnvelope.Data.GroupContext groupContext, Manager m) {

src/main/java/org/asamk/signal/json/JsonMention.java

@@ -1,9 +1,12 @@
 package org.asamk.signal.json;
 
+import io.micronaut.jsonschema.JsonSchema;
+
 import org.asamk.signal.manager.api.MessageEnvelope;
 
 import java.util.UUID;
 
+@JsonSchema(title = "Mention")
 public record JsonMention(@Deprecated String name, String number, String uuid, int start, int length) {
 
     static JsonMention from(MessageEnvelope.Data.Mention mention) {

src/main/java/org/asamk/signal/json/JsonMessageEnvelope.java

@@ -1,6 +1,7 @@
 package org.asamk.signal.json;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
+import io.micronaut.jsonschema.JsonSchema;
 
 import org.asamk.signal.manager.Manager;
 import org.asamk.signal.manager.api.MessageEnvelope;
@@ -10,6 +11,7 @@ import org.asamk.signal.manager.api.UntrustedIdentityException;
 
 import java.util.UUID;
 
+@JsonSchema(title = "MessageEnvelope")
 public record JsonMessageEnvelope(
         @Deprecated String source,
         String sourceNumber,

src/main/java/org/asamk/signal/json/JsonPayment.java

@@ -1,7 +1,10 @@
 package org.asamk.signal.json;
 
+import io.micronaut.jsonschema.JsonSchema;
+
 import org.asamk.signal.manager.api.MessageEnvelope;
 
+@JsonSchema(title = "Payment")
 public record JsonPayment(String note, byte[] receipt) {
 
     static JsonPayment from(MessageEnvelope.Data.Payment payment) {

src/main/java/org/asamk/signal/json/JsonPinMessage.java

@@ -1,9 +1,12 @@
 package org.asamk.signal.json;
 
+import io.micronaut.jsonschema.JsonSchema;
+
 import org.asamk.signal.manager.api.MessageEnvelope;
 
 import java.util.UUID;
 
+@JsonSchema(title = "PinMessage")
 public record JsonPinMessage(
         @Deprecated String targetAuthor,
         String targetAuthorNumber,

src/main/java/org/asamk/signal/json/JsonPollCreate.java

@@ -1,9 +1,12 @@
 package org.asamk.signal.json;
 
+import io.micronaut.jsonschema.JsonSchema;
+
 import org.asamk.signal.manager.api.MessageEnvelope;
 
 import java.util.List;
 
+@JsonSchema(title = "PollCreate")
 public record JsonPollCreate(
         String question, boolean allowMultiple, List<String> options
 ) {

src/main/java/org/asamk/signal/json/JsonPollTerminate.java

@@ -1,7 +1,10 @@
 package org.asamk.signal.json;
 
+import io.micronaut.jsonschema.JsonSchema;
+
 import org.asamk.signal.manager.api.MessageEnvelope;
 
+@JsonSchema(title = "PollTerminate")
 public record JsonPollTerminate(long targetSentTimestamp) {
 
     static JsonPollTerminate from(MessageEnvelope.Data.PollTerminate pollTerminate) {

src/main/java/org/asamk/signal/json/JsonPollVote.java

@@ -1,10 +1,13 @@
 package org.asamk.signal.json;
 
+import io.micronaut.jsonschema.JsonSchema;
+
 import org.asamk.signal.manager.api.MessageEnvelope;
 
 import java.util.List;
 import java.util.UUID;
 
+@JsonSchema(title = "PollVote")
 public record JsonPollVote(
         @Deprecated String author,
         String authorNumber,

src/main/java/org/asamk/signal/json/JsonPreview.java

@@ -1,7 +1,10 @@
 package org.asamk.signal.json;
 
+import io.micronaut.jsonschema.JsonSchema;
+
 import org.asamk.signal.manager.api.MessageEnvelope;
 
+@JsonSchema(title = "Preview")
 public record JsonPreview(String url, String title, String description, JsonAttachment image) {
 
     static JsonPreview from(MessageEnvelope.Data.Preview preview) {

src/main/java/org/asamk/signal/json/JsonQuote.java

@@ -1,12 +1,14 @@
 package org.asamk.signal.json;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
+import io.micronaut.jsonschema.JsonSchema;
 
 import org.asamk.signal.manager.api.MessageEnvelope;
 
 import java.util.List;
 import java.util.UUID;
 
+@JsonSchema(title = "Quote")
 public record JsonQuote(
         long id,
         @Deprecated String author,

src/main/java/org/asamk/signal/json/JsonQuotedAttachment.java

@@ -1,9 +1,11 @@
 package org.asamk.signal.json;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
+import io.micronaut.jsonschema.JsonSchema;
 
 import org.asamk.signal.manager.api.MessageEnvelope;
 
+@JsonSchema(title = "QuotedAttachment")
 public record JsonQuotedAttachment(
         String contentType, String filename, @JsonInclude(JsonInclude.Include.NON_NULL) JsonAttachment thumbnail
 ) {

src/main/java/org/asamk/signal/json/JsonReaction.java

@@ -1,9 +1,12 @@
 package org.asamk.signal.json;
 
+import io.micronaut.jsonschema.JsonSchema;
+
 import org.asamk.signal.manager.api.MessageEnvelope;
 
 import java.util.UUID;
 
+@JsonSchema(title = "Reaction")
 public record JsonReaction(
         String emoji,
         @Deprecated String targetAuthor,

src/main/java/org/asamk/signal/json/JsonReceiptMessage.java

@@ -1,9 +1,12 @@
 package org.asamk.signal.json;
 
+import io.micronaut.jsonschema.JsonSchema;
+
 import org.asamk.signal.manager.api.MessageEnvelope;
 
 import java.util.List;
 
+@JsonSchema(title = "ReceiptMessage")
 record JsonReceiptMessage(long when, boolean isDelivery, boolean isRead, boolean isViewed, List<Long> timestamps) {
 
     static JsonReceiptMessage from(MessageEnvelope.Receipt receiptMessage) {

src/main/java/org/asamk/signal/json/JsonRecipientAddress.java

@@ -1,9 +1,12 @@
 package org.asamk.signal.json;
 
+import io.micronaut.jsonschema.JsonSchema;
+
 import org.asamk.signal.manager.api.RecipientAddress;
 
 import java.util.UUID;
 
+@JsonSchema(title = "RecipientAddress")
 public record JsonRecipientAddress(String uuid, String number, String username) {
 
     public static JsonRecipientAddress from(RecipientAddress address) {

src/main/java/org/asamk/signal/json/JsonRemoteDelete.java

@@ -1,3 +1,6 @@
 package org.asamk.signal.json;
 
+import io.micronaut.jsonschema.JsonSchema;
+
+@JsonSchema(title = "RemoteDelete")
 record JsonRemoteDelete(long timestamp) {}

src/main/java/org/asamk/signal/json/JsonSendMessageResult.java

@@ -1,10 +1,12 @@
 package org.asamk.signal.json;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
+import io.micronaut.jsonschema.JsonSchema;
 
 import org.asamk.signal.manager.api.GroupId;
 import org.asamk.signal.manager.api.SendMessageResult;
 
+@JsonSchema(title = "SendMessageResult")
 public record JsonSendMessageResult(
         JsonRecipientAddress recipientAddress,
         @JsonInclude(JsonInclude.Include.NON_NULL) String groupId,

src/main/java/org/asamk/signal/json/JsonSharedContact.java

@@ -1,11 +1,13 @@
 package org.asamk.signal.json;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
+import io.micronaut.jsonschema.JsonSchema;
 
 import org.asamk.signal.manager.api.MessageEnvelope;
 
 import java.util.List;
 
+@JsonSchema(title = "SharedContact")
 public record JsonSharedContact(
         JsonContactName name,
         @JsonInclude(JsonInclude.Include.NON_NULL) JsonContactAvatar avatar,

src/main/java/org/asamk/signal/json/JsonSticker.java

@@ -1,8 +1,11 @@
 package org.asamk.signal.json;
 
+import io.micronaut.jsonschema.JsonSchema;
+
 import org.asamk.signal.manager.api.MessageEnvelope;
 import org.asamk.signal.util.Hex;
 
+@JsonSchema(title = "Sticker")
 public record JsonSticker(String packId, int stickerId) {
 
     static JsonSticker from(MessageEnvelope.Data.Sticker sticker) {

src/main/java/org/asamk/signal/json/JsonStoryContext.java

@@ -1,9 +1,12 @@
 package org.asamk.signal.json;
 
+import io.micronaut.jsonschema.JsonSchema;
+
 import org.asamk.signal.manager.api.MessageEnvelope;
 
 import java.util.UUID;
 
+@JsonSchema(title = "StoryContext")
 record JsonStoryContext(
         String authorNumber, String authorUuid, long sentTimestamp
 ) {

src/main/java/org/asamk/signal/json/JsonStoryMessage.java

@@ -1,6 +1,7 @@
 package org.asamk.signal.json;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
+import io.micronaut.jsonschema.JsonSchema;
 
 import org.asamk.signal.manager.api.Color;
 import org.asamk.signal.manager.api.GroupId;
@@ -8,6 +9,7 @@ import org.asamk.signal.manager.api.MessageEnvelope;
 
 import java.util.List;
 
+@JsonSchema(title = "StoryMessage")
 record JsonStoryMessage(
         boolean allowsReplies,
         @JsonInclude(JsonInclude.Include.NON_NULL) String groupId,

src/main/java/org/asamk/signal/json/JsonSyncDataMessage.java

@@ -2,6 +2,7 @@ package org.asamk.signal.json;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonUnwrapped;
+import io.micronaut.jsonschema.JsonSchema;
 
 import org.asamk.signal.manager.Manager;
 import org.asamk.signal.manager.api.MessageEnvelope;
@@ -9,6 +10,7 @@ import org.asamk.signal.manager.api.RecipientAddress;
 
 import java.util.UUID;
 
+@JsonSchema(title = "SyncDataMessage")
 record JsonSyncDataMessage(
         @Deprecated String destination,
         String destinationNumber,

src/main/java/org/asamk/signal/json/JsonSyncMessage.java

@@ -9,12 +9,15 @@ import org.asamk.signal.manager.api.RecipientAddress;
 
 import java.util.List;
 
+import io.micronaut.jsonschema.JsonSchema;
+
 enum JsonSyncMessageType {
     CONTACTS_SYNC,
     GROUPS_SYNC,
     REQUEST_SYNC
 }
 
+@JsonSchema(title = "SyncMessage")
 record JsonSyncMessage(
         @JsonInclude(JsonInclude.Include.NON_NULL) JsonSyncDataMessage sentMessage,
         @JsonInclude(JsonInclude.Include.NON_NULL) JsonSyncStoryMessage sentStoryMessage,

src/main/java/org/asamk/signal/json/JsonSyncReadMessage.java

@@ -1,9 +1,12 @@
 package org.asamk.signal.json;
 
+import io.micronaut.jsonschema.JsonSchema;
+
 import org.asamk.signal.manager.api.MessageEnvelope;
 
 import java.util.UUID;
 
+@JsonSchema(title = "SyncReadMessage")
 record JsonSyncReadMessage(
         @Deprecated String sender, String senderNumber, String senderUuid, long timestamp
 ) {

src/main/java/org/asamk/signal/json/JsonSyncStoryMessage.java

@@ -1,11 +1,13 @@
 package org.asamk.signal.json;
 
 import com.fasterxml.jackson.annotation.JsonUnwrapped;
+import io.micronaut.jsonschema.JsonSchema;
 
 import org.asamk.signal.manager.api.MessageEnvelope;
 
 import java.util.UUID;
 
+@JsonSchema(title = "SyncStoryMessage")
 record JsonSyncStoryMessage(
         String destinationNumber, String destinationUuid, @JsonUnwrapped JsonStoryMessage dataMessage
 ) {

src/main/java/org/asamk/signal/json/JsonTextStyle.java

@@ -1,7 +1,10 @@
 package org.asamk.signal.json;
 
+import io.micronaut.jsonschema.JsonSchema;
+
 import org.asamk.signal.manager.api.TextStyle;
 
+@JsonSchema(title = "TextStyle")
 public record JsonTextStyle(String style, int start, int length) {
 
     static JsonTextStyle from(TextStyle textStyle) {

src/main/java/org/asamk/signal/json/JsonTypingMessage.java

@@ -1,10 +1,12 @@
 package org.asamk.signal.json;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
+import io.micronaut.jsonschema.JsonSchema;
 
 import org.asamk.signal.manager.api.GroupId;
 import org.asamk.signal.manager.api.MessageEnvelope;
 
+@JsonSchema(title = "TypingMessage")
 record JsonTypingMessage(
         String action, long timestamp, @JsonInclude(JsonInclude.Include.NON_NULL) String groupId
 ) {

src/main/java/org/asamk/signal/json/JsonUnpinMessage.java

@@ -1,9 +1,12 @@
 package org.asamk.signal.json;
 
+import io.micronaut.jsonschema.JsonSchema;
+
 import org.asamk.signal.manager.api.MessageEnvelope;
 
 import java.util.UUID;
 
+@JsonSchema(title = "UnpinMessage")
 public record JsonUnpinMessage(
         @Deprecated String targetAuthor, String targetAuthorNumber, String targetAuthorUuid, long targetSentTimestamp
 ) {