Enhance Rule#18 Disallow YANG LISTs with Over-lapping Keys

[wen587]

Enhance Rule#18 in guideline to better describe rule requirement and make YANG LIST unique.

[wen587]

@dgsudharsan could you help review?

[qiluo-msft]

@NanQiSweeper Could you also help review?

[NanQiSweeper]

@wen587 In example 3, "keys with same number of elements and different type", if the different types here are sufficiently distinguished, is it supported? For example, both lists have only one key and different type.

typedef report-type {
    type enumeration {
        enum periodic;
        enum stream;
        enum once;
    }
}
typedef encoding {
    type enumeration {
        enum JSON_IETF;
        enum ASCII;
        enum BYTES;
        enum PROTO;
    }
}    
container EXAMPLE {
    list LIST_1 {  // 1st list
        key "report_type";
        leaf report_type {
            type report-type;
        }
    }
    list LIST_2 { // 2st list
        key "encoding";
        leaf encoding {
            type encoding;
        }
    }
}

[NanQiSweeper]

@NanQiSweeper Could you also help review?
Sure, I would be happy to help with the review.

[wen587]

@wen587 In example 3, "keys with same number of elements and different type", if the different types here are sufficiently distinguished, is it supported? For example, both lists have only one key and different type.

typedef report-type {
    type enumeration {
        enum periodic;
        enum stream;
        enum once;
    }
}
typedef encoding {
    type enumeration {
        enum JSON_IETF;
        enum ASCII;
        enum BYTES;
        enum PROTO;
    }
}    
container EXAMPLE {
    list LIST_1 {  // 1st list
        key "report_type";
        leaf report_type {
            type report-type;
        }
    }
    list LIST_2 { // 2st list
        key "encoding";
        leaf encoding {
            type encoding;
        }
    }
}

Hi @NanQiSweeper , I believe no.
When using GCU(Generic Config Updater) to add or remove entry, it always match to the LIST_1 as it only compares the length of key.

[NanQiSweeper]

@wen587 In example 3, "keys with same number of elements and different type", if the different types here are sufficiently distinguished, is it supported? For example, both lists have only one key and different type.

typedef report-type {
    type enumeration {
        enum periodic;
        enum stream;
        enum once;
    }
}
typedef encoding {
    type enumeration {
        enum JSON_IETF;
        enum ASCII;
        enum BYTES;
        enum PROTO;
    }
}    
container EXAMPLE {
    list LIST_1 {  // 1st list
        key "report_type";
        leaf report_type {
            type report-type;
        }
    }
    list LIST_2 { // 2st list
        key "encoding";
        leaf encoding {
            type encoding;
        }
    }
}

Hi @NanQiSweeper , I believe no. When using GCU(Generic Config Updater) to add or remove entry, it always match to the LIST_1 as it only compares the length of key.

@wen587 @qiluo-msft I get it, I have no more questions.

[wen587]

@sachinholla Hi thanks for you reveiw. Updated in lastest commit. Please help take a look.