@avirgulto/cmt_rest_client v1.1.0
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/
Class | Method | HTTP request | Description |
---|---|---|---|
SwaggerJsClient.OSLCServiceForCommentCommentSetApi | commentCreator | GET /serviceProviders/{serviceProviderId}/resources/creator | |
SwaggerJsClient.OSLCServiceForCommentCommentSetApi | createComment | POST /serviceProviders/{serviceProviderId}/resources/createComment | Creation factory for resources of type {Comment} |
SwaggerJsClient.OSLCServiceForCommentCommentSetApi | createCommentFromDialog | POST /serviceProviders/{serviceProviderId}/resources/creator | |
SwaggerJsClient.OSLCServiceForCommentCommentSetApi | createCommentSet | POST /serviceProviders/{serviceProviderId}/resources/createCommentSet | Creation factory for resources of type {CommentSet} |
SwaggerJsClient.OSLCServiceForCommentCommentSetApi | queryCommentSetsAsHtml | GET /serviceProviders/{serviceProviderId}/resources/query-commentset | Query capability for resources of type {CommentSet} |
SwaggerJsClient.OSLCServiceForCommentCommentSetApi | queryCommentsAsHtml | GET /serviceProviders/{serviceProviderId}/resources/query-comment | Query capability for resources of type {Comment} |
SwaggerJsClient.WebServiceForCommentSetCommentApi | deleteComment | DELETE /comment/serviceProvider/{serviceProviderId}/Comment/{id} | DELETE for resources of type {'Comment'} |
SwaggerJsClient.WebServiceForCommentSetCommentApi | deleteCommentSet | DELETE /comment/serviceProvider/{serviceProviderId}/CommentSet/{id} | DELETE for resources of type {'CommentSet'} |
SwaggerJsClient.WebServiceForCommentSetCommentApi | getCommentAsHtmlLargePreview | GET /comment/serviceProvider/{serviceProviderId}/Comment/{id}/largePreview | |
SwaggerJsClient.WebServiceForCommentSetCommentApi | getCommentAsHtmlSmallPreview | GET /comment/serviceProvider/{serviceProviderId}/Comment/{id}/smallPreview | |
SwaggerJsClient.WebServiceForCommentSetCommentApi | getCommentCompact | GET /comment/serviceProvider/{serviceProviderId}/Comment/{id} | GET for resources of type {'Comment'} |
SwaggerJsClient.WebServiceForCommentSetCommentApi | getCommentSet | GET /comment/serviceProvider/{serviceProviderId}/CommentSet/{id} | GET for resources of type {'CommentSet'} |
SwaggerJsClient.WebServiceForCommentSetCommentApi | getCommentSetAsHtmlLargePreview | GET /comment/serviceProvider/{serviceProviderId}/CommentSet/{id}/largePreview | |
SwaggerJsClient.WebServiceForCommentSetCommentApi | getCommentSetAsHtmlSmallPreview | GET /comment/serviceProvider/{serviceProviderId}/CommentSet/{id}/smallPreview | |
SwaggerJsClient.WebServiceForCommentSetCommentApi | updateComment | PUT /comment/serviceProvider/{serviceProviderId}/Comment/{id} | PUT for resources of type {'Comment'} |
SwaggerJsClient.WebServiceForCommentSetCommentApi | updateCommentSet | PUT /comment/serviceProvider/{serviceProviderId}/CommentSet/{id} | PUT for resources of type {'CommentSet'} |
Documentation for Models
- SwaggerJsClient.Comment
- SwaggerJsClient.CommentSet
- SwaggerJsClient.Compact
- SwaggerJsClient.Link
- SwaggerJsClient.Preview
- SwaggerJsClient.Response
Documentation for Authorization
All endpoints do not require authorization.