Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
43 commits
Select commit Hold shift + click to select a range
009a374
Add BasicAuth to all without it
juno-jin-ni Apr 19, 2021
7a8e2b1
Merge pull request #91 from ni/allow-basic-auth
juno-jin-ni Apr 20, 2021
9373ed3
Update SystemMetadata
May 12, 2021
e8d5b33
Merge pull request #92 from ipopa144/users/ipopa/update-systemmetadata
Jul 1, 2021
76e0dac
Merge pull request #94 from ni/users/vladbaja/export-openapi-for-21-1
vladbaja Jul 1, 2021
f974003
Merged PR 143611: Added check for all system properties updated
vdeac Apr 2, 2021
b7490da
Merged PR 143598: Pull OpenAPI docs from GitHub subrepo
Apr 2, 2021
87a3448
Merged PR 147691: Extend FileIngestion Service to allow force delete …
Everest2020 Apr 16, 2021
7c02db1
Merged PR 145036: This is a proposed fix for the bug 1355793 allowing…
Apr 20, 2021
8de837a
Merged PR 147792: Add missing Swagger documentation for tag historian
Apr 20, 2021
93b8650
Merged PR 153636: Add route to link files to an asset
vladbaja Apr 28, 2021
01c8141
Merged PR 154444: Add fileIds property on yml
Apr 29, 2021
690f175
Merged PR 154086: Updated the AssetUpdateModel in YML to include REMO…
tludusan Apr 29, 2021
b02a1bc
Merged PR 157149: Export notebooks as HTML or PDF
May 7, 2021
7545a81
Merged PR 158162: US 1449042: Support workspace filtering in Query Files
May 10, 2021
48d039c
Merged PR 164847: Add `unlink file` route to swagger
May 26, 2021
9341ff7
Merged PR 165886: Bug 1475922 - Updated swagger docs with recent work…
lnowotny May 27, 2021
46aa9ed
Merged PR 169224: Move values field under properties
brian-poteet-ni Jun 8, 2021
eb1f656
Merged PR 170365: Fix description in nifile.yml
Jun 9, 2021
5462e57
Merged PR 172517: Increase delete-files operation version
Jun 15, 2021
1acadbe
Add example on how to filter systems by DateTime values inside dictio…
ArinLucaNI Jun 22, 2021
963f853
Merged PR 178881: Updated swagger doc for asset summary route
vdeac Jun 30, 2021
ac17a98
Merged PR 179041: [BuildingFinals] Pull systemlink-openapi-documents …
vladbaja Jun 30, 2021
899211c
Merged PR 179689: Use valid query-steps filter in swagger example
mollykreis Jul 12, 2021
c6e4fd5
Merged PR 186899: Updated yml with SupportsSelfTest and SupportsReset
tludusan Jul 26, 2021
6fe6ebf
Merged PR 186908: Update link for Dynamic LINQ
chotea Jul 26, 2021
04a8304
Merged PR 188023: Fix build that auto-generates python clients from s…
andzn Jul 27, 2021
ff9f9bb
Merged PR 188055: Fix YAML format
Jul 27, 2021
7ac56d0
Merged PR 194959: Make corrections to test monitor swagger documentation
siddhukrs Aug 16, 2021
428dc1d
Merged PR 195386: Revert PR 194959: Changes I made to the swagger doc…
siddhukrs Aug 17, 2021
b9f9d06
Merged PR 195476: Attempt #2: Make corrections to TestMonitor's swagg…
siddhukrs Aug 20, 2021
bb7de4b
Merged PR 200198: Fix docs
haworthia Aug 30, 2021
28d00f7
Merged PR 207128: Add lastUpdatedTimestamp field to file model
codrutagherman Sep 17, 2021
9c82842
Merged PR 208425: Update TestMonitor API docs to add required tags fo…
adamarnesen Sep 17, 2021
8d8caee
Merged PR 216118: Pull systemlink-openapi-documents from GitHub
brian-poteet-ni Oct 5, 2021
9e6c9c0
Merged PR 217055: Add contact and description details to the User ser…
JD-Robertson Oct 6, 2021
e599597
Merged PR 216196: Fix Swagger example by moving notificationStrategyI…
siddhukrs Oct 8, 2021
0e6c7b3
Merged PR 217495: Change "National Instruments" to "NI" in Open API d…
JD-Robertson Oct 8, 2021
98584f4
Merged PR 223882: Updated documentation in Swagger for query-assets r…
tludusan Oct 22, 2021
3390ae1
Merged PR 231517: [Cherry-pick] Update Swagger docs with Postgres ID …
brian-poteet-ni Nov 10, 2021
7b016ef
Merged PR 239717: Cherry-pick PR 239386: Resolve spelling mistake in …
Dec 2, 2021
6c1200d
Merged PR 244484: Fixing V1 query-results example in Swagger.
jvaldezni Dec 14, 2021
cb7ca74
Merged PR 243928: Merged PR 241762: Separate the partial success resp…
haworthia Dec 14, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 15 additions & 8 deletions alarm/nialarm.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion asset-management-rule/niapmrule.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
20 changes: 14 additions & 6 deletions asset-managment/niapm.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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: >-
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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"
Expand Down
20 changes: 14 additions & 6 deletions auth/niauth.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -12,8 +17,11 @@ securityDefinitions:
type: apiKey
name: x-ni-api-key
in: header
BasicAuth:
type: basic
security:
- ApiKeyAuth: []
- BasicAuth: []
paths:
/auth:
get:
Expand Down Expand Up @@ -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:
Expand Down
8 changes: 7 additions & 1 deletion file/nifile.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -571,6 +576,7 @@ paths:
- created
- id
- size
- lastUpdatedTimestamp
- in: query
name: orderByDescending
description: >-
Expand Down
2 changes: 1 addition & 1 deletion message/nimessage.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion ni-notebook-execution/ninbexec.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion opcclient/niopcclient.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions repo/nirepo.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -754,7 +754,7 @@ definitions:
maintainer:
type: string
description: The maintainer of this package.
example: "National Instruments <support@ni.com>"
example: "NI <support@ni.com>"
predepends:
type: array
description: An array containing information about other packages this package predepends.
Expand Down Expand Up @@ -823,7 +823,7 @@ definitions:
Filename: 71e47fbf-2782-4c10-873e-dba414213dc9.nipkg
Homepage: http://www.ni.com
MD5Sum: 672a667ca32b6915ae9a968c55f80825
Maintainer: National Instruments <support@ni.com>
Maintainer: NI <support@ni.com>
Package: ni-securityupdate-kb67l8lcqw-killbits
Priority: standard
Section: Infrastructure
Expand Down
2 changes: 1 addition & 1 deletion service-registry/niserviceregistry.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
21 changes: 14 additions & 7 deletions systems-management/nisysmgmt.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down Expand Up @@ -442,7 +442,7 @@ definitions:
vendorName:
description: System vendor name.
type: string
example: National Instruments
example: NI
version:
description: Salt version.
type: string
Expand Down Expand Up @@ -761,7 +761,7 @@ definitions:
displayname: NI Package Manager Upgrader
displayversion: 19.5.0
url: http://www.ni.com
packager: National Instruments <support@ni.com>
packager: NI <support@ni.com>
priority: required
group: Infrastructure
version: 19.5.0.28-0+d28
Expand All @@ -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 <support@ni.com>
packager: NI <support@ni.com>
priority: standard
group: Infrastructure
version: 19.5.0.28-0+d28
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -1240,7 +1247,7 @@ definitions:
maintainer:
type: string
description: The maintainer of this package.
example: "National Instruments <support@ni.com>"
example: "NI <support@ni.com>"
name:
type: string
description: The name of the package.
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion systems-state/nisystemsstate.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
2 changes: 1 addition & 1 deletion tag-historian/nitaghistorian.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion tag-rule/nitagrule.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion tag/nitag.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading