Skip to content

Releases: HiberGlobal/api

0.208.0

10 Sep 08:19
c940cc5
Compare
Choose a tag to compare

0.208 (2024-09-10)

ExportService
  • Added Export.Configuration.AssetValues (and Export.Configuration.asset_values) to export values for assets.
    • This exports ValueContexts for the given Assets in the given TimeRange.
    • Added AvailableFieldsForExport.Request.asset_values to get available fields for assets to export.
FieldService
  • Added ListFieldsForAsset.Request.include_historic_fields to include fields that were available to the asset
    in the past (from devices assigned to it in the past).
ValueService
  • Added asset_identifier to ValueContext as the shared owner of the value (optional) and
    additional asset information, like asset_name and asset_type, for convenience.
    • This and other assets own the value, while the value is produced by a device assigned to it.
    • Removed assets, since it does not reflect the reality of how we want to use the data.
      • Removed ValueContext.ValueAssetContext since it is no longer needed.
  • Added convenience fields to Value.Numeric:
    • Added value to Value.Numeric to get the numeric value regardless of the Type.
      • The typed values still contain the value in the actual type (i.e. pressure)
      • Renamed the value oneof to typed_value for clarity.
    • Added textual to Value.Numeric to get the textual value regardless of the Type.
    • Added unit of UnitOfMeasurement to Value.Numeric to get the textual value regardless of the Type.
      • Note that this UnitOfMeasurement contains all possible units, and is different from the specific unit types:
        • For example: UnitOfMeasurement.PRESSURE_PSI versus Value.Numeric.Pressure.Unit.PSI which only
          contains pressure units.
  • Marked all converted_from fields in Value.Numeric.* types as optional, since they would otherwise
    default to the first Unit value.
ValueSimulationService
  • Added unit and type to ValueSimulation.ValueRotation.Numeric to specify what is being simulated.
ValueService
  • Added ValueSelection.data_selection to select the type of values to get:
    • Added field in the data_selection oneof to list values for a given (set of) field(s).
      • Deprecated the fields in the selection, because a repeated field cannot be used in a oneof.
    • Added numeric_value_type to list values with a specific Value.Numeric.Type.
      • Note that downsampling is done per Value.Numeric.Type when multiple are specified.
    • When no ValueSelection.data_selection is made:
      • ValueService.List will return all values.
      • ValueService.Downsampled will apply to all values by Value.Numeric.Type.
        • Values without a known Value.Numeric.Type will not be included.
      • ValueService.Aggregated does not currently support numeric_value_type, this will be added in the future.
ValueService
  • Added pressure unit kg/cm².

0.207.0

03 Sep 07:31
729abb7
Compare
Choose a tag to compare

0.207 (2024-09-03)

TokenService
  • Added Token.last_used with the date the token was last used.
  • Added Token.used_for_this_call to show that this token was used to make the call that resulted in this list of tokens.
TagService
  • Added ListTagsRequest.asset_count to count the assets for the listed tags.
    • Added ListTagsRequest.Response.tag_asset_count for the result.
AssetService
  • Added Asset.AssignedDevice.health to see the health of assigned device(s).
ValueService
  • Removed the repeated flag on ValueContext.assets and renamed the field to asset.
    • Values with multiple assets will be repeated instead.

0.204.0

06 Aug 12:51
16ac34d
Compare
Choose a tag to compare

0.204 (2024-08-06)

AssetService
  • Added extra information to Asset.AssignedDevice:
    • last_message_sent_at and last_message_received_at
    • assignment_time_range
  • Added Asset.inactive_devices to list previously assigned devices.
    These have less information available than a currently assigned device, but ues the same object type.

0.203.0

01 Aug 08:49
eef50f4
Compare
Choose a tag to compare

0.203 (2024-07-30)

AssignmentService
  • Added device to asset assignment in addition to asset to device. They are essentially the same and will be output in the default asset to device format.
    • Added Assignment.to_asset, Assign.Request.to_asset and Unassign.Request.from_asset to support the device to asset assignment.
CertificateService
  • Marked ca_certificate_name and ca_certificate_id in Certificate as optional.
