site-switcher-order

← All modules

2 endpoints.

GET /api/v1/instance-switcher-order

Get Instance Switcher Order

200 — Successful Response

{
  "properties": {
    "hub": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "title": "Hub"
    },
    "sites": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "title": "Sites"
    },
    "admin": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "title": "Admin"
    },
    "instances": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "title": "Sites"
    }
  },
  "type": "object",
  "title": "SwitcherOrder"
}

---

PUT /api/v1/instance-switcher-order

Set Instance Switcher Order

Request body

{
  "properties": {
    "hub": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "title": "Hub"
    },
    "sites": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "title": "Sites"
    },
    "admin": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "title": "Admin"
    },
    "instances": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "title": "Sites"
    }
  },
  "type": "object",
  "title": "SwitcherOrderIn",
  "description": "A PUT replaces only the lists it sends — sorting one block leaves the\nother exactly as it was, so two operators rearranging different halves\ncan't blank each other's work."
}

200 — Successful Response

{
  "properties": {
    "hub": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "title": "Hub"
    },
    "sites": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "title": "Sites"
    },
    "admin": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "title": "Admin"
    },
    "instances": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "title": "Sites"
    }
  },
  "type": "object",
  "title": "SwitcherOrder"
}

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