Add minor proto changes in AvailablePackageDetail (#3033)

* Add minor changes in AvailablePackageDetail * Update buf deps * Add generated files * Rename package_ref to available_package_ref * Add generated files
vmware-tanzu · Jun 24, 2021 · d6f065a · d6f065a
1 parent 4547597
commit d6f065a
Show file tree

Hide file tree

Showing 9 changed files with 274 additions and 238 deletions.
diff --git a/cmd/kubeapps-apis/buf.lock b/cmd/kubeapps-apis/buf.lock
@@ -4,9 +4,9 @@ deps:
     owner: beta
     repository: googleapis
     branch: main
-    commit: 2e73676eef8642dfba4ed782b7c8d6fe
-    digest: b1-vB11w98W2vFtEP4Veknm56Pi6DU6MpOuocESiOzvbqw=
-    create_time: 2021-04-26T14:55:30.644663Z
+    commit: 0b3d38cadbda4132b7dcc48e0701f23b
+    digest: b1-YCqrJ4Lyb1DPIAIg8uM48fWjWKNXFXriiozLrpC2f0c=
+    create_time: 2021-06-21T22:00:26.369819Z
   - remote: buf.build
     owner: grpc-ecosystem
     repository: grpc-gateway

diff --git a/cmd/kubeapps-apis/docs/kubeapps-apis.swagger.json b/cmd/kubeapps-apis/docs/kubeapps-apis.swagger.json
@@ -715,13 +715,16 @@
       "type": "object",
       "properties": {
         "typeUrl": {
-          "type": "string"
+          "type": "string",
+          "description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n  value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n  URL, or have them precompiled into a binary to avoid any\n  lookup. Therefore, binary compatibility needs to be preserved\n  on changes to types. (Use versioned type names to manage\n  breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics."
         },
         "value": {
           "type": "string",
-          "format": "byte"
+          "format": "byte",
+          "description": "Must be a valid serialized protocol buffer of the above specified type."
         }
-      }
+      },
+      "description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n    Foo foo = ...;\n    Any any;\n    any.PackFrom(foo);\n    ...\n    if (any.UnpackTo(\u0026foo)) {\n      ...\n    }\n\nExample 2: Pack and unpack a message in Java.\n\n    Foo foo = ...;\n    Any any = Any.pack(foo);\n    ...\n    if (any.is(Foo.class)) {\n      foo = any.unpack(Foo.class);\n    }\n\n Example 3: Pack and unpack a message in Python.\n\n    foo = Foo(...)\n    any = Any()\n    any.Pack(foo)\n    ...\n    if any.Is(Foo.DESCRIPTOR):\n      any.Unpack(foo)\n      ...\n\n Example 4: Pack and unpack a message in Go\n\n     foo := \u0026pb.Foo{...}\n     any, err := anypb.New(foo)\n     if err != nil {\n       ...\n     }\n     ...\n     foo := \u0026pb.Foo{}\n     if err := any.UnmarshalTo(foo); err != nil {\n       ...\n     }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n    package google.profile;\n    message Person {\n      string first_name = 1;\n      string last_name = 2;\n    }\n\n    {\n      \"@type\": \"type.googleapis.com/google.profile.Person\",\n      \"firstName\": \u003cstring\u003e,\n      \"lastName\": \u003cstring\u003e\n    }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n    {\n      \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n      \"value\": \"1.212s\"\n    }"
     },
     "rpcStatus": {
       "type": "object",
@@ -744,7 +747,7 @@
     "v1alpha1AvailablePackageDetail": {
       "type": "object",
       "properties": {
-        "packageRef": {
+        "availablePackageRef": {
           "$ref": "#/definitions/v1alpha1AvailablePackageReference",
           "description": "A reference uniquely identifying the package.",
           "title": "Available package reference"
@@ -756,9 +759,14 @@
         },
         "version": {
           "type": "string",
-          "description": "TODO: add description",
+          "description": "The version of the package (eg. chart version)",
           "title": "Available package version"
         },
+        "appVersion": {
+          "type": "string",
+          "description": "The version of the packaged application (eg. wordpress version or whatever).",
+          "title": "Available package app version"
+        },
         "iconUrl": {
           "type": "string",
           "description": "A url for an icon.",
@@ -776,18 +784,21 @@
         },
         "longDescription": {
           "type": "string",
-          "description": "A long description of the package, such as a README formatted with Markdown.",
+          "description": "A longer description of the package, a few sentences.",
           "title": "Available package long description"
         },
+        "readme": {
+          "type": "string",
+          "description": "A longer README with potentially pages of formatted Markdown.",
+          "title": "Available package readme"
+        },
         "defaultValues": {
           "type": "string",
           "description": "An example of default values used during package templating that can serve\nas documentation or a starting point for user customization.",
           "title": "Available package default values"
         },
         "valuesSchema": {
-          "type": "string",
-          "description": "An optional openapi/json schema that can be used to validate a user-provided values.",
-          "title": "Available package values schema"
+          "type": "string"
         },
         "maintainers": {
           "type": "array",
@@ -797,14 +808,10 @@
           "description": "List of Maintainer",
           "title": "Available package maintainers"
         },
-        "opaqueData": {
-          "type": "object",
-          "additionalProperties": {
-            "type": "string",
-            "format": "byte"
-          },
-          "description": "A plugin can define further key-values for data which does not (yet) fit\nwith the core.packaging.AvailablePackageDetail.",
-          "title": "Available package opaque data"
+        "customDetail": {
+          "$ref": "#/definitions/protobufAny",
+          "description": "Some additional information added by the plugin",
+          "title": "Custom data added by the plugin"
         }
       },
       "description": "An AvailablePackageDetail provides additional details required when\ninspecting an individual package.",