Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

API doc changes request #100

Closed
hudajkhan opened this issue May 31, 2019 · 4 comments
Closed

API doc changes request #100

hudajkhan opened this issue May 31, 2019 · 4 comments
Labels
wontfix This will not be worked on

Comments

@hudajkhan
Copy link

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
Copy link
Author

apidocchanges.txt

@hudajkhan
Copy link
Author

@hudajkhan
Copy link
Author

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

@hudajkhan hudajkhan added this to Next Step in QA in Infrastructure May 31, 2019
@elrayle elrayle moved this from Next Step in QA to Blocked / On Hold / Pending in Infrastructure Sep 11, 2019
@elrayle elrayle added the wontfix This will not be worked on label Nov 4, 2019
@elrayle
Copy link
Member

elrayle commented Nov 4, 2019

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

@elrayle elrayle closed this as completed Nov 4, 2019
Infrastructure automation moved this from Blocked / On Hold / Pending to DONE Nov 4, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
wontfix This will not be worked on
Projects
Development

No branches or pull requests

2 participants