aboutsummaryrefslogtreecommitdiff
path: root/vendor/github.com/container-orchestrated-devices/container-device-interface/pkg/cdi/doc.go
diff options
context:
space:
mode:
authorOpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com>2022-04-13 09:24:55 -0400
committerGitHub <noreply@github.com>2022-04-13 09:24:55 -0400
commitf6ce14b066ad57a86642f22c15ac42020fc0f660 (patch)
tree1ee9865c5b8f662750bb18782aad6b080bbac44b /vendor/github.com/container-orchestrated-devices/container-device-interface/pkg/cdi/doc.go
parent8586b4856fb2b3de8aed45300ce8ec324f5f6bcd (diff)
parent20384b03790097c1fe4c01cc7d249552db37466e (diff)
downloadpodman-f6ce14b066ad57a86642f22c15ac42020fc0f660.tar.gz
podman-f6ce14b066ad57a86642f22c15ac42020fc0f660.tar.bz2
podman-f6ce14b066ad57a86642f22c15ac42020fc0f660.zip
Merge pull request #13852 from elezar/bump-cdi-0.3.2
build(deps) bump github.com/container-orchestrated-devices/container-device-interface from 0.3.0 to 0.3.2
Diffstat (limited to 'vendor/github.com/container-orchestrated-devices/container-device-interface/pkg/cdi/doc.go')
-rw-r--r--vendor/github.com/container-orchestrated-devices/container-device-interface/pkg/cdi/doc.go20
1 files changed, 20 insertions, 0 deletions
diff --git a/vendor/github.com/container-orchestrated-devices/container-device-interface/pkg/cdi/doc.go b/vendor/github.com/container-orchestrated-devices/container-device-interface/pkg/cdi/doc.go
index 4fcdc44db..a9017259c 100644
--- a/vendor/github.com/container-orchestrated-devices/container-device-interface/pkg/cdi/doc.go
+++ b/vendor/github.com/container-orchestrated-devices/container-device-interface/pkg/cdi/doc.go
@@ -127,4 +127,24 @@
// The default directories are '/etc/cdi' and '/var/run/cdi'. By putting
// dynamically generated Spec files under '/var/run/cdi', those take
// precedence over static ones in '/etc/cdi'.
+//
+// CDI Spec Validation
+//
+// This package performs both syntactic and semantic validation of CDI
+// Spec file data when a Spec file is loaded via the registry or using
+// the ReadSpec API function. As part of the semantic verification, the
+// Spec file is verified against the CDI Spec JSON validation schema.
+//
+// If a valid externally provided JSON validation schema is found in
+// the filesystem at /etc/cdi/schema/schema.json it is loaded and used
+// as the default validation schema. If such a file is not found or
+// fails to load, an embedded no-op schema is used.
+//
+// The used validation schema can also be changed programmatically using
+// the SetSchema API convenience function. This function also accepts
+// the special "builtin" (BuiltinSchemaName) and "none" (NoneSchemaName)
+// schema names which switch the used schema to the in-repo validation
+// schema embedded into the binary or the now default no-op schema
+// correspondingly. Other names are interpreted as the path to the actual
+/// validation schema to load and use.
package cdi