search

IHTSDO / snowstorm

Scalable SNOMED CT Terminology Server using Elasticsearch
Other
208 stars 83 forks source link

API Documentation #245

Open kaboyles opened 3 years ago

kaboyles commented 3 years ago

Hello!

We are looking to create some documentation around the 'details of the API operations' for Snowstorm. For example, short explanations of each parameter, data format of the JSON object parameters, or how "metadata" should be used for 'POST'…

In lieu of re-inventing this wheel, I thought I would check with others who may be more Snowstorm advanced/mature than us. Perhaps, if something has been done, could you share? Possibly some are interested in collaborative work?

Thanks, Kim

peterdutey commented 3 years ago

Hello I would like to collaborate on this. There is common ground with the documentation of an R interface for Snowstorm. Development of that package paused with the pandemic but now resuming. You can see early draft of the parameters here. Obviously ample room to improve. Happy to discuss if relevant. Thanks Peter