#703 Bump Compliance Info schema version

.golangci.yml

@@ -80,4 +80,12 @@ issues:
         - perfsprint
         - dupword
         - testifylint
+    - path: _test\.go$
+      linters:
+        - staticcheck
+      text: "SA1019:"
+    - path: helpers\.go$
+      linters:
+        - staticcheck
+      text: "SA1019:"
 

Dockerfile

@@ -22,7 +22,7 @@
 FROM ubuntu:20.04 AS builder
 
 ARG GO_VERSION
-ENV GO_VERSION=1.20
+ENV GO_VERSION=1.20.14
 
 RUN apt-get update --fix-missing
 RUN apt-get install -y wget git gcc

Dockerfile-build

@@ -20,7 +20,7 @@
 FROM ubuntu:20.04 AS builder
 
 ARG GO_VERSION
-ENV GO_VERSION=1.20
+ENV GO_VERSION=1.20.14
 
 RUN apt-get update
 RUN apt-get install -y wget git gcc make

docs/mapping_against_matter_spec.md

@@ -27,16 +27,16 @@ Below is the list of notes to consider while mapping DCL Compliance module to Ma
 1. The [Device Software Compliance schema](https://github.com/CHIP-Specifications/connectedhomeip-spec/blob/master/src/service_device_management/DistributedComplianceLedger.adoc#8-devicesoftwarecompliance--compliance-test-result-schema) corresponds to the [Compliance Info](../proto/zigbeealliance/distributedcomplianceledger/compliance/compliance_info.proto) entity, and the associated `write/read` requests can be found in the [Compliance section](transactions.md#compliance)
 2. In DCL, specific endpoints are used (by CSA) to handle [certification status](https://github.com/CHIP-Specifications/connectedhomeip-spec/blob/master/src/service_device_management/DistributedComplianceLedger.adoc#82-softwareversioncertificationstatusenum-type) of the device software version according to the provided `certificatType`(ZB/Matter):
    - [Provision](transactions/compliance.md#PROVISION_MODEL) endpoint is used to register that particular device software is in `provisional` (going into certification testing phase) state
-      * **Note:** This endpoint **cannot** be used for device software versions that are already in `compliant` or `revoked` state
-   - [Certify](transactions/compliance.md#CERTIFY_MODEL) endpoint is used to register that particular device software version is in `compliant` state
+      * **Note:** This endpoint **cannot** be used for device software versions that are already in `certified` or `revoked` state
+   - [Certify](transactions/compliance.md#CERTIFY_MODEL) endpoint is used to register that particular device software version is in `certified` state
       * **Note:** This endpoint **can** be used for device software versions that are already in `provisional` or `revoked` state (e.g. re-certification)
    - [Revoke](transactions/compliance.md#REVOKE_MODEL_CERTIFICATION) endpoint is used to register that particular device software version is `revoked`
-     * **Note:** This endpoint **can** be used for device software versions that are already in `provisional` or `compliant` state
+     * **Note:** This endpoint **can** be used for device software versions that are already in `provisional` or `certified` state
    - [Update](transactions/compliance.md#UPDATE_COMPLIANCE_INFO) endpoint is used to update the additional-info/metadata of a particular device software version
      * **Note:** This endpoint **cannot** be used to change the certification status
 3. In DCL, there are several query endpoints can be used for specific reading purposes.
    - [Provisional Model](transactions/compliance.md#GET_PROVISIONAL_MODEL) can be used to retrieve/check the software version certification of particular device is in `provisional` state
-   - [Certified Model](transactions/compliance.md#GET_CERTIFIED_MODEL) can be used to retrieve/check the software version certification of particular device in `compliant` state
+   - [Certified Model](transactions/compliance.md#GET_CERTIFIED_MODEL) can be used to retrieve/check the software version certification of particular device in `certified` state
    - [Revoked Model](transactions/compliance.md#GET_REVOKED_MODEL) can be used to retrieve/check the software version certification of particular device in `revoked` state
    - [Compliance Info](transactions/compliance.md#GET_COMPLIANCE_INFO) can be used to get the full compliance(including certification state) information of a particular device software version, bypassing state check query calls mentioned above
    - [Device Software Compliance](transactions/compliance.md#GET_DEVICE_SOFTWARE_COMPLIANCE) can be used to get all compliance records associated with [CD Certificate ID](https://github.com/CHIP-Specifications/connectedhomeip-spec/blob/master/src/service_device_management/DistributedComplianceLedger.adoc#83-cdcertificateid)

docs/static/openapi.yml

@@ -285,8 +285,10 @@ paths:
                       type: string
                     compliantPlatformUsed:
                       type: string
+                      title: Deprecated
                     compliantPlatformVersion:
                       type: string
+                      title: Deprecated
                     transport:
                       type: string
                     familyId:
@@ -295,13 +297,18 @@ paths:
                       type: string
                     OSVersion:
                       type: string
+                      title: Deprecated
                     parentChild:
                       type: string
                     certificationIdOfSoftwareComponent:
                       type: string
+                      title: Deprecated
                     schemaVersion:
                       type: integer
                       format: int64
+                    specificationVersion:
+                      type: integer
+                      format: int64
               pagination:
                 type: object
                 properties:
@@ -473,8 +480,10 @@ paths:
                     type: string
                   compliantPlatformUsed:
                     type: string
+                    title: Deprecated
                   compliantPlatformVersion:
                     type: string
+                    title: Deprecated
                   transport:
                     type: string
                   familyId:
@@ -483,13 +492,18 @@ paths:
                     type: string
                   OSVersion:
                     type: string
+                    title: Deprecated
                   parentChild:
                     type: string
                   certificationIdOfSoftwareComponent:
                     type: string
+                    title: Deprecated
                   schemaVersion:
                     type: integer
                     format: int64
+                  specificationVersion:
+                    type: integer
+                    format: int64
         default:
           description: An unexpected error response.
           schema:
@@ -605,8 +619,10 @@ paths:
                             type: string
                           compliantPlatformUsed:
                             type: string
+                            title: Deprecated
                           compliantPlatformVersion:
                             type: string
+                            title: Deprecated
                           transport:
                             type: string
                           familyId:
@@ -615,13 +631,18 @@ paths:
                             type: string
                           OSVersion:
                             type: string
+                            title: Deprecated
                           parentChild:
                             type: string
                           certificationIdOfSoftwareComponent:
                             type: string
+                            title: Deprecated
                           schemaVersion:
                             type: integer
                             format: int64
+                          specificationVersion:
+                            type: integer
+                            format: int64
                     schemaVersion:
                       type: integer
                       format: int64
@@ -803,8 +824,10 @@ paths:
                           type: string
                         compliantPlatformUsed:
                           type: string
+                          title: Deprecated
                         compliantPlatformVersion:
                           type: string
+                          title: Deprecated
                         transport:
                           type: string
                         familyId:
@@ -813,13 +836,18 @@ paths:
                           type: string
                         OSVersion:
                           type: string
+                          title: Deprecated
                         parentChild:
                           type: string
                         certificationIdOfSoftwareComponent:
                           type: string
+                          title: Deprecated
                         schemaVersion:
                           type: integer
                           format: int64
+                        specificationVersion:
+                          type: integer
+                          format: int64
                   schemaVersion:
                     type: integer
                     format: int64
@@ -9221,6 +9249,9 @@ paths:
                   specificationVersion:
                     type: integer
                     format: int64
+                    title: >-
+                      Deprecated: will be stated/stored in ComplianceInfo
+                      record:
         default:
           description: An unexpected error response.
           schema:
@@ -17370,8 +17401,10 @@ definitions:
         type: string
       compliantPlatformUsed:
         type: string
+        title: Deprecated
       compliantPlatformVersion:
         type: string
+        title: Deprecated
       transport:
         type: string
       familyId:
@@ -17380,13 +17413,18 @@ definitions:
         type: string
       OSVersion:
         type: string
+        title: Deprecated
       parentChild:
         type: string
       certificationIdOfSoftwareComponent:
         type: string
+        title: Deprecated
       schemaVersion:
         type: integer
         format: int64
+      specificationVersion:
+        type: integer
+        format: int64
   zigbeealliance.distributedcomplianceledger.compliance.DeviceSoftwareCompliance:
     type: object
     properties:
@@ -17450,8 +17488,10 @@ definitions:
               type: string
             compliantPlatformUsed:
               type: string
+              title: Deprecated
             compliantPlatformVersion:
               type: string
+              title: Deprecated
             transport:
               type: string
             familyId:
@@ -17460,13 +17500,18 @@ definitions:
               type: string
             OSVersion:
               type: string
+              title: Deprecated
             parentChild:
               type: string
             certificationIdOfSoftwareComponent:
               type: string
+              title: Deprecated
             schemaVersion:
               type: integer
               format: int64
+            specificationVersion:
+              type: integer
+              format: int64
       schemaVersion:
         type: integer
         format: int64
@@ -17600,8 +17645,10 @@ definitions:
               type: string
             compliantPlatformUsed:
               type: string
+              title: Deprecated
             compliantPlatformVersion:
               type: string
+              title: Deprecated
             transport:
               type: string
             familyId:
@@ -17610,13 +17657,18 @@ definitions:
               type: string
             OSVersion:
               type: string
+              title: Deprecated
             parentChild:
               type: string
             certificationIdOfSoftwareComponent:
               type: string
+              title: Deprecated
             schemaVersion:
               type: integer
               format: int64
+            specificationVersion:
+              type: integer
+              format: int64
       pagination:
         type: object
         properties:
@@ -17711,8 +17763,10 @@ definitions:
                     type: string
                   compliantPlatformUsed:
                     type: string
+                    title: Deprecated
                   compliantPlatformVersion:
                     type: string
+                    title: Deprecated
                   transport:
                     type: string
                   familyId:
@@ -17721,13 +17775,18 @@ definitions:
                     type: string
                   OSVersion:
                     type: string
+                    title: Deprecated
                   parentChild:
                     type: string
                   certificationIdOfSoftwareComponent:
                     type: string
+                    title: Deprecated
                   schemaVersion:
                     type: integer
                     format: int64
+                  specificationVersion:
+                    type: integer
+                    format: int64
             schemaVersion:
               type: integer
               format: int64
@@ -17938,8 +17997,10 @@ definitions:
             type: string
           compliantPlatformUsed:
             type: string
+            title: Deprecated
           compliantPlatformVersion:
             type: string
+            title: Deprecated
           transport:
             type: string
           familyId:
@@ -17948,13 +18009,18 @@ definitions:
             type: string
           OSVersion:
             type: string
+            title: Deprecated
           parentChild:
             type: string
           certificationIdOfSoftwareComponent:
             type: string
+            title: Deprecated
           schemaVersion:
             type: integer
             format: int64
+          specificationVersion:
+            type: integer
+            format: int64
   zigbeealliance.distributedcomplianceledger.compliance.QueryGetDeviceSoftwareComplianceResponse:
     type: object
     properties:
@@ -18021,8 +18087,10 @@ definitions:
                   type: string
                 compliantPlatformUsed:
                   type: string
+                  title: Deprecated
                 compliantPlatformVersion:
                   type: string
+                  title: Deprecated
                 transport:
                   type: string
                 familyId:
@@ -18031,13 +18099,18 @@ definitions:
                   type: string
                 OSVersion:
                   type: string
+                  title: Deprecated
                 parentChild:
                   type: string
                 certificationIdOfSoftwareComponent:
                   type: string
+                  title: Deprecated
                 schemaVersion:
                   type: integer
                   format: int64
+                specificationVersion:
+                  type: integer
+                  format: int64
           schemaVersion:
             type: integer
             format: int64
@@ -23603,6 +23676,7 @@ definitions:
       specificationVersion:
         type: integer
         format: int64
+        title: 'Deprecated: will be stated/stored in ComplianceInfo record:'
   zigbeealliance.distributedcomplianceledger.model.ModelVersions:
     type: object
     properties:
@@ -23875,6 +23949,7 @@ definitions:
           specificationVersion:
             type: integer
             format: int64
+            title: 'Deprecated: will be stated/stored in ComplianceInfo record:'
   zigbeealliance.distributedcomplianceledger.model.QueryGetModelVersionsResponse:
     type: object
     properties: