[OSPP] Submitted the delta and cumulative API design plan, (#478)

* [OSPP] Submitted the delta and cumulative API design plan, which has passed the lint check * Update write.proto * fix the check --------- Co-authored-by: Gao Hongtao <[email protected]>
apache · Jul 2, 2024 · e721073 · e721073
1 parent c5f67ab
commit e721073
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 0 deletions.
diff --git a/api/proto/banyandb/measure/v1/write.proto b/api/proto/banyandb/measure/v1/write.proto
@@ -38,6 +38,16 @@ message DataPointValue {
   repeated model.v1.FieldValue fields = 3;
   // the version of the data point
   int64 version = 4;
+  // the type of the data point cumulative or delta
+  enum Type {
+    // TYPE_UNSPECIFIED is the default value.
+    TYPE_UNSPECIFIED = 0;
+    // TYPE_CUMULATIVE is the cumulative data
+    TYPE_CUMULATIVE = 1;
+    // TYPE_DELTA is the delta data
+    TYPE_DELTA = 2;
+  }
+  Type type = 5;
 }
 
 // WriteRequest is the request contract for write

diff --git a/docs/api-reference.md b/docs/api-reference.md
@@ -181,6 +181,8 @@
     - [WriteRequest](#banyandb-measure-v1-WriteRequest)
     - [WriteResponse](#banyandb-measure-v1-WriteResponse)
 
+    - [DataPointValue.Type](#banyandb-measure-v1-DataPointValue-Type)
+
 - [banyandb/measure/v1/rpc.proto](#banyandb_measure_v1_rpc-proto)
     - [MeasureService](#banyandb-measure-v1-MeasureService)
 
@@ -2640,6 +2642,7 @@ DataPointValue is the data point for writing. It only contains values.
 | tag_families | [banyandb.model.v1.TagFamilyForWrite](#banyandb-model-v1-TagFamilyForWrite) | repeated | the order of tag_families&#39; items match the measure schema |
 | fields | [banyandb.model.v1.FieldValue](#banyandb-model-v1-FieldValue) | repeated | the order of fields match the measure schema |
 | version | [int64](#int64) |  | the version of the data point |
+| type | [DataPointValue.Type](#banyandb-measure-v1-DataPointValue-Type) |  |  |
 
 
 
@@ -2699,6 +2702,19 @@ WriteResponse is the response contract for write
 
 
 
+
+<a name="banyandb-measure-v1-DataPointValue-Type"></a>
+
+### DataPointValue.Type
+the type of the data point cumulative or delta
+
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| TYPE_UNSPECIFIED | 0 | TYPE_UNSPECIFIED is the default value. |
+| TYPE_CUMULATIVE | 1 | TYPE_CUMULATIVE is the cumulative data |
+| TYPE_DELTA | 2 | TYPE_DELTA is the delta data |
+
+