Correcting OpenAPI response for GET logsink (#1114)

* created response without wrapper sink obj

* fixed lint issue

* added modular code

Author: DO-rrao

specification/resources/databases/databases_get_logsink.yml

@@ -15,8 +15,8 @@ parameters:
   - $ref: "parameters.yml#/logsink_id"
 
 responses:
-  "201":
-    $ref: "responses/logsink.yml"
+  "200":
+    $ref: "responses/logsink_data.yml"
 
   "401":
     $ref: "../../shared/responses/unauthorized.yml"
@@ -38,4 +38,4 @@ x-codeSamples:
 
 security:
   - bearer_auth:
-    - 'database:read'
+      - "database:read"

specification/resources/databases/databases_list_logsink.yml

@@ -14,7 +14,7 @@ parameters:
   - $ref: "parameters.yml#/database_cluster_uuid"
 
 responses:
-  "201":
+  "200":
     $ref: "responses/logsinks.yml"
 
   "401":
@@ -37,4 +37,4 @@ x-codeSamples:
 
 security:
   - bearer_auth:
-    - 'database:read'
+      - "database:read"

specification/resources/databases/responses/logsink.yml

@@ -13,13 +13,7 @@ content:
     schema:
       properties:
         sink:
-          allOf:
-            - $ref: "../models/logsink_verbose.yml"
-          required:
-            - sink_id
-            - sink_name
-            - sink_type
-            - config
+          $ref: "logsink_schema.yml"
     examples:
       Create an opensearch logsink:
         value:

specification/resources/databases/responses/logsink_data.yml

@@ -0,0 +1,43 @@
+description: A JSON object with logsink properties.
+
+headers:
+  ratelimit-limit:
+    $ref: "../../../shared/headers.yml#/ratelimit-limit"
+  ratelimit-remaining:
+    $ref: "../../../shared/headers.yml#/ratelimit-remaining"
+  ratelimit-reset:
+    $ref: "../../../shared/headers.yml#/ratelimit-reset"
+
+content:
+  application/json:
+    schema:
+      $ref: "logsink_schema.yml"
+    examples:
+      Get an opensearch logsink:
+        value:
+          sink_id: "dfcc9f57d86bf58e321c2c6c31c7a971be244ac7"
+          sink_name: "logs-sink"
+          sink_type: "opensearch"
+          config:
+            url: https://user:passwd@192.168.0.1:25060
+            index_prefix: "opensearch-logs"
+            index_days_max: 5
+      Get an elasticsearch logsink:
+        value:
+          sink_id: "dfcc9f57d86bf58e321c2c6c31c7a971be244ac7"
+          sink_name: "logs-sink"
+          sink_type: "elasticsearch"
+          config:
+            url: https://user:passwd@192.168.0.1:25060
+            index_prefix: "elasticsearch-logs"
+            index_days_max: 5
+      Get a rsyslog logsink:
+        value:
+          sink_id: "dfcc9f57d86bf58e321c2c6c31c7a971be244ac7"
+          sink_name: logs-sink
+          sink_type: rsyslog
+          config:
+            server: 192.168.0.1
+            port: 514
+            tls: false
+            format: rfc5424

specification/resources/databases/responses/logsink_schema.yml

@@ -0,0 +1,7 @@
+allOf:
+  - $ref: "../models/logsink_verbose.yml"
+required:
+  - sink_id
+  - sink_name
+  - sink_type
+  - config

specification/resources/databases/responses/logsinks.yml

@@ -15,13 +15,7 @@ content:
         sinks:
           type: array
           items:
-            allOf:
-              - $ref: "../models/logsink_verbose.yml"
-            required:
-              - sink_id
-              - sink_name
-              - sink_type
-              - config
+            $ref: "logsink_schema.yml"
     example:
       sinks:
         - sink_id: 799990b6-d551-454b-9ffe-b8618e9d6272