Project

General

Profile

Actions

User story #3294

closed

User story #3000: Build a REST API to manage all actions in Rudder (CRUD on Nodes, Groups, Directives and Rules)

Rest API : Directives

Added by Vincent MEMBRÉ about 11 years ago. Updated about 9 years ago.

Status:
Released
Priority:
2
Category:
API
Target version:
UX impact:
Suggestion strength:
User visibility:
Effort required:
Name check:
Fix check:
Regression:

Description

Following #3280, we should add an API based on the same model used for Rules

A first version of the API is :

  • List Directives
  • Display Directive Detail
  • Delete Directive
  • Clone Directive
  • Enable Directive
  • Disable Directive
Actions #1

Updated by Vincent MEMBRÉ about 11 years ago

A first version of the API (based on the same format as #3280):

  • List Directives
    • GET
    • /api/directives
    • Answer: list of availables Directives with following format :
      "directive":{
        "id": id
        "displayName": name
      }
      
  • See a Directive Details
    • GET
    • /api/directives/id
    • Answer: directive information, based on the following format :
      {"directive":{
        "id":Directive id,
        "displayName":Directive name,
        "shortDescription":short description,
        "longDescription":long description,
        "techniqueName":Technique name,
        "techniqueVersion":Technique version used,
        "parameters": based on a format described below
        "priority":priority,
        "isEnabled":boolean,
        "isSystem":boolean
        }
      }
      

directives parameters are descibed by this pattern :

{"section":{
  "name":section name
  "vars": array of :
    "var":{
      "name":var name
      "value":var value
    }
  "subsections": array of section
  }
}
  • Delete Directive
    • DELETE
    • /api/directives/delete/id
    • Answer: The rule has been deleted
  • Clone Directive
    • Put
    • /api/directives/clone/id
    • Answer: The new created Directive details (on the same format than the rule details)
  • Enable Directive
    • Put
    • /api/directives/enable/id
    • Answer : The Directive has been enabled
  • Disable Directive
    • Put
    • /api/directives/disable/id
    • Answer: The rule has been disabled
Actions #2

Updated by Vincent MEMBRÉ about 11 years ago

  • Tracker changed from Bug to Enhancement
Actions #3

Updated by Vincent MEMBRÉ about 11 years ago

  • Status changed from New to In progress
Actions #4

Updated by Jonathan CLARKE about 11 years ago

  • Category changed from 11 to API
Actions #5

Updated by Vincent MEMBRÉ about 11 years ago

  • Status changed from In progress to 10
  • Assignee changed from Vincent MEMBRÉ to Jonathan CLARKE

Going to functionnal review for this first version.

Actions #6

Updated by Nicolas PERRON about 11 years ago

  • Target version changed from 2.6.0~beta1 to 2.6.0~rc1
Actions #7

Updated by Jonathan CLARKE almost 11 years ago

  • Target version changed from 2.6.0~rc1 to 2.7.0~beta1
Actions #8

Updated by François ARMAND almost 11 years ago

  • Status changed from 10 to Pending technical review
  • Assignee changed from Jonathan CLARKE to François ARMAND
Actions #9

Updated by Vincent MEMBRÉ almost 11 years ago

  • Status changed from Pending technical review to Pending release
  • % Done changed from 0 to 100
Actions #10

Updated by Nicolas PERRON over 10 years ago

  • Status changed from Pending release to Released
Actions #11

Updated by Benoît PECCATTE about 9 years ago

  • Tracker changed from Enhancement to User story
Actions

Also available in: Atom PDF