[Index]

Model: data/Patch

A Patch represents an update to one or more models in a bundle. The patch tracks the version of the models and packages updated, the source code files that were modified, and the reason.

Model Details: data/Patch

Title Description Details
Name * The unique name of the patch.
  • Field Name: name
  • Type: String
  • MaxLength: 1024
Bundle The name of the bundle to which this patch applies.
  • Field Name: bundleName
  • Type: String
  • MaxLength: 1024
Description Description of the patch.
  • Field Name: description
  • Type: String
  • MaxLength: 1024
Releases The HCS release to which this patch applies.
  • Field Name: releases.[n]
  • Type: Array
Version The version of the patch.
  • Field Name: version
  • Type: String
  • MaxLength: 1024
Defect IDs A list defects that are fixed by this patch.
  • Field Name: defect_ids.[n]
  • Type: Array
Models
  • Field Name: models.[n]
  • Type: Array
Type The type of model included in the patch.
  • Field Name: models.[n].model_type
  • Type: String
  • MaxLength: 1024
Instances
  • Field Name: model_instances.[n]
  • Type: Array
Instance The business key of the model included in the patch.
  • Field Name: models.[n].model_instances.[n].model_instance
  • Type: String
  • MaxLength: 1024
Version The new version of the patched model.
  • Field Name: models.[n].model_instances.[n].model_version
  • Type: String
  • MaxLength: 1024
Description Description of the changes that were made to the given model instance.
  • Field Name: models.[n].model_instances.[n].description
  • Type: String
  • MaxLength: 1024
Source Code Changes Detailed information regarding each source code file that is updated by this patch.
  • Field Name: source_code_changes.[n]
  • Type: Array
Bubble The platform bubble being patched, for example voss-deviceapi, mongo, nginx.
  • Field Name: source_code_changes.[n].chroot
  • Type: String
  • MaxLength: 1024
File The path of a file that was patched.
  • Field Name: source_code_changes.[n].filepath
  • Type: String
  • MaxLength: 1024
Description Description of the changes that were made to the given source code file.
  • Field Name: source_code_changes.[n].description
  • Type: String
  • MaxLength: 1024
Notes A description of any side-effects resulting from applying this patch, such as migration of existing data.
  • Field Name: notes
  • Type: String
  • MaxLength: 1024