Usage

info

Please note that this content is under development and is not ready for implementation. This status message will be updated as content development progresses.

Once you have configured the test suite, you can run it to validate your UNTP credentials.

Running the Test Suite

To run the test suite with the configuration defined in the Configuration section:

yarn run untp test

To use a specific configuration file:

yarn run untp test --config path/to/credentials.json

Test Results

The test suite validates each credential against its corresponding schema and provides a summary of results.

Result Overview

For each tested credential, if you input a local schema file you will see:

• Credential type (Required)
• Version tested (Required)
• URL (Optional)
• Test result status

or if you input a remote schema URL you will see:

• Credential type (Optional)
• Version tested (Optional)
• URL of the remote schema (Required)
• Test result status

Result Categories

1. Pass: The credential fully conforms to the core UNTP data model without extensions.

2. Warn: The credential conforms to the core UNTP data model but includes extensions.

   • Review your extensions to ensure they are intentional.

3. Fail: The credential does not conform to the core UNTP data model.

   • Review and address each error to ensure compliance.

Detailed Feedback

For warnings and failures, you will receive:

• Specific properties causing issues
• Brief descriptions of each problem
• Suggestions for resolution (where applicable)

Next Steps

After successfully validating your credentials, you may want to explore extending the UNTP data model for your specific use case in the next section.