specs

specs copied to clipboard

allow Fixed Params

6

Would be nice to set some params globally, without having to add columns of fixed values. #52 gives two examples: - WD `language` - OpenCorporates `jurisdiction` Extra example: - I'm...

VladimirAlexiev

Originates from #91. As discussed in the last meeting (see [notes](https://etherpad.lobid.org/p/reconciliation-august-2022), lines 39-41) we should keep an eye on the development of the ["The HTTP QUERY Method" spec](https://datatracker.ietf.org/doc/draft-ietf-httpbis-safe-method-w-body/?include_text=1) and support...

acka47

This seems to be a simple oversight - I do not see why we should omit that otherwise.

wetneb

Impose pre-determined routes instead of announcing them in the manifest

4

This is a first step towards #84: instead of leaving the suggest, preview and property proposal paths up to the implementer, those paths are pre-determined by the spec. This was...

wetneb

Change the format of reconciliation queries, responses and data extension responses

2

Closes #33. Part of #84. This removes the use of arbitrary keys in JSON objects. As a result we are no longer using "patternProperties" in our own JSON schemas. This...

wetneb

Add "description" field to type and property classes

3

In the ["Core Concepts"](https://reconciliation-api.github.io/specs/latest/#core-concepts) section we describe the fields of entities, properties and types. While we mention that entities can have descriptions, we do not have descriptions for properties and...

wetneb

Normalize naming conventions across the API

2

In the manifest we have fields such as `identifierSpace` and `feature_view`. We should settle on a style: either `identifierSpace` and `featureView`, or `identifier_space` and `feature_view`. I think in JSON it...

wetneb

Unify the syntax for property values in reconciliation queries and data extension responses

1

The way we serialize our property values in JSON is different depending on the context: see the JSON schemas for reconciliation queries and for data extension responses. It would be...

wetneb

Avoid arbitrary keys in query and result batches

2

Currently a query batch is a JSON object where the keys can be anything, e.g. (from the [current spec, Example 3](https://reconciliation-api.github.io/specs/latest/#example-3)) ```json { "q1": { "query": "Hans-Eberhard Urbaniak" }, "q2":...

osma

Make the API more REST-y

6

I just had a very nice conversation with @stefanw who told me about his experience of implementing the reconciliation API for FragDenStaat.de. They use the Django REST Framework and he...

wetneb