feat(core): add /schemas/vaults/:name endpoint

changelog/unreleased/kong/11727.yml

@@ -0,0 +1,3 @@
+message: "Add a new endpoint `/schemas/vaults/:name` to retrieve the schema of a vault."
+type: feature
+scope: Core

kong/api/routes/kong.lua

@@ -183,6 +183,19 @@ return {
       return validate_schema(db_entity_name, self.params)
     end
   },
+
+  ["/schemas/vaults/:name"] = {
+    GET = function(self, db, helpers)
+      local subschema = kong.db.vaults.schema.subschemas[self.params.name]
+      if not subschema then
+        return kong.response.exit(404, { message = "No vault named '"
+                                  .. self.params.name .. "'" })
+      end
+      local copy = api_helpers.schema_to_jsonable(subschema)
+      strip_foreign_schemas(copy.fields)
+      return kong.response.exit(200, copy)
+    end
+  },
   ["/schemas/plugins/:name"] = {
     GET = function(self, db, helpers)
       local subschema = kong.db.plugins.schema.subschemas[self.params.name]

kong/vaults/env/schema.lua

@@ -5,7 +5,7 @@ return {
       config = {
         type = "record",
         fields = {
-          { prefix = { type = "string", match = [[^[%a_-][%a%d_-]*$]] } },
+          { prefix = { type = "string", match = [[^[%a_-][%a%d_-]*$]], description = "The prefix for the environment variable that the value will be stored in." } },
         },
       },
     },

spec/02-integration/04-admin_api/02-kong_routes_spec.lua

@@ -462,6 +462,30 @@ describe("Admin API - Kong routes with strategy #" .. strategy, function()
     end)
   end)
 
+  describe("/schemas/vaults/:name", function()
+    it("returns schema of all vaults", function()
+      for _, vault in ipairs({"env"}) do
+        local res = assert(client:send {
+          method = "GET",
+          path = "/schemas/vaults/" .. vault,
+        })
+        local body = assert.res_status(200, res)
+        local json = cjson.decode(body)
+        assert.is_table(json.fields)
+      end
+    end)
+
+    it("returns 404 on a non-existent vault", function()
+      local res = assert(client:send {
+        method = "GET",
+        path = "/schemas/vaults/not-present",
+      })
+      local body = assert.res_status(404, res)
+      local json = cjson.decode(body)
+      assert.same({ message = "No vault named 'not-present'" }, json)
+    end)
+  end)
+
   describe("/schemas/:entity", function()
     it("returns schema of all plugins", function()
       for plugin, _ in pairs(helpers.test_conf.loaded_plugins) do