Skip to content

Commit be28b8e

Browse files
committed
Add off-line validation desc. for supported schemas to README
Signed-off-by: Matt Rutkowski <[email protected]>
1 parent 5f6e6b8 commit be28b8e

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

README.md

+7-3
Original file line numberDiff line numberDiff line change
@@ -318,11 +318,16 @@ See each command's section for contextual examples of the `--where` flag filter
318318

319319
### Validate
320320

321-
This command will parse standardized SBOMs and validate it against its declared format and version (e.g., SPDX 2.3, CycloneDX 1.6). Custom variants of standard JSON schemas can be used for validation by supplying the `--variant` name as a flag. Explicit JSON schemas can be specified using the `--force` flag.
321+
This command will parse standardized SBOMs and validate it against its declared format and version (e.g., SPDX 2.3, CycloneDX 1.6).
322+
323+
Custom variants of standard JSON schemas can be used for validation by supplying the `--variant` name as a flag. Explicit JSON schemas can be specified using the `--force` flag.
322324

323325
#### Validating using supported schemas
324326

325-
Use the [schema](#schema) command to list supported schemas formats, versions and variants.
327+
Use the [schema](#schema) command to list supported schemas formats, versions and variants.
328+
329+
- A "supported" schema is already **"built-in"** to the utility resources along with any dependent schemas it imports.
330+
- This means that BOM files **can be validated when there is no network connection** to load the schemas from remote locations (a.k.a., *"off-line"* mode).
326331

327332
#### Validating using "custom" schemas
328333

@@ -333,7 +338,6 @@ Customized JSON schemas can also be permanently configured as named schema "vari
333338
- **"Customized" schema** variants, perhaps derived from standard BOM schemas, can be used for validation using the `--variant` flag (e.g., industry or company-specific schemas).
334339
- **Note**: *These variants need to be built into the utility binary as a resource.*
335340

336-
337341
#### Validate flags
338342

339343
The following flags can be used to improve performance when formatting error output results:

0 commit comments

Comments
 (0)