summaryrefslogtreecommitdiffstats
path: root/pmdictionaryvalidation/README.md
blob: 2bc91a55c6c472fdb189addc93b334ce69e7a772 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
PMDictionary Validation
=======================
This module can be used as a library to validate pmdictionary against the schema (schema is the first document in the file).

How to use PMDictionary validation library
------------------------------------------
VNF-SDK validation library (pmdictionaryvalidation) should be used to validate the PM_Dictionary file.
    Below dependency should be added to the required modules in your project.

        <dependency>
            <groupId>org.onap.vnfsdk.validation</groupId>
            <artifactId>validation-pmdictionary</artifactId>
            <version>version</version>
        </dependency>

How to validate PMDictionary
--------------------------
1.Validate PMDictionary from a path to the file.

    new YamlContentValidator().validate(pathToFile)

2.Validate PMDictionary file from the byte array.

    new YamlContentValidator().validate(fileContentAsByteArray)

Above methods return list of YamlDocumentValidationError(empty list for no errors) or throw YamlProcessingException/YAMLException when something goes wrong.