search

LD4P / qa_server

A rails engine with questioning authority gem installed to serve as an authority search server with normalized results.
Apache License 2.0
6 stars 3 forks source link

API doc changes request #100

Closed hudajkhan closed 4 years ago

hudajkhan commented 5 years ago

The Sinopia code currently uses the Swagger documentation to formulate the actual API call to be made to retrieve information from QA. For example, client.apis.SearchQuery.GET_searchAuthority corresponds to the call tagged with "SearchQuery" with format "/search/linked_data/{vocab}" and operationId "GET_searchAuthority" . If the tag has a space in it in the documentation, I have not been able to find a way to make a call using the same pattern as is there in the code (e.g. client.apis.[tag].[operationId]). I have issued a pull request on the sinopia code with the updated apidoc and am including that example below.

In addition, for sources that are not linked data but are still available through QA (such as Discogs), we would like to add API patterns for "/search/{vocab}" and fetch etc. I'll include a link below to what we have on the discogs branch in sinopia.

hudajkhan commented 5 years ago

apidocchanges.txt

hudajkhan commented 5 years ago

https://github.com/LD4P/sinopia_editor/blob/cornelldemo_discogs/src/lib/apidoc.json#L1056

hudajkhan commented 5 years ago

In the Discogs example, the tags and operation ids are different for the non-LD QA calls than the LD calls.

elrayle commented 4 years ago

Closing... Per latest conversation, Sinopia developers are satisfied with the current API doc. This includes the use of linked data authorities and Discogs.