Skip to content

Commit

Permalink
Explain that local recon endpoints can be tested (#70)
Browse files Browse the repository at this point in the history
Even though they shouldn't be added to the table, local recon endpoints
can be tested by going to the "Test bench" tab and entering their
address manually.

Closes #42.
  • Loading branch information
wetneb authored Sep 12, 2024
1 parent 93d9c80 commit 79df6b8
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion src/FeatureTable.js
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ export default class FeatureTable extends React.Component {
To add your service to it, follow these steps:
</p>
<ul>
<li>Make sure your service is publicly accessible - local endpoints (such as those with <code>localhost</code> or <code>127.0.0.1</code> in their address) should not be added to this table.</li>
<li>Make sure your service is publicly accessible - local endpoints (such as those with <code>localhost</code> or <code>127.0.0.1</code> in their address) should not be added to this table (but you can still test them in the <a href="#/client/">Test bench</a> tab).</li>
<li>Find out if there is already a Wikidata item about your service, your database or your identifier. You can use <a href="https://www.wikidata.org/wiki/Special:Search?ns0=1">Wikidata's search interface</a> for that. If there is not, you can <a href="https://www.wikidata.org/wiki/Special:NewItem">create a new one</a>.</li>
<li>Add a statement on that item, using the <a href="https://www.wikidata.org/wiki/Property:P6269">API endpoint (P6269)</a> property, adding the <a href="https://www.wikidata.org/wiki/Q64490175">OpenRefine reconciliation service API (Q64490175)</a> as <a href="https://www.wikidata.org/wiki/Property:P2700">protocol (P2700)</a> in a qualifier. You can also add a link to the documentation for the endpoint by adding a <a href="https://www.wikidata.org/wiki/Property:P2078">user manual link (P2078)</a> or <a href="https://www.wikidata.org/wiki/Property:P973">described at URL (P973)</a> qualifier. See <a href="https://www.wikidata.org/wiki/Q922063#P6269">this example for how it is done</a>.</li>
<li>Refresh this table - it might take a few minutes before your service appears in the table.</li>
Expand Down

0 comments on commit 79df6b8

Please sign in to comment.