Promote FormattableBody to restconf.api

[netconf.git] / protocol / restconf-api / src / main / java / org / opendaylight / restconf / api / FormatParameters.java

diff --git a/protocol/restconf-api/src/main/java/org/opendaylight/restconf/api/FormatParameters.java b/protocol/restconf-api/src/main/java/org/opendaylight/restconf/api/FormatParameters.java
new file mode 100644 (file)
index 0000000..9a3e59d
--- /dev/null
+++ b/protocol/restconf-api/src/main/java/org/opendaylight/restconf/api/FormatParameters.java
@@ -0,0 +1,26 @@
+/*
+ * Copyright (c) 2024 PANTHEON.tech, s.r.o. and others.  All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+package org.opendaylight.restconf.api;
+
+import org.eclipse.jdt.annotation.NonNullByDefault;
+import org.opendaylight.restconf.api.query.PrettyPrintParam;
+import org.opendaylight.restconf.api.query.RestconfQueryParam;
+import org.opendaylight.yangtools.concepts.Immutable;
+
+/**
+ * The set of {@link RestconfQueryParam}s governing output formatting.
+ */
+@NonNullByDefault
+public interface FormatParameters extends Immutable {
+    /**
+     * Return the {@link PrettyPrintParam} parameter.
+     *
+     * @return the {@link PrettyPrintParam} parameter
+     */
+    PrettyPrintParam prettyPrint();
+}