Skip to content

Dev #33

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
swhume merged 2 commits into from
Jun 18, 2025
Merged

Dev #33

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
18931f8
renames doc to docs
swhume Jun 18, 2025
0316039
update paths from doc to docs
swhume Jun 18, 2025
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
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
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](https://github.com/cdisc-org/DataExchange-DatasetJson).
doc/dataset-json-api-1-0.html
To review the Dataset-JSON API Specification, use the HTML version [dataset-json-api-1-0.html](https://html-preview.github.io/?url=https://github.com/cdisc-org/DataExchange-DatasetJson-API/blob/main/doc/dataset-json-api-1-0.html).
To review the Dataset-JSON API Specification, use the HTML version [dataset-json-api-1-0.html](https://html-preview.github.io/?url=https://github.com/cdisc-org/DataExchange-DatasetJson-API/blob/main/docs/dataset-json-api-1-0.html).

To review the Dataset-JSON API User Guide, see the Markdown version [dataset-json-api-1-0-ug](https://github.com/cdisc-org/DataExchange-DatasetJson-API/blob/main/doc/dataset-json-api-1-0-ug.md).
To review the Dataset-JSON API User Guide, see the Markdown version [dataset-json-api-1-0-ug](https://github.com/cdisc-org/DataExchange-DatasetJson-API/blob/main/docs/dataset-json-api-1-0-ug.md).

To review the Dataset-JSON API Specification as OAS, see the JSON version [dataset-json-api-1-0.json](https://github.com/cdisc-org/DataExchange-DatasetJson-API/blob/main/openapi/dataset-json-api-1-0.json).

Expand All @@ -24,7 +24,7 @@ documentation as well as to generate code for API clients. Check out this [list
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](https://github.com/cdisc-org/DataExchange-DatasetJson-API/blob/main/openapi/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](https://html-preview.github.io/?url=https://github.com/cdisc-org/DataExchange-DatasetJson-API/blob/main/doc/dataset-json-api-1-0.html).
[dataset-json-api-1-0.html](https://html-preview.github.io/?url=https://github.com/cdisc-org/DataExchange-DatasetJson-API/blob/main/docs/dataset-json-api-1-0.html).

## Contribution

Expand Down
2 changes: 1 addition & 1 deletion doc/dataset-json-api-1-0-ug.md → docs/dataset-json-api-1-0-ug.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ GitHub repository](https://github.com/cdisc-org/DataExchange-DatasetJson).
## Open API Specification
The primary technical documentation for the Dataset-JSON API is found in the
[Open API Specification 3.1 (OAS) for the Dataset-JSON API](https://github.com/cdisc-org/DataExchange-DatasetJson-API/blob/main/openapi/dataset-json-api-1-0.json).
An [HTML version of the specification](https://html-preview.github.io/?url=https://github.com/cdisc-org/DataExchange-DatasetJson-API/blob/main/doc/dataset-json-api-1-0.html)
An [HTML version of the specification](https://html-preview.github.io/?url=https://github.com/cdisc-org/DataExchange-DatasetJson-API/blob/main/docs/dataset-json-api-1-0.html)
has been generated as a human-readable representation. The machine-readable JSON version of the OAS Dataset-JSON API
specification includes a machine-readable representation of the endpoints and JSON payload that may be used by code
generators to create basic client and server software.
Expand Down
0 doc/dataset-json-api-1-0.html → docs/dataset-json-api-1-0.html
View file
Open in desktop
File renamed without changes.
0 doc/index.html → docs/index.html
View file
Open in desktop
File renamed without changes.