Categorygithub.com/documize/communitysdk
package
0.44.1
Repository: https://github.com/documize/community.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
16
Dependents
8
Files
1.2k SLOC

# README

SDK for the Documize system

The SDK is in development, please do not use in a live environment.

documize command

The directory "documize" contains a command line utility to load files onto the Documize server. Run the command with "--help" to see the available flags.

test suite (currently disabled)

The directory "exttest" contains a set of tests that are used both to test this package and to test the main documize code.

In order to run these tests two environment variables must be set:

  • DOCUMIZEAPI - the url of the endpoint, which must be http://localhost:5002 at present
  • DOCUMIZEAUTH - the authorization credentials in the form domain:email:password, which must be of the form :[email protected]:demo123 at present, with the Documize DB organistion record having the default (empty) subdomain.

There must also be a single folder named "Test" for code to find and use. TODO(Elliott) remove this restriction.

# Packages

No description provided by the author
No description provided by the author

# Functions

NewClient authorizes the user on Documize and returns the Client type whose methods allow API access the Documize system.

# Constants

HeaderAuthTokenName is the name of the authorization token required in the http header.

# Structs

Client holds the data for a sustained connection to Documize.