Merged in feature/docGen (pull request #88)

Basic Generate

* basicgenerate

* basic
This commit is contained in:
Michael McGuinness
2025-03-05 13:50:43 +00:00
parent 0815cb35fb
commit 0af049e96f
8 changed files with 210 additions and 33 deletions
+15
View File
@@ -1,3 +1,18 @@
// This API currently manages all user entities to be managed. This allows users of the service to change required entities and processes.
//
// The entities in question:
//
// - Client - A client is a single client of the Doczy project, all configurations and jobs for a client will be in reference to the respective client.
//
// - Job - A job is a single instance of requirements for a client. This maintains a set of queries and processes in relation to itself.
//
// - Collector - A collector specifies the required queries for export for a given job.
//
// - Sample - A sample is a subset of documents to be used for testing. When it is active a job will only process documents in the sample.
//
// - Query - A query is a block of processing of data which takes an input and produces an output.
//
// - Export - An export is a manually started process which outputs the results for a job to a given location.
package main
import (