PROJECT.yaml

# project name should be the official internal project name (unique key)
name: WT-106

# specification name should be how the spec (if any) is known externally;
# can set it to an empty string to indicate that there's no specification
# (default is derived from the project name, e.g. WT-xxx -> TR-xxx)
specname:

# title should be the official specification name
title: Data Model Template for CWMP Endpoints and USP Agents

# shorttitle can be a shorter version of the title, e.g., used in generating
# the changelog title (default is title)
shorttitle: Data Model Template

# shortertitle can be an even shorter version of the title, e.g., used in
# changelogs to indicate the project associated with a tag, as in "v1.2.0
# (USP specification didn't change)" (default is shorttitle)
shortertitle: TR-106

# tag line (should be a fragment, with no terminating period)
tagline: |
  How to use the data model schema to understand and develop CWMP/USP
  data models

# project summary, suitable for inclusion in changelog files
summary: |
  See <https://data-model-template.broadband-forum.org> for the
  current TR-106 specification.

# project description, suitable for inclusion in readme files (expected to be
# more extensive than the summary; any headings should start at level 2)
description: |
  TR-106 specifies data model guidelines to be followed by all [CWMP] (TR-069)
  Endpoints and [USP] (TR-369) Agents. These guidelines include:

  * Structural requirements for the data hierarchy
  * Requirements for versioning of data models
  * Requirements for defining profiles

  As part of this data modeling framework, TR-106 defines two XML Schemas:

  * The *Data Modeling (DM) Schema*, which is used for defining all CWMP and
    USP data models. This makes data model definitions rigorous, and helps to
    reduce the danger that different implementations will interpret data
    model definitions in different ways.

  * The *Device Type (DT) Schema*, that allows a device to describe its
    supported CWMP data models. This description is both specific and
    detailed, allowing a Controller to know exactly what is supported by the
    device, including any vendor-specific objects and parameters. USP uses a
    different mechanism (GetSupportedDM message) for the same purpose; this
    mechanism is specified in [TR-369][USP].

  The TR-106 GitHub repository contains [the above schemas][schemas],
  [support files][support] (e.g., common bibliographic references and
  data types), and the [TR-106 specification source][specification].
  The rendered GitHub Pages documentation can be found at
  <https://data-model-template.broadband-forum.org>.

  The TR-106 schemas and support files are also available at the
  [CWMP data models] and [USP data models] sites. These sites present
  integrated views of the CWMP and USP versions of the standard data
  models, and provide a convenient way of viewing current and past
  versions of the schemas and support files in context.

  [BBF]: https://www.broadband-forum.org
  [CWMP]: https://www.broadband-forum.org/technical/download/TR-069.pdf
  [CWMP data models]: https://cwmp-data-models.broadband-forum.org
  [USP]: https://usp.technology
  [USP data models]: https://usp-data-models.broadband-forum.org
  [schemas]: https://github.com/BroadbandForum/data-model-template/tree/master/schemas
  [support]: https://github.com/BroadbandForum/data-model-template/tree/master/support
  [specification]: https://github.com/BroadbandForum/data-model-template/tree/master/specification

# GitHub repository name
reponame: data-model-template

# GitHub pages (or other) website (default is https://%reponame%.
# broadband-forum.org if reponame is defined, otherwise empty)
website:

# XXX need to explain these
resources:
  specification:
    title: TR-106 Document
  data-model:
    title: Data Model
  dm-schema:
    title: DM Data Model Definition Schema (DM Schema)
    restype: schema
  dmr-schema:
    title: Data Model Report Schema (DMR Schema)
    restype: schema
  dt-schema:
    title: Device Type Schema (DT Schema)
    restype: schema
  dtf-schema:
    title: DT (Device Type) Features Schema (DTF Schema)
    restype: schema
  catalog:
    title: '[XML Catalog](https://en.wikipedia.org/wiki/XML_catalog)'
    restype: schema
    resname: catalog.xml
  dm-types:
    title: Data Model Data Types
    restype: support
  dm-bibrefs:
    title: Data Model Bibliographic References
    restype: support

