api,database: updated version_format documentation.

Version format documentation is updated in the example of feature struct and created in clair.proto along with accordingly generated swagger and protobuf files. Fixes #514
quay · Feb 2, 2018 · a75b8ac · a75b8ac
1 parent 52a42b8
commit a75b8ac
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 6 deletions.
diff --git a/api/v3/clairpb/clair.pb.go b/api/v3/clairpb/clair.pb.go
diff --git a/api/v3/clairpb/clair.proto b/api/v3/clairpb/clair.proto
@@ -45,6 +45,9 @@ message Feature{
 	string name = 1;
 	string namespace_name = 2;
 	string version = 3;
+
+	// version_format is the format used by installer package manager to store
+	// package versions.
 	string version_format = 4;
 	repeated Vulnerability vulnerabilities = 5;
 }

diff --git a/api/v3/clairpb/clair.swagger.json b/api/v3/clairpb/clair.swagger.json
@@ -232,7 +232,8 @@
           "type": "string"
         },
         "version_format": {
-          "type": "string"
+          "type": "string",
+          "description": "version_format is the format used by installer package manager to store\npackage versions."
         },
         "vulnerabilities": {
           "type": "array",

diff --git a/database/models.go b/database/models.go
@@ -71,8 +71,8 @@ type Namespace struct {
 // determined.
 //
 // e.g. Name: OpenSSL, Version: 1.0, VersionFormat: dpkg.
-// dpkg implies the installer package manager but the namespace (might be
-// debian:7, debian:8, ...) could not be determined.
+// dpkg is the version format of the installer package manager, which in this
+// case could be dpkg or apk.
 type Feature struct {
 	Name          string
 	Version       string