Skip to content
This repository has been archived by the owner on Mar 5, 2020. It is now read-only.

Commit

Permalink
Merge pull request #33 from VinceMacBuche/ust_8639/add_documentation_…
Browse files Browse the repository at this point in the history
…on_new_techniques_and_check_directive_api

Fixes #8639: Add documentation on new techniques and check directive API
  • Loading branch information
VinceMacBuche committed Jul 8, 2016
2 parents 4331623 + e841613 commit 328da39
Show file tree
Hide file tree
Showing 2 changed files with 763 additions and 0 deletions.
27 changes: 27 additions & 0 deletions src/api_v2/directive.md
Original file line number Diff line number Diff line change
Expand Up @@ -425,4 +425,31 @@ https://github.com/Normation/rudder/blob/master/rudder-web/src/main/scala/com/no



*/

[POST] api/directives/{id}/check
--------------------------

/**
@api {post} /api/directives/{id}/check 7. Check that update on a Directive is valid
@apiVersion 2.0.0
@apiName checkDirective
@apiGroup Directives
@apiUse directiveId

@apiParam (Mono) {String} [displayName] Name of the Directive to create.
@apiParam (Mono) {String} [shortDescription] Short description of the Directive.
@apiParam (Mono) {String} [longDescription] Long description of the Directive.
@apiParam (Mono) {JSON} [parameters] Directive parameters.
@apiParam (Mono) {Boolean} [enabled] Enable/disable the Directive.
@apiParam (Mono) {Int} [priority] Directive priority. Determine which value to use if there is Directives based on the same technique applied to a Node.
@apiParam (Mono) {TechniqueVersion} [techniqueVersion] Technique Version.

@apiExample Example usage:
// Update display name:
curl -H "X-API-Token: yourToken" -X POST http://rudder.example.com/rudder/api/latest/directives/DirectiveID/check -d "displayName=Name of New Directive"



*/
Loading

0 comments on commit 328da39

Please sign in to comment.