# this is a dictionary, typically keyed by vi.a.c revisions
# XXX need to ensure that we cover the YANG multi-tag case
versions:
  v1.14.0:
    date: 2024-07-23
    changes:
      specification:
        text: |
          * Added access type guidance
          * Documented the dmr:noNameCheck attribute
          * Documented the decimal datatype
          * Documented the list value defaults
          * Documented markdown syntax (and switch from MediaWiki)
          * Cosmetic changes
      dm-schema:
        resname: cwmp-datamodel-1-14.xsd
        text: |
          * Starting from this version, the DM schema version will be the
            same as the specification version
          * Removed the status attribute's default
          * Supported virtual components
          * Permitted changing the version of an existing parameter (sometimes
            needed when using components to define multiple parameters)
      dmr-schema:
        resname: cwmp-datamodel-report-1-0.xsd
        text: |
          * Added *noNameCheck* to suppress name checks (used for items
            that knowingly disobey the rules)
      dm-types:
        resname: tr-106-types.xml
        text: |
          * Updated *Alias* component to be virtual (with different CWMP
            and USP versions)
      dm-bibrefs:
        resname: tr-069-biblio.xml
        text: |
          * Fixed IPDR reference links
          * Added more bibrefs
      dt-schema:
        resname: cwmp-devicetype-1-14.xsd
        text: |
          * Starting from this version, the DT schema version will be the
            same as the specification version

  v1.13.0:
    date: 2024-01-18
    changes:
      specification:
        text: |
          * Clarified the requirements regarding vendor-specific prefixes
      dm-types:
        resname: tr-106-types.xml
        text: |
          * Added an *Alias* component to reduce cut-and-paste in the data
            models
          * Added an *Order* type to reduce cut-and-paste in the data models
      dm-bibrefs:
        resname: tr-069-biblio.xml
        text: |
          * Added more bibrefs

  v1.12.0:
    date: 2023-06-14
    editors:
      - William Lupton, Broadband Forum
    changes:
      specification:
        text: |
          ::: USP :::
          * Updated the *Mountable Object* and *Mount Point* descriptions to
            indicate that all top-level objects (other than mount points) are
            mountable
          * Updated path scoping rules to indicate that a path that starts
            with a period (`.`) is relative to its mount point (if mounted)
            or to the Root or Service Object (otherwise)
          :::
          * Updated the *hidden* and *secured* attributes to clarify that they
            can't both be set to *true*, and that for CWMP *secured* means
            the same as *hidden*
          * Tightened the *version* attribute definition. It can only be
            used when the version is later than the parent version,
            except that it always has to be specified for Objects and
            Profiles. Also added a new section on the use of the *version*
            attribute
          * Clarified that defaults defined in components will be "promoted"
            to *parameter* defaults when used in command or event arguments
          * Fixed the rules governing modifications of existing models. The
            basic rule is that the value space can only be expanded, never
            contracted
          * Added a new section on the DMR (Data Model Report) Schema
      dm-schema:
        resname: cwmp-datamodel-1-10.xsd
        text: |
          * Supported XSD v1.1, which allows more rigorous validation, e.g.,
            use of appropriate attributes when creating and modifying items
          * Added defaults for various attributes, e.g. *access*, *minEntries*
            and *maxEntries* default to *readOnly*, *1* and *1* respectively
          * Deprecated the *mountType* attribute's *none* and *mountable*
            values, because mountable objects are now determined automatically
          * Made the *uniqueKey/functional* and the *command/async*
            attributes mandatory
          * Relaxed rules governing the order of top-level elements such as
            *import*, *dataType* and *component*; they can now occur in any
            order
          * Tightened up the use of *dmr:* attributes, which can now only be
            used on elements where they make sense
          * Fixed a few bugs, e.g., added a *template* element uniqueness check
      dmr-schema:
        resname: cwmp-datamodel-report-1-0.xsd
        text: |
          * Added *noUnitsTemplate* to suppress "missing *{{units}}*
            template" warnings
          * Added *previousCommand* and *previousEvent* attributes
      dt-schema:
        resname: cwmp-devicetype-1-10.xsd
        text: |
          * Updated to reference latest published DM Schema version (v1.10)
          * Note that the DT Schema is v1.10 to match the DM Schema (DT
            Schema v1.7, v1.8 and v1.9 were skipped)

  # XXX need to define some version revision rules so can guarantee to be able
  #     to derive useful information from them
  v1.11.0:
    # contribution used for developing the specification
    contrib:

    # publication date
    date: 2022-01-27

    # backslash and following whitespace is discarded
    # XXX will probably be removing this logic
    # XXX can usually rely on auto-generated titles (add details)
    title:

    # tag effectively defaults to the revision; to omit tags, set tag or
    # tags to null

    # editors for this version
    editors:
      - William Lupton, Broadband Forum

    changes:
      # can split into sections
      # XXX add more here about relationship to specification and other
      #     resources
      specification:
        # pandoc 'fenced_divs' syntax is used for conditional text (unfenced
        # text is always included)
        text: |
          ::: USP :::
          * Clarified *forcedEnabled* and *forceDefaultEnabled* for USP
          :::
          * Clarified impact of deprecating or obsoleting profile items
          * Documented new description templates
          * Documented new *secured* attribute

      dm-schema:
        resname: cwmp-datamodel-1-9.xsd
        text: |
          * Allowed the *version* attribute in component references
          * Allowed *minEntries* and *maxEntries* in command and event
            argument objects
          * Allowed *status* attribute in profile command/event arguments
          * Added *secured* attribute

      dmr-schema:
        resname: cwmp-datamodel-report-1-0.xsd
        text: |
          * Changed version number to *1-0*, which indicates new
            markdown-friendly wrapped descriptions
          * Added *customNumEntriesParameter*, *noDiscriminatorParameter*
            and *noUnionObject* to suppress various warnings

      dt-schema:
        resname: cwmp-devicetype-1-6.xsd
        text: |
          * Updated to reference latest published DM Schema version (v1.9)

  v1.10.0:
    date: 2020-11-05
    editors:
      - William Lupton, Broadband Forum
    changes:
      specification:
        text: |
          * Converted document to markdown
          * Various editorial improvements
      dm-schema:
        resname: cwmp-datamodel-1-8.xsd
        text: |
          * Allowed command attributes, e.g. mandatory, in component
            definitions
      dt-schema:
        resname: cwmp-devicetype-1-5.xsd
        text: |
          * Updated to reference latest published DM Schema version (v1.8)
          * Supported event and command structures in device type files

  v1.9.0:
    date: 2019-09-04
    changes:
      # if the specification didn't change, don't add a 'specification' section
      # (if you do, the default title will link to a non-existent spec)
      text: |
        * Schema updates; document not updated
      dm-schema:
        resname: cwmp-datamodel-1-7.xsd
        text: |
          * Supported implementation defaults, version attribute,
            description templates, writeOnceReadOnly access type
            and the decimal datatype
      dt-schema:
        resname: cwmp-devicetype-1-4.xsd
        text: |
          * Updated to reference latest published DM Schema version (v1.7)
      dm-types:
        resname: tr-106-types.xml
        text: |
          * Added datatypes from versioned files
          * Added CWMP and USP versions of the Alias datatype
          * Added URI, URL and URL datatypes
      dm-bibrefs:
        resname: tr-069-biblio.xml
        text: |
          * Added references from versioned files (grouped by category and
            sorted within category)
          * Updated references for convention that "TR-nnn" means the latest
            Amendment and Corrigendum
          * Added references in support of Device:2.13 DM Instances
          * Added references for 3GPP 5G standards in support of Device:2.14
            DM Instances

  v1.8.0:
    date: 2018-05-10
    editors:
      - Jean-Didier Ott, Orange
      - William Lupton, Broadband Forum
    changes:
      specification:
        text: |
          * Added support of USP (mountable objects)
          * Removed references to obsolete data models
          * Moved device requirements to TR-069
      dm-schema:
        resname: cwmp-datamodel-1-6.xsd
        text: |
          * Supported USP commands, events and mount points
      # this has been around for a long time; adding it here because this was the
      # first version that supported USP
      catalog:
        text: |
          * Original

  v1.7.0+:
    date: 2014-09-17
    changes: |
      * Support file updates; document not updated

  v1.7.0:
    date: 2013-09-09
    editors:
      - William Lupton, Cisco
    changes:
      specification:
        text: |
          * Added descriptions of new features in DM Schema (v1.4 & v1.5) and
            DT Schema (v1.2 & v1.3)
          * Added Annex defining additional requirements for BBF standard data
            models
      dm-schema:
        resname: cwmp-datamodel-1-5.xsd
        text: |
          * Added *profile/@minVersion* attribute
          * Allowed *uniqueKey* parameters to be in sub-objects
          * Added *UUID* data type
          * Added *nestedBrackets* attribute, and allowed use of the
            *list* facet in named data type definitions
          * Several other minor updates and clarifications
      dt-schema:
        resname: cwmp-devicetype-1-3.xsd
        text: |
          * Many minor updates and clarifications

  v1.6.0:
    date: 2011-07
    editors:
      - Sarah Banks, Cisco
      - Andrea Colmegna, FASTWEB
      - Tim Spets, Motorola Mobility
    changes:
      specification:
        text: |
          * Removed definition of proxying, now defined in TR-069
          * Removed Common objects
          * Alias Parameter Requirements added
      dm-schema:
        resname: cwmp-datamodel-1-4.xsd
        text: |
          * Added top-level *file* attribute
      dt-schema:
        resname: cwmp-devicetype-1-2.xsd
        text: |
          * Added top-level UUID data type and attribute

  v1.5.0:
    date: 2010-11
    editors:
      - Paul Sigurdson, Broadband Forum
    changes:
      specification:
        text: |
          * Replaced definitions of named data types such as IPAddress with
            references to normative XML
          * Minor changes to DM Schema (v1.3) and DT Schema (v1.1)
      dm-schema:
        resname: cwmp-datamodel-1-3.xsd
        text: |
          * Relaxed some referential constraints (in the light of experience)
          * Added *description/@action* prefix option
          * Added *syntax/@command*
      dt-schema:
        resname: cwmp-devicetype-1-1.xsd
        text: |
          * Minor changes tracking DM Schema v1.3 changes

  v1.4.0:
    date: 2010-02
    editors:
      - William Lupton, 2Wire
      - Paul Sigurdson, Broadband Forum
    changes:
      specification:
        text: |
          * Moved data model definitions to TR-181 Issue 1
      dm-schema:
        resname: cwmp-datamodel-1-2.xsd
        text: |
          * Distinguished functional and non-functional keys
          * Supported *#.A* relative path syntax

  v1.3.0:
    date: 2009-09
    editors:
      - William Lupton, 2Wire
      - Håkan Westin, Tilgin
    changes:
      specification:
        text: |
          * Addition of device type XML Schema
      dm-schema:
        resname: cwmp-datamodel-1-1.xsd
        text: |
          * Made *import/@file* optional
          * Supported *range/@step*
      dmr-schema:
        resname: cwmp-datamodel-report.xsd
        text: |
          * Added *noUniqueKeys*
      dt-schema:
        resname: cwmp-devicetype-1-0.xsd
        text: |
          * Original
      dtf-schema:
        resname: cwmp-devicetype-features.xsd
        text: |
          * Original

  v1.2.0:
    date: 2008-11
    editors:
      - William Lupton, 2Wire
      - Håkan Westin, Tilgin
    changes:
      specification:
        text: |
          * Addition of data model definition XML Schema and normative XML
            common object and component definitions
      data-model:
        restype: root
        resname: Device:1.2
        text: |
          * Minor clarifications
      dm-schema:
        resname: cwmp-datamodel-1-0.xsd
        text: |
          * Original
      dmr-schema:
        resname: cwmp-datamodel-report.xsd
        text: |
          * Original

  v1.1.0:
    date: 2006-11
    no-tags: true
    editors:
      - Jeff Bernstein, 2Wire
      - John Blackford, 2Wire
      - Mike Digdon, SupportSoft
      - Heather Kirksey, Motive
      - William Lupton, 2Wire
      - Anton Okmianski, Cisco
    changes:
      specification:
        text: |
          * Clarification of original document
      data-model:
        restype: root
        resname: Device:1.1
        text: |
          * Added TR-069 Annex F and G ("TR-111") objects
          * Many clarifications to parameter descriptions

  v1.0.0:
    date: 2005-09
    editors:
      - Jeff Bernstein, 2Wire
      - Christele Bouchat, Alcatel
      - Tim Spets, Westell
    no-tags: true
    changes:
      specification:
        text: |
          * Original
      data-model:
        restype: root
        resname: Device:1.0
        text: |
          * Original

# Work Area and Work Area Directors
WA: Broadband User Services
WADs:
  - Jason Walls, QA Cafe
  - John Blackford, Vantiva

# Project Stream and Project Stream Leaders
# here the PS is empty
PS:
PSLs:
  - Daniel Egger, Axiros
  - Matthieu Anne, Orange