AbsaOSS / AbsaOSS/enceladus

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

Ouverte
#1,616 0 commentaires 1 réaction 0 personnes assignées Voir sur GitHub
feature priority: undecided under discussion
Langage dominant
Scala
Étoiles
33
Forks
16
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

## 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",
...
}
]
}
```

Guide de contribution

Ouvrir le guide de contribution

Évaluation

Cette issue n'a pas encore été évaluée.

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.