Add REST call to list repair actions for a pair
Reported by Ben Hood | September 28th, 2010 @ 08:48 AM | in 0.8
The UI needs to
- Show available repair options for an event/pair
- Invoke a repair option and then show the result
So the way this will work is that
- The client will be able to request a list of actions that can
be invoked on a pair. This action can either be:
- An RPC to the agent, in which case the each action will have
these attributes:
- Name - an identifier
- Type - the type will be "rpc"
- Action - a REST URL to the agent that has a mandatory entity id attribute
- Method - the HTTP method for the action
- An external link to a UI for more complicated repair actions.
It has these attributes:
- Name - see above
- Type - "external"
- Link - a link to the external application with the mandatory entity id attribute
- An RPC to the agent, in which case the each action will have
these attributes:
The REST API should look like this:
Request:
GET /fastdiff-agent/pair/${pairId}/actions
Response (eg, after request to
/fastdiff-agent/pair/PAIR-1/actions):
[
{"name":"Resend Source", "type":"rpc", "action":"/fastdiff-agent/pair/PAIR-1/action/foo/${id}", "method":"POST"},
{"name":"Console", "type":"external", "action":"http://someapp/entities/${id}"},
]
RPC Result:
{
"result":"success",
"output":"foo"
} {
"result":"error",
"output":"bar"
}
Comments and changes to this ticket
-
Ben Hood September 28th, 2010 @ 08:50 AM
- Title changed from “Add REST call to list repair actions for a participant” to “Add REST call to list repair actions for a pair”
-
Ben Hood September 28th, 2010 @ 08:50 AM
- Tag set to “repairs”
-
Ben Hood September 28th, 2010 @ 08:54 AM
- State changed from “new” to “open”
-
Ben Hood September 28th, 2010 @ 11:28 AM
I've added the Actions resource to the REST API and have regenerated the website - I've attached the Jekyll output to this ticket.
-
Ben Hood September 28th, 2010 @ 11:30 AM
Please also note that the site I generated has the colon stripped out of it - see #40
-
Ben Hood September 28th, 2010 @ 12:21 PM
For the 0.8 release we will only offer one action - resend and this will be hard coded. The reason for this is because there is a fair bit of config that we'd need to do to wire this in a dynamic sense. Issue #43 talks about having a scriptable config , which we'll implement, but for the initial release keeping it simple will do the trick.
-
Ben Hood September 28th, 2010 @ 06:09 PM
- State changed from “open” to “closed”
I've hardcoded the resend action into the upstream participant -> hence closing this particular issue.
-
Jonathan Lister October 7th, 2010 @ 12:51 PM
- Milestone order changed from “3” to “0”
Note:
This endpoint is:
diffa-agent/rest/actions/WEB-1Not:
diffa-agent/rest/pair/WEB-1/actions
Please Sign in or create a free account to add a new ticket.
With your very own profile, you can contribute to projects, track your activity, watch tickets, receive and update tickets through your email and much more.
Create new ticket
Create your profile
Help contribute to this project by taking a few moments to create your personal profile. Create your profile ยป
A Real Time Differencing Tool.
People watching this ticket
Ben Hood
Tags
Referenced by
-
51
Make participant actions configurable via the REST API
Ticket #39 exposed the Actions API, but provided no real
...
-
51
Make participant actions configurable via the REST API
Ticket #39 exposed the Actions API, but provided no real
...