Push changes for SystemLink 19.6 release (#67)

Updates the public repository with the latest OpenAPI documents for the SystemLink 19.6 release. Co-authored-by: Cristian Hotea <[email protected]> Co-authored-by: tschmittni <[email protected]> Co-authored-by: Alexander Weaver <[email protected]> Co-authored-by: vdeac <[email protected]> Co-authored-by: Christine Karas <[email protected]> Co-authored-by: mollykreis <[email protected]> Co-authored-by: Max Brown <[email protected]> Co-authored-by: vladbaja <[email protected]> Co-authored-by: Matthew Vaterlaus <[email protected]> Co-authored-by: Sergey Kizunov <[email protected]>
ni · Jan 8, 2020 · e6ec0ac · e6ec0ac
1 parent 0a01ff0
commit e6ec0ac
Show file tree

Hide file tree

Showing 15 changed files with 1,330 additions and 1,348 deletions.
diff --git a/asset-management-rule/niapmrule.yml b/asset-management-rule/niapmrule.yml
@@ -13,13 +13,18 @@ consumes:
 produces:
   - application/json
 securityDefinitions:
+  apiKeyAuth:
+    type: apiKey
+    name: x-ni-api-key
+    in: header
   basicAuth:
     type: basic
   cookieAuth:
     type: apiKey
     in: header
     name: Cookie
 security:
+  - apiKeyAuth: []
   - basicAuth: []
   - cookieAuth: []
 x-ni-routing-key: Skyline.AssetPerformanceManagementRuleEngine

diff --git a/asset-managment/niapm.yml b/asset-managment/niapm.yml
diff --git a/file/nifile.yml b/file/nifile.yml
@@ -146,6 +146,10 @@ definitions:
         type: integer
         format: int64
         example: 7277
+      workspace:
+        description: The workspace the file belongs to
+        type: string
+        example: MyWorkspace
   ServiceGroup:
     type: object
     properties:
@@ -684,6 +688,9 @@ paths:
                   type: string
                 example:
                   key: value
+              workspace:
+                description: This is an optional value. When specified, the workspace of the metadata will be updated to the new value.
+                type: string
             required:
               - replaceExisting
               - properties

diff --git a/ni-notebook-execution/ninbexec.yml b/ni-notebook-execution/ninbexec.yml
@@ -13,6 +13,10 @@ consumes: [application/json]
 produces: [application/json]
 
 securityDefinitions:
+  apiKeyAuth:
+    type: apiKey
+    name: x-ni-api-key
+    in: header
   basicAuth:
     type: basic
   cookieAuth:
@@ -21,6 +25,7 @@ securityDefinitions:
     name: Cookie
 
 security:
+  - apiKeyAuth: []
   - basicAuth: []
   - cookieAuth: []
 

diff --git a/opcclient/niopcclient.yml b/opcclient/niopcclient.yml
@@ -13,6 +13,10 @@ consumes: [application/json]
 produces: [application/json]
 
 securityDefinitions:
+  apiKeyAuth:
+    type: apiKey
+    name: x-ni-api-key
+    in: header        
   basicAuth:
     type: basic
   cookieAuth:
@@ -21,6 +25,7 @@ securityDefinitions:
     name: Cookie
 
 security:
+  - apiKeyAuth: []
   - basicAuth: []
   - cookieAuth: []
 

diff --git a/repo/nirepo.yml b/repo/nirepo.yml
@@ -12,6 +12,10 @@ consumes: [application/json]
 produces: [application/json]
 
 securityDefinitions:
+  apiKeyAuth:
+    type: apiKey
+    name: x-ni-api-key
+    in: header
   basicAuth:
     type: basic
   cookieAuth:
@@ -20,6 +24,7 @@ securityDefinitions:
     name: Cookie
 
 security:
+  - apiKeyAuth: []
   - basicAuth: []
   - cookieAuth: []
 
@@ -1780,4 +1785,4 @@ paths:
         401:
           $ref: '#/definitions/Unauthorized'            
         default:
-          $ref: '#/definitions/Error'
+          $ref: '#/definitions/Error'
diff --git a/systems-management/nisysmgmt.yml b/systems-management/nisysmgmt.yml
@@ -13,6 +13,10 @@ consumes: [application/json]
 produces: [application/json]
 
 securityDefinitions:
+  apiKeyAuth:
+    type: apiKey
+    name: x-ni-api-key
+    in: header
   basicAuth:
     type: basic
   cookieAuth:
@@ -21,6 +25,7 @@ securityDefinitions:
     name: Cookie
 
 security:
+  - apiKeyAuth: []
   - basicAuth: []
   - cookieAuth: []
 
@@ -635,14 +640,34 @@ definitions:
         format: date-time
         example: '2019-02-11T13:32:06.030958Z'
       data:
-        description: This map is used for grains/packages/feeds. All these are heterogeneous (integers, booleans, lists, dictionaries, ...) collections containing open-ended properties and flags.
+        description: This map is used for grains/feeds. All these are heterogeneous (integers, booleans, lists, dictionaries, ...) collections containing open-ended properties and flags.
         type: object
         additionalProperties:
           type: object
         example:
           key: value
     required: [lastUpdatedTimestamp, data]
 
+  ManagedSystemPackagesData:
+    description: Property of a system composed by the last updated timestamp and a dictionary with the actual packages installed on the system.
+    type: object
+    properties:
+      lastUpdatedTimestamp:
+        description: Last updated timestamp.
+        type: string
+        format: date-time
+        example: '2019-02-11T13:32:06.030958Z'
+      data:
+        description: Installed packages. The key of the dictionary is the name of the package, and the value is a dictionary with open-ended properties and flags
+        type: object
+        additionalProperties:
+          type: object
+          additionalProperties:
+            type: object
+        example:
+          key: value
+    required: [lastUpdatedTimestamp, data]
+
   ManagedSystem:
     description: Information about a managed system.
     title: Managed System
@@ -712,7 +737,7 @@ definitions:
             osrelease: 7
       packages:
         description: Software packages installed on the system.
-        $ref: '#/definitions/ManagedSystemDataPropertyMap'
+        $ref: '#/definitions/ManagedSystemPackagesData'
         example:
           lastUpdatedTimestamp: '2019-02-19T11:42:25.078Z'
           data:
@@ -1318,7 +1343,9 @@ definitions:
 
           - getGroups: The ability to retrieve the groups.
 
-          - manageSystems: The ability to register or unregister systems.
+          - manageSystems: The ability to manage keys and unregister systems.
+
+          - discoverSystems: The ability to discover and register systems.
 
           - createOrCancelJobs: The ability to create or cancel jobs.
 
@@ -1340,6 +1367,8 @@ definitions:
             $ref: '#/definitions/Operation'
           manageSystems:
             $ref: '#/definitions/Operation'
+          discoverSystems:
+            $ref: '#/definitions/Operation'
           createOrCancelJobs:
             $ref: '#/definitions/Operation'
           activateSystems:
@@ -1553,7 +1582,7 @@ definitions:
         example: 'lastUpdatedTimestamp descending'
         description: The order in which data returns.
 
-  QueryResponse:
+  QueryJobsResponse:
     description: Response of a query request.
     title: Query Response
     properties:
@@ -1571,6 +1600,28 @@ definitions:
         example: 1
     required: [data, count]
 
+  QuerySystemsResponse:
+    description: Response of a query systems request.
+    title: Query Systems response
+    properties:
+      data:
+        description: The data returned by query.
+        type: array
+        items:
+          type: object
+        example:
+          id: 'NI_PXIe-8880--SN-030A5D78--MAC-00-80-2F-21-C6-86'
+          grains:
+            data:
+              key: 'value'
+          lastUpdatedTimestamp: '2019-10-29T10:47:04.596+02:00'
+      count:
+        description: The total number of resources that matched the query.
+        type: integer
+        format: int64
+        example: 1
+    required: [data, count]
+
 paths:
   /:
     get:
@@ -1665,7 +1716,7 @@ paths:
           name: state
           description: A string defining the job state.
           type: string
-          x-example: Succeeded
+          x-example: SUCCEEDED
         - in: query
           name: fun
           description: A string defining the function executed by the job.
@@ -2063,6 +2114,8 @@ paths:
           $ref: '#/responses/PartialSuccess'
         204:
           description: No Content.
+        400:
+          $ref: '#/responses/BadRequest'
         401:
           $ref: '#/responses/Unauthorized'
         404:
@@ -2245,7 +2298,7 @@ paths:
       x-ni-request-timeout: 300000
       x-ni-operation: manageFeeds
       tags: [feeds]
-      summary: Get Available Packages
+      summary: Query packages
       description: Get available packages for a set of system configurations. If multiple system configurations are provided, only packages available to all applicable systems are returned. If OS architectures are provided, only the package with highest priority will be returned for packages of equal version.
       parameters:
         - in: body
@@ -2276,7 +2329,7 @@ paths:
       x-ni-operation: getJobs
       x-ni-request-timeout: 120000
       tags: [jobs]
-      summary: Get jobs by query
+      summary: Query jobs
       description: Get jobs by query.
       parameters:
         - in: body
@@ -2289,7 +2342,9 @@ paths:
         200:
           description: OK.
           schema:
-            $ref: '#/definitions/QueryResponse'
+            $ref: '#/definitions/QueryJobsResponse'
+        400:
+          $ref: '#/responses/BadRequest'
         401:
           $ref: '#/responses/Unauthorized'
         404:
@@ -2303,7 +2358,7 @@ paths:
       x-ni-operation: getSystems
       x-ni-request-timeout: 120000
       tags: [systems]
-      summary: Get systems by query.
+      summary: Query systems
       description: Get systems by query.
       parameters:
         - in: body
@@ -2316,7 +2371,9 @@ paths:
         200:
           description: OK.
           schema:
-            $ref: '#/definitions/QueryResponse'
+            $ref: '#/definitions/QuerySystemsResponse'
+        400:
+          $ref: '#/responses/BadRequest'
         401:
           $ref: '#/responses/Unauthorized'
         404:

diff --git a/systems-state/nisystemsstate.yml b/systems-state/nisystemsstate.yml
@@ -14,6 +14,10 @@ consumes: [application/json]
 produces: [application/json]
 
 securityDefinitions:
+  apiKeyAuth:
+    type: apiKey
+    name: x-ni-api-key
+    in: header
   basicAuth:
     type: basic
   cookieAuth:
@@ -22,6 +26,7 @@ securityDefinitions:
     name: Cookie
 
 security:
+  - apiKeyAuth: []
   - basicAuth: []
   - cookieAuth: []
 
@@ -530,11 +535,16 @@ definitions:
       version:
         type: string
         description: Version of the package.
+      installRecommends:
+        type: boolean
+        description: A boolean variable whose value controls the installation of the recommended packages. This property is available starting with version 2 of the getStates and createOrUpdateStates operations.
+        default: true
     required:
       - name
     example:
       name: vim
       version: '7.1'
+      installRecommends: true
 
 paths:
   /: