Rudder

Here is an example of Rule API:

• List Rules
  • /api/rules

• Add a Rule
  • /api/rules/add/{name}
• Delete a Rule
  • /api/rules/delete/{id}

• See a Rule Details
  • /api/rules/{id}

• Change Rule name
  • /api/rules/{id}/rename/{name}
• Short description
  • /api/rules/{id}/description/short/{description}
• Long description
  • /api/rules/{id}/description/long/{description}

• List Groups
  • /api/rules/{id}/groups
• Add Group
  • /api/rules/{id}/groups/add/{groupId}
• Remove Group
  • /api/rules/{id}/groups/remove/{groupId}

• List Directives
  • /api/rules/{id}/directives
• Add Directive
  • /api/rules/{id}/directives/add/{groupId}
• Remove Directive
  • /api/rules/{id}/directives/remove/{groupId}

• Activate Rule
  • /api/rules/{id}/on
  • /api/rules/activate/{id}

• Desactivate Rule
  • /api/rules/{id}/off
  • /api/rules/desactivate/{id}

• Clone Rule
  • /api/rules/clone§/{id}

I propose having a standard response for all the REST API looking like this :

{
  Called function:{
    "id": Target id,
    "status": Answer Status (Ok or Error),
    "message": The answer or an error message
  }
}

A first version of the API containing only:

• List Rules
  • GET
  • /api/rules
  • Answer: list of availables Rules with following format :
    "rule":{
    "id": id
    "displayName": name
    }

• Voir le détail d'une Rule
  • GET
  • /api/rules/id
  • Answer: rule information, based on the following format :
    "rule":{
    "id": id,
    "displayName": name,
    "serial":serial,
    "shortDescription": short,
    "longDescription": long,
    "directiveIds": list of Directives id,
    "targets": list of target groups,
    "isEnabled": boolean,
    "isSystem": boolean
    }

• Delete Rule
  • DELETE
  • /api/rules/delete/id
  • Answer: The rule has been deleted

• Clone Rule
  • Put
  • /api/rules/clone/id
  • Answer: The new created Rule details (on the same format than the rule details)

• Enable Rule
  • Put
  • /api/rules/enable/id
  • Answer : The Rule has been enabled

• Disable Rule
  • Put
  • /api/rules/disable/id
  • Answer: The rule has been disabled