Valetudo/backend/lib/webserver/capabilityRouters/doc/PresetSelectionCapabilityRouter.openapi.json

{
  "/api/v2/robot/capabilities/FanSpeedControlCapability/presets": {
    "get": {
      "tags": [
        "FanSpeedControlCapability"
      ],
      "summary": "Get available presets",
      "parameters": [],
      "responses": {
        "200": {
          "description": "Ok",
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  },
  "/api/v2/robot/capabilities/FanSpeedControlCapability/preset": {
    "put": {
      "tags": [
        "FanSpeedControlCapability"
      ],
      "summary": "Set preset value",
      "parameters": [],
      "requestBody": {
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string",
                  "description": "Preset name retrieved from the same capability"
                }
              }
            },
            "examples": {
              "medium":{
                "description": "Set fan speed to medium",
                "value": {
                  "name": "medium"
                }
              }
            }
          }
        }
      },
      "responses": {
        "200": {
          "$ref": "#/components/responses/200"
        },
        "400": {
          "$ref": "#/components/responses/400"
        }
      }
    }
  },
  "/api/v2/robot/capabilities/FanSpeedControlCapability/properties": {
    "get": {
      "tags": [
        "FanSpeedControlCapability"
      ],
      "summary": "Get various capability-related properties",
      "responses": {
        "200": {
          "description": "Ok",
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          }
        }
      }
    }
  },
  "/api/v2/robot/capabilities/WaterUsageControlCapability/presets": {
    "get": {
      "tags": [
        "WaterUsageControlCapability"
      ],
      "summary": "Get available presets",
      "parameters": [],
      "responses": {
        "200": {
          "description": "Ok",
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  },
  "/api/v2/robot/capabilities/WaterUsageControlCapability/preset": {
    "put": {
      "tags": [
        "WaterUsageControlCapability"
      ],
      "summary": "Set preset value",
      "parameters": [],
      "requestBody": {
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string",
                  "description": "Preset name retrieved from the same capability"
                }
              }
            },
            "examples": {
              "medium":{
                "description": "Set water usage to medium",
                "value": {
                  "name": "medium"
                }
              }
            }
          }
        }
      },
      "responses": {
        "200": {
          "$ref": "#/components/responses/200"
        },
        "400": {
          "$ref": "#/components/responses/400"
        }
      }
    }
  },
  "/api/v2/robot/capabilities/WaterUsageControlCapability/properties": {
    "get": {
      "tags": [
        "WaterUsageControlCapability"
      ],
      "summary": "Get various capability-related properties",
      "responses": {
        "200": {
          "description": "Ok",
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          }
        }
      }
    }
  },
  "/api/v2/robot/capabilities/OperationModeControlCapability/presets": {
    "get": {
      "tags": [
        "OperationModeControlCapability"
      ],
      "summary": "Get available presets",
      "parameters": [],
      "responses": {
        "200": {
          "description": "Ok",
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  },
  "/api/v2/robot/capabilities/OperationModeControlCapability/preset": {
    "put": {
      "tags": [
        "OperationModeControlCapability"
      ],
      "summary": "Set preset value",
      "parameters": [],
      "requestBody": {
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string",
                  "description": "Preset name retrieved from the same capability"
                }
              }
            },
            "examples": {
              "mop":{
                "description": "Set operation mode to mop only",
                "value": {
                  "name": "mop"
                }
              }
            }
          }
        }
      },
      "responses": {
        "200": {
          "$ref": "#/components/responses/200"
        },
        "400": {
          "$ref": "#/components/responses/400"
        }
      }
    }
  },
  "/api/v2/robot/capabilities/OperationModeControlCapability/properties": {
    "get": {
      "tags": [
        "OperationModeControlCapability"
      ],
      "summary": "Get various capability-related properties",
      "responses": {
        "200": {
          "description": "Ok",
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          }
        }
      }
    }
  }
}