Skip to content

Latest commit

 

History

History
29 lines (24 loc) · 2.12 KB

README.md

File metadata and controls

29 lines (24 loc) · 2.12 KB

OpenAPI-Specification

This repository contains a digest of OpenAPI specification documents for the Network Data Exchange (NDEx) REST API used to communicate with the NDEx Project public server and related NDEx private servers. The NDEx Project provides an open-source framework and online database commons where scientists can upload, share, and publicly distribute biological networks (Pratt et al., 2015, Cell Systems 1, 302-305, October 28, 2015 ©2015 Elsevier Inc. ScienceDirect).

OpenAPI is an open, portable and vendor neutral API description standard, and is defined by the Linux Foundation OpenAPI Initiative (OAI) governing body. It is employed worldwide by code generation, testing and document creation tools, many of which are listed here.

The OpenAPI documents contained in this repository are specifically used in conjunction with the ndextools/openapi-reader application, so that NDEx developers can interactively view and "try out" NDEx API requests, thus providing them with a low-level API and debugging environment as they create language-specific software applications and program libraries.

Except for these derivative OpenAPI documents, all references to the NDEx API, sources and documentation are copyrighted: © 2013-2020, The Regents of the University of California, The Cytoscape Consortium. All rights reserved. Please abide with their Terms of Use, Licensing and Sources. Likewise, the Swagger-UI document reader that displays this OpenAPI document is copyrighted by Smartbear Software. Its open-source software license is found here.

The currently supported REST API and supporting documentation is found at the NDEx Project website.