endpoint

package

v1.50.1 Latest Latest Go to latest Published: Jul 20, 2017 License: AGPL-3.0 Imports: 44 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/documize/community

Links

Open Source Insights

Documentation ¶

Overview ¶

Package endpoint provides API endpoints for Documize.

Index ¶

Constants
func AcceptSharedFolder(w http.ResponseWriter, r *http.Request)
func Add(prefix, path string, methods, queries []string, endPtFn RouteFunc) error
func AddAttachments(w http.ResponseWriter, r *http.Request)
func AddBlock(w http.ResponseWriter, r *http.Request)
func AddDocumentPage(w http.ResponseWriter, r *http.Request)
func AddFolder(w http.ResponseWriter, r *http.Request)
func AddPin(w http.ResponseWriter, r *http.Request)
func AddUser(w http.ResponseWriter, r *http.Request)
func AttachmentDownload(w http.ResponseWriter, r *http.Request)
func Authenticate(w http.ResponseWriter, r *http.Request)
func AuthenticateKeycloak(w http.ResponseWriter, r *http.Request)
func Authorize(w http.ResponseWriter, r *http.Request, next http.HandlerFunc)
func ChangeDocumentPageLevel(w http.ResponseWriter, r *http.Request)
func ChangeDocumentPageSequence(w http.ResponseWriter, r *http.Request)
func ChangeUserPassword(w http.ResponseWriter, r *http.Request)
func CopyPage(w http.ResponseWriter, r *http.Request)
func DeleteAttachment(w http.ResponseWriter, r *http.Request)
func DeleteBlock(w http.ResponseWriter, r *http.Request)
func DeleteDocument(w http.ResponseWriter, r *http.Request)
func DeleteDocumentPage(w http.ResponseWriter, r *http.Request)
func DeleteDocumentPages(w http.ResponseWriter, r *http.Request)
func DeleteFolder(w http.ResponseWriter, r *http.Request)
func DeleteUser(w http.ResponseWriter, r *http.Request)
func DeleteUserPin(w http.ResponseWriter, r *http.Request)
func ForgotUserPassword(w http.ResponseWriter, r *http.Request)
func GetAttachments(w http.ResponseWriter, r *http.Request)
func GetAuthConfig(w http.ResponseWriter, r *http.Request)
func GetBlock(w http.ResponseWriter, r *http.Request)
func GetBlocksForSpace(w http.ResponseWriter, r *http.Request)
func GetDocument(w http.ResponseWriter, r *http.Request)
func GetDocumentActivity(w http.ResponseWriter, r *http.Request)
func GetDocumentAsDocx(w http.ResponseWriter, r *http.Request)
func GetDocumentLinks(w http.ResponseWriter, r *http.Request)
func GetDocumentPage(w http.ResponseWriter, r *http.Request)
func GetDocumentPageDiff(w http.ResponseWriter, r *http.Request)
func GetDocumentPageMeta(w http.ResponseWriter, r *http.Request)
func GetDocumentPageRevisions(w http.ResponseWriter, r *http.Request)
func GetDocumentPages(w http.ResponseWriter, r *http.Request)
func GetDocumentPagesBatch(w http.ResponseWriter, r *http.Request)
func GetDocumentRevisions(w http.ResponseWriter, r *http.Request)
func GetDocumentsByFolder(w http.ResponseWriter, r *http.Request)
func GetDocumentsByTag(w http.ResponseWriter, r *http.Request)
func GetFolder(w http.ResponseWriter, r *http.Request)
func GetFolderPermissions(w http.ResponseWriter, r *http.Request)
func GetFolderUsers(w http.ResponseWriter, r *http.Request)
func GetFolderVisibility(w http.ResponseWriter, r *http.Request)
func GetFolders(w http.ResponseWriter, r *http.Request)
func GetLicense(w http.ResponseWriter, r *http.Request)
func GetLinkCandidates(w http.ResponseWriter, r *http.Request)
func GetMeta(w http.ResponseWriter, r *http.Request)
func GetOrganization(w http.ResponseWriter, r *http.Request)
func GetOrganizationUsers(w http.ResponseWriter, r *http.Request)
func GetPageMoveCopyTargets(w http.ResponseWriter, r *http.Request)
func GetRobots(w http.ResponseWriter, r *http.Request)
func GetSMTPConfig(w http.ResponseWriter, r *http.Request)
func GetSavedTemplates(w http.ResponseWriter, r *http.Request)
func GetSections(w http.ResponseWriter, r *http.Request)
func GetSitemap(w http.ResponseWriter, r *http.Request)
func GetStockTemplates(w http.ResponseWriter, r *http.Request)
func GetUser(w http.ResponseWriter, r *http.Request)
func GetUserFolderPermissions(w http.ResponseWriter, r *http.Request)
func GetUserPins(w http.ResponseWriter, r *http.Request)
func InviteToFolder(w http.ResponseWriter, r *http.Request)
func IsInvalidLicense() bool
func KeycloakUsers(c keycloakConfig) (users []entity.User, err error)
func RefreshSections(w http.ResponseWriter, r *http.Request)
func Remove(prefix, path string, methods, queries []string) error
func RemoveFolder(w http.ResponseWriter, r *http.Request)
func ResetUserPassword(w http.ResponseWriter, r *http.Request)
func RollbackDocumentPage(w http.ResponseWriter, r *http.Request)
func RunSectionCommand(w http.ResponseWriter, r *http.Request)
func SaveAsTemplate(w http.ResponseWriter, r *http.Request)
func SaveAuthConfig(w http.ResponseWriter, r *http.Request)
func SaveLicense(w http.ResponseWriter, r *http.Request)
func SaveSMTPConfig(w http.ResponseWriter, r *http.Request)
func SearchDocuments(w http.ResponseWriter, r *http.Request)
func SearchLinkCandidates(w http.ResponseWriter, r *http.Request)
func Serve(ready chan struct{})
func SetFolderPermissions(w http.ResponseWriter, r *http.Request)
func StartDocumentFromSavedTemplate(w http.ResponseWriter, r *http.Request)
func StartDocumentFromStockTemplate(w http.ResponseWriter, r *http.Request)
func StripAuthSecrets(provider, config string) string
func SyncKeycloak(w http.ResponseWriter, r *http.Request)
func UpdateBlock(w http.ResponseWriter, r *http.Request)
func UpdateDocument(w http.ResponseWriter, r *http.Request)
func UpdateDocumentPage(w http.ResponseWriter, r *http.Request)
func UpdateFolder(w http.ResponseWriter, r *http.Request)
func UpdateOrganization(w http.ResponseWriter, r *http.Request)
func UpdatePinSequence(w http.ResponseWriter, r *http.Request)
func UpdateUser(w http.ResponseWriter, r *http.Request)
func UploadConvertDocument(w http.ResponseWriter, r *http.Request)
func ValidateAuthToken(w http.ResponseWriter, r *http.Request)
type RouteFunc

