Merge pull request #11 from gotchazipc/master

spec 0.7.0

Author: gotchazipc

README-API.md

@@ -2,9 +2,9 @@
 
 This SDK Contains automatically generated sources & documents with the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
-- API version: 0.6.0
-- Package version: 0.6.0
-- Build date: 2016-07-13T17:50:12.792+09:00
+- API version: 0.7.0
+- Package version: 0.7.0
+- Build date: 2016-07-21T13:37:20.306+09:00
 - Build package: class io.swagger.codegen.languages.JavascriptClientCodegen
 
 ## Getting Started
@@ -26,6 +26,8 @@ var aliasId = "aliasId_example"; // {String} url path fragment alias id. should
 
 var workspaceId = "workspaceId_example"; // {String} webida workspace id in query part
 
+var srcPath = "srcPath_example"; // {String} source data path of some operations, without have heading /
+
 
 var callback = function(error, data, response) {
   if (error) {
@@ -34,7 +36,7 @@ var callback = function(error, data, response) {
     console.log('API called successfully. Returned data: ' + data);
   }
 };
-api.findAliases(aliasId, workspaceId, , callback);
+api.findAliases(aliasId, workspaceId, srcPath, callback);
 
 ```
 
@@ -67,10 +69,10 @@ Class | Method | HTTP request | Description
 *WebidaRestfulApi.WfsApi* | [**remove**](docs/WfsApi.md#remove) | **DELETE** /wfs/{wfsId}/any/{wfsPath} | 
 *WebidaRestfulApi.WfsApi* | [**stat**](docs/WfsApi.md#stat) | **GET** /wfs/{wfsId}/any/{wfsPath} | 
 *WebidaRestfulApi.WfsApi* | [**writeFile**](docs/WfsApi.md#writeFile) | **PUT** /wfs/{wfsId}/file/{wfsPath} | 
-*WebidaRestfulApi.WorkspaceApi* | [**cancel**](docs/WorkspaceApi.md#cancel) | **DELETE** /workspaces/{workspaceId}/exec | 
+*WebidaRestfulApi.WorkspaceApi* | [**cancel**](docs/WorkspaceApi.md#cancel) | **DELETE** /workspaces/{workspaceId}/procs | 
 *WebidaRestfulApi.WorkspaceApi* | [**createWorkspace**](docs/WorkspaceApi.md#createWorkspace) | **POST** /workspaces/{workspaceId} | 
-*WebidaRestfulApi.WorkspaceApi* | [**exec**](docs/WorkspaceApi.md#exec) | **POST** /workspaces/{workspaceId}/exec | 
-*WebidaRestfulApi.WorkspaceApi* | [**findProcs**](docs/WorkspaceApi.md#findProcs) | **GET** /workspaces/{workspaceId}/exec | 
+*WebidaRestfulApi.WorkspaceApi* | [**execute**](docs/WorkspaceApi.md#execute) | **POST** /workspaces/{workspaceId}/procs | 
+*WebidaRestfulApi.WorkspaceApi* | [**findProcs**](docs/WorkspaceApi.md#findProcs) | **GET** /workspaces/{workspaceId}/procs | 
 *WebidaRestfulApi.WorkspaceApi* | [**findWorkspaces**](docs/WorkspaceApi.md#findWorkspaces) | **GET** /workspaces/{workspaceId} | 
 *WebidaRestfulApi.WorkspaceApi* | [**removeWorkspace**](docs/WorkspaceApi.md#removeWorkspace) | **DELETE** /workspaces/{workspaceId} | 
 *WebidaRestfulApi.WorkspaceApi* | [**updateWorkspace**](docs/WorkspaceApi.md#updateWorkspace) | **PUT** /workspaces/{workspaceId} | 

api-bundle.js

@@ -20,9 +20,12 @@ java -jar swagger-codegen-cli.jar generate \
     -i $SPEC_DIR/swagger.yaml -l javascript \
     -t $TEMPLATES_DIR -o $API_DIR
 
-# rename generated README.md & restore original, then build with webpack
+# rename generated README.md & restore original
 cd $API_DIR
 mv README.md README-API.md
 mv README.md.tmp README.md
-npm install
-webpack --progress -p
+
+# building webpack bundle is not supported anymore. webida clients may build their own bundle
+# with wrappers and 3rd-party libs.
+# npm install
+# webpack --progress -p

api-bundle.js.map

@@ -385,6 +385,11 @@
       request.accept(accept);
     }
 
+    // if api returns file, then it should be handled as blob
+    if (returnType === File) {
+        request.responseType('blob');
+    }
+
 {{#usePromises}}    return new Promise(function(resolve, reject) {
       request.end(function(error, response) {
         if (error) {

api-spec/swagger.json

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

api-spec/swagger.yaml

@@ -3,8 +3,8 @@
 ## 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 path should not be included, especially / char. ?, *, and other special characters for shell are not also allowed. | [optional] 
-**workspaceId** | **String** | id of the workspace that contains source of alias | [optional] 
-**sourcePath** | **String** | the source of alias, relative path to workspace root directory. | [optional] 
+**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)  | 
+**workspaceId** | **String** | id of the workspace that contains source of alias | 
+**sourcePath** | **String** | the source of alias, relative path to workspace root directory. | 
 
 

builder/build.sh

@@ -11,11 +11,11 @@ Method | HTTP request | Description
 
 <a name="findAliases"></a>
 # **findAliases**
-> [Alias] findAliases(aliasId, workspaceId, )
+> [Alias] findAliases(aliasId, workspaceId, srcPath)
 
 
 
-get alias objects. set aliasId to &#39;*&#39; to find all aliases in some workspace. if alias id is given, only 0 or 1 matched alias object will be returned.
+get alias objects. set aliasId to &#39;*&#39; to find all aliases in some workspace. If alias id is given, only 0 or 1 matched alias object will be returned, ignoring workspaceId and srcPath. To get an alias object of some wfs path, set srcPath value to some path, and to find all aliases in a workspace, set it to &#39;*&#39; (empty value is not allowed by definition)
 
 ### Example
 ```javascript
@@ -34,6 +34,8 @@ var aliasId = "aliasId_example"; // String | url path fragment alias id. should
 
 var workspaceId = "workspaceId_example"; // String | webida workspace id in query part
 
+var srcPath = "srcPath_example"; // String | source data path of some operations, without have heading /
+
 
 var callback = function(error, data, response) {
   if (error) {
@@ -42,7 +44,7 @@ var callback = function(error, data, response) {
     console.log('API called successfully. Returned data: ' + data);
   }
 };
-apiInstance.findAliases(aliasId, workspaceId, , callback);
+apiInstance.findAliases(aliasId, workspaceId, srcPath, callback);
 ```
 
 ### Parameters
@@ -51,6 +53,7 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **aliasId** | **String**| url path fragment alias id. should have no &#39;/&#39; as well as any &#39;unsafe&#39; chars for url path.  especially, &#39;*&#39; is reserved for finding operations or some other special case. | 
  **workspaceId** | **String**| webida workspace id in query part | 
+ **srcPath** | **String**| source data path of some operations, without have heading / | 
 
 ### Return type
 
@@ -123,7 +126,7 @@ Name | Type | Description  | Notes
 
 <a name="removeAliases"></a>
 # **removeAliases**
-> RestOK removeAliases(aliasId, workspaceId, )
+> RestOK removeAliases(aliasId, workspaceId, srcPath)
 
 
 
@@ -146,6 +149,8 @@ var aliasId = "aliasId_example"; // String | url path fragment alias id. should
 
 var workspaceId = "workspaceId_example"; // String | webida workspace id in query part
 
+var srcPath = "srcPath_example"; // String | source data path of some operations, without have heading /
+
 
 var callback = function(error, data, response) {
   if (error) {
@@ -154,7 +159,7 @@ var callback = function(error, data, response) {
     console.log('API called successfully. Returned data: ' + data);
   }
 };
-apiInstance.removeAliases(aliasId, workspaceId, , callback);
+apiInstance.removeAliases(aliasId, workspaceId, srcPath, callback);
 ```
 
 ### Parameters
@@ -163,6 +168,7 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **aliasId** | **String**| url path fragment alias id. should have no &#39;/&#39; as well as any &#39;unsafe&#39; chars for url path.  especially, &#39;*&#39; is reserved for finding operations or some other special case. | 
  **workspaceId** | **String**| webida workspace id in query part | 
+ **srcPath** | **String**| source data path of some operations, without have heading / | 
 
 ### Return type