chore(plugins): tweak names in config-file format (#73)

Kong · Jul 12, 2023 · f36b02d · f36b02d
1 parent c8250aa
commit f36b02d
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 9 deletions.
diff --git a/plugins/plugin-file.yml b/plugins/plugin-file.yml
@@ -5,11 +5,11 @@ _format_version: "1.0"
 
 # plugins is an array of plugin operations, to be applied in order
 # for now only "add" is supported
-plugins:
+add-plugins:
   - selectors:            # defaults to ["$"]
     - "$.services[*]"
     overwrite: false      # defaults to false
-    add-plugins:
+    plugins:
     - name: key-auth
       config:
         key_names: [api_key, apikey]

diff --git a/plugins/pluginfile.go b/plugins/pluginfile.go
@@ -39,9 +39,9 @@ func (patch *AddPluginPatch) Parse(patchData map[string]interface{}, source stri
 		return fmt.Errorf("%s.selectors: %w", source, err)
 	}
 
-	patch.Plugins, err = jsonbasics.GetObjectArrayField(patchData, "add-plugins")
+	patch.Plugins, err = jsonbasics.GetObjectArrayField(patchData, "plugins")
 	if err != nil {
-		return fmt.Errorf("%s.add-plugins is not an array; %w", source, err)
+		return fmt.Errorf("%s.plugins is not an array; %w", source, err)
 	}
 
 	patch.Overwrite = false
@@ -99,14 +99,14 @@ func (pluginFile *DeckPluginFile) ParseFile(filename string) error {
 		logbasics.Debug("parsed unversioned plugin-file", "file", filename)
 	}
 
-	patchesRead, err := jsonbasics.GetObjectArrayField(data, "plugins")
+	patchesRead, err := jsonbasics.GetObjectArrayField(data, "add-plugins")
 	if err != nil {
-		return fmt.Errorf("%s: field 'plugins' is not an array; %w", filename, err)
+		return fmt.Errorf("%s: field 'add-plugins' is not an array; %w", filename, err)
 	}
 
 	for i, patch := range patchesRead {
 		var addPluginPatch AddPluginPatch
-		err := addPluginPatch.Parse(patch, fmt.Sprintf("%s: plugins[%d]", filename, i))
+		err := addPluginPatch.Parse(patch, fmt.Sprintf("%s: add-plugins[%d]", filename, i))
 		if err != nil {
 			return err
 		}

diff --git a/plugins/pluginfile_test.go b/plugins/pluginfile_test.go
@@ -18,7 +18,7 @@ var _ = Describe("plugin files", func() {
 							"$.services[*]"
 						],
 						"overwrite": true,
-						"add-plugins": [{
+						"plugins": [{
 							"name": "my-plugin"
 						}]
 					}`))
@@ -75,7 +75,7 @@ var _ = Describe("plugin files", func() {
 					{
 						"selectors": ["$.services[*]"],
 						"overwrite": true,
-						"add-plugins": [{
+						"plugins": [{
 							"name": "my-other-plugin"
 						}]
 					}`)), "test")