1.1.0 • Published 3 years ago

@avirgulto/cmt_rest_client v1.1.0

Weekly downloads
-
License
Unlicense
Repository
-
Last release
3 years ago

swagger-js-client

SwaggerJsClient - JavaScript client for swagger-js-client No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) This SDK is automatically generated by the Swagger Codegen project:

  • API version: 1.0.0
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.v3.generators.javascript.JavaScriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install swagger-js-client --save

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.OSLCServiceForCommentCommentSetApi()
var serviceProviderId = "serviceProviderId_example"; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.commentCreator(serviceProviderId, callback);

Documentation for API Endpoints

All URIs are relative to http://localhost:8081/oslc-server-mock-cmt/services/

ClassMethodHTTP requestDescription
SwaggerJsClient.OSLCServiceForCommentCommentSetApicommentCreatorGET /serviceProviders/{serviceProviderId}/resources/creator
SwaggerJsClient.OSLCServiceForCommentCommentSetApicreateCommentPOST /serviceProviders/{serviceProviderId}/resources/createCommentCreation factory for resources of type {Comment}
SwaggerJsClient.OSLCServiceForCommentCommentSetApicreateCommentFromDialogPOST /serviceProviders/{serviceProviderId}/resources/creator
SwaggerJsClient.OSLCServiceForCommentCommentSetApicreateCommentSetPOST /serviceProviders/{serviceProviderId}/resources/createCommentSetCreation factory for resources of type {CommentSet}
SwaggerJsClient.OSLCServiceForCommentCommentSetApiqueryCommentSetsAsHtmlGET /serviceProviders/{serviceProviderId}/resources/query-commentsetQuery capability for resources of type {CommentSet}
SwaggerJsClient.OSLCServiceForCommentCommentSetApiqueryCommentsAsHtmlGET /serviceProviders/{serviceProviderId}/resources/query-commentQuery capability for resources of type {Comment}
SwaggerJsClient.WebServiceForCommentSetCommentApideleteCommentDELETE /comment/serviceProvider/{serviceProviderId}/Comment/{id}DELETE for resources of type {'Comment'}
SwaggerJsClient.WebServiceForCommentSetCommentApideleteCommentSetDELETE /comment/serviceProvider/{serviceProviderId}/CommentSet/{id}DELETE for resources of type {'CommentSet'}
SwaggerJsClient.WebServiceForCommentSetCommentApigetCommentAsHtmlLargePreviewGET /comment/serviceProvider/{serviceProviderId}/Comment/{id}/largePreview
SwaggerJsClient.WebServiceForCommentSetCommentApigetCommentAsHtmlSmallPreviewGET /comment/serviceProvider/{serviceProviderId}/Comment/{id}/smallPreview
SwaggerJsClient.WebServiceForCommentSetCommentApigetCommentCompactGET /comment/serviceProvider/{serviceProviderId}/Comment/{id}GET for resources of type {'Comment'}
SwaggerJsClient.WebServiceForCommentSetCommentApigetCommentSetGET /comment/serviceProvider/{serviceProviderId}/CommentSet/{id}GET for resources of type {'CommentSet'}
SwaggerJsClient.WebServiceForCommentSetCommentApigetCommentSetAsHtmlLargePreviewGET /comment/serviceProvider/{serviceProviderId}/CommentSet/{id}/largePreview
SwaggerJsClient.WebServiceForCommentSetCommentApigetCommentSetAsHtmlSmallPreviewGET /comment/serviceProvider/{serviceProviderId}/CommentSet/{id}/smallPreview
SwaggerJsClient.WebServiceForCommentSetCommentApiupdateCommentPUT /comment/serviceProvider/{serviceProviderId}/Comment/{id}PUT for resources of type {'Comment'}
SwaggerJsClient.WebServiceForCommentSetCommentApiupdateCommentSetPUT /comment/serviceProvider/{serviceProviderId}/CommentSet/{id}PUT for resources of type {'CommentSet'}

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.

1.1.0

3 years ago

1.0.9

3 years ago

1.0.8

3 years ago

1.0.7

3 years ago

1.0.6

3 years ago

1.0.5

3 years ago

1.0.2

3 years ago

1.0.4

3 years ago

1.0.3

3 years ago

1.0.1

3 years ago

1.0.0

3 years ago