desci-labs / nodes

Secure PID containers for interoperable research objects
https://dpid.org
MIT License
41 stars 5 forks source link

Document the nodes-server API #119

Open hubsmoke opened 1 year ago

hubsmoke commented 1 year ago

Is your feature request related to a problem? Please describe. Developers don't know how to get started interacting with node-server instance -- see #24

Describe the solution you'd like Document the APIs

Describe alternatives you've considered Point to following info: create new node draft: https://github.com/desci-labs/nodes/blob/develop/desci-server/src/routes/v1/nodes.ts#L26 add component to node draft: https://github.com/desci-labs/nodes/blob/develop/desci-server/src/routes/v1/nodes.ts#L27 update a node draft: https://github.com/desci-labs/nodes/blob/develop/desci-server/src/routes/v1/nodes.ts#L28 adding data to a node draft: https://github.com/desci-labs/nodes/blob/develop/desci-server/src/routes/v1/datasets.ts#L14

additionally, you can find the data model for Draft Nodes here https://github.com/desci-labs/nodes/blob/develop/desci-models/src/ResearchObject.ts

carlaost commented 8 months ago

@hubsmoke can we close this?