MajorDomo interface utilities

Entity types

The MajorDomo server keeps track of the types of artefacts it references in the JSON data that the server sends to the browser client. Most importantly, each type of artefact must be obtained through different server interfaces. This is the subject of the entityInterfaceMapping provided below.

httpRoutes:
  getEntityInterfaceMapping:
    route: /entity/interface/mapping
    actions:
     - GET
    response: entityInterfaceMapping

jsonSchemaDefs:
   entityInterfaceMapping:
     type: dictionary
     items:
       $ref: "#/$defs/mountPoint"
   entityType:
     type: object
     properties:
       entityType:
         enum:
           - logFile
           - projectFile
           - directory
           - file
           - task
       url:
         type: string
   mountPoint:
     type: string

The following is the entity type to interface route mapping which is currently understood by the MajorDomo server:

jsonExamples:
   entityInterfaceMapping:
     title: The current entity to interface mapping
     httpRoutes:
       route:
         mountPoint: /entity/interface/mapping
       action: GET
---

# The following is the entity type to interface route mapping
# which is currently understood by the MajorDomo server

task:        targetStatus

logFile:     logfiles
projectFile: projects
directory:   listFiles
file:        listFiles

Where:

• <workspacePath> is a "path" to the required workspace directory or file.

• <taskPath> is a "path" to the required build dependency.