Project

General

Profile

Actions
Copy link

csAdr #6 | YANK-0003 · ADR-0003

closed
DD

Expose a REST API with JSON:API

csAdr #6 | YANK-0003 · ADR-0003: Expose a REST API with JSON:API

Added by Diego Developer about 5 hours ago. Updated about 5 hours ago.

Status:
Rejected
Priority:
Normal
Number:
ADR-0003
Format:
MADR
Date:
10/15/2026
Decision makers:
backend team
Consulted:
-
Supersedes:
-
Content:
Locked
Status:
Rejected
Informed:
-
Superseded by:
-

Description

Context and Problem Statement

External tools want to read the state of Yank. Should we expose a public REST API?

Considered Options

  • JSON:API over REST
  • Plain JSON over REST
  • No public API for now

Decision Outcome

Rejected: no external consumer needs an API yet.

Consequences

  • Good, because there is nothing new to maintain.
  • Bad, because integrations must use the CLI.

Hierarchy

Loading diagram...

Dependencies

Loading diagram...

Combined

Loading diagram...

Document catalog

Document references

No data to display

Linked issues

No issue links to or mentions this ADR.

Actions
Copy link

Also available in: PDF Atom