From b9b696b757a8821aef034c4c9ebebc38a4ed35ea Mon Sep 17 00:00:00 2001
From: Felix Dallidet <felix.dallidet@normation.com>
Date: Wed, 29 Apr 2020 14:38:41 +0200
Subject: [PATCH] Fixes #17292: API documentation is lacking of a Json based
 update of rule/directive

---
 .../code_samples/curl/rules/update_json.sh    |  1 +
 .../components/schemas/rule-update.yml        | 50 +++++++++++++++++++
 2 files changed, 51 insertions(+)
 create mode 100644 webapp/sources/api-doc/code_samples/curl/rules/update_json.sh
 create mode 100644 webapp/sources/api-doc/components/schemas/rule-update.yml

diff --git a/webapp/sources/api-doc/code_samples/curl/rules/update_json.sh b/webapp/sources/api-doc/code_samples/curl/rules/update_json.sh
new file mode 100644
index 00000000000..5d7dbbf41a0
--- /dev/null
+++ b/webapp/sources/api-doc/code_samples/curl/rules/update_json.sh
@@ -0,0 +1 @@
+curl --header "X-API-Token: yourToken" --header "Content-Type: application/json" --request POST 'https://rudder.example.com/rudder/api/latest/rules/17dadf50-6056-4c8b-a935-6b97d14b89a7' --d @payload
diff --git a/webapp/sources/api-doc/components/schemas/rule-update.yml b/webapp/sources/api-doc/components/schemas/rule-update.yml
new file mode 100644
index 00000000000..50e08e1868f
--- /dev/null
+++ b/webapp/sources/api-doc/components/schemas/rule-update.yml
@@ -0,0 +1,50 @@
+type: object
+properties:
+  id:
+    type: string
+    description: Rule id
+    example: 0c1713ae-cb9d-4f7b-abda-ca38c5d643ea
+    format: uuid
+  displayName:
+    type: string
+    example: Security policy
+    description: Rule name
+  shortDescription:
+    type: string
+    example: Baseline applying CIS guidelines
+    description: One line rule description
+  longDescription:
+    type: string
+    example: This rules should be applied to all Linux nodes required basic hardening
+    description: Rule documentation
+  directives:
+    type: array
+    description: Directives linked to the rule
+    items:
+      type: string
+      description: "Directive id"
+  targets:
+    type: array
+    description: Groups linked to the rule
+    items:
+      type: string
+      description: "Group id"
+  enabled:
+    type: boolean
+    description: Is the rule enabled
+    example: true
+  system:
+    type: boolean
+    description: If true it is an internal Rudder rule
+    example: false
+  tags:
+    type: array
+    items:
+      type: object
+      properties:
+        name:
+          type: string
+          description: Value of the `name` key
+          example: value
+      example:
+        customer: MyCompany