@redbrick-sdk/challenge v2.0.0-rc221115131825
redbrick_challenge
RedbrickChallenge - JavaScript client for redbrick_challenge Redbrick Challenge API This SDK is automatically generated by the Swagger Codegen project:
- API version: 2.0.0-rc221115131825
- Package version: 2.0.0-rc221115131825
- 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 redbrick_challenge --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 RedbrickChallenge = require('redbrick_challenge');
var defaultClient = RedbrickChallenge.ApiClient.instance;
var api = new RedbrickChallenge.ChallengeApi();
var opts = {
body: new RedbrickChallenge.ChallengeCommentBody(), // {ChallengeCommentBody}
};
var callback = function (error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.createChallengeComment(opts, callback);
Documentation for API Endpoints
All URIs are relative to http://localhost:8083/{version}
Class | Method | HTTP request | Description |
---|---|---|---|
RedbrickChallenge.ChallengeApi | createChallengeComment | POST /challenge/comment | |
RedbrickChallenge.ChallengeApi | createChallengeCommentLike | POST /challenge/comment/like/{id} | |
RedbrickChallenge.ChallengeApi | createChallengeReComment | POST /challenge/re/comment/{id} | |
RedbrickChallenge.ChallengeApi | createChallengeReCommentLike | POST /challenge/re/comment/like/{id} | |
RedbrickChallenge.ChallengeApi | createVoteChallenge | POST /challenge/vote | |
RedbrickChallenge.ChallengeApi | deleteChallengeComment | DELETE /challenge/comment | |
RedbrickChallenge.ChallengeApi | deleteChallengeCommentLike | DELETE /challenge/comment/like/{id} | |
RedbrickChallenge.ChallengeApi | deleteChallengeReComment | DELETE /challenge/re/comment/{id} | |
RedbrickChallenge.ChallengeApi | deleteChallengeReCommentLike | DELETE /challenge/re/comment/like/{id} | |
RedbrickChallenge.ChallengeApi | deleteVoteChallenge | DELETE /challenge/vote | |
RedbrickChallenge.ChallengeApi | listChallenge | GET /challenge/list | |
RedbrickChallenge.ChallengeApi | listChallengeComment | GET /challenge/comment | |
RedbrickChallenge.ChallengeApi | listChallengeReComment | GET /challenge/re/comment/{id} | |
RedbrickChallenge.ChallengeApi | updateChallengeComment | PATCH /challenge/comment | |
RedbrickChallenge.ChallengeApi | updateChallengeReComment | PATCH /challenge/re/comment/{id} | |
RedbrickChallenge.ChallengeApi | updateChallengeVotecount | PATCH /challenge/votecount/{id} | |
RedbrickChallenge.ServiceApi | liveness | GET /liveness | |
RedbrickChallenge.ServiceApi | ready | GET /ready |
Documentation for Models
- RedbrickChallenge.ChallengeCommentBody
- RedbrickChallenge.ChallengeCommentBody1
- RedbrickChallenge.CommentIdBody
- RedbrickChallenge.CommentIdBody1
- RedbrickChallenge.CommentResponse
- RedbrickChallenge.ListChallengeResponse
- RedbrickChallenge.ResponseMessage
- RedbrickChallenge.VotecountIdBody
Documentation for Authorization
ApiKeyAuth
- Type: API key
- API key parameter name: X-API-Key
- Location: HTTP header
BasicAuth
- Type: HTTP basic authentication
BearerAuth
OAuth2AuthorizationCode
- Type: OAuth
- Flow: accessCode
- Authorization URL: https://api.redbrick.land/v2/oauth/authorize
- Scopes:
- :
OAuth2Client
- Type: OAuth
- Flow: application
- Authorization URL:
- Scopes:
- :
OAuth2Password
- Type: OAuth
- Flow: password
- Authorization URL:
- Scopes:
- :
1 year ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago