apidocs.json

{
 "schemes": [
  "http"
 ],
 "swagger": "2.0",
 "info": {
  "description": "Manage Function Stream Resources",
  "title": "Function Stream Service",
  "contact": {
   "name": "Function Stream Org",
   "url": "https://github.com/FunctionStream"
  },
  "license": {
   "name": "Apache 2",
   "url": "http://www.apache.org/licenses/"
  },
  "version": "1.0.0"
 },
 "host": "localhost:7300",
 "paths": {
  "/api/v1/consume/{name}": {
   "get": {
    "consumes": [
     "application/json"
    ],
    "produces": [
     "application/json"
    ],
    "tags": [
     "tube"
    ],
    "summary": "consume a message",
    "operationId": "consumeMessage",
    "parameters": [
     {
      "type": "string",
      "description": "tube name",
      "name": "name",
      "in": "path",
      "required": true
     }
    ],
    "responses": {
     "200": {
      "description": "OK",
      "schema": {
       "type": "string",
       "format": "byte"
      }
     }
    }
   }
  },
  "/api/v1/function": {
   "get": {
    "consumes": [
     "application/json"
    ],
    "produces": [
     "application/json"
    ],
    "tags": [
     "function"
    ],
    "summary": "get all functions",
    "operationId": "getAllFunctions",
    "responses": {
     "200": {
      "description": "OK",
      "schema": {
       "type": "array",
       "items": {
        "type": "string"
       }
      }
     }
    }
   },
   "post": {
    "consumes": [
     "application/json"
    ],
    "produces": [
     "application/json"
    ],
    "tags": [
     "function"
    ],
    "summary": "create a function",
    "operationId": "createFunction",
    "parameters": [
     {
      "name": "body",
      "in": "body",
      "required": true,
      "schema": {
       "$ref": "#/definitions/model.Function"
      }
     }
    ],
    "responses": {
     "200": {
      "description": "OK"
     }
    }
   }
  },
  "/api/v1/function-store/reload": {
   "get": {
    "tags": [
     "function-store"
    ],
    "summary": "reload functions from the function store",
    "operationId": "reloadFunctions",
    "responses": {
     "200": {
      "description": "OK"
     }
    }
   }
  },
  "/api/v1/function/{namespace}/{name}": {
   "delete": {
    "consumes": [
     "application/json"
    ],
    "produces": [
     "application/json"
    ],
    "tags": [
     "function"
    ],
    "summary": "delete a namespaced function",
    "operationId": "deleteNamespacedFunction",
    "parameters": [
     {
      "type": "string",
      "description": "name of the function",
      "name": "name",
      "in": "path",
      "required": true
     },
     {
      "type": "string",
      "description": "namespace of the function",
      "name": "namespace",
      "in": "path",
      "required": true
     }
    ],
    "responses": {
     "200": {
      "description": "OK"
     }
    }
   }
  },
  "/api/v1/function/{name}": {
   "delete": {
    "consumes": [
     "application/json"
    ],
    "produces": [
     "application/json"
    ],
    "tags": [
     "function"
    ],
    "summary": "delete a function",
    "operationId": "deleteFunction",
    "parameters": [
     {
      "type": "string",
      "description": "name of the function",
      "name": "name",
      "in": "path",
      "required": true
     }
    ],
    "responses": {
     "200": {
      "description": "OK"
     }
    }
   }
  },
  "/api/v1/http-tube/{endpoint}": {
   "post": {
    "consumes": [
     "application/json"
    ],
    "produces": [
     "application/json"
    ],
    "tags": [
     "http-tube"
    ],
    "summary": "trigger the http tube endpoint",
    "operationId": "triggerHttpTubeEndpoint",
    "parameters": [
     {
      "type": "string",
      "description": "Endpoint",
      "name": "endpoint",
      "in": "path",
      "required": true
     },
     {
      "name": "body",
      "in": "body",
      "required": true,
      "schema": {
       "type": "string",
       "format": "byte"
      }
     }
    ],
    "responses": {
     "200": {
      "description": "OK"
     }
    }
   }
  },
  "/api/v1/produce/{name}": {
   "post": {
    "consumes": [
     "application/json"
    ],
    "produces": [
     "application/json"
    ],
    "tags": [
     "tube"
    ],
    "summary": "produce a message",
    "operationId": "produceMessage",
    "parameters": [
     {
      "name": "body",
      "in": "body",
      "required": true,
      "schema": {
       "type": "string",
       "format": "byte"
      }
     },
     {
      "type": "string",
      "description": "tube name",
      "name": "name",
      "in": "path",
      "required": true
     }
    ],
    "responses": {
     "200": {
      "description": "OK"
     }
    }
   }
  },
  "/api/v1/state/{key}": {
   "get": {
    "tags": [
     "state"
    ],
    "summary": "get a state",
    "operationId": "getState",
    "parameters": [
     {
      "type": "string",
      "description": "state key",
      "name": "key",
      "in": "path",
      "required": true
     }
    ],
    "responses": {
     "200": {
      "description": "OK",
      "schema": {
       "type": "string",
       "format": "byte"
      }
     }
    }
   },
   "post": {
    "tags": [
     "state"
    ],
    "summary": "set a state",
    "operationId": "setState",
    "parameters": [
     {
      "type": "string",
      "description": "state key",
      "name": "key",
      "in": "path",
      "required": true
     },
     {
      "name": "body",
      "in": "body",
      "required": true,
      "schema": {
       "type": "string",
       "format": "byte"
      }
     }
    ],
    "responses": {
     "200": {
      "description": "OK"
     }
    }
   }
  },
  "/api/v1/status": {
   "get": {
    "tags": [
     "status"
    ],
    "summary": "Get the status of the Function Stream",
    "operationId": "getStatus",
    "responses": {
     "200": {
      "description": "OK"
     }
    }
   }
  }
 },
 "definitions": {
  "model.Function": {
   "required": [
    "name",
    "package",
    "runtime",
    "source",
    "sink",
    "replicas"
   ],
   "properties": {
    "config": {
     "type": "object",
     "additionalProperties": {
      "type": "string"
     }
    },
    "name": {
     "type": "string"
    },
    "namespace": {
     "type": "string"
    },
    "package": {
     "type": "string"
    },
    "replicas": {
     "type": "integer",
     "format": "int32"
    },
    "runtime": {
     "$ref": "#/definitions/model.RuntimeConfig"
    },
    "sink": {
     "$ref": "#/definitions/model.TubeConfig"
    },
    "source": {
     "type": "array",
     "items": {
      "$ref": "#/definitions/model.TubeConfig"
     }
    }
   }
  },
  "model.RuntimeConfig": {
   "required": [
    "type"
   ],
   "properties": {
    "config": {
     "type": "object"
    },
    "type": {
     "type": "string"
    }
   }
  },
  "model.TubeConfig": {
   "required": [
    "type"
   ],
   "properties": {
    "config": {
     "type": "object"
    },
    "type": {
     "type": "string"
    }
   }
  },
  "restfulspec.SchemaType": {
   "required": [
    "RawType",
    "Format"
   ],
   "properties": {
    "Format": {
     "type": "string"
    },
    "RawType": {
     "type": "string"
    }
   }
  }
 },
 "tags": [
  {
   "description": "Managing functions",
   "name": "function"
  },
  {
   "description": "Managing tubes",
   "name": "tube"
  },
  {
   "description": "Managing state",
   "name": "state"
  },
  {
   "description": "Managing HTTP tubes",
   "name": "http-tube"
  },
  {
   "description": "Managing function store",
   "name": "function-store"
  }
 ]
}