ddots-client v0.1.0

ddots-client

DDOTS - JavaScript client for ddots-client

Explore the demo server I suggest you start with signing up a new user. To do so, use POST /users/ endpoint with recaptcha_key=\"secret_key\". You will need to know the API Client ID to authenticate, so here it is: documentation. Sometimes (e.g. for token refreshing) you might need API Client Secret: KQ()SWK)SQK)QWSKQW(SKQ)S(QWSQW(SJ*HQ&HQW*SQ*^SSQWSGQSG. There are also two built-in users: root (administrator with all permissions) with password q user (regular user) with password w

This SDK is automatically generated by the Swagger Codegen project:

• API version: 0.1.1
• Package version: 0.1.1
• Build package: io.swagger.codegen.languages.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 ddots-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.

Getting Started

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

var DDOTS = require('ddots-client');

var defaultClient = DDOTS.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_password
var oauth2_password = defaultClient.authentications['oauth2_password'];
oauth2_password.accessToken = "YOUR ACCESS TOKEN"

var api = new DDOTS.AuthApi()

var defaultScopes = ["defaultScopes_example"]; // {[String]} 

var opts = { 
  'redirectUris': ["redirectUris_example"] // {[String]} 
};
api.createOauthClient(defaultScopes, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to https://localhost/api/v1

Documentation for Models

• DDOTS.BaseOAuth2Client
• DDOTS.BaseProblem
• DDOTS.BaseProgrammingLanguage
• DDOTS.BaseSolution
• DDOTS.BaseSolutionAuthor
• DDOTS.BaseSolutionProblem
• DDOTS.BaseSolutionProgrammingLanguage
• DDOTS.BaseTeam
• DDOTS.BaseTeamMember
• DDOTS.BaseTeamMemberTeam
• DDOTS.BaseUser
• DDOTS.Body
• DDOTS.Body1
• DDOTS.Body2
• DDOTS.Body3
• DDOTS.Body4
• DDOTS.DetailedOAuth2Client
• DDOTS.DetailedProblem
• DDOTS.DetailedProgrammingLanguage
• DDOTS.DetailedSolution
• DDOTS.DetailedSolutionTestingReport
• DDOTS.DetailedTeam
• DDOTS.DetailedTeamMembers
• DDOTS.DetailedUser
• DDOTS.HTTPError401
• DDOTS.HTTPError403
• DDOTS.HTTPError404
• DDOTS.HTTPError409
• DDOTS.HTTPError422
• DDOTS.ProblemTestsArchiveSchema
• DDOTS.SolutionSourceCodeSchema
• DDOTS.SolutionssolutionIdtestingreportTests
• DDOTS.TestingSolution
• DDOTS.TestingSolutionProgrammingLanguage
• DDOTS.UserSignupForm

Documentation for Authorization

oauth2_password

• Type: OAuth
• Flow: password
• Authorization URL:
• Scopes:
  • auth:read: Provide access to auth details
  • auth:write: Provide write access to auth details
  • problems:read: Provide access to problem details
  • problems:write: Provide write access to problem details
  • programming_languages:read: Provide access to programming language details
  • programming_languages:write: Provide write access to programming language details
  • solutions:read: Provide access to solution details
  • solutions:write: Provide write access to solution details
  • teams:read: Provide access to team details
  • teams:write: Provide write access to team details
  • users:read: Provide access to user details
  • users:write: Provide write access to user details