Skip to content

Commit e3da0b5

Browse files
committed
fixup! squash/drop: Remove top-level schema namespace
Update docs talking about Specifications not having an explicit version, now that they do (though it still doesn't get sent over the wire). Signed-off-by: David Feltell <[email protected]>
1 parent 59f394a commit e3da0b5

File tree

1 file changed

+2
-4
lines changed

1 file changed

+2
-4
lines changed

examples/working_with_trait_versions.ipynb

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -173,21 +173,19 @@
173173
"execution_count": 4
174174
},
175175
{
176+
"metadata": {},
176177
"cell_type": "markdown",
177178
"source": [
178179
"### Specifications\n",
179180
"\n",
180181
"Specifications are a way to document well-known sets of traits that categorize entities, relationships, locales, or policies. Agreement on these as an industry is crucial for effective interop.\n",
181182
"\n",
182-
"However, they do not have an independent version - their version is implicit in the (versioned) traits that they compose. A major consequence of this is that no specification version is embedded in the data itself.\n",
183+
"However, no specification version is embedded in the data itself. The data sent between host and manager only contains the versions of the composite traits. Detecting that some trait data satisfies a specification therefore requires a try-and-see approach, checking the data against the specification's trait set.\n",
183184
"\n",
184185
"If the raison d'être of specifications is a way to have an industry-standard collection of trait sets, then is the exact version of those traits really important? On the assumption that a new version of a trait doesn't fundamentally change its meaning (otherwise it would be an entirely new trait), then it's reasonable to say that specifications are trait version agnostic.\n",
185186
"\n",
186187
"So specifications are invaluable as documentation of common trait sets. However, the auto-generateed `Specification` view classes should be used with caution: using a specification view class to categorize an entity may lead to unexpected false negatives when the trait versions do not line up.\n"
187188
],
188-
"metadata": {
189-
"collapsed": false
190-
},
191189
"id": "ab4dde470a3808d4"
192190
},
193191
{

0 commit comments

Comments
 (0)