From 1265e2375086fc0bc343649a601bc80c355f093e Mon Sep 17 00:00:00 2001 From: Nico Schottelius Date: Sat, 1 Aug 2020 14:05:12 +0200 Subject: [PATCH] [doc] add bootstrap --- doc/README-billing.org | 3 +++ doc/uncloud-manual-2020-08-01.org | 22 +++++++++++++++++++++- 2 files changed, 24 insertions(+), 1 deletion(-) diff --git a/doc/README-billing.org b/doc/README-billing.org index 83c133b..50b26fa 100644 --- a/doc/README-billing.org +++ b/doc/README-billing.org @@ -1,4 +1,7 @@ * How to handle billing in general +** Manual test flow / setting up bills + - Needs orders + - ** Orders - Orders are the heart of uncloud billing - Have a starting date diff --git a/doc/uncloud-manual-2020-08-01.org b/doc/uncloud-manual-2020-08-01.org index 2a16633..7024e2f 100644 --- a/doc/uncloud-manual-2020-08-01.org +++ b/doc/uncloud-manual-2020-08-01.org @@ -1,4 +1,11 @@ -* Templates +* Bootstrap + - Login via a user so that the user object gets created + - Run the following (replace nicocustomer with the username) + #+BEGIN_SRC sh + python manage.py bootstrap-user --username nicocustomer + #+END_SRC + + * Testing / CLI Access Access via the commandline (CLI) can be done using curl or httpie. In our examples we will use httpie. @@ -13,3 +20,16 @@ * URLs - api/ - the rest API +* Models +** Bill + Bills are summarising usage in a specific timeframe. Bills usually + spawn one month. +** BillRecord + Bill records are used to model the usage of one order during the + timeframe. +** Order + Orders register the intent of a user to buy something. They might + refer to a product. (???) + Order register the one time price and the recurring price. These + fields should be treated as immutable. If they need to be modified, + a new order that replaces the current order should be created.