Skip to content

README-API.md

Latest commit

 

History

History
107 lines (82 loc) · 5.76 KB

README-API.md

File metadata and controls

107 lines (82 loc) · 5.76 KB

webida_restful_api

This SDK Contains automatically generated sources & documents with the Swagger Codegen project:

  • API version: 0.7.1
  • Package version: 0.7.1
  • Build date: 2016-08-18T15:47:36.665+09:00
  • Build package: class io.swagger.codegen.languages.JavascriptClientCodegen

Getting Started

var WebidaRestfulApi = require('webida_restful_api');

var defaultClient = WebidaRestfulApi.ApiClient.default;

// Configure API key authorization: webida-simple-auth
var webida-simple-auth = defaultClient.authentications['webida-simple-auth'];
webida-simple-auth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//webida-simple-auth.apiKeyPrefix['Authorization'] = "Token"

var api = new WebidaRestfulApi.AliasApi()

var aliasId = "aliasId_example"; // {String} url path fragment alias id. should have no '/' as well as any 'unsafe' chars for url path.  especially, '*' is reserved for finding operations or some other special case.

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) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findAliases(aliasId, workspaceId, srcPath, callback);

Documentation for API Endpoints

The end point of Webida Restful API is not fixed in swagger spec file. So, generated basePath https://localhost/api should be changed to ${serverUrl}/api

Class Method HTTP request Description
WebidaRestfulApi.AliasApi findAliases GET /aliass/{aliasId}
WebidaRestfulApi.AliasApi putAlias PUT /aliass/{aliasId}
WebidaRestfulApi.AliasApi removeAliases DELETE /aliass/{aliasId}
WebidaRestfulApi.AuthApi getInfo GET /auth/info
WebidaRestfulApi.AuthApi issueToken POST /auth/token
WebidaRestfulApi.AuthApi login POST /auth/login
WebidaRestfulApi.RemotesApi findRemoteAccesses GET /remotes
WebidaRestfulApi.RemotesApi putRemoteAccess PUT /remotes
WebidaRestfulApi.RemotesApi removeRemoteAccess DELETE /remotes
WebidaRestfulApi.SessionApi closeSessions DELETE /sessions/{sessionId}
WebidaRestfulApi.SessionApi findSessions GET /sessions/{sessionId}
WebidaRestfulApi.WfsApi copy PUT /wfs/{wfsId}/any/{wfsPath}
WebidaRestfulApi.WfsApi createDir PUT /wfs/{wfsId}/dir/{wfsPath}
WebidaRestfulApi.WfsApi dirTree GET /wfs/{wfsId}/dir/{wfsPath}
WebidaRestfulApi.WfsApi move POST /wfs/{wfsId}/any/{wfsPath}
WebidaRestfulApi.WfsApi readFile GET /wfs/{wfsId}/file/{wfsPath}
WebidaRestfulApi.WfsApi remove DELETE /wfs/{wfsId}/any/{wfsPath}
WebidaRestfulApi.WfsApi replace POST /wfs/{wfsId}/ops/replace
WebidaRestfulApi.WfsApi search GET /wfs/{wfsId}/ops/search
WebidaRestfulApi.WfsApi stat GET /wfs/{wfsId}/any/{wfsPath}
WebidaRestfulApi.WfsApi writeFile PUT /wfs/{wfsId}/file/{wfsPath}
WebidaRestfulApi.WorkspaceApi cancel DELETE /workspaces/{workspaceId}/procs
WebidaRestfulApi.WorkspaceApi createWorkspace POST /workspaces/{workspaceId}
WebidaRestfulApi.WorkspaceApi execute POST /workspaces/{workspaceId}/procs
WebidaRestfulApi.WorkspaceApi findProcs GET /workspaces/{workspaceId}/procs
WebidaRestfulApi.WorkspaceApi findWorkspaces GET /workspaces/{workspaceId}
WebidaRestfulApi.WorkspaceApi removeWorkspace DELETE /workspaces/{workspaceId}
WebidaRestfulApi.WorkspaceApi updateWorkspace PUT /workspaces/{workspaceId}

Documentation for Models

Documentation for Authorization

webida-simple-auth

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header