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É almost 12 years ago.
Updated over 9 years ago.
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
A first version of the API (based on the same format as #3280):
- 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
- Tracker changed from Bug to Enhancement
- Status changed from New to In progress
- Category changed from 11 to API
- Status changed from In progress to 10
- Assignee changed from Vincent MEMBRÉ to Jonathan CLARKE
Going to functionnal review for this first version.
- Target version changed from 2.6.0~beta1 to 2.6.0~rc1
- Target version changed from 2.6.0~rc1 to 2.7.0~beta1
- Status changed from 10 to Pending technical review
- Assignee changed from Jonathan CLARKE to François ARMAND
- Status changed from Pending technical review to Pending release
- % Done changed from 0 to 100
- Status changed from Pending release to Released
- Tracker changed from Enhancement to User story
Also available in: Atom
PDF