Documents

Open-source software (OSS) licenses often require the disclosure of the used OSS component, including its version, copyright, and license text. To comply with this legal requirement, modules can provide links to their disclosure documents to Web Portal. The Open-Source Documents page, accessible from the help menu in the header, lists all document links for registered modules.

The public API documentation for a Nexeed Industrial Application System instance can be found in the help menu or at <domain of Web Portal>/docs/api in the URL. This page displays the OpenAPI 3.0 specifications for all registered modules without requiring authentication. Modules provide their specifications for public endpoints that can be used by customers to implement their own use cases. It is important to note that internal APIs should not be included or should be clearly marked.