From b729e87176cab8f31e52102158c4ad92ee99d3a9 Mon Sep 17 00:00:00 2001
From: Xi Chen <xichen@uber.com>
Date: Tue, 20 Dec 2016 15:58:29 -0500
Subject: [PATCH] Add Markdown file to describe wire format for encoded metrics

---
 protocol/msgpack/schema.go       | 22 ---------
 protocol/msgpack/unaggregated.md | 83 ++++++++++++++++++++++++++++++++
 2 files changed, 83 insertions(+), 22 deletions(-)
 create mode 100644 protocol/msgpack/unaggregated.md

diff --git a/protocol/msgpack/schema.go b/protocol/msgpack/schema.go
index 027ab63..489db56 100644
--- a/protocol/msgpack/schema.go
+++ b/protocol/msgpack/schema.go
@@ -18,28 +18,6 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 // THE SOFTWARE.
 
-/*
-
-The message-pack based encoder uses the following schema for encoding objects:
-
-current encoder version
-encoded object
-
-When encoding an object, the encoder first writes the number of fields to be
-encoded for the object, and then writes each object field. If an object field
-is also an object, the encoder encodes that field recursively.
-
-Backward-compatible changes (e.g., adding an additional field to the end of
-the object) can be deployed or rolled back separately on the client-side and
-the server-side. It is unnecessary to increase the version for
-backward-compatible changes.
-
-Backward-incompatible changes (e.g., removing a field or changing a field type)
-must be deployed to the server-side first then to the client-side. It is REQUIRED
-to increase the version for backward-incompatible changes.
-
-*/
-
 package msgpack
 
 type objectType int
diff --git a/protocol/msgpack/unaggregated.md b/protocol/msgpack/unaggregated.md
new file mode 100644
index 0000000..ab385cd
--- /dev/null
+++ b/protocol/msgpack/unaggregated.md
@@ -0,0 +1,83 @@
+## Wire format
+
+* Message format
+  * Version
+  * Number of root object fields
+  * Root object type
+  * Root object (can be one of the following):
+    * CounterWithPolicies
+    * BatchTimerWithPolicies
+    * GaugeWithPolicies
+
+* CounterWithPolicies format
+  * Number of CounterWithPolicies fields
+  * Counter object
+  * VersionedPolicies object
+
+* BatchTimerWithPolicies format
+  * Number of BatchTimerWithPolicies fields
+  * BatchTimer object
+  * VersionedPolicies object
+
+* GaugeWithPolicies format
+  * Number of GaugeWithPolicies fields
+  * Gauge object
+  * VersionedPolicies object
+
+* Counter object
+  * Number of Counter fields
+  * Counter ID
+  * Counter value
+
+* BatchTimer object
+  * Number of BatchTimer fields
+  * BatchTimer ID
+  * BatchTimer values
+
+* Gauge object
+  * Number of Gauge fields
+  * Gauge ID
+  * Gauge value
+
+* VersionedPolicies object
+  * Number of VersionedPolicies fields
+  * Versioned Policies type
+  * Versioned Policies (can be one of the following)
+    * DefaultVersionedPolicies
+    * CustomVersionedPolicies
+      * Version
+      * List of Policy objects
+
+* Policy object
+  * Number of Policy fields
+  * Resolution object
+  * Retention object
+
+* Resolution object
+  * Number of Resolution fields
+  * Resolution type
+  * Resolution (can be one of the following)
+    * KnownResolution
+      * ResolutionValue
+    * UnknownResolution
+      * Resolution window
+      * Resolution precision
+
+* Retention object
+  * Number of Retention fields
+  * Retention type
+  * Retention (can be one of the following)
+    * KnownRetention
+      * RetentionValue
+    * UnknownRetention
+      * Retention duration
+
+## Schema changes
+
+Backward-compatible changes (e.g., adding an additional field to the end of an object) can be
+deployed or rolled back separately on the client-side and the server-side. It is unnecessary to
+increase the version for backward-compatible changes.
+
+Backward-incompatible changes (e.g., removing a field or changing a field type) must be deployed
+to the server-side first then to the client-side. It is REQUIRED to increase the version for
+backward-incompatible changes.
\ No newline at end of file