0.210.0

HiberGlobal · Sep 24, 2024 · ccc8ead · ccc8ead
1 parent de8966a
commit ccc8ead
Show file tree

Hide file tree

Showing 66 changed files with 635 additions and 185 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,28 @@
 # Changelog Hiber API
 
+### 0.210 (2024-09-24)
+
+##### AssetService
+
+- Added new asset types.
+- Added `numeric_value_types` to `Asset.AssignedDevice` to easily see which devices produce which `Value.Numeric.Type`.
+
+##### CurrentUserService
+
+- Marked a number of fields `optional` for cases where you do not have permission to see them, or, for the permission filters, if they are empty.
+
+##### EventService
+
+- Updated the event json examples with default values for fields.
+
+##### Publisher
+
+- Marked a number of deprecated data fields `optional`.
+
+##### TokenService
+
+- Add an option to `minimize` tokens in `CreateTokenRequest`. This reduces the length of the token significantly.
+
 ### 0.209 (2024-09-17)
 
 ##### MessageService

diff --git a/asset.proto b/asset.proto
@@ -31,13 +31,17 @@ message Asset {
         WELL_ANNULUS_B = 2;
         WELL_ANNULUS_C = 3;
         WELL_ANNULUS_D = 4;
+        WELL_HEAD = 15;
         WELL_TUBING_HEAD = 5;
         WELL_TUBING = 6;
         WELL_FLOW_LINE = 7;
         WELL_CASING = 8;
         WELL_PRODUCTION_CASING_PRESSURE = 9;
         WELL_INTERMITTENT_CASING_PRESSURE = 10;
         PIPELINE = 11;
+        PRODUCTION_LINE = 12;
+        GAS_MANIFOLD = 13;
+        PRODUCTION_MANIFOLD = 14;
     }
 
     /* A device assigned to this asset.
@@ -53,6 +57,7 @@ message Asset {
         optional Timestamp last_message_received_at = 6;
         optional TimeRange assignment_time_range = 7;
         optional health.HealthLevel health = 8;
+        repeated value.Value.Numeric.Type numeric_value_types = 9;
     }
 
     string identifier = 1;

diff --git a/currentuser.proto b/currentuser.proto
@@ -36,37 +36,45 @@ service CurrentUserService {
 /* Your personal data. */
 message CurrentUser {
     string id = 1;
-    string email = 2;
-    string name = 3;
+
+    /* Email address of the current user.
+     * Only set when you have permission to read the user data (i.e. a token without that permission would not see this)
+     */
+    optional string email = 2;
+
+    /* Name of the current user.
+     * Only set when you have permission to read the user data (i.e. a token without that permission would not see this)
+     */
+    optional string name = 3;
 
     /* The organizations that this user has access to. */
     repeated string organizations = 4;
 
-    /* The default organization for this user. */
-    string default_organization = 5;
+    /* The default organization for this user, if any. */
+    optional string default_organization = 5;
 
     /* Open access requests. */
     repeated string requested_organizations = 6;
 
     reserved 7;
 
     /* The current organization for this user.
-     * If this is a user, this equals the default_organization.
+     * If this is a user, this equals the default_organization, if any.
      * If this is a token, it's the token's organization.
      */
-    string current_organization = 8;
+    optional string current_organization = 8;
 
     /* Permissions for the current organization. */
-    Filter.OrganizationPermissions current_organization_permissions = 9;
+    optional Filter.OrganizationPermissions current_organization_permissions = 9;
 
-    /* Permissions for the user. If this is a token, the user permissions may be limited. */
-    Filter.UserPermissions user_permissions = 10;
+    /* Permissions for the user. If this is a token, the user permissions may be limited or omitted. */
+    optional Filter.UserPermissions user_permissions = 10;
 
     /* Permissions for customer support.
      * Used for features typically reserved for customer support, or that behave differently
      * when used by a customer support operator.
      */
-    Filter.SupportPermissions support_permissions = 14;
+    optional Filter.SupportPermissions support_permissions = 14;
 
     /* Roles for the current organization. */
     repeated string roles = 15;

diff --git a/docs/enum-json/asset.json b/docs/enum-json/asset.json
@@ -7,12 +7,16 @@
     , "WELL_ANNULUS_B": ""
     , "WELL_ANNULUS_C": ""
     , "WELL_ANNULUS_D": ""
+    , "WELL_HEAD": ""
     , "WELL_TUBING_HEAD": ""
     , "WELL_TUBING": ""
     , "WELL_FLOW_LINE": ""
     , "WELL_CASING": ""
     , "WELL_PRODUCTION_CASING_PRESSURE": ""
     , "WELL_INTERMITTENT_CASING_PRESSURE": ""
     , "PIPELINE": ""
+    , "PRODUCTION_LINE": ""
+    , "GAS_MANIFOLD": ""
+    , "PRODUCTION_MANIFOLD": ""
     }
 }]
