BlueBrain / BlueBrain/nexus

Analyse the v1 API and describe tradeoffs for its evolution strategy

Open
#2,923 0 comments 0 reactions 0 assignees View on GitHub
delta design enhancement
Dominant language
Scala
Stars
301
Forks
76
PR merge metrics
No merged PRs in 30d

Description

**Motivation**
The design and behaviour of the Delta API inherits from its initial version where all control resources where managed uniformly. After v1.5, where plugins were introduced, the current design of the API is not well suited for independent pluggable behaviour and while not necessarily apparent there is tight coupling in between plugins.

Additionally, the current design of the API is not well suited for consumption from web clients, specific issues include:
- eventual consistency (write and query)
- global access to resources
- api composition
- etc.

**Acceptance criteria**
1. Analyse and document the current API issues
2. Present options for correcting and evolving the API and their trade-offs (means of achieving it, pros and cons, cost, impact on existing clients etc.)
3. Document solutions that alleviate the problems for web client consumption

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.