Constants ¶

View Source

const (
	// RoutePrefixPublic used for the unsecured api
	RoutePrefixPublic = "/api/public/"
	// RoutePrefixPrivate used for secured api (requiring api)
	RoutePrefixPrivate = "/api/"
	// RoutePrefixRoot used for unsecured endpoints at root (e.g. robots.txt)
	RoutePrefixRoot = "/"
)

Variables ¶

This section is empty.

Functions ¶

func AcceptSharedFolder ¶

func AcceptSharedFolder(w http.ResponseWriter, r *http.Request)

AcceptSharedFolder records the fact that a user has completed folder onboard process.

func Add ¶

func Add(prefix, path string, methods, queries []string, endPtFn RouteFunc) error

Add an endpoint to those that will be processed when Serve() is called.

func AddAttachments ¶

func AddAttachments(w http.ResponseWriter, r *http.Request)

AddAttachments stores files against a document.

func AddBlock ¶ added in v0.40.0

func AddBlock(w http.ResponseWriter, r *http.Request)

AddBlock inserts new reusable content block into database.

func AddDocumentPage ¶

func AddDocumentPage(w http.ResponseWriter, r *http.Request)

AddDocumentPage inserts new section into document.

func AddPin ¶ added in v0.34.0

func AddPin(w http.ResponseWriter, r *http.Request)

AddPin saves pinned item.

func AddUser ¶

func AddUser(w http.ResponseWriter, r *http.Request)

AddUser is the endpoint that enables an administrator to add a new user for their orgaisation.

func AttachmentDownload ¶

func AttachmentDownload(w http.ResponseWriter, r *http.Request)

AttachmentDownload is the end-point that responds to a request for a particular attachment by sending the requested file to the client.

func Authenticate ¶

func Authenticate(w http.ResponseWriter, r *http.Request)

Authenticate user based up HTTP Authorization header. An encrypted authentication token is issued with an expiry date.

func AuthenticateKeycloak ¶ added in v1.48.2

func AuthenticateKeycloak(w http.ResponseWriter, r *http.Request)

AuthenticateKeycloak checks Keycloak authentication credentials.

func Authorize ¶