diff --git a/docs/html/asset.html b/docs/html/asset.html
@@ -914,6 +914,13 @@ <h3 id="hiber.asset.Asset.AssignedDevice">Asset.AssignedDevice</h3>
                   <td><p> </p></td>
                 </tr>
 
+                <tr>
+                  <td>numeric_value_types</td>
+                  <td><a href="#hiber.value.Value.Numeric.Type">hiber.value.Value.Numeric.Type</a></td>
+                  <td>repeated</td>
+                  <td><p> </p></td>
+                </tr>
+
             </tbody>
           </table>
 
@@ -1006,6 +1013,12 @@ <h3 id="hiber.asset.Asset.Type">Asset.Type</h3>
                 <td><p></p></td>
               </tr>
 
+              <tr>
+                <td>WELL_HEAD</td>
+                <td>15</td>
+                <td><p></p></td>
+              </tr>
+
               <tr>
                 <td>WELL_TUBING_HEAD</td>
                 <td>5</td>
@@ -1048,6 +1061,24 @@ <h3 id="hiber.asset.Asset.Type">Asset.Type</h3>
                 <td><p></p></td>
               </tr>
 
+              <tr>
+                <td>PRODUCTION_LINE</td>
+                <td>12</td>
+                <td><p></p></td>
+              </tr>
+
+              <tr>
+                <td>GAS_MANIFOLD</td>
+                <td>13</td>
+                <td><p></p></td>
+              </tr>
+
+              <tr>
+                <td>PRODUCTION_MANIFOLD</td>
+                <td>14</td>
+                <td><p></p></td>
+              </tr>
+
           </tbody>
         </table>
 

diff --git a/docs/html/asset_service.html b/docs/html/asset_service.html
@@ -4299,6 +4299,13 @@ <h3 id="hiber.asset.Asset.AssignedDevice">Asset.AssignedDevice</h3>
                   <td><p> </p></td>
                 </tr>
 
+                <tr>
+                  <td>numeric_value_types</td>
+                  <td><a href="#hiber.value.Value.Numeric.Type">hiber.value.Value.Numeric.Type</a></td>
+                  <td>repeated</td>
+                  <td><p> </p></td>
+                </tr>
+
             </tbody>
           </table>
 
@@ -4391,6 +4398,12 @@ <h3 id="hiber.asset.Asset.Type">Asset.Type</h3>
                 <td><p></p></td>
               </tr>
 
+              <tr>
+                <td>WELL_HEAD</td>
+                <td>15</td>
+                <td><p></p></td>
+              </tr>
+
               <tr>
                 <td>WELL_TUBING_HEAD</td>
                 <td>5</td>
@@ -4433,6 +4446,24 @@ <h3 id="hiber.asset.Asset.Type">Asset.Type</h3>
                 <td><p></p></td>
               </tr>
 
+              <tr>
+                <td>PRODUCTION_LINE</td>
+                <td>12</td>
+                <td><p></p></td>
+              </tr>
+
+              <tr>
+                <td>GAS_MANIFOLD</td>
+                <td>13</td>
+                <td><p></p></td>
+              </tr>
+
+              <tr>
+                <td>PRODUCTION_MANIFOLD</td>
+                <td>14</td>
+                <td><p></p></td>
+              </tr>
+
           </tbody>
         </table>
 

diff --git a/docs/html/assignment.html b/docs/html/assignment.html
@@ -5318,6 +5318,13 @@ <h3 id="hiber.asset.Asset.AssignedDevice">Asset.AssignedDevice</h3>
                   <td><p> </p></td>
                 </tr>
 
