Skip to content

Commit

Permalink
2024-07-23: Release 1.4
Browse files Browse the repository at this point in the history
  • Loading branch information
BBF Tools committed Jul 23, 2024
1 parent 271db29 commit b12c40d
Show file tree
Hide file tree
Showing 72 changed files with 10,396 additions and 5,168 deletions.
47 changes: 46 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,48 @@

See <https://usp.technology> for the current USP specification.

## 2024-07-23: [Release 1.4][TR-369 Amendment 4]

*Tags: [v1.4.0] (USP specification),
[v1.4.0][usp-data-models-v1.4.0] (data models)*

### TR-369 Document
Release contains the specification for the User Services Platform 1.4

* Updated ResolvedPathResult Fields to clarify that R-GET.4 does not return parameters for which the Controller
does not have Read permission for.
* Added Appendix VI Usage of the Register Operation to define the Rules related to USP Services Registering data model paths.
* Added TLS Support to the UDS MTP impacting Section Handling Failures to Deliver USP Records with new requirements
(R-UDS.23a and R-UDS.23b) and updates to Appendix V1 Basic Solution Concepts.
* Expanded Error Codes Section Applicability to multiple error codes from Error Message to Any, to send an
operate response rather than USP error.
* Updated GetSupportedDM Request Fields Section to expand the Register Message for Commands, Events, and Parameters. Updated
Definitions Section with new definitions for Command Path and Event Path.
* Updated R-OPR.4 and R-OPR.5 to align with R-OPR.1.
* Updated Appendix 1 Basic Solution Concepts Section to define that the Execution Environment is no longer static,
and is managed via USP Software Module Management.
* Updated Handling of WebSocket Frames Section adding R-WS.14b to discourage the use of WebSocket fragmentation.
* Updated Handling of the WebSocket Session Section adding note to R-WS.8 to clarify the encoding of USP Endpoint ID
for URI use.
* Opened up the OUI definition and Use of authorityscheme and authorityid Section R-ARC.2a to allow for not only the old
24-bit OUIs but to also allow for 36-bit OUIs.
* Updated OnBoardRequest Section to state that the OnBoardRequest notification MUST be sent with send_resp=true,
which included updates to R-NOT.5 and R-NOT-6 as well as the addition of R-NOT-6a to insure the
Controller retries until a notification response is recieved.
* Defined the term "Partial Path" in Definitions Section.
* Fixed the Operate example in Operate Examples Section to include both sync and async data model commands.
* Updated the GetSupportedDM to now indicate the unique keys of a table, which caused updates to the
examples in GetSupportedDM Examples Section and the usp-msg-1-4.proto file within the GetSupportedDM message.
* Updated Role Definition Section with clarifications to Role permissions applying to Supported and Instantiated
Data model and the Secured Role as applying to "secured" parameter in the path(s), with examples
of both.

### USP Protocol Buffers Schemas
USP v1.4 Record Schema

USP v1.4 Message Schema
* Added unique_key_set to GetSupportedDM

## 2023-10-20: [Release 1.3.1][TR-369 Amendment 3 Corrigendum 1]

*Tags: [v1.3.1] (USP specification),
Expand All @@ -13,7 +55,7 @@ See <https://usp.technology> for the current USP specification.
This Corrigendum has the following fixes
* Fix example by populating the empty UNIX Domain Socket references
* Small fixes to UDS example images
* Fix UnixDomainSocket path in example
* Fix UnixDomainSocket path in example

## 2023-06-14: [Release 1.3][TR-369 Amendment 3]

Expand Down Expand Up @@ -226,6 +268,7 @@ USP v1.0 Message Schema
[TR-369 Amendment 2]: https://www.broadband-forum.org/download/TR-369_Amendment-2.pdf
[TR-369 Amendment 3]: https://www.broadband-forum.org/download/TR-369_Amendment-3.pdf
[TR-369 Amendment 3 Corrigendum 1]: https://www.broadband-forum.org/download/TR-369_Amendment-3_Corrigendum-1.pdf
[TR-369 Amendment 4]: https://www.broadband-forum.org/download/TR-369_Amendment-4.pdf
[TR-369 Corrigendum 1]: https://www.broadband-forum.org/download/TR-369_Corrigendum-1.pdf
[TR-369 Corrigendum 2]: https://www.broadband-forum.org/download/TR-369_Corrigendum-2.pdf
[TR-369 Issue 1]: https://www.broadband-forum.org/download/TR-369_Issue-1.pdf
Expand All @@ -236,6 +279,7 @@ USP v1.0 Message Schema
[usp-data-models-v1.1.2]: https://github.com/BroadbandForum/usp-data-models/releases/tag/v1.1.2
[usp-data-models-v1.2.0]: https://github.com/BroadbandForum/usp-data-models/releases/tag/v1.2.0
[usp-data-models-v1.3.0]: https://github.com/BroadbandForum/usp-data-models/releases/tag/v1.3.0
[usp-data-models-v1.4.0]: https://github.com/BroadbandForum/usp-data-models/releases/tag/v1.4.0
[v1.0.0]: https://github.com/BroadbandForum/usp/releases/tag/v1.0.0
[v1.0.1]: https://github.com/BroadbandForum/usp/releases/tag/v1.0.1
[v1.0.2]: https://github.com/BroadbandForum/usp/releases/tag/v1.0.2
Expand All @@ -247,3 +291,4 @@ USP v1.0 Message Schema
[v1.2.0]: https://github.com/BroadbandForum/usp/releases/tag/v1.2.0
[v1.3.0]: https://github.com/BroadbandForum/usp/releases/tag/v1.3.0
[v1.3.1]: https://github.com/BroadbandForum/usp/releases/tag/v1.3.1
[v1.4.0]: https://github.com/BroadbandForum/usp/releases/tag/v1.4.0
86 changes: 67 additions & 19 deletions PROJECT.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,54 @@ resources:
restype: schema

versions:
v1.4.0:
date: 2024-07-23
title: |
[Release 1.4][TR-369 Amendment 4]
depends-on:
usp-data-models: v1.4.0
changes:
specification:
text: |
Release contains the specification for the User Services Platform 1.4
* Updated ResolvedPathResult Fields to clarify that R-GET.4 does not return parameters for which the Controller
does not have Read permission for.
* Added Appendix VI Usage of the Register Operation to define the Rules related to USP Services Registering data model paths.
* Added TLS Support to the UDS MTP impacting Section Handling Failures to Deliver USP Records with new requirements
(R-UDS.23a and R-UDS.23b) and updates to Appendix V1 Basic Solution Concepts.
* Expanded Error Codes Section Applicability to multiple error codes from Error Message to Any, to send an
operate response rather than USP error.
* Updated GetSupportedDM Request Fields Section to expand the Register Message for Commands, Events, and Parameters. Updated
Definitions Section with new definitions for Command Path and Event Path.
* Updated R-OPR.4 and R-OPR.5 to align with R-OPR.1.
* Updated Appendix 1 Basic Solution Concepts Section to define that the Execution Environment is no longer static,
and is managed via USP Software Module Management.
* Updated Handling of WebSocket Frames Section adding R-WS.14b to discourage the use of WebSocket fragmentation.
* Updated Handling of the WebSocket Session Section adding note to R-WS.8 to clarify the encoding of USP Endpoint ID
for URI use.
* Opened up the OUI definition and Use of authorityscheme and authorityid Section R-ARC.2a to allow for not only the old
24-bit OUIs but to also allow for 36-bit OUIs.
* Updated OnBoardRequest Section to state that the OnBoardRequest notification MUST be sent with send_resp=true,
which included updates to R-NOT.5 and R-NOT-6 as well as the addition of R-NOT-6a to insure the
Controller retries until a notification response is recieved.
* Defined the term "Partial Path" in Definitions Section.
* Fixed the Operate example in Operate Examples Section to include both sync and async data model commands.
* Updated the GetSupportedDM to now indicate the unique keys of a table, which caused updates to the
examples in GetSupportedDM Examples Section and the usp-msg-1-4.proto file within the GetSupportedDM message.
* Updated Role Definition Section with clarifications to Role permissions applying to Supported and Instantiated
Data model and the Secured Role as applying to "secured" parameter in the path(s), with examples
of both.
usp-record-schema:
resname: usp-record-1-4.proto
text: |
USP v1.4 Record Schema
usp-msg-schema:
resname: usp-msg-1-4.proto
text: |
USP v1.4 Message Schema
* Added unique_key_set to GetSupportedDM
v1.3.1:
date: 2023-10-20
title: |
Expand All @@ -70,7 +118,7 @@ versions:
This Corrigendum has the following fixes
* Fix example by populating the empty UNIX Domain Socket references
* Small fixes to UDS example images
* Fix UnixDomainSocket path in example
* Fix UnixDomainSocket path in example
v1.3.0:
date: 2023-06-14
title: |
Expand Down Expand Up @@ -125,6 +173,14 @@ versions:
text: |
USP v1.3 Message Schema
* Adds Register and Deregister messages
acknowledgments:
- name: Matthieu Anne
company: Orange
email: [email protected]
- name: Thales Fragoso
company: Axiros
email: [email protected]

