data.swagger.api-docs.userCommands.json Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of restapi-v3 Show documentation
The newest version!
{
  "apiVersion" : "v3",
  "swaggerVersion" : "1.2",
  "basePath" : "/v3",
  "resourcePath" : "/userCommands",
  "apis" : [ {
    "path" : "/commands/user/{id}/run",
    "operations" : [ {
      "method" : "POST",
      "summary" : "Fire an user's command",
      "notes" : "",
      "type" : "void",
      "nickname" : "fire",
      "produces" : [ "application/json" ],
      "authorizations" : { },
      "parameters" : [ {
        "name" : "id",
        "description" : "UUID of user's command to execute",
        "required" : true,
        "type" : "string",
        "paramType" : "path"
      } ]
    } ]
  }, {
    "path" : "/commands/user/runonce",
    "operations" : [ {
      "method" : "POST",
      "summary" : "Fire a custom command",
      "notes" : "",
      "type" : "void",
      "nickname" : "fire",
      "produces" : [ "application/json" ],
      "consumes" : [ "application/json" ],
      "authorizations" : { },
      "parameters" : [ {
        "name" : "body",
        "required" : false,
        "type" : "Command",
        "paramType" : "body"
      } ]
    } ]
  }, {
    "path" : "/commands/user",
    "operations" : [ {
      "method" : "GET",
      "summary" : "List all user commands",
      "notes" : "",
      "type" : "void",
      "nickname" : "list",
      "produces" : [ "application/json" ],
      "authorizations" : { },
      "parameters" : [ ]
    }, {
      "method" : "POST",
      "summary" : "Add a new user's command",
      "notes" : "",
      "type" : "void",
      "nickname" : "create",
      "produces" : [ "application/json" ],
      "consumes" : [ "application/json" ],
      "authorizations" : { },
      "parameters" : [ {
        "name" : "body",
        "required" : false,
        "type" : "Command",
        "paramType" : "body"
      } ],
      "responseMessages" : [ {
        "code" : 201,
        "message" : "New user's command added"
      } ]
    } ]
  }, {
    "path" : "/commands/user/{id}",
    "operations" : [ {
      "method" : "GET",
      "summary" : "Get an user's command",
      "notes" : "",
      "type" : "void",
      "nickname" : "get",
      "produces" : [ "application/json" ],
      "authorizations" : { },
      "parameters" : [ {
        "name" : "id",
        "description" : "UUID of user's command to fetch (e.g. df28cda0-a866-11e2-9e96-0800200c9a66)",
        "required" : true,
        "type" : "string",
        "paramType" : "path"
      } ],
      "responseMessages" : [ {
        "code" : 404,
        "message" : "User's command not found"
      } ]
    }, {
      "method" : "PUT",
      "summary" : "Update an user's command",
      "notes" : "",
      "type" : "void",
      "nickname" : "update",
      "produces" : [ "application/json" ],
      "consumes" : [ "application/json" ],
      "authorizations" : { },
      "parameters" : [ {
        "name" : "id",
        "description" : "UUID of user's command to update (e.g. df28cda0-a866-11e2-9e96-0800200c9a66)",
        "required" : true,
        "type" : "string",
        "paramType" : "path"
      }, {
        "name" : "body",
        "required" : false,
        "type" : "Command",
        "paramType" : "body"
      } ],
      "responseMessages" : [ {
        "code" : 304,
        "message" : "User's command not modified"
      } ]
    }, {
      "method" : "DELETE",
      "summary" : "Delete an user's command",
      "notes" : "",
      "type" : "void",
      "nickname" : "delete",
      "authorizations" : { },
      "parameters" : [ {
        "name" : "id",
        "description" : "UUID of user's command to delete (e.g. df28cda0-a866-11e2-9e96-0800200c9a66)",
        "required" : true,
        "type" : "string",
        "paramType" : "path"
      } ],
      "responseMessages" : [ {
        "code" : 404,
        "message" : "User's command not found"
      } ]
    } ]
  }, {
    "path" : "/commands/user/{id}/copy",
    "operations" : [ {
      "method" : "POST",
      "summary" : "Copy an item",
      "notes" : "",
      "type" : "void",
      "nickname" : "copy",
      "authorizations" : { },
      "parameters" : [ {
        "name" : "id",
        "description" : "ID of item to copy",
        "required" : true,
        "type" : "string",
        "paramType" : "path"
      } ],
      "responseMessages" : [ {
        "code" : 404,
        "message" : "Source item not found"
      } ]
    } ]
  } ],
  "models" : {
    "Config" : {
      "id" : "Config",
      "properties" : {
        "properties" : {
          "$ref" : "Properties"
        },
        "xmlFile" : {
          "type" : "string"
        },
        "tuples" : {
          "$ref" : "Tuples"
        }
      }
    },
    "Command" : {
      "id" : "Command",
      "properties" : {
        "name" : {
          "type" : "string"
        },
        "receiver" : {
          "type" : "string"
        },
        "uuid" : {
          "type" : "string"
        },
        "delay" : {
          "type" : "integer",
          "format" : "int32"
        },
        "description" : {
          "type" : "string"
        },
        "stopIf" : {
          "type" : "string"
        },
        "tags" : {
          "$ref" : "java.util.HashSet"
        },
        "hardwareLevel" : {
          "type" : "boolean"
        },
        "editable" : {
          "type" : "boolean"
        },
        "executed" : {
          "type" : "boolean"
        },
        "properties" : {
          "$ref" : "Config"
        },
        "replyTimeout" : {
          "type" : "integer",
          "format" : "int32"
        }
      }
    },
    "Properties" : {
      "id" : "Properties",
      "properties" : {
        "values" : {
          "$ref" : "java.util.Collection"
        },
        "empty" : {
          "type" : "boolean"
        },
        "entrySet" : {
          "$ref" : "Set[java.util.Map.java.util.Map$Entry]"
        },
        "keySet" : {
          "type" : "array",
          "uniqueItems" : true,
          "items" : {
            "$ref" : "K"
          }
        }
      }
    }
  }
}