diff --git a/alarm/nialarm.yml b/alarm/nialarm.yml index 8c697c6..a507b34 100644 --- a/alarm/nialarm.yml +++ b/alarm/nialarm.yml @@ -4,7 +4,7 @@ info: title: Alarm Web Service description: SystemLink Alarm Service HTTP API. Only available on SystemLink Server. contact: - name: National Instruments + name: NI url: 'https://www.ni.com/systemlink' email: support@ni.com basePath: /nialarm @@ -189,6 +189,13 @@ definitions: description: The number of transitions which overflowed a given alarm instance's *transition's* field type: integer example: 0 + notificationStrategyIds: + description: The IDs of the notification strategies which should be triggered if this request results + in an alarm instance being created or transitioning to a new highest severity + type: array + items: + type: string + example: [] currentSeverityLevel: description: The current severity level of a given alarm instance type: integer @@ -291,13 +298,6 @@ definitions: example: 2 default: 2 minimum: -1 - notificationStrategyIds: - description: The IDs of the notification strategies which should be triggered if this request results - in an alarm instance being created or transitioning to a new highest severity - type: array - items: - type: string - example: [] condition: description: A description of the condition associated with the transition type: string @@ -731,6 +731,13 @@ paths: example: 3d411024-9db8-42d1-8ab8-6cee0e6cd841 transition: $ref: '#/definitions/AlarmTransition' + notificationStrategyIds: + description: The IDs of the notification strategies which should be triggered if this request results + in an alarm instance being created or transitioning to a new highest severity + type: array + items: + type: string + example: [] createdBy: description: An identifier for who or what created a given alarm instance. This is usually used to identify the particular rule engine which requested that a given alarm be created. diff --git a/asset-management-rule/niapmrule.yml b/asset-management-rule/niapmrule.yml index 108aa4c..afc038a 100644 --- a/asset-management-rule/niapmrule.yml +++ b/asset-management-rule/niapmrule.yml @@ -4,7 +4,7 @@ info: title: Asset Performance Management Rule Web Service description: Create and manage calibration rules for assets. contact: - name: National Instruments + name: NI url: 'https://www.ni.com/systemlink' email: support@ni.com basePath: /niapmrule diff --git a/asset-managment/niapm.yml b/asset-managment/niapm.yml index 64927c9..e88d1a4 100644 --- a/asset-managment/niapm.yml +++ b/asset-managment/niapm.yml @@ -4,7 +4,7 @@ info: title: Asset Performance Management Web Service description: Asset Performance Management HTTP API contact: - name: National Instruments + name: NI url: 'https://www.ni.com/systemlink' email: support@ni.com basePath: /niapm @@ -530,6 +530,14 @@ definitions: items: type: string example: '608a5684800e325b48837c2a' + supportsSelfTest: + description: Whether the asset supports self-test. + type: boolean + example: true + supportsReset: + description: Whether the asset supports reset. + type: boolean + example: true AssetCreateModel: title: Asset Create Model description: >- @@ -881,7 +889,7 @@ definitions: vendorName: description: Vendor name of the asset. type: string - example: National Instruments + example: NI vendorNumber: description: Vendor number of the asset. type: integer @@ -1387,7 +1395,7 @@ parameters: - It determines the type of the report. When true, the file will be a calibration report. If this is false, the file will be an asset report. - - If asset IDs are in the request, this property will not be used for filtering. If no asset IDs are in the request, setting this property to true will generate a report only for the calibrated assets. + - If asset IDs property or the filter string are in the request, this property will not be used for filtering. If no asset IDs are in the request and the filter string is unspecified, setting this property to true will generate a report only for the calibrated assets. type: boolean default: false @@ -2802,7 +2810,7 @@ paths: post: tags: [assets] summary: Query assets - description: Returns the assets satisfying the provided filtering criteria. If the the caller requests a JSON inline response, the returned assets are filtered based on the filter string and the IDs and calibratableOnly properties are not taken into consideration. When the caller requests a CSV response, the filter is not taken into consideration, but the IDs and calibratableOnly properties are used to filter the assets from the response. + description: Returns the assets satisfying the provided filtering criteria. If the the caller requests a JSON inline response, the returned assets are filtered based on the filter string and the IDs and calibratableOnly properties are not taken into consideration. When the caller requests a CSV response, the IDs property has higher precedence than the filter string when used to filter the assets from the response. operationId: query-assets x-ni-auth: true parameters: @@ -3215,14 +3223,14 @@ paths: post: tags: [reports] summary: Gets an asset availability history report for multiple assets. - description: Gets a CSV file report conatining asset availability history for multiple assets based on the specified timespans. + description: Gets a CSV file report containing asset availability history for multiple assets based on the specified timespans. operationId: query-assets-availability-report x-ni-auth: true parameters: - $ref: '#/parameters/QueryAssetsAvailabilityReportRequestBody' responses: 200: - description: A CSV file report conatining the asset availability history of the assets specified by their IDs during the given time intervals. + description: A CSV file report containing the asset availability history of the assets specified by their IDs during the given time intervals. schema: type: file example: "Asset Id,Asset Name,Start Date,End Date,System Alias,Availability Percentage\n0030b58e-4e1a-47ea-9e1e-d60ba3341551,PXI3Slot7,2020-11-10 00:00:00Z,2021-01-06 00:00:00Z,NI_PXIe-8133_Embedded_Controller--MAC-00-80-2F-14-2C-06,0.0815299529054917" diff --git a/auth/niauth.yaml b/auth/niauth.yaml index fe42e22..c0ea59f 100644 --- a/auth/niauth.yaml +++ b/auth/niauth.yaml @@ -2,6 +2,11 @@ swagger: '2.0' info: version: '1.0' title: SystemLink Auth Service + description: Manage authorization policies for a SystemLink server. + contact: + name: NI + url: https://www.ni.com/systemlink + email: support@ni.com basePath: /niauth/v1 consumes: - application/json @@ -12,8 +17,11 @@ securityDefinitions: type: apiKey name: x-ni-api-key in: header + BasicAuth: + type: basic security: - ApiKeyAuth: [] + - BasicAuth: [] paths: /auth: get: @@ -743,31 +751,31 @@ definitions: message: There has been an error with your request args: [] innerErrors: [] - + UserPolicy: type: object title: User Policy description: A policy defines what a user or device is allowed to do properties: - id: + id: description: The identifier of a policy type: string name: description: The policy name type: string - templateId: + templateId: description: The identifier of a policy template type: string - workspaceId: + workspaceId: description: The identifier of a workspace type: string - + UserPolicyTemplate: type: object title: User Policy Template description: A policy template defines what a user or device is allowed to do but is not bound to a workspace. When the template is referenced by a policy, the connection between the actions and the workspace is created. properties: - id: + id: description: The identifier of a policy template type: string name: diff --git a/file/nifile.yml b/file/nifile.yml index 9267adb..47cdd03 100644 --- a/file/nifile.yml +++ b/file/nifile.yml @@ -4,7 +4,7 @@ info: title: SystemLink File Service description: Upload and download files from a SystemLink server contact: - name: National Instruments + name: NI url: https://www.ni.com/systemlink email: support@ni.com basePath: /nifile @@ -155,6 +155,11 @@ definitions: description: The workspace the file belongs to type: string example: MyWorkspace + lastUpdatedTimestamp: + description: The date and time the file was last updated in the file service + type: string + format: date-time + example: '2018-05-15T18:54:27.519Z' ServiceGroup: type: object properties: @@ -571,6 +576,7 @@ paths: - created - id - size + - lastUpdatedTimestamp - in: query name: orderByDescending description: >- diff --git a/message/nimessage.yml b/message/nimessage.yml index a6777a7..9fc869a 100644 --- a/message/nimessage.yml +++ b/message/nimessage.yml @@ -4,7 +4,7 @@ info: version: '1' title: SystemLink Message Service contact: - name: National Instruments + name: NI url: 'https://www.ni.com/systemlink' email: support@ni.com basePath: /nimessage diff --git a/ni-notebook-execution/ninbexec.yml b/ni-notebook-execution/ninbexec.yml index 23bc012..0840932 100644 --- a/ni-notebook-execution/ninbexec.yml +++ b/ni-notebook-execution/ninbexec.yml @@ -4,7 +4,7 @@ info: title: Notebook Execution Service description: Execute Jupyter notebooks. contact: - name: National Instruments + name: NI url: https://www.ni.com/systemlink email: support@ni.com basePath: /ninbexec diff --git a/opcclient/niopcclient.yml b/opcclient/niopcclient.yml index 6152100..c074412 100644 --- a/opcclient/niopcclient.yml +++ b/opcclient/niopcclient.yml @@ -4,7 +4,7 @@ info: title: OpcClientService HTTP APIs description: OpcClientService HTTP APIs contact: - name: National Instruments + name: NI url: https://www.ni.com/systemlink email: support@ni.com basePath: /niopcclient diff --git a/repo/nirepo.yml b/repo/nirepo.yml index a49e5e6..9391fac 100644 --- a/repo/nirepo.yml +++ b/repo/nirepo.yml @@ -4,7 +4,7 @@ info: title: "Package Repository Service" description: "Manages a repository of packages" contact: - name: National Instruments + name: NI url: https://www.ni.com/systemlink email: support@ni.com basePath: "/nirepo" @@ -754,7 +754,7 @@ definitions: maintainer: type: string description: The maintainer of this package. - example: "National Instruments " + example: "NI " predepends: type: array description: An array containing information about other packages this package predepends. @@ -823,7 +823,7 @@ definitions: Filename: 71e47fbf-2782-4c10-873e-dba414213dc9.nipkg Homepage: http://www.ni.com MD5Sum: 672a667ca32b6915ae9a968c55f80825 - Maintainer: National Instruments + Maintainer: NI Package: ni-securityupdate-kb67l8lcqw-killbits Priority: standard Section: Infrastructure diff --git a/service-registry/niserviceregistry.yml b/service-registry/niserviceregistry.yml index 4db5893..02753c6 100644 --- a/service-registry/niserviceregistry.yml +++ b/service-registry/niserviceregistry.yml @@ -4,7 +4,7 @@ info: title: Service Registry Web Service description: View information about installed SystemLink services contact: - name: National Instruments + name: NI url: 'https://www.ni.com/systemlink' email: support@ni.com basePath: /niserviceregistry diff --git a/systems-management/nisysmgmt.yml b/systems-management/nisysmgmt.yml index c0c1dbe..46ff42a 100644 --- a/systems-management/nisysmgmt.yml +++ b/systems-management/nisysmgmt.yml @@ -4,7 +4,7 @@ info: version: '1' title: 'SystemLink Systems Management' contact: - name: National Instruments + name: NI url: https://www.ni.com/systemlink email: support@ni.com basePath: '/nisysmgmt' @@ -442,7 +442,7 @@ definitions: vendorName: description: System vendor name. type: string - example: National Instruments + example: NI version: description: Salt version. type: string @@ -761,7 +761,7 @@ definitions: displayname: NI Package Manager Upgrader displayversion: 19.5.0 url: http://www.ni.com - packager: National Instruments + packager: NI priority: required group: Infrastructure version: 19.5.0.28-0+d28 @@ -770,7 +770,7 @@ definitions: displayname: System Package for 64-Bit Windows OS displayversion: 19.5.0 url: http://www.ni.com - packager: National Instruments + packager: NI priority: standard group: Infrastructure version: 19.5.0.28-0+d28 @@ -1122,6 +1122,13 @@ definitions: type: string description: The ID of the workspace. example: '5bc5e9092a4fa4c71cfa7197' + properties: + type: object + description: The new properties (key-value pairs). + additionalProperties: + type: string + example: + owner: admin QueryAvailablePackagesRequest: title: Get Available Packages Request @@ -1240,7 +1247,7 @@ definitions: maintainer: type: string description: The maintainer of this package. - example: "National Instruments " + example: "NI " name: type: string description: The name of the package. @@ -1435,7 +1442,7 @@ definitions: $ref: '#/definitions/Operation' QuerySystemsRequest: - description: Request for querying resources. More info here -> https://github.com/StefH/System.Linq.Dynamic.Core/wiki/Dynamic-Expressions and https://stefh.github.io/System.Linq.Dynamic.Core/html/144078bd-d1ad-bece-4daa-7fdd3a7ed7dc.htm + description: Request for querying systems resources. Dynamic LINQ is used for query syntax. More info can be found at https://dynamic-linq.net title: Query Systems Request properties: skip: @@ -1551,7 +1558,7 @@ definitions: description: The order in which data returns. QueryJobsRequest: - description: Request for querying jobs resources. More info here -> https://github.com/StefH/System.Linq.Dynamic.Core/wiki/Dynamic-Expressions and https://stefh.github.io/System.Linq.Dynamic.Core/html/144078bd-d1ad-bece-4daa-7fdd3a7ed7dc.htm + description: Request for querying jobs resources. Dynamic LINQ is used for query syntax. More info can be found at https://dynamic-linq.net title: Query Jobs Request properties: skip: diff --git a/systems-state/nisystemsstate.yml b/systems-state/nisystemsstate.yml index 9fb0fac..a23aa68 100644 --- a/systems-state/nisystemsstate.yml +++ b/systems-state/nisystemsstate.yml @@ -4,7 +4,7 @@ info: version: "1" title: "SystemLink Systems State Manager" contact: - name: National Instruments + name: NI url: https://www.ni.com/systemlink email: support@ni.com basePath: "/nisystemsstate" diff --git a/tag-historian/nitaghistorian.yml b/tag-historian/nitaghistorian.yml index 04589a6..88ae9b0 100644 --- a/tag-historian/nitaghistorian.yml +++ b/tag-historian/nitaghistorian.yml @@ -4,7 +4,7 @@ info: title: Tag Historian Web Service description: SystemLink Tag Historian Service HTTP API. contact: - name: National Instruments + name: NI url: 'https://www.ni.com/systemlink' email: support@ni.com basePath: /nitaghistorian diff --git a/tag-rule/nitagrule.yml b/tag-rule/nitagrule.yml index 60a8b33..79691da 100644 --- a/tag-rule/nitagrule.yml +++ b/tag-rule/nitagrule.yml @@ -4,7 +4,7 @@ info: title: Tag Rule Engine Web Service description: SystemLink Tag Rule Engine Service HTTP API. Only available on SystemLink Server. contact: - name: National Instruments + name: NI url: 'https://www.ni.com/systemlink' email: support@ni.com basePath: /nitagrule diff --git a/tag/nitag.yml b/tag/nitag.yml index c9edc19..5915835 100644 --- a/tag/nitag.yml +++ b/tag/nitag.yml @@ -4,7 +4,7 @@ info: version: '2' title: SystemLink Tag Service contact: - name: National Instruments + name: NI url: 'https://www.ni.com/systemlink' email: support@ni.com basePath: /nitag diff --git a/tdm-reader/nitdmreader.yml b/tdm-reader/nitdmreader.yml index ea2f8e3..e05a05d 100644 --- a/tdm-reader/nitdmreader.yml +++ b/tdm-reader/nitdmreader.yml @@ -4,7 +4,7 @@ info: title: TDMReader Web Service description: TDMReader HTTP API contact: - name: National Instruments + name: NI url: 'https://www.ni.com/systemlink' email: support@ni.com basePath: /nitdmreader diff --git a/test-monitor/nitestmonitor-v1.yml b/test-monitor/nitestmonitor-v1.yml index 56358a2..198d7dd 100644 --- a/test-monitor/nitestmonitor-v1.yml +++ b/test-monitor/nitestmonitor-v1.yml @@ -4,7 +4,7 @@ info: title: Test Monitor Web Service description: Test Monitor HTTP API contact: - name: National Instruments + name: NI url: 'https://www.ni.com/systemlink' email: support@ni.com basePath: /nitestmonitor @@ -69,7 +69,7 @@ definitions: - name: TestMonitor.InvalidId code: -253700 resourceType: TestResult - resourceId: 4afb2ce3741fe11d88838cc9 + resourceId: bd9126f5-b0b1-446a-8b08-dc6460047377 message: Invalid Id. args: [] Operation: @@ -386,7 +386,7 @@ definitions: id: description: Id of the test result type: string - example: 5e30938d93cac80468534720 + example: bd9126f5-b0b1-446a-8b08-dc6460047377 systemId: description: Id of the system type: string @@ -450,7 +450,7 @@ definitions: id: description: Test result id to update type: string - example: 5e30938d93cac80468534720 + example: bd9126f5-b0b1-446a-8b08-dc6460047377 programName: description: Program name type: string @@ -519,7 +519,7 @@ definitions: items: type: string example: - - 5e30938d93cac80468534720 + - bd9126f5-b0b1-446a-8b08-dc6460047377 programNames: description: Array of program names type: array @@ -575,8 +575,8 @@ definitions: type: object additionalProperties: type: string - example: - key1: value1 + example: + key1: value1 updatedAtQuery: description: Time query object for the test result's last updated timestamp type: array @@ -616,10 +616,10 @@ definitions: properties: stepId: type: string - example: 5e30934193cac8046851acb4 + example: 02600cf8-c2bb-4ff9-a139-031e943fb0c0 resultId: type: string - example: 5e30938d93cac80468534720 + example: bd9126f5-b0b1-446a-8b08-dc6460047377 StepDataObject: title: Step Data description: Data returned by the test step @@ -683,14 +683,14 @@ definitions: items: type: string example: - - 5e30934193cac8046851acb4 + - bd9126f5-b0b1-446a-8b08-dc6460047377 resultIds: description: Array of result ids type: array items: type: string example: - - 5e30938d93cac80468534720 + - 02600cf8-c2bb-4ff9-a139-031e943fb0c0 path: description: Step path type: string @@ -701,8 +701,8 @@ definitions: items: type: string example: - - 5e30934193cac8046851acb2 - - 5e30931993cac8046850a996 + - 4e303cdd-efc5-477f-a331-932dcbdd1ca8 + - 5bb6aa1a-4e88-4e50-ada4-4aa20b4e82b3 statuses: description: Array of step statuses type: array @@ -782,7 +782,7 @@ definitions: resultId: description: Result id type: string - example: 5e30938d93cac80468534720 + example: 02600cf8-c2bb-4ff9-a139-031e943fb0c0 children: description: Nested child steps type: array @@ -860,7 +860,7 @@ definitions: resultId: description: Result id type: string - example: 5e30938d93cac80468534720 + example: 02600cf8-c2bb-4ff9-a139-031e943fb0c0 path: description: Step path type: string @@ -1282,7 +1282,7 @@ paths: type: array items: type: string - example: 5e30938d93cac80468534720 + example: 02600cf8-c2bb-4ff9-a139-031e943fb0c0 deleteSteps: description: Indicates whether to delete the test steps associated with the test result type: boolean diff --git a/test-monitor/nitestmonitor-v2.yml b/test-monitor/nitestmonitor-v2.yml index 611ced4..28ba210 100644 --- a/test-monitor/nitestmonitor-v2.yml +++ b/test-monitor/nitestmonitor-v2.yml @@ -4,7 +4,7 @@ info: title: Test Monitor Web Service description: Test Monitor HTTP API contact: - name: National Instruments + name: NI url: 'https://www.ni.com/systemlink' email: support@ni.com basePath: /nitestmonitor @@ -69,7 +69,7 @@ definitions: - name: TestMonitor.InvalidId code: -253700 resourceType: TestResult - resourceId: 4afb2ce3741fe11d88838cc9 + resourceId: 02600cf8-c2bb-4ff9-a139-031e943fb0c0 message: Invalid Id. args: [] Operation: @@ -350,7 +350,7 @@ definitions: id: description: ID of the product type: string - example: 5e30931793cac80468509487 + example: 02600cf8-c2bb-4ff9-a139-031e943fb0c0 partNumber: description: The part number of the product type: string @@ -398,7 +398,7 @@ definitions: id: description: ID of the product to update type: string - example: 5e30931793cac80468509487 + example: 02600cf8-c2bb-4ff9-a139-031e943fb0c0 name: description: The name of the product type: string @@ -431,6 +431,7 @@ definitions: TestResultRequestObject: title: Test Result Request type: object + required: [programName, status] properties: programName: description: Program name @@ -519,7 +520,7 @@ definitions: id: description: Id of the test result type: string - example: 5e30938d93cac80468534720 + example: 02600cf8-c2bb-4ff9-a139-031e943fb0c0 systemId: description: Id of the system type: string @@ -587,7 +588,7 @@ definitions: id: description: Test result id to update type: string - example: 5e30938d93cac80468534720 + example: 02600cf8-c2bb-4ff9-a139-031e943fb0c0 programName: description: Program name type: string @@ -692,7 +693,7 @@ definitions: The unique ID of this path. Note that this value may change if the collection is repaired. type: string - example: 507f191e810c19729de860ea + example: 02600cf8-c2bb-4ff9-a139-031e943fb0c0 path: description: >- Identifies the steps that this path is representative of. @@ -738,6 +739,9 @@ definitions: myMeasurement: {} ProductsAdvancedQuery: title: Advanced Query Object for Products + description: >- + Product fields that the response can be ordered by are + `ID`, `PART_NUMBER`, `NAME`, `FAMILY`, and `UPDATED_AT`. type: object properties: filter: @@ -798,6 +802,9 @@ definitions: example: false PathsAdvancedQuery: title: Advanced Query Object for Paths + description: >- + Path fields that the response can be ordered by are + `ID`, `PROGRAM_NAME`, `PART_NUMBER`, and `PATH`. type: object properties: filter: @@ -858,6 +865,11 @@ definitions: example: false ResultsAdvancedQuery: title: Advanced Query Object for Test Results + description: >- + Test Result fields that the response can be ordered by are + `ID`, `STARTED_AT`, `UPDATED_AT`, `PROGRAM_NAME`, `SYSTEM_ID`, + `HOST_NAME`, `OPERATOR`, `SERIAL_NUMBER`, `PART_NUMBER`, + and `TOTAL_TIME_IN_SECONDS`. type: object properties: filter: @@ -936,12 +948,17 @@ definitions: $ref: '#/definitions/ResponseFormat' StepsAdvancedQuery: title: Advanced Query Object for Test Steps + description: >- + Test Step fields that the response can be ordered by are + `NAME`, `STEP_TYPE`, `STEP_ID`, `PARENT_ID`, `RESULT_ID`, + `PATH`, `TOTAL_TIME_IN_SECONDS`, `STARTED_AT`, `UPDATED_AT`, + and `DATA_MODEL`. type: object properties: filter: description: The step query filter in Dynamic Linq type: string - example: (operator == "user1") || ((programName != "MyProgram") && (totalTimeInSeconds < @0)) + example: (stepType == "NumericLimitTest") && (totalTimeInSeconds > @0) substitutions: description: >- Makes substitutions in the query filter expression. Substitutions for the query expression @@ -1117,10 +1134,10 @@ definitions: properties: stepId: type: string - example: 5e30934193cac8046851acb4 + example: bd9126f5-b0b1-446a-8b08-dc6460047377 resultId: type: string - example: 5e30938d93cac80468534720 + example: 02600cf8-c2bb-4ff9-a139-031e943fb0c0 StepDataObject: title: Step Data description: Data returned by the test step @@ -1177,7 +1194,7 @@ definitions: resultId: description: Result id type: string - example: 5e30938d93cac80468534720 + example: 02600cf8-c2bb-4ff9-a139-031e943fb0c0 children: description: Nested child steps type: array @@ -1259,7 +1276,7 @@ definitions: resultId: description: Result id type: string - example: 5e30938d93cac80468534720 + example: 02600cf8-c2bb-4ff9-a139-031e943fb0c0 path: description: Step path type: string @@ -1381,7 +1398,7 @@ responses: items: type: string example: - - 5e30931793cac80468509487 + - 02600cf8-c2bb-4ff9-a139-031e943fb0c0 failed: description: Array of product ids that failed to delete type: array @@ -1458,6 +1475,27 @@ responses: $ref: '#/definitions/TestResultRequestObject' error: $ref: '#/definitions/Error' + ResultsUpdatePartialSuccessResponse: + description: Test Results Update Partial Success Response + schema: + description: Test Results Update Partial Success Response + title: ResultsUpdatePartialSuccessResponse + type: object + required: + - results + properties: + results: + description: Array of test results + type: array + items: + $ref: '#/definitions/TestResultResponseObject' + failed: + description: Array of test result update requests that failed + type: array + items: + $ref: '#/definitions/TestResultUpdateRequestObject' + error: + $ref: '#/definitions/Error' DeleteResultsResponse: description: Delete Test Results Response schema: @@ -1911,7 +1949,7 @@ paths: type: array items: type: string - example: 5e30931793cac80468509487 + example: 02600cf8-c2bb-4ff9-a139-031e943fb0c0 responses: 200: $ref: '#/responses/DeleteProductsResponse' @@ -2077,7 +2115,7 @@ paths: Queries known values for an indexed, scalar result field. Supported fields are `ID`, `STARTED_AT`, `UPDATED_AT`, `PROGRAM_NAME`, `SYSTEM_ID`, `HOST_NAME`, `OPERATOR`, `SERIAL_NUMBER`, `PART_NUMBER`, - `TOTAL_TIME_IN_SECONDS`, and `WORKSPACE`. + and `TOTAL_TIME_IN_SECONDS`. operationId: query-result-values-v2 x-ni-operation: queryResults x-ni-auth: true @@ -2112,7 +2150,7 @@ paths: $ref: '#/definitions/UpdateTestResultsRequest' responses: 200: - $ref: '#/responses/ResultsPartialSuccessResponse' + $ref: '#/responses/ResultsUpdatePartialSuccessResponse' 401: $ref: '#/responses/Unauthorized' default: @@ -2142,7 +2180,7 @@ paths: type: array items: type: string - example: 5e30938d93cac80468534720 + example: 02600cf8-c2bb-4ff9-a139-031e943fb0c0 deleteSteps: description: Indicates whether to delete the test steps associated with the test result type: boolean @@ -2311,8 +2349,8 @@ paths: description: >- Queries known values for an indexed, scalar step field. Supported fields are `NAME`, `STEP_TYPE`, `STEP_ID`, `PARENT_ID`, `RESULT_ID`, - `PATH`, `TOTAL_TIME_IN_SECONDS`, `STARTED_AT`, `UPDATED_AT`, - `DATA_MODEL`, and `WORKSPACE`. + `PATH`, `TOTAL_TIME_IN_SECONDS`, `STARTED_AT`, `UPDATED_AT`, and + `DATA_MODEL`. operationId: query-step-values-v2 x-ni-operation: querySteps x-ni-auth: true diff --git a/user-data/niuserdata.yml b/user-data/niuserdata.yml index ee1424b..918af55 100644 --- a/user-data/niuserdata.yml +++ b/user-data/niuserdata.yml @@ -4,7 +4,7 @@ info: title: User Data Service description: Manage user specific data. contact: - name: National Instruments + name: NI url: https://www.ni.com/systemlink email: support@ni.com basePath: /niuserdata diff --git a/user/niuser.yaml b/user/niuser.yaml index 04f1447..cc75f66 100644 --- a/user/niuser.yaml +++ b/user/niuser.yaml @@ -2,6 +2,11 @@ swagger: '2.0' info: version: '1.0' title: SystemLink User Service + description: 'Manage users, workspaces, and permissions for a SystemLink server.' + contact: + name: NI + url: https://www.ni.com/systemlink + email: support@ni.com basePath: /niuser/v1 consumes: - application/json @@ -12,8 +17,11 @@ securityDefinitions: type: apiKey name: x-ni-api-key in: header + BasicAuth: + type: basic security: - ApiKeyAuth: [] + - BasicAuth: [] paths: '/users/query': post: diff --git a/webapp/niapp.yaml b/webapp/niapp.yaml index 36a7768..3d810a8 100644 --- a/webapp/niapp.yaml +++ b/webapp/niapp.yaml @@ -12,8 +12,11 @@ securityDefinitions: type: apiKey name: x-ni-api-key in: header + BasicAuth: + type: basic security: - ApiKeyAuth: [] + - BasicAuth: [] paths: '/webapps/{id}': get: