We're updating the issue view to help you get more done. 

Concept of a more stable REST API

Description

At the moment, there are a lot of changes in our REST API between the DATAGERRY releases. Mostly, the JSON structures, that needs to be sent are affected

Examples:

  • the field “root” in categories were gone with database update 20200226

  • date fields in objects needs to be set in a new format since database update 20200214

If a user sends a JSON structure in an incorrect format, parts of DATAGERRY will break. Also there is no documentation for REST endpoints and expected JSON structures.

For the future, we’ll need a concept for a more stable REST API. This concept should be the base for migrating the current REST API step by step (endpoint by endpoint) within the next few sprints.

In this concept, we should clarify the following things:

  • how can we achieve a more stable REST API (REST versioning, internal API for us, external API for users, …?)

  • how can we document our REST API

  • what are the next steps for implementation

  • how can we validate input JSON structures

This concept should also be documented in our development guide.

Activity

Show:
Michael Batz
November 18, 2020, 10:36 AM

Changed the Jira Workflow from DATAGERRY -> DATAGERRY 2.0

Done

Assignee

Mark Heumüller

Reporter

Michael Batz

Labels

None

Story Points

5

Tester

None

Sprint

None

Fix versions

Priority

Medium
Configure