LP-1362664 :: Rename actionDoc Payload to Parameters

johnweldon · johnweldon · commit fc35dfd500a6 · 2014-09-01T07:49:04.000-07:00
diff --git a/state/action.go b/state/action.go
@@ -60,9 +60,9 @@ type actionDoc struct {
 	// match an action defined by the unit's charm.
 	Name string `bson:"name"`
 
-	// Payload holds the action's parameters, if any; it should validate
+	// Parameters holds the action's parameters, if any; it should validate
 	// against the schema defined by the named action in the unit's charm
-	Payload map[string]interface{} `bson:"payload"`
+	Parameters map[string]interface{} `bson:"parameters"`
 }
 
 // Action represents an instruction to do some "action" and is expected
@@ -111,11 +111,11 @@ func (a *Action) Name() string {
 	return a.doc.Name
 }
 
-// Payload will contain a structure representing arguments or parameters to
+// Parameters will contain a structure representing arguments or parameters to
 // an action, and is expected to be validated by the Unit using the Charm
 // definition of the Action
-func (a *Action) Payload() map[string]interface{} {
-	return a.doc.Payload
+func (a *Action) Parameters() map[string]interface{} {
+	return a.doc.Parameters
 }
 
 // ActionResults is a data transfer object that holds the key Action
@@ -165,7 +165,7 @@ func newActionDoc(st *State, ar ActionReceiver, actionName string, parameters ma
 	if err != nil {
 		return actionDoc{}, err
 	}
-	return actionDoc{Id: actionId, Name: actionName, Payload: parameters}, nil
+	return actionDoc{Id: actionId, Name: actionName, Parameters: parameters}, nil
 }
 
 var ensureActionMarker = ensureSuffixFn(actionMarker)
diff --git a/state/action_test.go b/state/action_test.go
@@ -75,7 +75,7 @@ func (s *ActionSuite) TestAddAction(c *gc.C) {
 
 	// verify we get out what we put in
 	c.Assert(action.Name(), gc.Equals, name)
-	c.Assert(action.Payload(), jc.DeepEquals, params)
+	c.Assert(action.Parameters(), jc.DeepEquals, params)
 }
 
 func (s *ActionSuite) TestAddActionAcceptsDuplicateNames(c *gc.C) {
@@ -105,7 +105,7 @@ func (s *ActionSuite) TestAddActionAcceptsDuplicateNames(c *gc.C) {
 
 	action2, err := s.State.Action(a2.Id())
 	c.Assert(err, gc.IsNil)
-	c.Assert(action2.Payload(), jc.DeepEquals, params2)
+	c.Assert(action2.Parameters(), jc.DeepEquals, params2)
 
 	// verify only one left, and it's the expected one
 	actions, err = s.unit.Actions()
diff --git a/state/actionresult.go b/state/actionresult.go
@@ -124,7 +124,7 @@ func newActionResultDoc(a *Action, finalStatus ActionStatus, results map[string]
 	return actionResultDoc{
 		Id:         id,
 		ActionName: a.doc.Name,
-		Parameters: a.doc.Payload,
+		Parameters: a.doc.Parameters,
 		Status:     finalStatus,
 		Results:    results,
 		Message:    message,
diff --git a/state/apiserver/uniter/uniter.go b/state/apiserver/uniter/uniter.go
@@ -815,7 +815,7 @@ func (u *UniterAPI) getOneActionByTag(tag names.ActionTag) (params.ActionsQueryR
 
 	result.Action = &params.Action{
 		Name:   action.Name(),
-		Params: action.Payload(),
+		Params: action.Parameters(),
 	}
 	return result, nil
 }

Original file line number	Diff line number	Diff line change
`@@ -60,9 +60,9 @@ type actionDoc struct {`
`60`	`60`	`// match an action defined by the unit's charm.`
`61`	`61`	Name string `bson:"name"`
`62`	`62`
`63`		`- // Payload holds the action's parameters, if any; it should validate`
	`63`	`+ // Parameters holds the action's parameters, if any; it should validate`
`64`	`64`	`// against the schema defined by the named action in the unit's charm`
`65`		- Payload map[string]interface{} `bson:"payload"`
	`65`	+ Parameters map[string]interface{} `bson:"parameters"`
`66`	`66`	`}`
`67`	`67`
`68`	`68`	`// Action represents an instruction to do some "action" and is expected`
`@@ -111,11 +111,11 @@ func (a *Action) Name() string {`
`111`	`111`	`return a.doc.Name`
`112`	`112`	`}`
`113`	`113`
`114`		`-// Payload will contain a structure representing arguments or parameters to`
	`114`	`+// Parameters will contain a structure representing arguments or parameters to`
`115`	`115`	`// an action, and is expected to be validated by the Unit using the Charm`
`116`	`116`	`// definition of the Action`
`117`		`-func (a *Action) Payload() map[string]interface{} {`
`118`		`- return a.doc.Payload`
	`117`	`+func (a *Action) Parameters() map[string]interface{} {`
	`118`	`+ return a.doc.Parameters`
`119`	`119`	`}`
`120`	`120`
`121`	`121`	`// ActionResults is a data transfer object that holds the key Action`
`@@ -165,7 +165,7 @@ func newActionDoc(st *State, ar ActionReceiver, actionName string, parameters ma`
`165`	`165`	`if err != nil {`
`166`	`166`	`return actionDoc{}, err`
`167`	`167`	`}`
`168`		`- return actionDoc{Id: actionId, Name: actionName, Payload: parameters}, nil`
	`168`	`+ return actionDoc{Id: actionId, Name: actionName, Parameters: parameters}, nil`
`169`	`169`	`}`
`170`	`170`
`171`	`171`	`var ensureActionMarker = ensureSuffixFn(actionMarker)`
Original file line number	Diff line number	Diff line change
`@@ -815,7 +815,7 @@ func (u *UniterAPI) getOneActionByTag(tag names.ActionTag) (params.ActionsQueryR`
`815`	`815`
`816`	`816`	`result.Action = &params.Action{`
`817`	`817`	`Name: action.Name(),`
`818`		`- Params: action.Payload(),`
	`818`	`+ Params: action.Parameters(),`
`819`	`819`	`}`
`820`	`820`	`return result, nil`
`821`	`821`	`}`