system-map

← All modules

3 endpoints.

GET /api/v1/system-map

List System Maps

The picker's index — titles only, never the (large) bodies.

200 — Successful Response

{
  "items": {
    "properties": {
      "slug": {
        "type": "string",
        "title": "Slug"
      },
      "title": {
        "type": "string",
        "title": "Title"
      },
      "summary": {
        "anyOf": [
          {
            "type": "string"
          },
          {
            "type": "null"
          }
        ],
        "title": "Summary"
      }
    },
    "type": "object",
    "required": [
      "slug",
      "title"
    ],
    "title": "SystemMapSummary"
  },
  "type": "array",
  "title": "Response List System Maps Api V1 System Map Get"
}

---

GET /api/v1/system-map/{slug}

Get System Map

Parameters

Name	In	Required	Type	Description
slug	path	yes	string

200 — Successful Response

{
  "properties": {
    "slug": {
      "type": "string",
      "title": "Slug"
    },
    "title": {
      "type": "string",
      "title": "Title"
    },
    "summary": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Summary"
    },
    "html": {
      "type": "string",
      "title": "Html"
    }
  },
  "type": "object",
  "required": [
    "slug",
    "title",
    "html"
  ],
  "title": "SystemMapDoc"
}

422 — Validation Error

{
  "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"
}

---

PUT /api/v1/system-map/{slug}

Update System Map

Save a document edited in place on the viewer page.

The body-only counterpart to the system-maps grid, which owns every other field (title, summary, enabled, sort_order) — this exists because the viewer is where a map is actually read, so it is where a correction gets noticed, and the grid's drawer is a poor surface for a full-width document.

Writes to the hub DB the read path uses, so an edit made from any site lands on the one set of documents the whole estate shares. Same superuser gate.

Parameters

Name	In	Required	Type	Description
slug	path	yes	string

Request body

{
  "properties": {
    "html": {
      "type": "string",
      "title": "Html"
    }
  },
  "type": "object",
  "required": [
    "html"
  ],
  "title": "SystemMapBody"
}

200 — Successful Response

{
  "properties": {
    "slug": {
      "type": "string",
      "title": "Slug"
    },
    "title": {
      "type": "string",
      "title": "Title"
    },
    "summary": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Summary"
    },
    "html": {
      "type": "string",
      "title": "Html"
    }
  },
  "type": "object",
  "required": [
    "slug",
    "title",
    "html"
  ],
  "title": "SystemMapDoc"
}

422 — Validation Error

{
  "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"
}