Skip to content

Common Application Programming Interface (API) for machine-actionable Data Management Plans (maDMPs)

License

Notifications You must be signed in to change notification settings

meta-introspector/common-madmp-api

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Common maDMP API

Warning

This is an initial work in progress and the API is subject to change.

Abstract

This API provides a common baseline standard for exchanging Data Management Plans among compliant platforms. The API specification is based on the work of the Common maDMP Standard.

Implementing this API

We provide an OpenAPI document suitable for automatic code generation. You can generate both client and server libraries with it. While any OpenAPI 3.1-compliant generator may work, we have a good track record with this generator.

Please note the following two implementation concerns:

  1. This API is built for extensibility. Your server and client implementations must support content negotiation using the Accept header.
  2. The PUT API supports conditional uploads to manage conflicts. Your server implementation must support the If-Unmodified-Since header.

To view the full documentation, see this link.

License

This work is licensed under the Creative Commons Zero (CC0) license. See LICENSE for more information.

About

Common Application Programming Interface (API) for machine-actionable Data Management Plans (maDMPs)

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Shell 55.6%
  • JavaScript 44.4%