func Authorize(w http.ResponseWriter, r *http.Request, next http.HandlerFunc)

Authorize secure API calls by inspecting authentication token. request.Context provides caller user information. Site meta sent back as HTTP custom headers.

func ChangeDocumentPageLevel ¶

func ChangeDocumentPageLevel(w http.ResponseWriter, r *http.Request)

ChangeDocumentPageLevel handles page indent/outdent changes.

func ChangeDocumentPageSequence ¶

func ChangeDocumentPageSequence(w http.ResponseWriter, r *http.Request)

ChangeDocumentPageSequence will swap page sequence for a given number of pages.

func ChangeUserPassword ¶

func ChangeUserPassword(w http.ResponseWriter, r *http.Request)

ChangeUserPassword accepts password change from within the app.

func CopyPage ¶ added in v0.40.0

func CopyPage(w http.ResponseWriter, r *http.Request)

CopyPage copies page to either same or different document.

func DeleteAttachment ¶

func DeleteAttachment(w http.ResponseWriter, r *http.Request)

DeleteAttachment is an endpoint that deletes a particular document attachment.

func DeleteBlock ¶ added in v0.40.0

func DeleteBlock(w http.ResponseWriter, r *http.Request)

DeleteBlock removes requested reusable content block.

func DeleteDocument ¶

func DeleteDocument(w http.ResponseWriter, r *http.Request)

DeleteDocument is an endpoint that deletes a document specified by documentID.

func DeleteFolder ¶ added in v1.48.2

func DeleteFolder(w http.ResponseWriter, r *http.Request)

DeleteFolder deletes empty folder.

func DeleteUser ¶

func DeleteUser(w http.ResponseWriter, r *http.Request)

DeleteUser is the endpoint to delete a user specified by userID, the caller must be an Administrator.

func DeleteUserPin ¶ added in v0.34.0

func DeleteUserPin(w http.ResponseWriter, r *http.Request)

DeleteUserPin removes saved user pin.

func ForgotUserPassword ¶

func ForgotUserPassword(w http.ResponseWriter, r *http.Request)

ForgotUserPassword initiates the change password procedure. Generates a reset token and sends email to the user. User has to click link in email and then provide a new password.

func GetAttachments ¶

func GetAttachments(w http.ResponseWriter, r *http.Request)

GetAttachments is an end-point that returns all of the attachments of a particular documentID.

func GetAuthConfig ¶ added in v1.48.2

func GetAuthConfig(w http.ResponseWriter, r *http.Request)

GetAuthConfig returns installation-wide auth configuration

func GetBlock ¶ added in v0.40.0

func GetBlock(w http.ResponseWriter, r *http.Request)

GetBlock returns requested reusable content block.

func GetBlocksForSpace ¶ added in v0.40.0

func GetBlocksForSpace(w http.ResponseWriter, r *http.Request)

GetBlocksForSpace returns available reusable content blocks for the space.

func GetDocument ¶

func GetDocument(w http.ResponseWriter, r *http.Request)

GetDocument is an endpoint that returns the document-level information for a given documentID.

func GetDocumentActivity ¶ added in v1.48.2

func GetDocumentActivity(w http.ResponseWriter, r *http.Request)

GetDocumentActivity is an endpoint returning the activity logs for specified document.

func GetDocumentAsDocx ¶

func GetDocumentAsDocx(w http.ResponseWriter, r *http.Request)

GetDocumentAsDocx returns a Word document.

func GetDocumentLinks ¶ added in v0.31.0

func GetDocumentLinks(w http.ResponseWriter, r *http.Request)

GetDocumentLinks is an endpoint returning the links for a document.

func GetDocumentPage ¶

func GetDocumentPage(w http.ResponseWriter, r *http.Request)

GetDocumentPage gets specified page for document.

func GetDocumentPageDiff ¶ added in v0.35.0

func GetDocumentPageDiff(w http.ResponseWriter, r *http.Request)

GetDocumentPageDiff returns HTML diff between two revisions of a given page.

func GetDocumentPageMeta ¶

func GetDocumentPageMeta(w http.ResponseWriter, r *http.Request)

GetDocumentPageMeta gets page meta data for specified document page.

func GetDocumentPageRevisions ¶ added in v0.35.0

func GetDocumentPageRevisions(w http.ResponseWriter, r *http.Request)

GetDocumentPageRevisions returns all changes for a given page.

func GetDocumentPages ¶

func GetDocumentPages(w http.ResponseWriter, r *http.Request)

GetDocumentPages gets all pages for document.

func GetDocumentPagesBatch ¶

