Skip to content

Commit 17c3e3d

Browse files
authored
Merge pull request #121 from wonsuk73/260224-wonsuk-update-core-spec
Editorial update for Core spec
2 parents 9a6a99d + be61ab0 commit 17c3e3d

File tree

1 file changed

+18
-13
lines changed

1 file changed

+18
-13
lines changed

spec/VISSv3.1_Core.html

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ <h2>Introduction</h2>
203203
This specification describes the messaging API for the VISS protocol.
204204
This includes the messaging layer and set of rules for structuring
205205
data.<br>
206-
The specification is agnostic to which transport protocol that is used
206+
The specification is agnostic to which transport protocol is used
207207
as long as it conforms to this messaging API and data rule set.
208208
Transport protocols that cannot conform to the entire CORE
209209
specification can still be conformant by describing their deviations in
@@ -347,6 +347,11 @@ <h2>Definitions</h2>
347347
External Consent Framework. An agent that is responsible for
348348
inquiring a data owner about consent for client access to data.
349349
</dd>
350+
<dt><dfn data-dfn-type="dfn" id="dfn-dc">dc</dfn></dt>
351+
<dd>
352+
A string identifying the compression scheme applied to path
353+
and/or timestamp data in server responses.
354+
</dd>
350355
</dl>
351356
</section>
352357
</section>
@@ -366,7 +371,7 @@ <h2>Data Model</h2>
366371
rule set and definition of the content of the tree but in VISSv3.1 the
367372
<a href="https://github.com/COVESA/hierarchical_information_model">HIM</a>
368373
data profile rule set is instead used. This enables other trees than the
369-
VSS tree also to be used. A server may manage a set of trees, a so called
374+
VSS tree also to be used. A server may manage a set of trees, a so-called
370375
forest, that a client can access.<br>
371376
Typically at least three trees are used in a VISS-based server
372377
implementation:<br>
@@ -392,7 +397,7 @@ <h2>Data Model</h2>
392397
The server capabilities tree shall only be represented by one tree, while
393398
both the vehicle tree and the datatype definition tree can be represented
394399
by multiple trees. An example could be a scenario with a truck pulling one
395-
or more trailers, where the truck vehicle signals are repesented in one
400+
or more trailers, where the truck vehicle signals are represented in one
396401
tree, and the signals of each trailer is represented in a separate tree.
397402
Each of these trees may use a separate datatype definition tree.<br>
398403
The different trees must have unique root node names as specified in
@@ -515,9 +520,9 @@ <h2>Data representation</h2>
515520
with the key names "value" and "ts".<br>
516521
The "ts" value MUST be a string as specified in
517522
<a href="#timestamp"></a>.<br>
518-
The "value" value MUST be represented as a string for simple datatypes.
523+
The "value" MUST be represented as a string for simple datatypes.
519524
If the value is an array it MUST be represented as a JSON array of
520-
strings. In the case the value is a struct complex datatype it MUST be
525+
strings. In the case where the value is a struct complex datatype it MUST be
521526
represented as a JSON object, see below. For supported datatypes see
522527
<a
523528
href="https://covesa.github.io/hierarchical_information_model/common_rule_set/data_entry/datatypes/"
@@ -582,7 +587,7 @@ <h2>Read</h2>
582587
</li>
583588
<li><a>authorization</a> The authorization token.</li>
584589
<li>
585-
data compression The compression scheme(s) used for
590+
<a>dc</a> The compression scheme(s) used for
586591
transmitted data.
587592
</li>
588593
</ul>
@@ -692,7 +697,7 @@ <h2>Subscribe</h2>
692697
</li>
693698
<li><a>authorization</a> The authorization token.</li>
694699
<li>
695-
data compression The compression scheme(s) used for
700+
<a>dc</a> The compression scheme(s) used for
696701
transmitted data.
697702
</li>
698703
</ul>
@@ -1311,7 +1316,7 @@ <h2>Metadata Filter Operation</h2>
13111316
<section id="forest-inquiry">
13121317
<h2>Forest Inquiry</h2>
13131318
<p>
1314-
A metadata request can also be used by the client to retrive
1319+
A metadata request can also be used by the client to retrieve
13151320
information about the set of trees that the server manages, a so
13161321
called "forest inquiry". This request must have a path starting
13171322
with the root node name "HIM" which may be appended with one dot
@@ -1368,7 +1373,7 @@ <h2>Response syntax</h2>
13681373
<li>Request for a single value from multiple nodes.</li>
13691374
<li>Request for multiple values from multiple nodes.</li>
13701375
</ul>
1371-
The syntax to accomodate these four cases have a common structure
1376+
The syntax to accommodate these four cases have a common structure
13721377
where a data point ("dp") consists of one or more objects containing
13731378
a "value" and a timestamp ("ts"), and the complete aggregation
13741379
("data"), consists of one or more objects containing a "path" and a
@@ -2372,7 +2377,7 @@ <h2>Short-Term Access Grant Token</h2>
23722377
</section>
23732378

23742379
<section id="client-signed-agtoken">
2375-
<h2>Long Term Access Grant Token</h2>
2380+
<h2>Long-Term Access Grant Token</h2>
23762381
Except for the vehicle identity (vin) claim, which is optional,
23772382
the long term access grant token SHALL include the following
23782383
claims in both the header and the payload.<br>
@@ -2554,7 +2559,7 @@ <h2>Proof of Possession</h2>
25542559
If PoP freshness is a critical requirement, the nonce could be
25552560
derived from a public source of randomness, such as the
25562561
<a href="https://www.cloudflare.com/leagueofentropy/"
2557-
>Leage of Entropy</a
2562+
>League of Entropy</a
25582563
>
25592564
or
25602565
<a
@@ -2610,7 +2615,7 @@ <h2>Client Context</h2>
26102615
decide on which authentication method to use per sub-actor can be quite
26112616
complex. However, this complexity can be reduced if the
26122617
<a href="#client-def">client</a> explicitly requests specific roles for
2613-
each sub-actor. Following the principle of least priviledge, a
2618+
each sub-actor. Following the principle of least privilege, a
26142619
<a href="#client-def">client</a> should not have access to more vehicle
26152620
signals than necessary. This is achieved by the
26162621
<a href="#purpose-list-def">purpose list</a>, that assigns only the for
@@ -4389,7 +4394,7 @@ <h3>Data channel realization</h3>
43894394
<li>HTTP port number: 445</li>
43904395
<li>WebSocket port number: 6445</li>
43914396
</ul>
4392-
The recommended mechanism for MQTT is to assing a separate topic
4397+
The recommended mechanism for MQTT is to assign a separate topic
43934398
name to the data channel. The recommended topic name is created by
43944399
appending "/datachannel" to the topic name of the control channel.
43954400
</section>

0 commit comments

Comments
 (0)