AbsaOSS / AbsaOSS/enceladus

Menas API: replace arrays with objects as top-level JSON reponses

Offen
#1,616 0 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen
feature priority: undecided under discussion
Vorherrschende Sprache
Scala
Sterne
33
Forks
16
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

## Background
As outlined in https://github.com/AbsaOSS/enceladus/pull/1597#discussion_r540049514, Menas API contains top-level arrays in response payloads in a number of endpoints. For reasons outline in the lined discussion, these should be replaced by wrapper objects.

API calls in question:
- `/api/properties/datasets`
- `/api/runs/{summaries, {datasetName}, grouped, /grouped/{datasetName}, /{datasetName}/{datasetVersion}}`
- `/{list, searchSuggestions, /allVersions/{name}}`

## Feature
There should be an (extensible) object as a response in JSON.

## Example
`GET /api/properties/datasets` now yields:
```json
[
{
"name": "datasetProperty1",
...
},
{
"name": "datasetProperty2",
...
}
]
```
The intended response should be e.g.:
```json
{
"propertyDefinitions" : [
{
"name": "datasetProperty1",
...
},
{
"name": "datasetProperty2",
...
}
]
}
```

Beitragsleitfaden

Beitragsleitfaden öffnen

Bewertung

Dieses Issue wurde noch nicht bewertet.

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.