+                <tr>
+                  <td>numeric_value_types</td>
+                  <td><a href="#hiber.value.Value.Numeric.Type">hiber.value.Value.Numeric.Type</a></td>
+                  <td>repeated</td>
+                  <td><p> </p></td>
+                </tr>
+
             </tbody>
           </table>
 
@@ -5410,6 +5417,12 @@ <h3 id="hiber.asset.Asset.Type">Asset.Type</h3>
                 <td><p></p></td>
               </tr>
 
+              <tr>
+                <td>WELL_HEAD</td>
+                <td>15</td>
+                <td><p></p></td>
+              </tr>
+
               <tr>
                 <td>WELL_TUBING_HEAD</td>
                 <td>5</td>
@@ -5452,6 +5465,24 @@ <h3 id="hiber.asset.Asset.Type">Asset.Type</h3>
                 <td><p></p></td>
               </tr>
 
+              <tr>
+                <td>PRODUCTION_LINE</td>
+                <td>12</td>
+                <td><p></p></td>
+              </tr>
+
+              <tr>
+                <td>GAS_MANIFOLD</td>
+                <td>13</td>
+                <td><p></p></td>
+              </tr>
+
+              <tr>
+                <td>PRODUCTION_MANIFOLD</td>
+                <td>14</td>
+                <td><p></p></td>
+              </tr>
+
           </tbody>
         </table>
 

diff --git a/docs/html/currentuser.html b/docs/html/currentuser.html
@@ -893,15 +893,17 @@ <h3 id="hiber.user.CurrentUser">CurrentUser</h3>
                 <tr>
                   <td>email</td>
                   <td><a href="#string">string</a></td>
-                  <td></td>
-                  <td><p> </p></td>
+                  <td>optional</td>
+                  <td><p>Email address of the current user.
+Only set when you have permission to read the user data (i.e. a token without that permission would not see this) </p></td>
                 </tr>
 
                 <tr>
                   <td>name</td>
                   <td><a href="#string">string</a></td>
-                  <td></td>
-                  <td><p> </p></td>
+                  <td>optional</td>
+                  <td><p>Name of the current user.
+Only set when you have permission to read the user data (i.e. a token without that permission would not see this) </p></td>
                 </tr>
 
                 <tr>
@@ -914,8 +916,8 @@ <h3 id="hiber.user.CurrentUser">CurrentUser</h3>
                 <tr>
                   <td>default_organization</td>
                   <td><a href="#string">string</a></td>
-                  <td></td>
-                  <td><p>The default organization for this user. </p></td>
+                  <td>optional</td>
+                  <td><p>The default organization for this user, if any. </p></td>
                 </tr>
 
                 <tr>
@@ -928,30 +930,30 @@ <h3 id="hiber.user.CurrentUser">CurrentUser</h3>
                 <tr>
                   <td>current_organization</td>
                   <td><a href="#string">string</a></td>
-                  <td></td>
+                  <td>optional</td>
                   <td><p>The current organization for this user.
-If this is a user, this equals the default_organization.
+If this is a user, this equals the default_organization, if any.
 If this is a token, it&#39;s the token&#39;s organization. </p></td>
                 </tr>
 
                 <tr>
                   <td>current_organization_permissions</td>
                   <td><a href="#hiber.Filter.OrganizationPermissions">hiber.Filter.OrganizationPermissions</a></td>
-                  <td></td>
+                  <td>optional</td>
                   <td><p>Permissions for the current organization. </p></td>
                 </tr>
 
                 <tr>
                   <td>user_permissions</td>
                   <td><a href="#hiber.Filter.UserPermissions">hiber.Filter.UserPermissions</a></td>
-                  <td></td>
-                  <td><p>Permissions for the user. If this is a token, the user permissions may be limited. </p></td>
+                  <td>optional</td>
+                  <td><p>Permissions for the user. If this is a token, the user permissions may be limited or omitted. </p></td>
                 </tr>
 
                 <tr>
                   <td>support_permissions</td>
                   <td><a href="#hiber.Filter.SupportPermissions">hiber.Filter.SupportPermissions</a></td>
-                  <td></td>
+                  <td>optional</td>
                   <td><p>Permissions for customer support.
 Used for features typically reserved for customer support, or that behave differently
 when used by a customer support operator. </p></td>