[OASIS Issue Tracker] (MQTT-430) WD12 Review comments by Alex Kritikos

[OASIS Issues Tracker <workgroup_mailer@lists.oasis-open.org>]

     [ https://issues.oasis-open.org/browse/MQTT-430?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Ken Borgendale updated MQTT-430:
--------------------------------

    Assignee: Andrew Banks  (was: Ken Borgendale)

I made the small fixes thruout the document.

This leaves one major issue which I will leave for Andrew Banks to decide as a style issue.  We currently use the word Auth in the name of the properties Auth Data and Auth Method.  We currently use Auth as the proper name, and authentication as the definition. Alex suggests that these be expanded to Authentication Data and Authentication Method. 

I tend to like the shorter form but I do not feel strongly about it.  While these methods and data are primarily for authentication, they allow for authorization as well.  On the other hand, a full word is generally preferred..  

> WD12 Review comments by Alex Kritikos
> -------------------------------------
>
>                 Key: MQTT-430
>                 URL: https://issues.oasis-open.org/browse/MQTT-430
>             Project: OASIS Message Queuing Telemetry Transport (MQTT) TC
>          Issue Type: Bug
>          Components: edits
>    Affects Versions: 5, wd12
>            Reporter: Alex Kritikos
>            Assignee: Andrew Banks
>             Fix For: 5, wd13
>
>
> @1.5.4
> 632 A UTF-8 encoded sequence 0xEF 0xBB 0xBF is always interpreted as U+FEFF ("ZERO WIDTH NO- [Removed extra space after as]
> 637 For example, the string A which is LATIN CAPITAL Letter A followed by the code point U+2A6D4 [Removed extra space after A]
> @1.5.5
> 655 The algorithm for encoding a non-negative integer (X) into the Variable Byte Integer encoding [Changed non negative to non-negative]
> 662 Removed spaces around brackets and operator of algorithm
> 666 As above
> @2.1.2
> 757  Table 2‑1 MQTT Control Packet types
> Publish complete (QoS 2 delivery part 3)
> [Changed (QoS delivery part 3 to QoS 2 delivery part 3)]
> @2.1.3
> 766 Table 2‑2 Flag Bits
> PUBLISH
> Used in MQTT v5.0
> DUP1
> QoS2
> QoS2
> RETAIN3
> What is the significance of Used in MQTT v5.0 ? Are they not used in other versions?
> @2.2.3.2
> 859 Table 2.6 – Properties
> 21
> 0x15
> Auth Method
> 22
> 0x16
> Auth Data
> Why not Authentication Method and Authentication Data? All other values of AUTH packet seem to be fully described
> @3.1.2.1
> 898 Figure 3‑2 Protocol Name bytes [changed to Figure 3‑2 - Protocol Name bytes]
> @3.2.1.11.10
> 1248 Why not describe Auth Method as Authentication Method for consistency?
> 1249 Same as above
> @3.2.1.11.11
> 1256 Why not describe Auth Data as Authentication Data for consistency?
> 1257 Same as above
> @3.2.2.1.1
> 1416 Changed In both cases it MUST set a 0x00 (Success) Return Code in the to In both cases, it MUST set a 0x00 (Success) Return Code in the
> 1417 Changed CONNACK packet. [MQTT-3.2.2-3]. to CONNACK packet [MQTT-3.2.2-3].
> 1422 Same as above, remove dot
> 1425 Same as above, remove dot
> @3.2.2.2
> 1440 Table 3‑1 - Connect Return Code values
> 132
> 0x84
> Unsupported Protocol Version
> [Suggested description: The Server does not support the version of the MQTT protocol requested by the Client]
> 133
> 0x85
> Client Identifier invalid
> [Suggested description: The Client Identifier is invalid or valid but not allowed by the Server]
> 1445 Should leave a black line for consistency
> @3.2.2.3.16
> 1679 Why Auth Method and not Authentication Method
> 1680 same as above
> @3.2.2.3.17
> 1684 Why Auth Data and not Authentication Data
> 1685 same as above
> @3.8.3.2
> 2394 Figure 3‑21 - Payload byte format non-normative example
> byte 6
> Subscription Options(1)
> byte 12
> Subscription Options(2)
> Changed Subscription Options(1) to Subscription Options (1) & Subscription Options(2) to Subscription Options (2)
> @3.10.3
> 2594 Figure 3.30 - Payload byte format Non-Normative example
> Should leave 1 blank line for consistency
> @3.14.2.1
> 2739 Table 3‑13 – Disconnect Return Code s [MQTT-3.14.2-1]. The Return Code 0x00 (Success) and no Properties may be
> [Should be Table 3‑13 – Disconnect Return Codes [MQTT-3.14.2-1]. The Return Code 0x00 (Success) and no Properties may be]
> @3.15.1
> 2815 send an AUTH packet if the CONNECT packet did not contain an Auth Method.
> Should it not be Authentication Method?
> @3.15.2.2.2 Auth Method
> Should it not be Authentication Method? or AUTH Method?
> 2843 21 (0x15) Byte, Identifier of the Auth Method
> Should it not be Authentication Method?
> @3.15.2.2.3 Auth Data
> Should it not be Authentication Data or AUTH Data?
> 2848 Same as above
> @4.3.3
> 3064 Error reference
> @4.6
> 3153 Missing bold formatting
> @4.10.2
> 3528 Error reference
> @4.12
> 3587 Should it not be Authentication Method or AUTH Method?
> 3588 Same as above
> 3589 Same as above
> 3592 Same as above
> 3593 Same as above
> 3596 Same as above
> 3599 Same as above
> 3600 Same as above
> 3604 Same as above
> 3605 Same as above
> 3608 Same as above
> 3609 Same as above
> 3613 Same as above
> 3615 Should it not be Authentication Data or AUTH Data?
> 3620 Should it not be Authentication Method or AUTH Method?
> 3622 Should it not be Authentication Data or AUTH Data?
> 3626 Should it not be Authentication Method or AUTH Method?
> 3627 Same as above
> 3628 Should it not be Authentication Data or AUTH Data?
> 3631 Same as above
> 3632 Same as above
> 3633 Same as above
> 3634 Same as above
> 3637 Same as above
> 3638 Same as above
> 3639 Same as above
> 3641 Same as above
> 3643 Same as above
> 3644 Same as above
> @4.12.1
> 3648 Should it not be Authentication Method or AUTH Method?
> 3649 Same as above
> 3650 Same as above
> 3652 Same as above
> 3655 continues using the previous authentication.
> Should be:  continue using the previous authentication.
> @4.13.1
> 3715 There are no consequences for other Sessions.
> What if part of a shared subscription?
> @4.13.2
> 3725 Same as above
> @5.4.2
> 3824 Error reference



--
This message was sent by Atlassian JIRA
(v6.2.2#6258)