v1.2.0:
date: 2022-01-27
title: |
Expand Down Expand Up @@ -316,16 +372,13 @@ versions:
text: |
USP v1.0 Message Schema
# XXX these are USP-style editors; are they appropriate here?
editors:
- name: Barbara Stark
company: AT&T
email: [email protected]
role: Editor/USP Project Lead
# don't report editors in the 'Issue History' table
editors-from-versions: False

editors:
- name: Tim Spets
company: Assia
email: tspets@assia-inc.com
company: Nokia
email: timothy.spets@nokia.com
role: Editor/USP Project Lead

- name: Jason Walls
Expand All @@ -334,11 +387,10 @@ editors:
role: Editor/Broadband User Services Work Area Director

- name: John Blackford
company: Commscope
email: john.blackford@commscope.com
company: Vantiva
email: john.blackford@vantiva.com
role: Editor/Broadband User Services Work Area Director

# XXX these are USP-style acknowledgments; are they appropriate here?
acknowledgments:
- name: Jean-Didier Ott
company: Orange
Expand Down Expand Up @@ -376,10 +428,6 @@ acknowledgments:
company: Broadband Forum
email: [email protected]

- name: Matthieu Anne
company: Orange
email: [email protected]

- name: Thales Fragoso
company: Axiros
email: [email protected]
- name: Barbara Stark
company: AT&T
email: [email protected]
47 changes: 46 additions & 1 deletion docs/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,48 @@

See <https://usp.technology> for the current USP specification.

## 2024-07-23: [Release 1.4][TR-369 Amendment 4]

*Tags: [v1.4.0] (USP specification),
[v1.4.0][usp-data-models-v1.4.0] (data models)*

### TR-369 Document
Release contains the specification for the User Services Platform 1.4

* Updated ResolvedPathResult Fields to clarify that R-GET.4 does not return parameters for which the Controller
does not have Read permission for.
* Added Appendix VI Usage of the Register Operation to define the Rules related to USP Services Registering data model paths.
* Added TLS Support to the UDS MTP impacting Section Handling Failures to Deliver USP Records with new requirements
(R-UDS.23a and R-UDS.23b) and updates to Appendix V1 Basic Solution Concepts.
* Expanded Error Codes Section Applicability to multiple error codes from Error Message to Any, to send an
operate response rather than USP error.
* Updated GetSupportedDM Request Fields Section to expand the Register Message for Commands, Events, and Parameters. Updated
Definitions Section with new definitions for Command Path and Event Path.
* Updated R-OPR.4 and R-OPR.5 to align with R-OPR.1.
* Updated Appendix 1 Basic Solution Concepts Section to define that the Execution Environment is no longer static,
and is managed via USP Software Module Management.
* Updated Handling of WebSocket Frames Section adding R-WS.14b to discourage the use of WebSocket fragmentation.
* Updated Handling of the WebSocket Session Section adding note to R-WS.8 to clarify the encoding of USP Endpoint ID
for URI use.
* Opened up the OUI definition and Use of authorityscheme and authorityid Section R-ARC.2a to allow for not only the old
24-bit OUIs but to also allow for 36-bit OUIs.
* Updated OnBoardRequest Section to state that the OnBoardRequest notification MUST be sent with send_resp=true,
which included updates to R-NOT.5 and R-NOT-6 as well as the addition of R-NOT-6a to insure the
Controller retries until a notification response is recieved.
* Defined the term "Partial Path" in Definitions Section.
* Fixed the Operate example in Operate Examples Section to include both sync and async data model commands.
* Updated the GetSupportedDM to now indicate the unique keys of a table, which caused updates to the
examples in GetSupportedDM Examples Section and the usp-msg-1-4.proto file within the GetSupportedDM message.
* Updated Role Definition Section with clarifications to Role permissions applying to Supported and Instantiated
Data model and the Secured Role as applying to "secured" parameter in the path(s), with examples
of both.