MQTTService
  • We now enforce the use of mqtts:// for new MQTT integrations.
    • Added override_url_validation to CreateMQTTPublisherRequest and UpdateMQTTPublisherRequest override this if necessary.

0.198.0

25 Jun 07:54
8071729
Compare
Choose a tag to compare

0.198 (2024-06-25)

AssetService
  • Added ListAsset.Request.child_organizations to list assets in child organizations.
    • Added Asset.organization to show the owner organization of an asset.
UserService
  • Added UserValidation.require_verified_email_addresses and
    UpdateUserValidationRequest.require_verified_email_addresses to require all users to have verified
    their email address in your organization.
  • A few changes to sign-in restrictions:
    • Added UpdateUserValidationRequest.allow_all_sign_in_providers to remove sign-in provider restrictions.
    • When UserValidation.allowed_sign_in_providers does not allow the SignInProvider.PASSWORD sign-in method,
      creating users will not be allowed.
ModemService
  • Added Modem.Lifecycle.SPARE.

0.197.0

18 Jun 08:27
Compare
Choose a tag to compare

0.197 (2024-06-18)

CurrentUserService
  • Fixed a bug where CurrentUser would return an inaccessible default organization when using a token from a child organization.
  • Adjusted CurrentUser to allow it to be used with a token with UserPermission.READ by limiting the data returned, but still returning permissions and roles.

0.196.1

11 Jun 08:07
Compare
Choose a tag to compare

0.196 (2024-06-11)

UserService
  • Added UserValidation.allowed_sign_in_providers to limit the sign in providers for an organization.
    • Added UserValidation.SignInProvider list of supported sign in providers.
      • If any new providers would be added, and a limitation is in place, they are excluded by default.

0.195.1

04 Jun 07:42
Compare
Choose a tag to compare

0.195 (2024-06-04)

FieldService
  • Added ForAsset to list the fields for an asset.
ValueService
  • Added assets to ValueSelection, in a oneof, so a selection selects either assets or devices.
    • Renamed modems to devices.
  • Added assets to ValueContext for values for assets.
  • Renamed modem to device in ValueContext.
  • Marked AggregatedValues.location optional instead of deprecated.
AssignmentService
  • Removed the option for future time values for assignment, since it has unintended consequences.
AssetService
  • Removed the option for future time values for assignment, since it has unintended consequences.

0.192.0

14 May 09:17
Compare
Choose a tag to compare

0.192 (2024-05-14)

AssignmentService
  • Added override_time and schedule_end_time to Assign.Request to customize the assignment time.
  • Added override_time to Unassign.Request to customize the unassignment time.
  • Added include_inactive_assignments to ListAssignments.Request to list inactive assignments.
    • Assignments that no longer have an effect while inactive may be removed automatically.

0.191.0

30 Apr 09:46
Compare
Choose a tag to compare

0.191 (2024-04-30)

AssetService
  • Introducing Assets as the conceptual counterpart of the devices.
    • Assets are abstractions managed by the customer and linked to devices.
    • Assets will own data (values) produced by devices, but when a device is replaced, the asset's values will just
      continue with the data from the new device.
    • Assets have type for common use cases (currently well-related Annulus A/B/C/D and tubing head pressure).
      • Asset are not limited to the predefined types, they can be anything that is required to collect data
        into one place.
    • Assets will get SLA configuration and calculate SLAs.
      • We will phase out SLA configuration on devices slowly.
base.proto
  • Deprecated the Update* types in favor of using optional fields.
    • Deprecated UpdateZeroableInt.
    • Deprecated UpdateClearableString.
    • Deprecated UpdateOptionalId.
    • Deprecated UpdateOptionalDuration.
    • Deprecated UpdateBoolean.
    • Deprecated Filter.ChildOrganizations.Update.
    • Deprecated Filter.Events.Update.
    • Deprecated Filter.Modems.Update.
    • Deprecated Filter.Tags.Update.
    • Deprecated BytesOrHex.Update.
    • Updated a lot of services to use optional instead of Update* types.
Organization Permissions
  • Split the MODEMS_ALARMS permission to manage alarms into a view permission MODEMS_ALARMS and manage permission MODEMS_ALARMS_UPDATE.
    • Roles have been updated to keep effective permissions consistent, but new roles will have more granularity.