Merge pull request #996 from tranchitella/fix-api-docs

fix: example for the artifact info properties in the API docs
mendersoftware · Feb 19, 2024 · ea39612 · ea39612
2 parents 92d7771 + c16f5ed
commit ea39612
Show file tree

Hide file tree

Showing 3 changed files with 40 additions and 40 deletions.
diff --git a/docs/internal_api.yml b/docs/internal_api.yml
@@ -780,8 +780,8 @@ definitions:
             name: Application 1.0.0
             device_types_compatible: [Beagle Bone]
             info:
-              type_info:
-                type: rootfs
+              format: mender
+              version: 3
             signed: false
             updates:
               - type_info:
@@ -914,8 +914,8 @@ definitions:
           name: Application 1.0.0
           device_types_compatible: [Beagle Bone]
           info:
-            type_info:
-              type: rootfs
+            format: mender
+            version: 3
           signed: false
           updates:
             - type_info:

diff --git a/docs/management_api.yml b/docs/management_api.yml
@@ -778,8 +778,8 @@ paths:
                     description: Johns Monday test build
                     device_types_compatible: [Beagle Bone]
                     info:
-                      type_info:
-                        type: rootfs
+                      format: mender
+                      version: 3
                     signed: false
                     updates:
                       - type_info:
@@ -806,8 +806,8 @@ paths:
                     description: Johns Monday test build
                     device_types_compatible: [Raspberry Pi]
                     info:
-                      type_info:
-                        type: rootfs
+                      format: mender
+                      version: 3
                     signed: false
                     updates:
                       - type_info:
@@ -836,8 +836,8 @@ paths:
                     description: Johns Monday test build
                     device_types_compatible: [Beagle Bone]
                     info:
-                      type_info:
-                        type: rootfs
+                      format: mender
+                      version: 3
                     signed: false
                     updates:
                       - type_info:
@@ -949,8 +949,8 @@ paths:
                     description: Johns Monday test build
                     device_types_compatible: [Beagle Bone]
                     info:
-                      type_info:
-                        type: rootfs
+                      format: mender
+                      version: 3
                     signed: false
                     updates:
                       - type_info:
@@ -977,8 +977,8 @@ paths:
                     description: Johns Monday test build
                     device_types_compatible: [Raspberry Pi]
                     info:
-                      type_info:
-                        type: rootfs
+                      format: mender
+                      version: 3
                     signed: false
                     updates:
                       - type_info:
@@ -1007,8 +1007,8 @@ paths:
                     description: Johns Monday test build
                     device_types_compatible: [Beagle Bone]
                     info:
-                      type_info:
-                        type: rootfs
+                      format: mender
+                      version: 3
                     signed: false
                     updates:
                       - type_info:
@@ -1388,8 +1388,8 @@ paths:
               description: Johns Monday test build
               device_types_compatible: [Beagle Bone]
               info:
-                type_info:
-                  type: rootfs
+                format: mender
+                version: 3
               signed: false
               updates:
                 - type_info:
@@ -1937,8 +1937,8 @@ definitions:
           name: Application 1.0.0
           device_types_compatible: [Beagle Bone]
           info:
-            type_info:
-              type: rootfs
+            format: mender
+            version: 3
           signed: false
           updates:
             - type_info:
@@ -2000,8 +2000,8 @@ definitions:
             name: Application 1.0.0
             device_types_compatible: [Beagle Bone]
             info:
-              type_info:
-                type: rootfs
+              format: mender
+              version: 3
             signed: false
             updates:
               - type_info:
@@ -2146,8 +2146,8 @@ definitions:
       description: Johns Monday test build
       device_types_compatible: [Beagle Bone]
       info:
-        type_info:
-          type: rootfs
+        format: mender
+        version: 3
       signed: false
       updates:
         - type_info:
@@ -2285,8 +2285,8 @@ definitions:
           description: Johns Monday test build
           device_types_compatible: [Beagle Bone]
           info:
-            type_info:
-              type: rootfs
+            format: mender
+            version: 3
           signed: false
           updates:
             - type_info:
@@ -2313,8 +2313,8 @@ definitions:
           description: Johns Monday test build
           device_types_compatible: [Raspberry Pi]
           info:
-            type_info:
-              type: rootfs
+            format: mender
+            version: 3
           signed: false
           updates:
             - type_info:

diff --git a/docs/management_api_v2.yml b/docs/management_api_v2.yml
@@ -124,8 +124,8 @@ paths:
                     description: Johns Monday test build
                     device_types_compatible: [Beagle Bone]
                     info:
-                      type_info:
-                        type: rootfs
+                      format: mender
+                      version: 3
                     signed: false
                     updates:
                       - type_info:
@@ -152,8 +152,8 @@ paths:
                     description: Johns Monday test build
                     device_types_compatible: [Raspberry Pi]
                     info:
-                      type_info:
-                        type: rootfs
+                      format: mender
+                      version: 3
                     signed: false
                     updates:
                       - type_info:
@@ -182,8 +182,8 @@ paths:
                     description: Johns Monday test build
                     device_types_compatible: [Beagle Bone]
                     info:
-                      type_info:
-                        type: rootfs
+                      format: mender
+                      version: 3
                     signed: false
                     updates:
                       - type_info:
@@ -456,8 +456,8 @@ definitions:
       description: Johns Monday test build
       device_types_compatible: [Beagle Bone]
       info:
-        type_info:
-          type: rootfs
+        format: mender
+        version: 3
       signed: false
       updates:
         - type_info:
@@ -543,8 +543,8 @@ definitions:
           description: Johns Monday test build
           device_types_compatible: [Beagle Bone]
           info:
-            type_info:
-              type: rootfs
+            format: mender
+            version: 3
           signed: false
           updates:
             - type_info:
@@ -571,8 +571,8 @@ definitions:
           description: Johns Monday test build
           device_types_compatible: [Raspberry Pi]
           info:
-            type_info:
-              type: rootfs
+            format: mender
+            version: 3
           signed: false
           updates:
             - type_info: