From 7a7b2a03a44fcc49ee8e04d202487f54c9dc35f6 Mon Sep 17 00:00:00 2001
From: Robert Varga <robert.varga@pantheon.tech>
Date: Tue, 26 Oct 2021 23:19:37 +0200
Subject: [PATCH] Note future YangErrorInfo evolution

We need to evolve this contract based on experience gained during
implementation.

Change-Id: I20597ae15830386c13d9b4df4cc0a5942d77ff0c
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>
---
 .../opendaylight/yangtools/yang/data/api/YangErrorInfo.java  | 5 +++++
 .../yangtools/yang/data/api/YangNetconfError.java            | 5 +++++
 2 files changed, 10 insertions(+)

diff --git a/data/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/YangErrorInfo.java b/data/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/YangErrorInfo.java
index 5677776de4..531df3f826 100644
--- a/data/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/YangErrorInfo.java
+++ b/data/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/YangErrorInfo.java
@@ -21,7 +21,11 @@ import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
  */
 @Beta
 @NonNullByDefault
+// FIXME: 8.0.0: Split this into two interfaces + scenery:
+//               - yang.common.ErrorInfoRepresentation
+//               - make NormalizedNodeContainer implement ErrorInfoRepresentation
 public final class YangErrorInfo {
+    // FIXME: 8.0.0: implies it extends ErrorInfoRepresentation, but ... perhaps NormalizedErrorInfo
     private final DataContainerChild value;
 
     private YangErrorInfo(final DataContainerChild value) {
@@ -32,6 +36,7 @@ public final class YangErrorInfo {
         return new YangErrorInfo(value);
     }
 
+    // FIXME: 8.0.0: yang.common version returns ErrorInfoRepresentation
     public DataContainerChild value() {
         return value;
     }
diff --git a/data/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/YangNetconfError.java b/data/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/YangNetconfError.java
index fb29012956..3a751e79bc 100644
--- a/data/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/YangNetconfError.java
+++ b/data/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/YangNetconfError.java
@@ -29,6 +29,9 @@ import org.opendaylight.yangtools.yang.common.ErrorType;
 @Value.Style(stagedBuilder = true, allowedClasspathAnnotations = {
     SuppressWarnings.class, Generated.class, SuppressFBWarnings.class,
 })
+// FIXME: 8.0.0: Split this interface into two:
+//               - yang.common.NetconfError, which does not have a builder sets up the stage
+//               - data.api.schema.NormalizedNetconfError
 public interface YangNetconfError {
     /**
      * Return this error's severity.
@@ -72,6 +75,7 @@ public interface YangNetconfError {
      *
      * @return Triggering path, or null.
      */
+    // FIXME: 8.0.0: yang.common returns concepts.HierarchicalIdentifier<?>
     @Nullable YangInstanceIdentifier path();
 
     /**
@@ -79,5 +83,6 @@ public interface YangNetconfError {
      *
      * @return Additional info.
      */
+    // FIXME: 8.0.0: return NetconfErrorInfoRepresentation
     List<YangErrorInfo> info();
 }
-- 
2.36.6