Skip to content

demo ​

← All modules

2 endpoints.

POST /api/v1/demo/request ​

Request Demo

Request body

json
{
  "properties": {
    "full_name": {
      "type": "string",
      "title": "Full Name"
    },
    "email": {
      "type": "string",
      "format": "email",
      "title": "Email"
    },
    "interest": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 32
        },
        {
          "type": "null"
        }
      ],
      "title": "Interest"
    }
  },
  "type": "object",
  "required": [
    "full_name",
    "email"
  ],
  "title": "DemoRequestIn"
}

200 — Successful Response

json
{
  "properties": {
    "redirect_url": {
      "type": "string",
      "title": "Redirect Url"
    }
  },
  "type": "object",
  "required": [
    "redirect_url"
  ],
  "title": "DemoRequestOut"
}

422 — Validation Error

json
{
  "properties": {
    "detail": {
      "items": {
        "properties": {
          "loc": {
            "items": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "type": "array",
            "title": "Location"
          },
          "msg": {
            "type": "string",
            "title": "Message"
          },
          "type": {
            "type": "string",
            "title": "Error Type"
          }
        },
        "type": "object",
        "required": [
          "loc",
          "msg",
          "type"
        ],
        "title": "ValidationError"
      },
      "type": "array",
      "title": "Detail"
    }
  },
  "type": "object",
  "title": "HTTPValidationError"
}

POST /api/v1/demo/household ​

Start Household Demo

money.lubb.co.za/demo: a one-time login code for the household site's shared demo login (household_books.demo_email, seeded and reset nightly by app.scripts.money_demo_seed). The SPA's /demo route exchanges it at POST /auth/impersonate, exactly like /demo-login.

Nothing is reset here: the demo's books are rebuilt by the nightly reseed, and what the demo login may not do is refused per request (household_books.refuses_demo_write). 404 on any site without a demo.

200 — Successful Response

json
{
  "properties": {
    "code": {
      "type": "string",
      "title": "Code"
    }
  },
  "type": "object",
  "required": [
    "code"
  ],
  "title": "HouseholdDemoOut"
}

Lubb Business Documentation