Skip to content

Update README.md #16

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
merged 2 commits into from
Jul 28, 2025
Merged

Update README.md #16

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
41d1625
Update README.md
bmribler Jul 25, 2025
89b4f43
Updated Node version to fix test failure
bmribler Jul 28, 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
2 changes: 1 addition & 1 deletion .github/workflows/validate.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,6 @@ jobs:
- name: Use Node.js
uses: actions/setup-node@v2
with:
node-version: 12
node-version: 16
- run: npm install -g ibm-openapi-validator
- run: lint-openapi openapi.yaml
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# HDF REST API

The HDF REST API is an interface to HDF5 data stored on network-based architectures. The HDF REST API has provisions to support CRUD (create, read, update and delete) operations on the full spectrum of HDF5 objects including: groups, links, datasets, attributes, and committed data types. See <https://support.hdfgroup.org/pubs/papers/RESTful_HDF5.pdf> for background on the design principles that guided the development of the RESTful HDF5 interface.
The HDF REST API is an interface to HDF5 data stored on network-based architectures. The HDF REST API has provisions to support CRUD (create, read, update and delete) operations on the full spectrum of HDF5 objects including: groups, links, datasets, attributes, and committed data types. See [RESTful_HDF5.pdf](https://support.hdfgroup.org/archive/support/pubs/papers/index.html) for background on the design principles that guided the development of the RESTful HDF5 interface.

This repository provides documentation on what operations are supported by the HDF REST API and some guidelines as to how to effectively use these.

Expand All @@ -14,12 +14,12 @@ Not all implementations support all the REST operations documented here. When a

There are also various packages and libraries that utilize the REST API as a client. These include:

* Python SDK - h5pyd: <https://github.com/HDFGroup/h5pyd>
* C/Fortran HDF5 REST VOL: <https://bitbucket.hdfgroup.org/users/jhenderson/repos/rest-vol/browse>
* R SDK - restfulSE: <https://github.com/vjcitn/restfulSE>
* [Python SDK - h5pyd](https://github.com/HDFGroup/h5pyd)
* [C/Fortran HDF5 REST VOL](https://bitbucket.hdfgroup.org/users/jhenderson/repos/rest-vol/browse)
* [R SDK - restfulSE](https://github.com/vjcitn/restfulSE)



The following diagram illustrates the various resources and operations of the HDF REST API:

![RESTful HDF Diagram](./RESTful_HDF5.png)
![RESTful HDF Diagram](./RESTful_HDF5.png)
Loading