AbsaOSS / AbsaOSS/enceladus

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

未关闭
#1,616 0 条评论 1 个 reaction 已指派 0 人 在 GitHub 查看
feature priority: undecided under discussion
主要语言
Scala
星标
33
派生
16
PR 合并指标
30 天内没有已合并 PR

描述

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

贡献指南

打开贡献指南

评估

这个 Issue 还没有评估数据。

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。