func GetDocumentPagesBatch(w http.ResponseWriter, r *http.Request)

GetDocumentPagesBatch gets specified pages for document.

func GetDocumentRevisions ¶ added in v0.35.0

func GetDocumentRevisions(w http.ResponseWriter, r *http.Request)

GetDocumentRevisions returns all changes for a document.

func GetDocumentsByFolder ¶

func GetDocumentsByFolder(w http.ResponseWriter, r *http.Request)

GetDocumentsByFolder is an endpoint that returns the documents in a given folder.

func GetDocumentsByTag ¶

func GetDocumentsByTag(w http.ResponseWriter, r *http.Request)

GetDocumentsByTag is an endpoint that returns the documents with a given tag.

func GetFolderPermissions ¶

func GetFolderPermissions(w http.ResponseWriter, r *http.Request)

GetFolderPermissions returns user permissions for the requested folder.

func GetFolderUsers ¶

func GetFolderUsers(w http.ResponseWriter, r *http.Request)

GetFolderUsers returns every user within a given space

func GetFolderVisibility ¶

func GetFolderVisibility(w http.ResponseWriter, r *http.Request)

GetFolderVisibility returns the users that can see the shared folders.

func GetFolders ¶

func GetFolders(w http.ResponseWriter, r *http.Request)

GetFolders returns the folders the user can see.

func GetLicense ¶ added in v1.48.2

func GetLicense(w http.ResponseWriter, r *http.Request)

GetLicense returns product license

func GetLinkCandidates ¶ added in v0.28.0

func GetLinkCandidates(w http.ResponseWriter, r *http.Request)

GetLinkCandidates returns references to documents/sections/attachments.

func GetMeta ¶

func GetMeta(w http.ResponseWriter, r *http.Request)

GetMeta provides org meta data based upon request domain (e.g. acme.documize.com).

func GetOrganization ¶

func GetOrganization(w http.ResponseWriter, r *http.Request)

GetOrganization returns the requested organization.

func GetOrganizationUsers ¶

func GetOrganizationUsers(w http.ResponseWriter, r *http.Request)

GetOrganizationUsers is the endpoint that allows administrators to view the users in their organisation.

func GetPageMoveCopyTargets ¶ added in v0.40.0

func GetPageMoveCopyTargets(w http.ResponseWriter, r *http.Request)

GetPageMoveCopyTargets returns available documents for page copy/move axction.

func GetRobots ¶

func GetRobots(w http.ResponseWriter, r *http.Request)

GetRobots returns robots.txt depending on site configuration. Did we allow anonymouse access?

func GetSMTPConfig ¶ added in v1.48.2

func GetSMTPConfig(w http.ResponseWriter, r *http.Request)

GetSMTPConfig returns installation-wide SMTP settings

func GetSavedTemplates ¶

func GetSavedTemplates(w http.ResponseWriter, r *http.Request)

GetSavedTemplates returns all templates saved by the user

func GetSections ¶

func GetSections(w http.ResponseWriter, r *http.Request)

GetSections returns available smart sections.

func GetSitemap ¶

func GetSitemap(w http.ResponseWriter, r *http.Request)

GetSitemap returns URLs that can be indexed. We only include public folders and documents (e.g. can be seen by everyone).

func GetStockTemplates ¶

func GetStockTemplates(w http.ResponseWriter, r *http.Request)

GetStockTemplates returns available templates from the public Documize repository.

func GetUserFolderPermissions ¶

func GetUserFolderPermissions(w http.ResponseWriter, r *http.Request)

GetUserFolderPermissions returns folder permission for authenticated user.

func GetUserPins ¶ added in v0.34.0

func GetUserPins(w http.ResponseWriter, r *http.Request)

GetUserPins returns users' pins.

func InviteToFolder ¶

func InviteToFolder(w http.ResponseWriter, r *http.Request)

InviteToFolder sends users folder invitation emails.

func IsInvalidLicense ¶ added in v1.48.2

func IsInvalidLicense() bool

IsInvalidLicense returns true if license is invalid

func KeycloakUsers ¶ added in v1.48.2

func KeycloakUsers(c keycloakConfig) (users []entity.User, err error)

KeycloakUsers gets list of Keycloak users for specified Realm, Client Id

func RefreshSections ¶

func RefreshSections(w http.ResponseWriter, r *http.Request)

RefreshSections updates document sections where the data is externally sourced.

func RemoveFolder ¶

func RemoveFolder(w http.ResponseWriter, r *http.Request)

RemoveFolder moves documents to another folder before deleting it

func ResetUserPassword ¶

