search

usnationalarchives / OPAProd

Tracking enhancements to OPAProd
1 stars 0 forks source link

Need plan re: SDKs #51

Closed DominicBM closed 9 years ago

DominicBM commented 9 years ago

We have a requirement for a SDK that was deferred to R2 because it would not have been completed. It reads as follows:

7.7. The OPA system shall provide open source - compatible software development kits (SDK) for the APIs.

There are no decomposed requirements and no design was ever done. We need to decide how we want to move forward with this. Potentially, if we want to do it right, we should have an idea ourselves of what we are after and determine first if further requirements are needed beyond this vague one to achieve that.

I'm assigning this to David, since this is more your area. Any ideas?

naffis commented 9 years ago

I'd prefer we don't call it an SDK and rather see it as a collection of independent libraries and examples. What I have in mind is a handful of API wrappers along with documentation and code samples for each. I can polish up and check in the the wrappers I have written for Ruby, PHP, and Python (Javascript is partially done as well). I'll add documentation for each as well as a few examples. Let me know if there are specific use cases we want to demonstrate with the API that could potentially be made into their own libraries. Also, if there are other high-value (i.e. high use) languages/platforms we should target for API wrappers. Let me know what you think.

DominicBM commented 9 years ago

So, should we ask to withdraw the SDK requirement from the Search Tech contract, and just stick to what is being built in-house? I'm not exactly confident we'd get anything that is really worth the trouble from them.

@naffis: Let me know about the ETA for those wrappers. I'm writing the blog post announcing our API, and that would be good to be able to point to!

naffis commented 9 years ago

Yeah, let's withdraw it. I also question the quality of what they deliver. I can work on it more today and tomorrow and have it ready for public consumption on Monday. Does that work with your timeline or did you want to post something sooner?

DominicBM commented 9 years ago

That works great. We're not looking to post until next week at the earliest, and that depends on how soon we can get permission to put the code out.