auto_grading_api

AutoGradingApi - JavaScript client for auto_grading_api No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) This SDK is automatically generated by the OpenAPI Generator project:

• API version: 0.1.3
• Package version: 0.1.3
• Build package: org.openapitools.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 auto_grading_api --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your auto_grading_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

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 AutoGradingApi = require('auto_grading_api');

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

var api = new AutoGradingApi.AssignmentsApi()
var uid = "uid_example"; // {String} 
var lid = "lid_example"; // {String} 
var assignmentModel = new AutoGradingApi.AssignmentModel(); // {AssignmentModel} 
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createAssignment(uid, lid, assignmentModel, callback);

Documentation for API Endpoints

All URIs are relative to http://localhost:8000

Class	Method	HTTP request	Description
AutoGradingApi.AssignmentsApi	createAssignment	POST /users/{uid}/lectures/{lid}/assignments	Create Assignment
AutoGradingApi.AssignmentsApi	deleteAssignment	DELETE /users/{uid}/lectures/{lid}/assignments/{aid}	Delete Assignment
AutoGradingApi.AssignmentsApi	getSingleAssignment	GET /users/{uid}/lectures/{lid}/lessons/{aid}	Show Assignment
AutoGradingApi.AssignmentsApi	listAssignmentsOfLecture	GET /users/{uid}/lectures/{lid}/assignments	List Assignments
AutoGradingApi.AssignmentsApi	updateAssignment	PUT /users/{uid}/lectures/{lid}/assignments/{aid}	Update Assignment
AutoGradingApi.DefaultApi	loginForAccessTokenTokenPost	POST /token	Login For Access Token
AutoGradingApi.GradesApi	createGrade	POST /users/lectures/{lid}/students/{sid}/grades	Create Grade
AutoGradingApi.GradesApi	deleteGrade	DELETE /users/lectures/{lid}/students/{sid}/grades/{gid}	Delete Grade
AutoGradingApi.GradesApi	getSingleGrade	GET /users/lectures/{lid}/students/{sid}/grades/{aid}	Show Grade
AutoGradingApi.GradesApi	listGradesOfStudent	GET /users/lectures/{lid}/students/{sid}/grades	List Grades
AutoGradingApi.GradesApi	updateGrade	PUT /users/lectures/{lid}/students/{sid}/grades/{gid}	Update Grade
AutoGradingApi.LecturesApi	createLecture	POST /users/{uid}/lectures	Create Lecture
AutoGradingApi.LecturesApi	deleteLecture	DELETE /users/{uid}/lectures/{lid}	Delete Lecture
AutoGradingApi.LecturesApi	getSingleLecture	GET /users/{uid}/lectures/{lid}	Show Lecture
AutoGradingApi.LecturesApi	listLectures	GET /users/{uid}/lectures	List Lectures
AutoGradingApi.LecturesApi	updateLecture	PUT /users/{uid}/lectures/{lid}	Update Lecture
AutoGradingApi.StudentsApi	createStudent	POST /users/{uid}/lectures/{lid}/students	Create Student
AutoGradingApi.StudentsApi	deleteStudent	DELETE /users/{uid}/lectures/{lid}/students/{sid}	Delete Student
AutoGradingApi.StudentsApi	getSingleStudent	GET /users/{uid}/lectures/{lid}/students/{sid}	Show Student
AutoGradingApi.StudentsApi	listStudentsOfLecture	GET /users/{uid}/lectures/{lid}/students	List Students
AutoGradingApi.StudentsApi	updateStudent	PUT /users/{uid}/lectures/{lid}/students/{sid}	Update Student
AutoGradingApi.UsersApi	createUser	POST /users	Create User
AutoGradingApi.UsersApi	deleteUser	DELETE /users/{uid}	Delete User
AutoGradingApi.UsersApi	getCurrentUser	GET /users	Get Current
AutoGradingApi.UsersApi	getStudentList	GET /users/students	Show Student List
AutoGradingApi.UsersApi	updatePassword	PUT /users/{uid}/change-password	Update Password

Documentation for Models

• AutoGradingApi.AssignmentModel
• AutoGradingApi.BodyLoginForAccessTokenTokenPost
• AutoGradingApi.HTTPValidationError
• AutoGradingApi.LectureModel
• AutoGradingApi.Message
• AutoGradingApi.StudentGradeModel
• AutoGradingApi.StudentModel
• AutoGradingApi.Token
• AutoGradingApi.UpdatePasswordModel
• AutoGradingApi.UserModel
• AutoGradingApi.ValidationError

Documentation for Authorization

OAuth2PasswordBearer

• Type: OAuth
• Flow: password
• Authorization URL:
• Scopes: N/A