edits to obj descriptions

specification/resources/monitoring/models/destination.yml

@@ -4,7 +4,7 @@ required:
 properties:
   id:
     type: string
-    description: "A uuid uniquely identifying a destination"
+    description: "A unique identifier for a destination."
     example: "01f30bfa-319a-4769-ba95-9d43971fb514"
   name:
     type: string

specification/resources/monitoring/models/destination_omit_credentials.yml

@@ -2,7 +2,7 @@ type: object
 properties:
   id:
     type: string
-    description: "A uuid uniquely identifying a destination"
+    description: "A unique identifier for a destination."
     example: "01f30bfa-319a-4769-ba95-9d43971fb514"
   name:
     type: string

specification/resources/monitoring/models/opensearch_config.yml

@@ -4,11 +4,11 @@ required:
 properties:
   id:
     type: string
-    description: "A uuid uniquely identifying a configuration"
+    description: "A unique identifier for a configuration."
     example: "41078d41-165c-4cff-9f0a-19536e3e3d49"
   credentials:
     type: object
-    description: "credentials for Opensearch cluster user. Optional if `cluster_uuid` is passed."
+    description: "Credentials for an OpenSearch cluster user. Optional if `cluster_uuid` is passed."
     properties:
       username:
         type: string
@@ -19,20 +19,20 @@ properties:
   endpoint:
     type: string
     example: "example.com"
-    description: "host of the Opensearch cluster"
+    description: "host of the OpenSearch cluster"
   cluster_uuid:
     type: string
     example: "85148069-7e35-4999-80bd-6fa1637ca385"
-    description: "Uuid of managed Opensearch cluster"
+    description: "A unique identifier for a managed OpenSearch cluster."
   cluster_name:
     type: string
     example: "managed_dbaas_cluster"
-    description: "Name of managed Opensearch cluster"
+    description: "Name of a managed OpenSearch cluster."
   index_name:
     type: string
-    description: "Opensearch index to send logs"
+    description: "OpenSearch index to send logs to."
     example: "logs"
   retention_days:
     type: integer
-    description: "Number of days to retain logs in Opensearch (default: 14)"
+    description: "Number of days to retain logs in OpenSearch (default: 14)"
     example: 14

specification/resources/monitoring/models/opensearch_config_omit_credentials.yml

@@ -3,7 +3,7 @@ description: "Opensearch destination configuration with `credentials` omitted."
 properties:
   id:
     type: string
-    description: "A uuid uniquely identifying a configuration"
+    description: "A unique identifier for a configuration."
     example: "41078d41-165c-4cff-9f0a-19536e3e3d49"
   endpoint:
     type: string
@@ -12,14 +12,14 @@ properties:
   cluster_uuid:
     type: string
     example: "85148069-7e35-4999-80bd-6fa1637ca385"
-    description: "Uuid of managed Opensearch cluster"
+    description: "A unique identifier for a managed OpenSearch cluster."
   cluster_name:
     type: string
     example: "managed_dbaas_cluster"
-    description: "Name of managed Opensearch cluster"
+    description: "Name of a managed OpenSearch cluster."
   index_name:
     type: string
-    description: "Opensearch index to send logs"
+    description: "OpenSearch index to send logs to."
     example: "logs"
   retention_days:
     type: integer

specification/resources/monitoring/models/opensearch_config_request.yml

@@ -4,7 +4,7 @@ required:
 properties:
   credentials:
     type: object
-    description: "credentials for Opensearch cluster user. Optional if `cluster_uuid` is passed."
+    description: "Credentials for an OpenSearch cluster user. Optional if `cluster_uuid` is passed."
     properties:
       username:
         type: string
@@ -19,18 +19,19 @@ properties:
   cluster_uuid:
     type: string
     example: "85148069-7e35-4999-80bd-6fa1637ca385"
-    description: "Uuid of managed Opensearch cluster"
+    description: "A unique identifier for a managed OpenSearch cluster."
   cluster_name:
     type: string
     example: "managed_dbaas_cluster"
-    description: "Name of managed Opensearch cluster"
+    description: "Name of a managed OpenSearch cluster."
   index_name:
     type: string
-    description: "Opensearch index to send logs"
+    description: "OpenSearch index to send logs to."
     example: "logs"
   retention_days:
     type: integer
-    description: "Number of days to retain logs in Opensearch (default: 14)"
+    description: "Number of days to retain logs in an OpenSearch cluster."
     example: 14
+    default: 14
 
 

specification/resources/monitoring/models/sinks_response.yml

@@ -6,6 +6,6 @@ properties:
     $ref: '../models/destination.yml'
   resources:
     type: array
-    description: "list of resources identified by urn"
+    description: "List of resources identified by their URNs."
     items:
       $ref: '../models/sink_resource.yml'

specification/resources/monitoring/monitoring_create_sink.yml

@@ -37,10 +37,10 @@ requestBody:
           destination_uuid:
             type: string
             example: "9df2b7e9-3fb2-4577-b60a-e9c0d53f9a99"
-            description: "uuid of an already-existing destination"
+            description: "A unique identifier for an already-existing destination."
           resources:
             type: array
-            description: "list of resources identified by urn"
+            description: "List of resources identified by their URNs."
             items:
               $ref: 'models/sink_resource.yml'
 

specification/resources/monitoring/parameters.yml

@@ -28,7 +28,7 @@ load_balancer_id:
 resource_id:
   in: query
   name: resource_id
-  description: A unique urn for a resource.
+  description: A unique URN for a resource.
   schema:
     $ref: '../../shared/attributes/urn.yml' 
   example: do:kubernetes:5ba4518b-b9e2-4978-aa92-2d4c727e8824
@@ -94,7 +94,7 @@ alert_uuid:
 destination_uuid:
   in: path
   name: destination_uuid
-  description: A unique identifier for a detination.
+  description: A unique identifier for a destination.
   required: true
   schema:
     type: string

specification/resources/monitoring/responses/destination.yml

@@ -1,4 +1,4 @@
-description: The response will be a JSON object with a `destination` key.
+description: The response is a JSON object with a `destination` key.
 
 headers:
   ratelimit-limit:

specification/resources/monitoring/responses/list_sinks.yml

@@ -1,4 +1,4 @@
-description: The response will be a JSON object with a `sinks` key.
+description: The response is a JSON object with a `sinks` key.
 
 headers:
   ratelimit-limit:
@@ -14,6 +14,6 @@ content:
       properties:
         sinks:
           type: array
-          description: "list of sinks identified by urn"
+          description: "List of sinks identified by their URNs."
           items:
             $ref: '../models/sinks_response.yml'

specification/resources/monitoring/responses/monitoring_list_destinations.yml

@@ -1,4 +1,4 @@
-description: The response will be a JSON object with a `destinations` key.
+description: The response is a JSON object with a `destinations` key.
 
 headers:
   ratelimit-limit:

specification/resources/monitoring/responses/sinks.yml

@@ -1,4 +1,4 @@
-description: The response will be a JSON object with a `sink` key.
+description: The response is a JSON object with a `sink` key.
 
 headers:
   ratelimit-limit: