CPS-461 Align DataNode for Get and Post/Put endpoints in CPS Core

CPS-461 - Getting issue details... STATUS

Introduction

Yang module used for testing

module stores {
    yang-version 1.1;
    namespace "org:onap:ccsdk:sample";

    prefix book-store;

    revision "2020-09-15" {
        description
        "Sample Model";
    }

    typedef year {
        type uint16 {
            range "1000..9999";
        }
    }

    container bookstore {

        leaf bookstore-name {
            type string;
        }

    list categories {

        key "code";

        leaf code {
            type string;
        }

        leaf name {
            type string;
        }

        list books {
            key title;

            leaf title {
                type string;
            }
            leaf lang {
                type string;
            }
            leaf-list authors {
                type string;
            }
            leaf pub_year {
                type year;
            }
            leaf price {
                type uint64;
            }
        }
    }
    }
}

It has been noted that the json content for read and write requests in CPS-Core is inconsistent

Solution

For the JSON output of Get DataNode we need to alter the DataMapUtils class. The function toDataMap translates a datanode object to a JSON output. We only want this to occur on the top node and as such we can create a new method which is called before toDataMap:

public static Map<String, Object> toDataMapTopNode(final DataNode dataNode) {
    final String nodeName = dataNode.getXpath().substring(dataNode.getXpath().lastIndexOf('/') + 1)
        .replaceAll("\\[.*?\\]", "");
    return ImmutableMap.<String, Object>builder().put(nodeName,
        toDataMap(dataNode)
    ).build();
}

We only want the container name on the top level of the JSON output and as such have to distinguish between a top level node and non top level node. We create an outer map to wrap the inner map which creates the appropriate levels in the JSON output. 

This produces the following response in the Post Request output:

Tests would need to be updated to accept the new JSON output which is returned. Examples would need to be updated in openapi

Backwards Compatibility 

Queries which use toDataMap:

Outstanding issues: