Knowledge Graph API Reference

At IBM Watson, I was the first technical writer to document the Knowledge Graph API. The following Swagger API reference was written almost entirely by me with some developer input. Please note the following PDF represents only the tip of the iceberg; I also wrote extensive documentation on the json payload parameters, not shown here for the sake of brevity:

I would say that the most challenging endpoint to document was GET /relationshipsByTemplate, an in-development endpoint that required me to leverage my knowledge of the "semantic web" and to experiment heavily with the endpoint myself in order to write intelligibly and come up with my own examples:




Note that the API has since changed quite a bit.  I considered its usability to be pretty raw when I documented the 1.0 version. The API has since been simplified and incorporated into another API -- See the Knowledge Graph endpoints in the Discovery service (please note, this link changes often, please comment if broken)

No comments:

Post a Comment