reconciliation-api / specs

Specifications of the reconciliation API
https://reconciliation-api.github.io/specs/draft/
31 stars 9 forks source link

Add Reconciliation Candidates response example #54

Open saumier opened 3 years ago

saumier commented 3 years ago

It would be helpful to add a Reconciliation Candidates response example in JSON, as in the other sections.

Example below copied from OpenRefine Wiki

The response is a JSON literal object with the same keys as in the request

{
    "q0" : {
      "result" : { ... }
    },
    "q1" : {
      "result" : { ... }
    }
  }

Each result consists of a JSON literal object with the structure

{
    "result" : [
      {
        "id" : ... string, database ID ...
        "name" : ... string ...
        "type" : ... array of strings ...
        "score" : ... double ...
        "match" : ... boolean, true if the service is quite confident about the match ...
      },
      ... more results ...
    ],
    ... potentially some useful envelope data, such as timing stats ...
  }
wetneb commented 3 years ago

That is what this section of the specs intend to do: https://reconciliation-api.github.io/specs/latest/#reconciliation-query-responses

But if the wiki seems clearer to you we can totally rephrase that! Would you like to make a pull request for that?

saumier commented 3 years ago

Hi. That is great. I was commenting on the draft version 0.1 of the document which did not have the example. Great work.

wetneb commented 3 years ago

Since this is not a change in the specs but an improvement of the documentation, we might want to add this example to version 0.1 as well.