This repository contains the Dataset-JSON API Specification v1.0 and associated User Guide. This API standard complements the Dataset-JSON CDISC Data Exchange standard.
To review the Dataset-JSON API Specification, use the HTML version dataset-json-api-1-0.html.
To review the Dataset-JSON API User Guide, see the Markdown version dataset-json-api-1-0-ug.
To review the Dataset-JSON API Specification as OAS, see the JSON version dataset-json-api-1-0.json.
The main purpose of DataExchange-DatasetJson-API is to create a standard API specification for exchanging Dataset-JSON datasets.
The API endpoints, payloads, and other details are available in the JSON and HTML versions of the specification. The User Guide provides additional information useful to client and server API implementers.
Please add any comments or issues into the GitHub repository under Discussions or Issues, respectively.
The API specification has been developed using the machine-readable Open API Specification (OAS) 3.1 standard. API specifications in OAS format can be used to generate documentation as well as to generate code for API clients. Check out this list of OAS tools.
For those interested in generating content using the API specification, see the JSON version in the openapi folder. The dataset-json-api-1-0.json file contains the machine-readable specification used to generate the HTML documentation file dataset-json-api-1-0.html.
Contributions are welcome. When you contribute to this repository you are doing so under the licenses below. Please check out Contribution for additional information. All contributions must adhere to the following Code of Conduct.
This project uses the MIT license
(see LICENSE) for code, schemas, models, JSON-based specifications, and scripts.
Documentation content files are released under CC-BY-4.0. This does not include trademark permissions.
When you want to re-use and refer to the content, please do so like the following:
Content based on Dataset-JSON API (GitHub) used under the CC-BY-4.0 license.