(skywalking-banyandb) branch main updated: [OSPP] Submitted the delta and cumulative API design plan, (#478)

[hanahmily]

This is an automated email from the ASF dual-hosted git repository.

hanahmily pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/skywalking-banyandb.git


The following commit(s) were added to refs/heads/main by this push:
     new e7210733 [OSPP] Submitted the delta and cumulative API design plan, 
(#478)
e7210733 is described below

commit e7210733022566cd0cee7ea2dc12cfb2f30fa8f3
Author: Su Yijun <45656504+sumingfi...@users.noreply.github.com>
AuthorDate: Tue Jul 2 11:19:47 2024 +0800

    [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 <hanahm...@gmail.com>
---
 api/proto/banyandb/measure/v1/write.proto | 10 ++++++++++
 docs/api-reference.md                     | 16 ++++++++++++++++
 2 files changed, 26 insertions(+)

diff --git a/api/proto/banyandb/measure/v1/write.proto 
b/api/proto/banyandb/measure/v1/write.proto
index ea43dc59..35493efe 100644
--- 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
index c4107a80..b837540d 100644
--- 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 |
+
+