Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
dk1844 opened this issue Dec 10, 2020 · 0 comments
Open

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

dk1844 opened this issue Dec 10, 2020 · 0 comments
Labels
feature New feature priority: undecided Undecided priority to be assigned after discussion under discussion Requires consideration before a decision is made whether/how to implement

Comments

@dk1844
Copy link
Contributor

dk1844 commented Dec 10, 2020

Background

As outlined in #1597 (comment), 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}}
  • <? extends VersionedModelController>/{list, searchSuggestions, /allVersions/{name}}

Feature

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

Example

GET /api/properties/datasets now yields:

[
    {
        "name": "datasetProperty1",
        ...
    },
    {
        "name": "datasetProperty2",
        ...
    }
]

The intended response should be e.g.:

{
    "propertyDefinitions" : [
        {
          "name": "datasetProperty1",
          ...
        },
        {
          "name": "datasetProperty2",
          ...
        }
    ]
}
@dk1844 dk1844 added feature New feature under discussion Requires consideration before a decision is made whether/how to implement priority: undecided Undecided priority to be assigned after discussion labels Dec 10, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature priority: undecided Undecided priority to be assigned after discussion under discussion Requires consideration before a decision is made whether/how to implement
Projects
None yet
Development

No branches or pull requests

1 participant