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

add "varies by" (language, jurisdiction) to testbench #19

Open
VladimirAlexiev opened this issue Oct 22, 2020 · 2 comments
Open

add "varies by" (language, jurisdiction) to testbench #19

VladimirAlexiev opened this issue Oct 22, 2020 · 2 comments

Comments

@VladimirAlexiev
Copy link

(related to reconciliation-api/specs#52 and reconciliation-api/specs#55)

https://reconciliation-api.github.io/testbench/ shows lang-specific URLs for the first two services.

Wikidata
  API endpoint: https://wikidata.reconci.link/en/api
    protocol: OpenRefine reconciliation service API
    described at URL: https://wikidata.reconci.link/
    source code repository: https://github.com/wetneb/openrefine-wikibase
    language of work or name: English
  • However, WD has a gazillion service URLs that vary by lang, eg https://wikidata.reconci.link/bg/api
  • It would be counter-productive to add them all as separate instances of P6269, and that would overload the testbench table

How to indicate endpoint URL variation by a fixed param? I imagine it as an extra column Varies By in the table.

How to express this in Wikidata? URL templates are called formatters in WD. I looked at available props, and maybe https://www.wikidata.org/wiki/Property:P8183 is what we need. The data needs to be restructured as follows:

Wikidata
  online service (P2361): Wikidata OpenRefine reconciliation service
Wikidata OpenRefine reconciliation service
  protocol: OpenRefine reconciliation service API
  # API endpoint: no language-independent endpoint
  general property-based URL formatter (P8183): https://wikidata.reconci.link/{P407}/api # language of work
  described at URL: https://wikidata.reconci.link/
  source code repository: https://github.com/wetneb/openrefine-wikibase

OpenCorporates
  online service (P2361): OpenCorporates OpenRefine reconciliation service
OpenCorporates OpenRefine reconciliation service
  protocol: OpenRefine reconciliation service API
  API endpoint: https://opencorporates.com/reconcile # ALL jurisdictions
  general property-based URL formatter (P8183): https://opencorporates.com/reconcile/{P1001} # applies to jurisdiction
  described at URL: https://api.opencorporates.com/documentation/Open-Refine-Reconciliation-API
@wetneb
Copy link
Member

wetneb commented Oct 22, 2020

If reconciliation-api/specs#55 makes it way to the specs, then I'd leave the modeling on Wikidata as it is. If the accepted parameters are exposed by the service manifests directly, then we should not need a redundant modeling on Wikidata's side. The testbench could potentially be adapted to display these variants after fetching the manifests (and let users fill particular values for them when testing the endpoint interactively).

Moving this issue to the testbench repository (let's see if links to issues are preserved). Edit: it seems to have worked great!

@wetneb wetneb transferred this issue from reconciliation-api/specs Oct 22, 2020
@tfmorris
Copy link
Member

The "gazillion" URLs represent a usability problem, so I think effort would be better spent on fixing it, rather than accommodating it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants