Merge branch 'bug_17292/api_documentation_is_lacking_of_a_json_based_…

…update_of_rule_directive_pr' into branches/rudder/6.0

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

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