Merge pull request #13 from gotchazipc/master

updated version to 0.8.0

Author: gotchazipc

README-API.md

@@ -4,7 +4,7 @@ This SDK Contains automatically generated sources & documents with the [Swagger
 
 - API version: 0.7.1
 - Package version: 0.7.1
-- Build date: 2016-07-26T15:37:20.836+09:00
+- Build date: 2016-08-09T17:23:32.460+09:00
 - Build package: class io.swagger.codegen.languages.JavascriptClientCodegen
 
 ## Getting Started

api-spec/swagger.json

@@ -205,7 +205,7 @@
     "/auth/token" : {
       "post" : {
         "tags" : [ "auth" ],
-        "description" : "Creates new token from current access token, inheriting workspace id & session id. The duration of generated token is (and should not be) parameterizable. Server should set proper duration, respecting \"reconnect\" period of socket.io clients. Remember that most of socket.io client implementations (including official js client) do not provide any ways to change connection parameters (header or query) while reconnecting to server.\n\nLike login API, this endpoint does not provide any encryption. Server should not set any data to harm security in the token & should provide some signinig/encryption mechanism to protect token. Simple JSON Web Token with HMAC-SHA will do.\n",
+        "description" : "Creates new token from current access token, inheriting workspace id & session id. The duration of generated token is not (and should not be) parameterizable. Server should set proper duration, respecting \"reconnect\" period of socket.io clients. Remember that most of socket.io client implementations (including official js client) do not provide any ways to change connection parameters (header or query) while reconnecting to server.\n\nLike login API, this endpoint does not provide any encryption. Server should not set any data to harm security in the token & should provide some signinig/encryption mechanism to protect token. Simple JSON Web Token with HMAC-SHA will do.\n",
         "operationId" : "issueToken",
         "parameters" : [ {
           "name" : "type",
@@ -724,7 +724,7 @@
         }, {
           "name" : "If-None-Match",
           "in" : "header",
-          "description" : "Usual if-non-match header, allowing only 1 e-tag value from previous readFile response, including weak prefix and quotation chars. This header value precedes if-modified-since, and server should ignore if-modified-since header when if-none-match header exists, as RFC-2616 declines.",
+          "description" : "Usual if-non-match header, allowing only 1 e-tag value from previous readFile response. The value of this header can have weak prefix and quotation chars. This header value precedes the value of if-modified-since header. Server should ignore if-modified-since header when if-none-match header exists, as RFC-2616.",
           "required" : false,
           "type" : "string"
         } ],
@@ -1478,7 +1478,7 @@
     },
     "Session" : {
       "type" : "object",
-      "required" : [ "clientAddress", "connectedAt", "disconnectedAt", "id", "name", "state" ],
+      "required" : [ "clientAddress", "connectedAt", "id", "name", "state" ],
       "properties" : {
         "id" : {
           "type" : "string",
@@ -1490,8 +1490,8 @@
         },
         "state" : {
           "type" : "string",
-          "description" : "NORMAL = connected, normally working\nLOSING = disconnected, waiting reconnection. still accessible with api\nCLOSING = socket connection will close connection by server (clinet will be notified)\n\nThere\"s no \"CLOSED\" / \"LOST\" state, for server will remove session object in registry  when the server closes connection or stops waiting for reconnection for timeout.\n",
-          "enum" : [ "NORMAL", "LOSING", "CLOSING" ]
+          "description" : "NORMAL = connected, normally working.\nCLOSING = server requested client to disconnect. Connection will be closed soon.\nTERMINATED = disconnected. server will remove this session from registry ASAP.\n",
+          "enum" : [ "NORMAL", "CLOSING", "TERMINATED" ]
         },
         "workspaceId" : {
           "type" : "string",
@@ -1506,20 +1506,10 @@
           "format" : "date-time",
           "description" : "the time when socket connection is established"
         },
-        "disconnectedAt" : {
-          "type" : "string",
-          "format" : "date-time",
-          "description" : "the time when socket is closed."
-        },
         "willCloseAt" : {
           "type" : "string",
           "format" : "date-time",
-          "description" : "when state becomes CLOSING, actual closing time will be updated by server."
-        },
-        "willLoseAt" : {
-          "type" : "string",
-          "format" : "date-time",
-          "description" : "when state becomes LOSING, server will not wait for reconnection after this time."
+          "description" : "when state becomes CLOSING, server sets this time as deadline."
         }
       },
       "description" : "an application session per ide instance. bound to access token"
@@ -1631,7 +1621,7 @@
       "properties" : {
         "id" : {
           "type" : "string",
-          "description" : "id, and the path-fragment to access. Since this id is a path-fragment, any unsafe chars for file system path should not be included. Windows OS prohibits following characters to be used in a file name.\n < (less than)\n > (greater than)\n : (colon)\n \" (double quote)\n / (forward slash)\n \\ (backslash)\n | (vertical bar or pipe)\n ? (question mark)\n * (asterisk)\n"
+          "description" : "id, and the path-fragment to access. Since this id is a path-fragment, any unsafe chars for file system path should not be included. Windows OS prohibits following characters.\n < (less than)\n > (greater than)\n : (colon)\n \" (double quote)\n / (forward slash)\n \\ (backslash)\n | (vertical bar or pipe)\n ? (question mark)\n * (asterisk)\n"
         },
         "workspaceId" : {
           "type" : "string",

api-spec/swagger.yaml

@@ -102,7 +102,7 @@ paths:
       x-handler: handlers/auth/issueToken.js
       tags: ["auth"]
       description: |
-        Creates new token from current access token, inheriting workspace id & session id. The duration of generated token is (and should not be) parameterizable. Server should set proper duration, respecting "reconnect" period of socket.io clients. Remember that most of socket.io client implementations (including official js client) do not provide any ways to change connection parameters (header or query) while reconnecting to server.
+        Creates new token from current access token, inheriting workspace id & session id. The duration of generated token is not (and should not be) parameterizable. Server should set proper duration, respecting "reconnect" period of socket.io clients. Remember that most of socket.io client implementations (including official js client) do not provide any ways to change connection parameters (header or query) while reconnecting to server.
 
         Like login API, this endpoint does not provide any encryption. Server should not set any data to harm security in the token & should provide some signinig/encryption mechanism to protect token. Simple JSON Web Token with HMAC-SHA will do.
 
@@ -168,7 +168,7 @@ paths:
         - name: If-None-Match
           in: header
           required: false
-          description: Usual if-non-match header, allowing only 1 e-tag value from previous readFile response, including weak prefix and quotation chars. This header value precedes if-modified-since, and server should ignore if-modified-since header when if-none-match header exists, as RFC-2616 declines.
+          description: Usual if-non-match header, allowing only 1 e-tag value from previous readFile response. The value of this header can have weak prefix and quotation chars. This header value precedes the value of if-modified-since header. Server should ignore if-modified-since header when if-none-match header exists, as RFC-2616.
           type: string
       responses:
         "200":
@@ -1237,16 +1237,14 @@ definitions:
         type: string
       state:
         description: |
-          NORMAL = connected, normally working
-          LOSING = disconnected, waiting reconnection. still accessible with api
-          CLOSING = socket connection will close connection by server (clinet will be notified)
-
-          There"s no "CLOSED" / "LOST" state, for server will remove session object in registry  when the server closes connection or stops waiting for reconnection for timeout.
+          NORMAL = connected, normally working.
+          CLOSING = server requested client to disconnect. Connection will be closed soon.
+          TERMINATED = disconnected. server will remove this session from registry ASAP.
         type: string
         enum:
           - NORMAL
-          - LOSING
           - CLOSING
+          - TERMINATED
       workspaceId:
         description: the id of workspace that this sessions is working on. If falsy, then this session is not belonged to any workpsace. Usually, dashboard / monitoring app will create a session without workspace id.
         type: string
@@ -1257,16 +1255,8 @@ definitions:
         description: the time when socket connection is established
         type: string
         format: date-time
-      disconnectedAt:
-        description: the time when socket is closed.
-        type: string
-        format: date-time
       willCloseAt:
-        description: when state becomes CLOSING, actual closing time will be updated by server.
-        type: string
-        format: date-time
-      willLoseAt:
-        description: when state becomes LOSING, server will not wait for reconnection after this time.
+        description: when state becomes CLOSING, server sets this time as deadline.
         type: string
         format: date-time
     required:
@@ -1275,7 +1265,6 @@ definitions:
       - state
       - clientAddress
       - connectedAt
-      - disconnectedAt
 
   Execution:
     type: object
@@ -1398,7 +1387,7 @@ definitions:
     properties:
       id:
         description: |
-          id, and the path-fragment to access. Since this id is a path-fragment, any unsafe chars for file system path should not be included. Windows OS prohibits following characters to be used in a file name.
+          id, and the path-fragment to access. Since this id is a path-fragment, any unsafe chars for file system path should not be included. Windows OS prohibits following characters.
            < (less than)
            > (greater than)
            : (colon)

builder/templates/package.mustache

@@ -1,6 +1,6 @@
 {
   "name": "webida-restful-api",
-  "version": "0.7.1",
+  "version": "0.8.0",
   "description": "Webida Restful API Spec & generated clients",
   "license": "Apache-2.0",
   "main": "{{sourceFolder}}{{#invokerPackage}}/{{invokerPackage}}{{/invokerPackage}}/index.js",

docs/Alias.md

@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **String** | id, and the path-fragment to access. Since this id is a path-fragment, any unsafe chars for file system path should not be included. Windows OS prohibits following characters to be used in a file name.  < (less than)  > (greater than)  : (colon)  \" (double quote)  / (forward slash)  \\ (backslash)  | (vertical bar or pipe)  ? (question mark)  * (asterisk)  | 
+**id** | **String** | id, and the path-fragment to access. Since this id is a path-fragment, any unsafe chars for file system path should not be included. Windows OS prohibits following characters.  < (less than)  > (greater than)  : (colon)  \" (double quote)  / (forward slash)  \\ (backslash)  | (vertical bar or pipe)  ? (question mark)  * (asterisk)  | 
 **workspaceId** | **String** | id of the workspace that contains source of alias | 
 **sourcePath** | **String** | the source of alias, relative path to workspace root directory. | 
 

docs/AuthApi.md

@@ -62,7 +62,7 @@ This endpoint does not need any parameter.
 
 
 
-Creates new token from current access token, inheriting workspace id & session id. The duration of generated token is (and should not be) parameterizable. Server should set proper duration, respecting \"reconnect\" period of socket.io clients. Remember that most of socket.io client implementations (including official js client) do not provide any ways to change connection parameters (header or query) while reconnecting to server.  Like login API, this endpoint does not provide any encryption. Server should not set any data to harm security in the token & should provide some signinig/encryption mechanism to protect token. Simple JSON Web Token with HMAC-SHA will do. 
+Creates new token from current access token, inheriting workspace id & session id. The duration of generated token is not (and should not be) parameterizable. Server should set proper duration, respecting \"reconnect\" period of socket.io clients. Remember that most of socket.io client implementations (including official js client) do not provide any ways to change connection parameters (header or query) while reconnecting to server.  Like login API, this endpoint does not provide any encryption. Server should not set any data to harm security in the token & should provide some signinig/encryption mechanism to protect token. Simple JSON Web Token with HMAC-SHA will do. 
 
 ### Example
 ```javascript

docs/Session.md

@@ -5,13 +5,11 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **String** | the id of a session. usually same to socket id. | 
 **name** | **String** | human readable name, usually derived from workspace name. | 
-**state** | **String** | NORMAL = connected, normally working LOSING = disconnected, waiting reconnection. still accessible with api CLOSING = socket connection will close connection by server (clinet will be notified)  There\"s no \"CLOSED\" / \"LOST\" state, for server will remove session object in registry  when the server closes connection or stops waiting for reconnection for timeout.  | 
+**state** | **String** | NORMAL = connected, normally working. CLOSING = server requested client to disconnect. Connection will be closed soon. TERMINATED = disconnected. server will remove this session from registry ASAP.  | 
 **workspaceId** | **String** | the id of workspace that this sessions is working on. If falsy, then this session is not belonged to any workpsace. Usually, dashboard / monitoring app will create a session without workspace id. | [optional] 
 **clientAddress** | **String** | the peer address of session connection. not always | 
 **connectedAt** | **Date** | the time when socket connection is established | 
-**disconnectedAt** | **Date** | the time when socket is closed. | 
-**willCloseAt** | **Date** | when state becomes CLOSING, actual closing time will be updated by server. | [optional] 
-**willLoseAt** | **Date** | when state becomes LOSING, server will not wait for reconnection after this time. | [optional] 
+**willCloseAt** | **Date** | when state becomes CLOSING, server sets this time as deadline. | [optional] 
 
 
 <a name="StateEnum"></a>
@@ -20,10 +18,10 @@ Name | Type | Description | Notes
 
 * `NORMAL` (value: `"NORMAL"`)
 
-* `LOSING` (value: `"LOSING"`)
-
 * `CLOSING` (value: `"CLOSING"`)
 
+* `TERMINATED` (value: `"TERMINATED"`)
+
 
 
 

docs/WfsApi.md

@@ -286,7 +286,7 @@ var wfsPath = "wfsPath_example"; // String | webida file system path to access.
 
 var opts = { 
   'ifModifiedSince': "ifModifiedSince_example", // String | Usual if-modified-since header. So, should be RFC-1123(same to RFC-822) format, not RFC-3339 (same to ISO-8601).
-  'ifNoneMatch': "ifNoneMatch_example" // String | Usual if-non-match header, allowing only 1 e-tag value from previous readFile response, including weak prefix and quotation chars. This header value precedes if-modified-since, and server should ignore if-modified-since header when if-none-match header exists, as RFC-2616 declines.
+  'ifNoneMatch': "ifNoneMatch_example" // String | Usual if-non-match header, allowing only 1 e-tag value from previous readFile response. The value of this header can have weak prefix and quotation chars. This header value precedes the value of if-modified-since header. Server should ignore if-modified-since header when if-none-match header exists, as RFC-2616.
 };
 
 var callback = function(error, data, response) {
@@ -306,7 +306,7 @@ Name | Type | Description  | Notes
  **wfsId** | **String**| webida file system id (same to workspace id) to access. | 
  **wfsPath** | **String**| webida file system path to access. without heading /. should be placed at the end of path arguments | 
  **ifModifiedSince** | **String**| Usual if-modified-since header. So, should be RFC-1123(same to RFC-822) format, not RFC-3339 (same to ISO-8601). | [optional] 
- **ifNoneMatch** | **String**| Usual if-non-match header, allowing only 1 e-tag value from previous readFile response, including weak prefix and quotation chars. This header value precedes if-modified-since, and server should ignore if-modified-since header when if-none-match header exists, as RFC-2616 declines. | [optional] 
+ **ifNoneMatch** | **String**| Usual if-non-match header, allowing only 1 e-tag value from previous readFile response. The value of this header can have weak prefix and quotation chars. This header value precedes the value of if-modified-since header. Server should ignore if-modified-since header when if-none-match header exists, as RFC-2616. | [optional] 
 
 ### Return type
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "webida-restful-api",
-  "version": "0.7.1",
+  "version": "0.8.0",
   "description": "Webida Restful API Spec & generated clients",
   "license": "Apache-2.0",
   "main": "src/index.js",

src/api/AuthApi.js

@@ -103,7 +103,7 @@
      */
 
     /**
-     * Creates new token from current access token, inheriting workspace id & session id. The duration of generated token is (and should not be) parameterizable. Server should set proper duration, respecting \"reconnect\" period of socket.io clients. Remember that most of socket.io client implementations (including official js client) do not provide any ways to change connection parameters (header or query) while reconnecting to server.  Like login API, this endpoint does not provide any encryption. Server should not set any data to harm security in the token & should provide some signinig/encryption mechanism to protect token. Simple JSON Web Token with HMAC-SHA will do. 
+     * Creates new token from current access token, inheriting workspace id & session id. The duration of generated token is not (and should not be) parameterizable. Server should set proper duration, respecting \"reconnect\" period of socket.io clients. Remember that most of socket.io client implementations (including official js client) do not provide any ways to change connection parameters (header or query) while reconnecting to server.  Like login API, this endpoint does not provide any encryption. Server should not set any data to harm security in the token & should provide some signinig/encryption mechanism to protect token. Simple JSON Web Token with HMAC-SHA will do. 
      * @param {module:model/String} type 
      * @param {Object} opts Optional parameters
      * @param {String} opts.workspaceId Clients to save some remote access info should issue a MASTER type token restricted to specific workspace id.