Id property renames

[michaelcfanning]

Note to first-time readers of this issue:

Our thinking about this issue evolved from the time @michaelcfanning first filed it. The gist is that we now understand the distinction between globally unique "instance identifiers" (like the identifier that uniquely identifies the reporting of a result in a specific run) and "logical identifiers" (like the identifier that tells you that this is the x86 variant of the nightly security tools run). We want to define the "instance identifiers" as GUIDs, we want to define the logical identifiers as "hierarchical strings", and we want the property names to make that distinction explicit to the reader of the log file. See my comment below ("I am going to break this into two issues...") to see where we landed.

Original issue description begins here:

today we have run.automationId and run.stableId. first, stableId is a bad name, no other identifier (even when it is a stable one) qualifies the term as such. We seem to be header towards preferring 'correlation' as a clarifying term (see #158).

I propose the we use the following new names:
run.automationCorrelationId
run.correlationId

these should point to descriptor objects with the following properties:

descriptor{
guid -> a guid
id -> the namespaced, human-readable id
description -> readable text that provides mode information on what the described thing is pointing to
}

[ghost]

@michaelcfanning When we spoke, I agreed with run.stableId => run.correlationId, but I pushed back on run.automationCorrelationId. The more I think about that one, the more I like it. It's an identifier that correlates the run with something in the automation system. Whereas run.correlationId associates logically similar runs, and result.correlationId associates logically identical results. I'm sold.

I'm not sold on the descriptor object, though. You can see me on it when we talk.

[ghost]

@michaelcfanning I am going to break this into two issues:

This issue is about the property renames, which we agreed to as follows:

• run.id → run.instanceGuid
• run.stableId → run.logicalId
• run.baselineId → run.baselineInstanceGuid
• run.automationId → run.automationLogicalId
• result.id → result.instanceGuid
• Add result.correlationGuid (we'd previously thought of calling it correlationId).
  NOTE: We will add this property when we implement Introduce result.correlationId and clarify purpose of result.fingerprints array #158.

I filed a separate issue #165, "Add run.description," for your other suggestion:

• Add run.description of type message. It's an extended human-readable description of the type of run that run.logicalId identifies.