geogig v1.1.20

geogig

Geogig - JavaScript client for geogig GeoGig Web API. You can find out more about GeoGig at http://geogig.org This SDK is automatically generated by the Swagger Codegen project:

• API version: 0.1.0
• Package version: 0.1-SNAPSHOT
• Build date: 2018-03-08T17:05:29.376-08:00
• 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 geogig --save

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

Finally, switch to the directory you want to use your geogig from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('geogig') in javascript files from the directory you ran the last command above from.

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, that's to say your javascript file where you actually use this library):

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 Geogig = require('geogig');

var defaultClient = Geogig.ApiClient.instance;

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

// Configure HTTP basic authorization: BasicAuth
var BasicAuth = defaultClient.authentications['BasicAuth'];
BasicAuth.username = 'YOUR USERNAME'
BasicAuth.password = 'YOUR PASSWORD'

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

var api = new Geogig.AsyncApi()

var taskId = "taskId_example"; // {String} Async task identifier

api.abortTask(taskId).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 http://virtserver.swaggerhub.com/groldan/geogig-web/1.0.0

Documentation for Models

• Geogig.AsyncTaskInfo
• Geogig.BoundingBox
• Geogig.BranchInfo
• Geogig.Coordinate
• Geogig.Error
• Geogig.Feature
• Geogig.FeatureFilter
• Geogig.FeatureQuery
• Geogig.IdentifiedObject
• Geogig.LayerInfo
• Geogig.LayerSummary
• Geogig.ObjectHash
• Geogig.ObjectType
• Geogig.Person
• Geogig.ProgressInfo
• Geogig.PullRequestInfo
• Geogig.PullRequestRequest
• Geogig.Ref
• Geogig.RefMap
• Geogig.RepoLayerSummary
• Geogig.RevisionObject
• Geogig.SRS
• Geogig.SimplePropertyDescriptor
• Geogig.StoreConnectionInfo
• Geogig.TaskResult
• Geogig.TransactionInfo
• Geogig.TransactionStatus
• Geogig.TreeBucket
• Geogig.TreeNode
• Geogig.UpdateFeaturesRequest
• Geogig.UserInfoPrivateProfile
• Geogig.UserInfoPublicProfile
• Geogig.UserLayerSummary
• Geogig.UserType
• Geogig.Value
• Geogig.ValueType
• Geogig.VersionInfo
• Geogig.FeatureCollection
• Geogig.FileStoreInfo
• Geogig.PostgresStoreInfo
• Geogig.RepositoryInfo
• Geogig.RevisionCommit
• Geogig.RevisionFeature
• Geogig.RevisionFeatureType
• Geogig.RevisionTag
• Geogig.RevisionTree
• Geogig.StoreInfo
• Geogig.UserInfo

Documentation for Authorization

ApiKeyAuth

• Type: API key
• API key parameter name: X-GeoGig-API-Key
• Location: HTTP header

BasicAuth

• Type: HTTP basic authentication

OAuth2

• Type: OAuth
• Flow: accessCode
• Authorization URL: https://example.com/oauth/authorize
• Scopes:
  • read: Grants read access
  • write: Grants write access
  • admin: Grants read and write access to administrative information