Merge branch 'main' into DEVDOCS-6355

Author: chris-nowicki

reference/store_logs.v3.yml

@@ -38,19 +38,21 @@ paths:
                   meta:
                     $ref: '#/components/schemas/IndexMeta'
       parameters:
-        - schema:
+        - name: limit
+          in: query
+          schema:
             type: integer
             default: 50
-          in: query
-          name: limit
           description: Query parameter that lets you return the number of results displayed per page.
-        - schema:
+        - name: page
+          in: query
+          schema:
             type: integer
             default: 1
-          in: query
-          name: page
           description: Query parameter that lets you specify the starting page in which results are returned.
-        - schema:
+        - name: type
+          in: query
+          schema:
             type: string
             enum: 
               - general
@@ -61,59 +63,69 @@ paths:
               - emailintegration
               - ordersettings
               - design
-          in: query
-          name: type
           description: Query parameter that lets you filter the results by log type.
-        - schema:
-            type: string
+        - name: 'type:not'
           in: query
-          name: 'type:not'
+          schema:
+            type: string
           description: Query parameter that lets you exclude a log type from the results.
-        - schema:
+        - name: module
+          in: query
+          schema:
             type: string
             enum:
               - export+only
               - email+message
               - theme+download
               - order+status
               - optimized+checkout
-          in: query
-          name: module
           description: Query parameter that lets you filter the results by module.
-        - schema:
-            type: string
+        - name: 'module:not'
           in: query
-          name: 'module:not'
+          schema:
+            type: string
           description: Query parameter that lets you exclude a log module from the results.
-        - schema:
+        - name: severity
+          in: query
+          schema:
             type: integer
             enum:
               - 1
               - 2
               - 3
               - 4
-          in: query
-          name: severity
           description: 'Query parameter that lets you filter results by severity level, as an integer. The following values are possible: Success = 1, Notice = 2, Warning = 3, Error = 4'
-        - schema:
-            type: integer
+        - name: 'severity:min'
           in: query
-          name: 'severity:min'
-          description: 'Query parameter that lets you filter by minimum severity, as an integer.'
-        - schema:
+          schema:
             type: integer
+          description: 'Query parameter that lets you filter by minimum severity, as an integer.'
+        - name: 'severity:max'
           in: query
-          name: 'severity:max'
+          schema:
+            type: integer
           description: 'Query parameter that lets you filter by maximum severity, as an integer.'
-        - schema:
+        - name: 'id:in'
+          in: query
+          schema:
             type: array
             items:
               type: integer
           style: form
           explode: false
-          in: query
-          name: 'id:in'
           description: 'A comma-separated list of log IDs by which to filter. For example, `?id:in=3,4,6`.'
+        - name: 'sort'
+          in: query
+          schema:
+            type: string
+            enum: ['date_created','type']
+          description: 'The log key by which to sort results. If left blank, results will be reported in order of creation. This parameter is case-sensitive.'
+        - name: 'direction'
+          in: query
+          schema:
+            type: string
+            enum: ['asc','desc']
+          description: 'The direction in which to sort results. Defaults to ascending (`asc`). This parameter is case-sensitive.'
     parameters: []
 components:
   schemas: