@lansweeper/data-platform-outbound-grpc 0.0.2 → 0.0.3

package/gen-proto/outbound_grpc_pb.js

@@ -2,11 +2,11 @@
 
 // Original file comments:
 // *
-// Copyright Lansweper (c)
+// Copyright Lansweeper (c)
 //
-// This files contains
+// This files contains the Data Access API and the definition of outbound model
 //
-// https://github.com/pseudomuto/protoc-gen-doc
+// N.B. This file has been documented using the specification available here: https://github.com/pseudomuto/protoc-gen-doc
 'use strict';
 var grpc = require('@grpc/grpc-js');
 var outbound_pb = require('./outbound_pb.js');
@@ -59,6 +59,10 @@ function deserialize_com_lansweeper_dp_outboundapi_v1_ListEntityResponse(buffer_
 
 // ----- Service Part ------
 //
+// *
+// GRPC Service. Currently supported operation:
+//   - Get Entity
+//   - Stream Entities
 var DataCoreOutboundServiceService = exports.DataCoreOutboundServiceService = {
   // Retrieve a single entity by site/inst-id/type/id
 getEntity: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lansweeper/data-platform-outbound-grpc",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "Data Platform Outbound gRPC",
   "main": "gen-proto/index.js",
   "types": "gen-proto/index.d.ts",
@@ -9,5 +9,5 @@
     "@grpc/grpc-js": "^1.5.1",
     "google-protobuf": "^3.17.0"
   },
-  "gitHead": "d4a83e99adabaab53f138bfee7a5da579695c919"
+  "gitHead": "c29a82ff50cbb36b815fe7c92d5936b818178d49"
 }

package/proto/DOC.md

@@ -0,0 +1,591 @@
+# Protocol Documentation
+<a name="top"></a>
+
+## Table of Contents
+
+- [outbound.proto](#outbound-proto)
+    - [Asset](#com-lansweeper-dp-outboundapi-v1-Asset)
+    - [AssetType](#com-lansweeper-dp-outboundapi-v1-AssetType)
+    - [CatalogBrand](#com-lansweeper-dp-outboundapi-v1-CatalogBrand)
+    - [CatalogModel](#com-lansweeper-dp-outboundapi-v1-CatalogModel)
+    - [CatalogMonitor](#com-lansweeper-dp-outboundapi-v1-CatalogMonitor)
+    - [CatalogOs](#com-lansweeper-dp-outboundapi-v1-CatalogOs)
+    - [CatalogSoftware](#com-lansweeper-dp-outboundapi-v1-CatalogSoftware)
+    - [CoreFields](#com-lansweeper-dp-outboundapi-v1-CoreFields)
+    - [Entity](#com-lansweeper-dp-outboundapi-v1-Entity)
+    - [EntityPath](#com-lansweeper-dp-outboundapi-v1-EntityPath)
+    - [GetEntityRequest](#com-lansweeper-dp-outboundapi-v1-GetEntityRequest)
+    - [GetEntityResponse](#com-lansweeper-dp-outboundapi-v1-GetEntityResponse)
+    - [HardwareInfo](#com-lansweeper-dp-outboundapi-v1-HardwareInfo)
+    - [ListEntityRequest](#com-lansweeper-dp-outboundapi-v1-ListEntityRequest)
+    - [ListEntityResponse](#com-lansweeper-dp-outboundapi-v1-ListEntityResponse)
+    - [OperatingSystemInfo](#com-lansweeper-dp-outboundapi-v1-OperatingSystemInfo)
+    - [RawHardwareInfo](#com-lansweeper-dp-outboundapi-v1-RawHardwareInfo)
+    - [RawSoftware](#com-lansweeper-dp-outboundapi-v1-RawSoftware)
+    - [Software](#com-lansweeper-dp-outboundapi-v1-Software)
+    - [SoftwareInventory](#com-lansweeper-dp-outboundapi-v1-SoftwareInventory)
+    - [WindowsRawOperatingSystemInfo](#com-lansweeper-dp-outboundapi-v1-WindowsRawOperatingSystemInfo)
+  
+    - [DataCoreOutboundService](#com-lansweeper-dp-outboundapi-v1-DataCoreOutboundService)
+  
+- [Scalar Value Types](#scalar-value-types)
+
+
+
+<a name="outbound-proto"></a>
+<p align="right"><a href="#top">Top</a></p>
+
+## outbound.proto
+Copyright Lansweeper (c)
+
+This files contains the Data Access API and the definition of outbound model
+
+N.B. This file has been documented using the specification available here: https://github.com/pseudomuto/protoc-gen-doc
+
+
+<a name="com-lansweeper-dp-outboundapi-v1-Asset"></a>
+
+### Asset
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| id | [EntityPath](#com-lansweeper-dp-outboundapi-v1-EntityPath) |  |  |
+| last_synced | [google.protobuf.Timestamp](#google-protobuf-Timestamp) |  |  |
+| first_seen | [google.protobuf.Timestamp](#google-protobuf-Timestamp) |  |  |
+| last_updated | [google.protobuf.Timestamp](#google-protobuf-Timestamp) |  |  |
+| last_enriched | [google.protobuf.Timestamp](#google-protobuf-Timestamp) |  |  |
+| core | [CoreFields](#com-lansweeper-dp-outboundapi-v1-CoreFields) |  |  |
+| hw | [HardwareInfo](#com-lansweeper-dp-outboundapi-v1-HardwareInfo) | optional |  |
+| os | [OperatingSystemInfo](#com-lansweeper-dp-outboundapi-v1-OperatingSystemInfo) | optional |  |
+| software_inventory | [SoftwareInventory](#com-lansweeper-dp-outboundapi-v1-SoftwareInventory) | optional |  |
+
+
+
+
+
+
+<a name="com-lansweeper-dp-outboundapi-v1-AssetType"></a>
+
+### AssetType
+Asset Type enables customers to manage the settings for a
+category of information in a centralized, reusable way.
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| ls_name | [string](#string) |  | Lansweeper Asset Type. Full list available here: /lansweeperapis/packages/model/masterData/content/masterData.json |
+| fing_type | [string](#string) | optional | Fing Type |
+
+
+
+
+
+
+<a name="com-lansweeper-dp-outboundapi-v1-CatalogBrand"></a>
+
+### CatalogBrand
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| id | [int64](#int64) |  |  |
+| make_key | [string](#string) |  |  |
+| make_name | [string](#string) |  |  |
+| override_id | [int64](#int64) | optional |  |
+| parent_id | [int64](#int64) | optional |  |
+| last_update_time | [int64](#int64) | optional |  |
+| country_code | [string](#string) | optional |  |
+| logo_image_url | [string](#string) | optional |  |
+| banner_image_url | [string](#string) | optional |  |
+| wikipedia_id | [string](#string) | optional |  |
+| wikipedia_lang_code | [string](#string) | optional |  |
+| website_url | [string](#string) | optional |  |
+| support_url | [string](#string) | optional |  |
+| support_phone | [string](#string) | optional |  |
+| facebook_account | [string](#string) | optional |  |
+| twitter_account | [string](#string) | optional |  |
+| warranty_url | [string](#string) | optional |  |
+| warranty_direct_url | [string](#string) | optional |  |
+| community_url | [string](#string) | optional |  |
+| linkedin_account | [string](#string) | optional |  |
+| instagram_account | [string](#string) | optional |  |
+| youtube_account | [string](#string) | optional |  |
+| pinterest_account | [string](#string) | optional |  |
+| class_hardware | [bool](#bool) | optional |  |
+| class_software | [bool](#bool) | optional |  |
+| class_consumer | [bool](#bool) | optional |  |
+| class_enterprise | [bool](#bool) | optional |  |
+| class_industrial | [bool](#bool) | optional |  |
+| class_individual | [bool](#bool) | optional |  |
+| match_score | [int32](#int32) | optional | relevant only in search result |
+
+
+
+
+
+
+<a name="com-lansweeper-dp-outboundapi-v1-CatalogModel"></a>
+
+### CatalogModel
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| id | [int64](#int64) |  |  |
+| key | [string](#string) |  |  |
+| make_id | [int64](#int64) |  |  |
+| device_model | [string](#string) |  |  |
+| device_type | [string](#string) | optional |  |
+| device_model_code | [string](#string) | optional |  |
+| override_id | [int64](#int64) | optional |  |
+| os_default_id | [int64](#int64) | optional |  |
+| os_latest_id | [int64](#int64) | optional |  |
+| family_id | [int64](#int64) | optional |  |
+| is_family | [bool](#bool) | optional |  |
+| manual_url | [string](#string) | optional |  |
+| faq_url | [string](#string) | optional |  |
+| release_date | [int64](#int64) | optional |  |
+| disc_date | [int64](#int64) | optional |  |
+| eos_date | [int64](#int64) | optional |  |
+| lifecyle_confidence | [string](#string) | optional |  |
+| price_class | [string](#string) | optional |  |
+| product_class | [string](#string) | optional |  |
+| sh_ifttt_handle | [string](#string) | optional |  |
+| sh_google_ass_langs | [string](#string) | repeated |  |
+| sh_alexa_langs | [string](#string) | repeated |  |
+| sh_hass_handle | [string](#string) | optional |  |
+| sh_apple_home_kit | [bool](#bool) | optional |  |
+| sh_open_hab_handle | [string](#string) | optional |  |
+| nist_cpe | [string](#string) | optional |  |
+| spread_in_type | [double](#double) | optional |  |
+| last_update_time | [int64](#int64) | optional |  |
+| match_score | [int32](#int32) | optional | filled only when a result of search |
+
+
+
+
+
+
+<a name="com-lansweeper-dp-outboundapi-v1-CatalogMonitor"></a>
+
+### CatalogMonitor
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| id | [int64](#int64) |  |  |
+
+
+
+
+
+
+<a name="com-lansweeper-dp-outboundapi-v1-CatalogOs"></a>
+
+### CatalogOs
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| id | [int64](#int64) |  |  |
+| os_key | [string](#string) |  |  |
+| os_name | [string](#string) |  |  |
+| os_version | [string](#string) | optional |  |
+| os_build | [string](#string) | optional |  |
+| os_version_name | [string](#string) | optional |  |
+| override_id | [int64](#int64) | optional |  |
+| make_id | [int64](#int64) | optional |  |
+| parent_id | [int64](#int64) | optional |  |
+| release_date | [int64](#int64) | optional |  |
+| eol_date | [int64](#int64) | optional |  |
+| eos_date | [int64](#int64) | optional |  |
+| eosx_date | [int64](#int64) | optional |  |
+| lifecyle_confidence | [string](#string) | optional |  |
+| logo_image_url | [string](#string) | optional |  |
+| banner_image_url | [string](#string) | optional |  |
+| wikipedia_id | [string](#string) | optional |  |
+| wikipedia_lang_code | [string](#string) | optional |  |
+| website_url | [string](#string) | optional |  |
+| support_url | [string](#string) | optional |  |
+| support_phone | [string](#string) | optional |  |
+| facebook_account | [string](#string) | optional |  |
+| twitter_account | [string](#string) | optional |  |
+| nist_cpe | [string](#string) | optional |  |
+| last_update_time | [int64](#int64) | optional |  |
+| match_score | [int32](#int32) | optional | filled only when a result of search |
+
+
+
+
+
+
+<a name="com-lansweeper-dp-outboundapi-v1-CatalogSoftware"></a>
+
+### CatalogSoftware
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| id | [int64](#int64) |  |  |
+| sw_key | [string](#string) |  |  |
+| sw_name | [string](#string) |  |  |
+| sw_version | [string](#string) | optional |  |
+| sw_market_ver | [string](#string) | optional |  |
+| sw_edition | [string](#string) | optional |  |
+| sw_lang | [string](#string) | optional |  |
+| sw_build | [string](#string) | optional |  |
+| override_id | [int64](#int64) | optional |  |
+| make_id | [int64](#int64) | optional |  |
+| parent_id | [int64](#int64) | optional |  |
+| sw_type | [string](#string) | optional |  |
+| sw_category | [string](#string) | optional |  |
+| nist_cpe_template | [string](#string) | optional |  |
+| release_date | [int64](#int64) | optional |  |
+| eol_date | [int64](#int64) | optional |  |
+| eos_date | [int64](#int64) | optional |  |
+| eosx_date | [int64](#int64) | optional |  |
+| lifecyle_confidence | [string](#string) | optional |  |
+| last_update_time | [int64](#int64) | optional |  |
+| flag_latest | [bool](#bool) | optional |  |
+| flag_widespread | [bool](#bool) | optional |  |
+| flag_deprecated | [bool](#bool) | optional |  |
+| match_score | [int32](#int32) | optional | filled only when a result of search |
+
+
+
+
+
+
+<a name="com-lansweeper-dp-outboundapi-v1-CoreFields"></a>
+
+### CoreFields
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| type | [AssetType](#com-lansweeper-dp-outboundapi-v1-AssetType) |  |  |
+| name | [string](#string) |  |  |
+| domain | [string](#string) | optional |  |
+| ip_address | [string](#string) | optional |  |
+| serial | [string](#string) | optional |  |
+| mac | [string](#string) | optional |  |
+| mac_vendor | [string](#string) | optional |  |
+| sensor_id | [string](#string) | optional |  |
+
+
+
+
+
+
+<a name="com-lansweeper-dp-outboundapi-v1-Entity"></a>
+
+### Entity
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| asset | [Asset](#com-lansweeper-dp-outboundapi-v1-Asset) |  | User user = 2; Other ... |
+
+
+
+
+
+
+<a name="com-lansweeper-dp-outboundapi-v1-EntityPath"></a>
+
+### EntityPath
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| site_id | [string](#string) |  |  |
+| source_id | [string](#string) | optional |  |
+| source_type | [string](#string) | optional | IT, OT, CDK, 3rdParty |
+| entity_type | [string](#string) | optional | &#34;asset&#34; &#34;user&#34; etc |
+| entity_id | [string](#string) | optional |  |
+
+
+
+
+
+
+<a name="com-lansweeper-dp-outboundapi-v1-GetEntityRequest"></a>
+
+### GetEntityRequest
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| entity_path | [EntityPath](#com-lansweeper-dp-outboundapi-v1-EntityPath) |  | bool send_related = 2; // send also related entities |
+
+
+
+
+
+
+<a name="com-lansweeper-dp-outboundapi-v1-GetEntityResponse"></a>
+
+### GetEntityResponse
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| entity | [Entity](#com-lansweeper-dp-outboundapi-v1-Entity) |  |  |
+| related | [Entity](#com-lansweeper-dp-outboundapi-v1-Entity) | repeated |  |
+
+
+
+
+
+
+<a name="com-lansweeper-dp-outboundapi-v1-HardwareInfo"></a>
+
+### HardwareInfo
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| type_id | [int64](#int64) | optional |  |
+| make_id | [int64](#int64) | optional |  |
+| model_id | [int64](#int64) | optional |  |
+| family_id | [int64](#int64) | optional |  |
+| is_family | [bool](#bool) | optional |  |
+| serial | [string](#string) | optional |  |
+| type_name | [string](#string) | optional |  |
+| make_name | [string](#string) | optional |  |
+| model_name | [string](#string) | optional |  |
+| family_name | [string](#string) | optional |  |
+| cpe | [string](#string) | optional |  |
+| rank | [int32](#int32) | optional |  |
+| catalog_brand | [CatalogBrand](#com-lansweeper-dp-outboundapi-v1-CatalogBrand) | optional |  |
+| catalog_model | [CatalogModel](#com-lansweeper-dp-outboundapi-v1-CatalogModel) | optional |  |
+| raw | [RawHardwareInfo](#com-lansweeper-dp-outboundapi-v1-RawHardwareInfo) | optional |  |
+
+
+
+
+
+
+<a name="com-lansweeper-dp-outboundapi-v1-ListEntityRequest"></a>
+
+### ListEntityRequest
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| filter | [EntityPath](#com-lansweeper-dp-outboundapi-v1-EntityPath) |  | minimum is for a site |
+
+
+
+
+
+
+<a name="com-lansweeper-dp-outboundapi-v1-ListEntityResponse"></a>
+
+### ListEntityResponse
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| entity | [Entity](#com-lansweeper-dp-outboundapi-v1-Entity) |  |  |
+| related | [Entity](#com-lansweeper-dp-outboundapi-v1-Entity) | repeated |  |
+
+
+
+
+
+
+<a name="com-lansweeper-dp-outboundapi-v1-OperatingSystemInfo"></a>
+
+### OperatingSystemInfo
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| id | [int64](#int64) | optional |  |
+| name | [string](#string) | optional |  |
+| version | [string](#string) | optional |  |
+| build | [string](#string) | optional |  |
+| fw_version | [string](#string) | optional |  |
+| cpe | [string](#string) | optional |  |
+| fw_cpe | [string](#string) | optional |  |
+| rank | [int32](#int32) | optional |  |
+| catalog_brand | [CatalogBrand](#com-lansweeper-dp-outboundapi-v1-CatalogBrand) | optional |  |
+| catalog_os | [CatalogOs](#com-lansweeper-dp-outboundapi-v1-CatalogOs) | optional |  |
+| windows | [WindowsRawOperatingSystemInfo](#com-lansweeper-dp-outboundapi-v1-WindowsRawOperatingSystemInfo) |  |  |
+
+
+
+
+
+
+<a name="com-lansweeper-dp-outboundapi-v1-RawHardwareInfo"></a>
+
+### RawHardwareInfo
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| architecture | [string](#string) | optional |  |
+| model | [string](#string) | optional |  |
+| manufacturer | [string](#string) | optional |  |
+| serial_number | [string](#string) | optional |  |
+
+
+
+
+
+
+<a name="com-lansweeper-dp-outboundapi-v1-RawSoftware"></a>
+
+### RawSoftware
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| name | [string](#string) |  |  |
+| vendor | [string](#string) | optional |  |
+| version | [string](#string) | optional |  |
+| info | [string](#string) | optional |  |
+| exe_path | [string](#string) | optional |  |
+| arch | [string](#string) | optional | when available the specific sw arch |
+| install_date | [int64](#int64) | optional |  |
+| source_type | [string](#string) | optional | Registry | System | MsStore | Package | Custom | etc |
+| sw_id | [string](#string) | optional | optional SW id on the client side |
+
+
+
+
+
+
+<a name="com-lansweeper-dp-outboundapi-v1-Software"></a>
+
+### Software
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| rank | [int32](#int32) | optional |  |
+| type_id | [int64](#int64) | optional |  |
+| cat_id | [int64](#int64) | optional |  |
+| make_id | [int64](#int64) | optional |  |
+| sw_id | [int64](#int64) | optional |  |
+| parent_id | [int64](#int64) | optional |  |
+| type_name | [string](#string) | optional |  |
+| cat_name | [string](#string) | optional |  |
+| make_name | [string](#string) | optional |  |
+| name | [string](#string) | optional |  |
+| version | [string](#string) | optional |  |
+| market_ver | [string](#string) | optional |  |
+| edition | [string](#string) | optional |  |
+| build | [string](#string) | optional |  |
+| cpe | [string](#string) | optional |  |
+| catalog_software | [CatalogSoftware](#com-lansweeper-dp-outboundapi-v1-CatalogSoftware) | optional |  |
+| raw | [RawSoftware](#com-lansweeper-dp-outboundapi-v1-RawSoftware) |  |  |
+
+
+
+
+
+
+<a name="com-lansweeper-dp-outboundapi-v1-SoftwareInventory"></a>
+
+### SoftwareInventory
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| timestamp | [google.protobuf.Timestamp](#google-protobuf-Timestamp) |  |  |
+| software | [Software](#com-lansweeper-dp-outboundapi-v1-Software) | repeated |  |
+
+
+
+
+
+
+<a name="com-lansweeper-dp-outboundapi-v1-WindowsRawOperatingSystemInfo"></a>
+
+### WindowsRawOperatingSystemInfo
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| version | [string](#string) | optional |  |
+| service_pack | [int32](#int32) | optional |  |
+| build | [string](#string) | optional | &#34;WindowsVersion&#34;: &#34;10.0.19045&#34; |
+| version_name | [string](#string) | optional | OsVersion&#34;: &#34;22H2&#34;, |
+| build_number | [string](#string) | optional | &#34;OsBuildNumber&#34;: &#34;2486&#34;, |
+| product_type | [int32](#int32) | optional | WindowsProductType: 1 |
+| is_domain_controller | [bool](#bool) | optional |  |
+| part_of_domain | [bool](#bool) | optional |  |
+| is_azure_ad_joined | [bool](#bool) | optional |  |
+| os_code | [string](#string) | optional | &#34;OsCode&#34;: &#34;10.0.19045&#34; - with S if server |
+
+
+
+
+
+ 
+
+ 
+
+ 
+
+
+<a name="com-lansweeper-dp-outboundapi-v1-DataCoreOutboundService"></a>
+
+### DataCoreOutboundService
+GRPC Service. Currently supported operation:
+  - Get Entity
+  - Stream Entities
+
+| Method Name | Request Type | Response Type | Description |
+| ----------- | ------------ | ------------- | ------------|
+| GetEntity | [GetEntityRequest](#com-lansweeper-dp-outboundapi-v1-GetEntityRequest) | [GetEntityResponse](#com-lansweeper-dp-outboundapi-v1-GetEntityResponse) | Retrieve a single entity by site/inst-id/type/id |
+| ListEntities | [ListEntityRequest](#com-lansweeper-dp-outboundapi-v1-ListEntityRequest) | [ListEntityResponse](#com-lansweeper-dp-outboundapi-v1-ListEntityResponse) stream | lists entities for a site or site/type |
+
+ 
+
+
+
+## Scalar Value Types
+
+| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby |
+| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- |
+| <a name="double" /> double |  | double | double | float | float64 | double | float | Float |
+| <a name="float" /> float |  | float | float | float | float32 | float | float | Float |
+| <a name="int32" /> int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
+| <a name="int64" /> int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long | int64 | long | integer/string | Bignum |
+| <a name="uint32" /> uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) |
+| <a name="uint64" /> uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) |
+| <a name="sint32" /> sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
+| <a name="sint64" /> sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum |
+| <a name="fixed32" /> fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) |
+| <a name="fixed64" /> fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum |
+| <a name="sfixed32" /> sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
+| <a name="sfixed64" /> sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum |
+| <a name="bool" /> bool |  | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass |
+| <a name="string" /> string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) |
+| <a name="bytes" /> bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) |
+

package/proto/outbound.proto

@@ -1,9 +1,9 @@
 /**
- * Copyright Lansweper (c)
+ * Copyright Lansweeper (c)
  *
- * This files contains
+ * This files contains the Data Access API and the definition of outbound model
  *
- * https://github.com/pseudomuto/protoc-gen-doc
+ * N.B. This file has been documented using the specification available here: https://github.com/pseudomuto/protoc-gen-doc
  */
 syntax = "proto3";
 package com.lansweeper.dp.outboundapi.v1;
@@ -12,6 +12,11 @@ import "google/protobuf/timestamp.proto";
 
 // ----- Service Part ------
 
+/**
+ * GRPC Service. Currently supported operation:
+ *   - Get Entity
+ *   - Stream Entities
+ */
 service DataCoreOutboundService {
 
   // Retrieve a single entity by site/inst-id/type/id