Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Status


StateDraft
Discussion Thread

Voting Thread
Created

$action.dateFormatter.formatGivenString("yyyy-MM-dd", $content.getCreationDate())

Project
Authors

Motivation

Today, the interaction between the frontend and backend is quite messy and inconsistent. In AIP-79 Replace Flask AppBuilder, we plan to remove much of FAB. We will need to rewrite a lot of endpoints, so we should take the opportunity to standardize on a new UI API.

...

The UI REST API should be structured very similarly as the public REST API. It should have an OpenAPI spec from which the UI can auto-generate types and even the query functions.

We looked into having this exist inside of the existing REST API and adding a flag to UI-only endpoints to exclude from documentation. That is a bit too fragile as it can be easy for typos or to forget to add a tag. A separate API does the job well. While the public REST API maintains backward compatibility, the UI REST API does not. So it would be best not to mix them up. Since both APIs will be so similar, it makes it relatively easy isn't as big of a step to contribute to the public REST API. Committers should use their judgement and keep the UI-only REST API minimal.

What defines this AIP as done?

...