Package models describes the communication format between JS snd Go.

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

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

AddAttachments stores files against a document.

AddBlock inserts new reusable content block into database.

AddDocumentPage inserts new section into document.

AddFolder creates a new folder.

AddPin saves pinned item.

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

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

Authenticate user based up HTTP Authorization header.

AuthenticateKeycloak checks Keycloak authentication credentials.

Authorize secure API calls by inspecting authentication token.

ChangeDocumentPageLevel handles page indent/outdent changes.

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

ChangeUserPassword accepts password change from within the app.

CopyPage copies page to either same or different document.

DeleteAttachment is an endpoint that deletes a particular document attachment.

DeleteBlock removes requested reusable content block.

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

DeleteDocumentPage deletes a page.

DeleteDocumentPages batch deletes pages.

DeleteFolder deletes empty folder.

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

DeleteUserPin removes saved user pin.

ForgotUserPassword initiates the change password procedure.

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

GetBlock returns requested reusable content block.

GetBlocksForSpace returns available reusable content blocks for the space.

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

GetDocumentAsDocx returns a Word document.

GetDocumentLinks is an endpoint returning the links for a document.

GetDocumentMeta is an endpoint returning the metadata for a document.

GetDocumentPage gets specified page for document.

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

GetDocumentPageMeta gets page meta data for specified document page.

GetDocumentPageRevisions returns all changes for a given page.

GetDocumentPages gets all pages for document.

GetDocumentPagesBatch gets specified pages for document.

GetDocumentRevisions returns all changes for a document.

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

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

GetFolder returns the requested folder.

GetFolderPermissions returns user permissions for the requested folder.

GetFolders returns the folders the user can see.

GetFolderUsers returns every user within a given space.

GetFolderVisibility returns the users that can see the shared folders.

GetLicense returns product license.

GetLinkCandidates returns references to documents/sections/attachments.

GetMeta provides org meta data based upon request domain (e.g.

GetOrganization returns the requested organization.

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

GetPageMoveCopyTargets returns available documents for page copy/move axction.

GetRobots returns robots.txt depending on site configuration.

GetSavedTemplates returns all templates saved by the user.

GetSections returns available smart sections.

GetSitemap returns URLs that can be indexed.

GetSMTPConfig returns installation-wide SMTP settings.

GetStockTemplates returns available templates from the public Documize repository.

GetUser returns user specified by Id.

GetUserFolderPermissions returns folder permission for authenticated user.

GetUserPins returns users' pins.

InviteToFolder sends users folder invitation emails.

IsInvalidLicense returns true if license is invalid.

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

RefreshSections updates document sections where the data is externally sourced.

Remove an endpoint.

RemoveFolder moves documents to another folder before deleting it.

ResetUserPassword stores the newly chosen password for the user.

RollbackDocumentPage rolls-back to a specific page revision.

RunSectionCommand passes UI request to section handler.

SaveAsTemplate saves existing document as a template.

SaveAuthConfig returns installation-wide authentication configuration.

SaveLicense persists product license.

SaveSMTPConfig persists global SMTP configuration.

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

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

Serve the Documize endpoint.

SetFolderPermissions persists specified folder permissions.

StartDocumentFromSavedTemplate creates new document using a saved document as a template.

StartDocumentFromStockTemplate creates new document using one of the stock templates.

StripAuthSecrets removes sensitive data from auth provider configuration.

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

UpdateBlock inserts new reusable content block into database.

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

UpdateDocumentPage will persist changed page and note the fact that this is a new revision.

UpdateFolder processes request to save folder object to the database.

UpdateOrganization saves organization amends.

UpdatePinSequence records order of pinned items.

UpdateUser is the endpoint to update user information for the given userID.

UploadConvertDocument is an endpoint to both upload and convert a document.

RoutePrefixPrivate used for secured api (requiring api).

RoutePrefixPublic used for the unsecured api.

RoutePrefixRoot used for unsecured endpoints at root (e.g.

Product details app edition and version.

RouteFunc describes end-point functions.