Documents › DesignRoutes · version 1 ·
description
The API of d2conf as designed: conventions and the routes each feature uses
tags
#ai #design #routes
status
draft

d2conf: routes as designed✎ edit

This is DesignRoutes, kept by the designer: the API conventions of d2conf and the specific routes the design decided, per feature (the same {#id} as in Design). The routes as one code base built them are in its own …Routes topic. Its companions: Spec (what it does), SpecUi (how the UI behaves), Design (the mechanisms), DesignRoutes (the API) and SpecTest (the black-box tests); each code base that builds d2conf keeps its own topics, named after it (e.g. Proto1Impl, Proto1Code, Proto1Routes, Proto1Test).

Goals✎ edit

  • Role: every route the design decided, with its request, answer and error codes.
  • A line belongs here if a client of d2conf would break when it changed.
  • It fails if a route exists only in a code base's topics, or if it names how one code base serves it.

Conventions✎ edit

Routes✎ edit