func ResetUserPassword(w http.ResponseWriter, r *http.Request)

ResetUserPassword stores the newly chosen password for the user.

func RollbackDocumentPage ¶ added in v0.35.0

func RollbackDocumentPage(w http.ResponseWriter, r *http.Request)

RollbackDocumentPage rolls-back to a specific page revision.

func RunSectionCommand ¶

func RunSectionCommand(w http.ResponseWriter, r *http.Request)

RunSectionCommand passes UI request to section handler.

func SaveAsTemplate ¶

func SaveAsTemplate(w http.ResponseWriter, r *http.Request)

SaveAsTemplate saves existing document as a template.

func SaveAuthConfig ¶ added in v1.48.2

func SaveAuthConfig(w http.ResponseWriter, r *http.Request)

SaveAuthConfig returns installation-wide authentication configuration

func SaveLicense ¶ added in v1.48.2

func SaveLicense(w http.ResponseWriter, r *http.Request)

SaveLicense persists product license

func SaveSMTPConfig ¶ added in v1.48.2

func SaveSMTPConfig(w http.ResponseWriter, r *http.Request)

SaveSMTPConfig persists global SMTP configuration.

func SearchDocuments ¶

func SearchDocuments(w http.ResponseWriter, r *http.Request)

SearchDocuments endpoint takes a list of keywords and returns a list of document references matching those keywords.

func SearchLinkCandidates ¶ added in v0.28.0

func SearchLinkCandidates(w http.ResponseWriter, r *http.Request)

SearchLinkCandidates endpoint takes a list of keywords and returns a list of document references matching those keywords.

func SetFolderPermissions ¶

func SetFolderPermissions(w http.ResponseWriter, r *http.Request)

SetFolderPermissions persists specified folder permissions

func StartDocumentFromSavedTemplate ¶

func StartDocumentFromSavedTemplate(w http.ResponseWriter, r *http.Request)

StartDocumentFromSavedTemplate creates new document using a saved document as a template. If template ID is ZERO then we provide an Empty Document as the new document.

func StartDocumentFromStockTemplate ¶

func StartDocumentFromStockTemplate(w http.ResponseWriter, r *http.Request)

StartDocumentFromStockTemplate creates new document using one of the stock templates

func StripAuthSecrets ¶ added in v1.48.2

func StripAuthSecrets(provider, config string) string

StripAuthSecrets removes sensitive data from auth provider configuration

func SyncKeycloak ¶ added in v1.48.2

func SyncKeycloak(w http.ResponseWriter, r *http.Request)

SyncKeycloak gets list of Keycloak users and inserts new users into Documize and marks Keycloak disabled users as inactive.

func UpdateBlock ¶ added in v0.40.0

func UpdateBlock(w http.ResponseWriter, r *http.Request)

UpdateBlock inserts new reusable content block into database.

func UpdateDocument ¶

func UpdateDocument(w http.ResponseWriter, r *http.Request)

UpdateDocument updates an existing document using the format described in NewDocumentModel() encoded as JSON in the request.

func UpdateDocumentPage ¶

func UpdateDocumentPage(w http.ResponseWriter, r *http.Request)

UpdateDocumentPage will persist changed page and note the fact that this is a new revision. If the page is the first in a document then the corresponding document title will also be changed.

func UpdateFolder ¶

func UpdateFolder(w http.ResponseWriter, r *http.Request)

UpdateFolder processes request to save folder object to the database

func UpdateOrganization ¶

func UpdateOrganization(w http.ResponseWriter, r *http.Request)

UpdateOrganization saves organization amends.

func UpdatePinSequence ¶ added in v0.34.0

func UpdatePinSequence(w http.ResponseWriter, r *http.Request)

UpdatePinSequence records order of pinned items.

func UpdateUser ¶

func UpdateUser(w http.ResponseWriter, r *http.Request)

UpdateUser is the endpoint to update user information for the given userID. Note that unless they have admin privildges, a user can only update their own information. Also, only admins can update user roles in organisations.

func UploadConvertDocument ¶

func UploadConvertDocument(w http.ResponseWriter, r *http.Request)

UploadConvertDocument is an endpoint to both upload and convert a document

func ValidateAuthToken ¶

func ValidateAuthToken(w http.ResponseWriter, r *http.Request)

ValidateAuthToken finds and validates authentication token.

Types ¶

type RouteFunc ¶

type RouteFunc func(http.ResponseWriter, *http.Request)

RouteFunc describes end-point functions

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
models Package models describes the communication format between JS snd Go.	Package models describes the communication format between JS snd Go.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL