docs: Update CoreData API doc

Update CoreData API doc and fix format

Signed-off-by: bruce <[email protected]>

Author: weichou1229

openapi/core-data.yaml

@@ -351,6 +351,15 @@ components:
         minimum: 0
         default: 0
       description: "The number of items to skip before starting to collect the result set."
+    readingOffsetParam:
+      in: query
+      name: offset
+      required: false
+      schema:
+        type: integer
+        minimum: 0
+        default: 0
+      description: "The number of items to skip before starting to collect the result set. Specify -1 will not count the total reading to improve the performance for the large dataset."
     limitParam:
       in: query
       name: limit
@@ -1138,7 +1147,7 @@ paths:
   /reading/all:
     parameters:
       - $ref: '#/components/parameters/correlatedRequestHeader'
-      - $ref: '#/components/parameters/offsetParam'
+      - $ref: '#/components/parameters/readingOffsetParam'
       - $ref: '#/components/parameters/limitParam'
     get:
       summary: "Given the entire range of readings sorted by origin descending, returns a portion of that range according to the offset and limit parameters. Readings returned will all inherit from BaseReading but their concrete types will be either SimpleReading or BinaryReading, potentially interleaved."
@@ -1280,7 +1289,7 @@ paths:
       schema:
         type: string
       description: "Uniquely identifies a given device"
-    - $ref: '#/components/parameters/offsetParam'
+    - $ref: '#/components/parameters/readingOffsetParam'
     - $ref: '#/components/parameters/limitParam'
     get:
       summary: "Given a range of readings from the specified device sorted by origin descending, returns a portion of that range according to the device name, offset and limit parameters."
@@ -1344,7 +1353,7 @@ paths:
       schema:
         type: string
       description: The device resource name of readings.
-    - $ref: '#/components/parameters/offsetParam'
+    - $ref: '#/components/parameters/readingOffsetParam'
     - $ref: '#/components/parameters/limitParam'
     get:
       summary: Returns a paginated list of readings whose resource name is of the specified one.
@@ -1416,7 +1425,7 @@ paths:
         schema:
           type: string
         description: The device resource name of readings.
-      - $ref: '#/components/parameters/offsetParam'
+      - $ref: '#/components/parameters/readingOffsetParam'
       - $ref: '#/components/parameters/limitParam'
     get:
       summary: "Returns a paginated range of readings by deviceName and resourceName"
@@ -1488,7 +1497,7 @@ paths:
         schema:
           type: integer
         description: "Unix timestamp (nanoseconds) indicating the end of a date/time range"
-      - $ref: '#/components/parameters/offsetParam'
+      - $ref: '#/components/parameters/readingOffsetParam'
       - $ref: '#/components/parameters/limitParam'
     get:
       summary: "Return a paginated range of readings with a create date inside the specified start/end values."
@@ -1566,7 +1575,7 @@ paths:
         schema:
           type: integer
         description: "Unix timestamp (nanoseconds) indicating the end of a date/time range"
-      - $ref: '#/components/parameters/offsetParam'
+      - $ref: '#/components/parameters/readingOffsetParam'
       - $ref: '#/components/parameters/limitParam'
     get:
       summary: "Return a paginated range of readings by resourceName and specified time range."
@@ -1650,7 +1659,7 @@ paths:
         schema:
           type: integer
         description: "Unix timestamp (nanoseconds) indicating the end of a date/time range"
-      - $ref: '#/components/parameters/offsetParam'
+      - $ref: '#/components/parameters/readingOffsetParam'
       - $ref: '#/components/parameters/limitParam'
     get:
       summary: "Return a paginated range of readings by deviceName, resourceName and specified time range."
@@ -1728,20 +1737,10 @@ paths:
         schema:
           type: integer
         description: "Unix timestamp (nanoseconds) indicating the end of a date/time range"
-      - $ref: '#/components/parameters/offsetParam'
+      - $ref: '#/components/parameters/readingOffsetParam'
       - $ref: '#/components/parameters/limitParam'
     get:
       summary: "Return a paginated range of readings by deviceName and specified time range while also allowing multiple resource names specified in the request body as query criteria.  If resource names or request body is empty, return all the readings that meet deviceName and specified time range."
-      requestBody:
-        required: false
-        content:
-          application/json:
-            schema:
-              $ref: '#/components/schemas/AddEventRequest'
-            example:
-              resourceNames:
-                - resource-001
-                - resource-002
       responses:
         '200':
           description: "OK"

openapi/core-metadata.yaml

@@ -1178,16 +1178,16 @@ components:
       required: false
       schema:
         type: boolean
+        default: false
       description: "Indicates whether to skip the Device Service Validation API call."
-      default: false
     forceParam:
       in: query
       name: force
       required: false
       schema:
         type: boolean
+        default: false
       description: "Indicates whether to force add the device if device name already exists."
-      default: false
   headers:
     correlatedResponseHeader:
       description: "A response header that returns the unique correlation ID used to initiate the request."