DagsHubApi - JavaScript client for dags_hub_api This API provides a way to retrive & interact with data about DagsHub repositories, users, issues, webhooks and more. The API is also used by the DagsHub Direct Data Access streaming client to stream content from a repository for easier and faster training. This SDK is automatically generated by the Swagger Codegen project:

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

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

Then install it via:

npm install dags_hub_api --save

If the library is hosted at a git repository, e.g. https://github.com/DagsHub/api-clients then install it via:

    npm install DagsHub/api-clients --save

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.

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
      }
    }
  ]
}

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

var DagsHubApi = require('dags_hub_api');
var defaultClient = DagsHubApi.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['token'] = "Token"

var api = new DagsHubApi.BranchesApi()
var owner = "owner_example"; // {String} owner of the repository
var repo = "repo_example"; // {String} name of the repository
var branch = "branch_example"; // {String} branch of the repository

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getBranch(owner, repo, branch, callback);

All URIs are relative to https://dagshub.com/api/v1

• DagsHubApi.Assignee
• DagsHubApi.Body
• DagsHubApi.Closed
• DagsHubApi.CollaboratorsCollaboratorBody
• DagsHubApi.CreateRepo
• DagsHubApi.EditExperimentPost
• DagsHubApi.ExperimentKeys
• DagsHubApi.File
• DagsHubApi.Files
• DagsHubApi.Files1
• DagsHubApi.HooksIdBody
• DagsHubApi.Integration
• DagsHubApi.IntegrationInner
• DagsHubApi.Issue
• DagsHubApi.IssueAssignee
• DagsHubApi.IssueLabels
• DagsHubApi.IssueMilestone
• DagsHubApi.Issues
• DagsHubApi.Labels
• DagsHubApi.MigrateRepo
• DagsHubApi.Milestone
• DagsHubApi.PatchIssue
• DagsHubApi.PostIssue
• DagsHubApi.PutFile
• DagsHubApi.RepoHooksBody
• DagsHubApi.State
• DagsHubApi.Title
• DagsHubApi.User
• DagsHubApi.WebhookConfig
• DagsHubApi.WebhookEvents

• Type: HTTP basic authentication

• Type: API key
• API key parameter name: token
• Location: URL query string