### USP Protocol Buffers Schemas
USP v1.4 Record Schema

USP v1.4 Message Schema
* Added unique_key_set to GetSupportedDM

## 2023-10-20: [Release 1.3.1][TR-369 Amendment 3 Corrigendum 1]

*Tags: [v1.3.1] (USP specification),
Expand All @@ -13,7 +55,7 @@ See <https://usp.technology> for the current USP specification.
This Corrigendum has the following fixes
* Fix example by populating the empty UNIX Domain Socket references
* Small fixes to UDS example images
* Fix UnixDomainSocket path in example
* Fix UnixDomainSocket path in example

## 2023-06-14: [Release 1.3][TR-369 Amendment 3]

Expand Down Expand Up @@ -226,6 +268,7 @@ USP v1.0 Message Schema
[TR-369 Amendment 2]: https://www.broadband-forum.org/download/TR-369_Amendment-2.pdf
[TR-369 Amendment 3]: https://www.broadband-forum.org/download/TR-369_Amendment-3.pdf
[TR-369 Amendment 3 Corrigendum 1]: https://www.broadband-forum.org/download/TR-369_Amendment-3_Corrigendum-1.pdf
[TR-369 Amendment 4]: https://www.broadband-forum.org/download/TR-369_Amendment-4.pdf
[TR-369 Corrigendum 1]: https://www.broadband-forum.org/download/TR-369_Corrigendum-1.pdf
[TR-369 Corrigendum 2]: https://www.broadband-forum.org/download/TR-369_Corrigendum-2.pdf
[TR-369 Issue 1]: https://www.broadband-forum.org/download/TR-369_Issue-1.pdf
Expand All @@ -236,6 +279,7 @@ USP v1.0 Message Schema
[usp-data-models-v1.1.2]: https://github.com/BroadbandForum/usp-data-models/releases/tag/v1.1.2
[usp-data-models-v1.2.0]: https://github.com/BroadbandForum/usp-data-models/releases/tag/v1.2.0
[usp-data-models-v1.3.0]: https://github.com/BroadbandForum/usp-data-models/releases/tag/v1.3.0
[usp-data-models-v1.4.0]: https://github.com/BroadbandForum/usp-data-models/releases/tag/v1.4.0
[v1.0.0]: https://github.com/BroadbandForum/usp/releases/tag/v1.0.0
[v1.0.1]: https://github.com/BroadbandForum/usp/releases/tag/v1.0.1
[v1.0.2]: https://github.com/BroadbandForum/usp/releases/tag/v1.0.2
Expand All @@ -247,3 +291,4 @@ USP v1.0 Message Schema
[v1.2.0]: https://github.com/BroadbandForum/usp/releases/tag/v1.2.0
[v1.3.0]: https://github.com/BroadbandForum/usp/releases/tag/v1.3.0
[v1.3.1]: https://github.com/BroadbandForum/usp/releases/tag/v1.3.1
[v1.4.0]: https://github.com/BroadbandForum/usp/releases/tag/v1.4.0
62 changes: 52 additions & 10 deletions docs/METADATA-1.md
Original file line number Diff line number Diff line change
Expand Up @@ -160,10 +160,46 @@
- This Corrigendum has the following fixes
* Fix example by populating the empty UNIX Domain Socket references
* Small fixes to UDS example images
* Fix UnixDomainSocket path in example
* Fix UnixDomainSocket path in example

* - [Release 1.4][TR-369 Amendment 4]
- July 2024
- Release contains the specification for the User Services Platform 1.4

* Updated ResolvedPathResult Fields to clarify that R-GET.4 does not return parameters for which the Controller
does not have Read permission for.
* Added Appendix VI Usage of the Register Operation to define the Rules related to USP Services Registering data model paths.
* Added TLS Support to the UDS MTP impacting Section Handling Failures to Deliver USP Records with new requirements
(R-UDS.23a and R-UDS.23b) and updates to Appendix V1 Basic Solution Concepts.
* Expanded Error Codes Section Applicability to multiple error codes from Error Message to Any, to send an
operate response rather than USP error.
* Updated GetSupportedDM Request Fields Section to expand the Register Message for Commands, Events, and Parameters. Updated
Definitions Section with new definitions for Command Path and Event Path.
* Updated R-OPR.4 and R-OPR.5 to align with R-OPR.1.
* Updated Appendix 1 Basic Solution Concepts Section to define that the Execution Environment is no longer static,
and is managed via USP Software Module Management.
* Updated Handling of WebSocket Frames Section adding R-WS.14b to discourage the use of WebSocket fragmentation.
* Updated Handling of the WebSocket Session Section adding note to R-WS.8 to clarify the encoding of USP Endpoint ID
for URI use.
* Opened up the OUI definition and Use of authorityscheme and authorityid Section R-ARC.2a to allow for not only the old
24-bit OUIs but to also allow for 36-bit OUIs.
* Updated OnBoardRequest Section to state that the OnBoardRequest notification MUST be sent with send_resp=true,
which included updates to R-NOT.5 and R-NOT-6 as well as the addition of R-NOT-6a to insure the
Controller retries until a notification response is recieved.
* Defined the term "Partial Path" in Definitions Section.
* Fixed the Operate example in Operate Examples Section to include both sync and async data model commands.
* Updated the GetSupportedDM to now indicate the unique keys of a table, which caused updates to the
examples in GetSupportedDM Examples Section and the usp-msg-1-4.proto file within the GetSupportedDM message.
* Updated Role Definition Section with clarifications to Role permissions applying to Supported and Instantiated
Data model and the Secured Role as applying to "secured" parameter in the path(s), with examples
of both.

:::

Comments or questions about this Broadband Forum Technical Report should be directed to <[email protected]>.

::: nobreak

### Editors {.unnumbered .unlisted}

::: {.list-table .editors aligns=l,l,l,l widths=12,10,15,21}
Expand All @@ -173,14 +209,9 @@
- Email
- Role

* - Barbara Stark
- AT&T
- [email protected]
- Editor/USP Project Lead

* - Tim Spets
- Assia
- tspets@assia-inc.com
- Nokia
- timothy.spets@nokia.com
- Editor/USP Project Lead

* - Jason Walls
Expand All @@ -189,12 +220,16 @@
- Editor/Broadband User Services Work Area Director

* - John Blackford
- Commscope
- john.blackford@commscope.com
- Vantiva
- john.blackford@vantiva.com
- Editor/Broadband User Services Work Area Director

:::

:::

::: nobreak

### Acknowledgments {.unnumbered .unlisted}

::: {.list-table .acknowledgments aligns=l,l,l widths=12,10,15}
Expand Down Expand Up @@ -239,6 +274,10 @@
- Broadband Forum
- [email protected]

* - Barbara Stark
- AT&T
- [email protected]

* - Matthieu Anne
- Orange
- [email protected]
Expand All @@ -249,10 +288,13 @@

:::

:::

[TR-369 Amendment 1]: https://www.broadband-forum.org/download/TR-369_Amendment-1.pdf
[TR-369 Amendment 2]: https://www.broadband-forum.org/download/TR-369_Amendment-2.pdf
[TR-369 Amendment 3]: https://www.broadband-forum.org/download/TR-369_Amendment-3.pdf
[TR-369 Amendment 3 Corrigendum 1]: https://www.broadband-forum.org/download/TR-369_Amendment-3_Corrigendum-1.pdf
[TR-369 Amendment 4]: https://www.broadband-forum.org/download/TR-369_Amendment-4.pdf
[TR-369 Corrigendum 1]: https://www.broadband-forum.org/download/TR-369_Corrigendum-1.pdf
[TR-369 Corrigendum 2]: https://www.broadband-forum.org/download/TR-369_Corrigendum-2.pdf
[TR-369 Issue 1]: https://www.broadband-forum.org/download/TR-369_Issue-1.pdf
Loading

0 comments on commit b12c40d

Please sign in to comment.