@gyselroth/tubee-sdk-node/swagger.yml

swagger: "2.0"
info:
  description: ""
  version: "1.0.0"
  title: "Tubee API"
  termsOfService: ""
  contact:
    email: "opensource@gyselroth.net"
  license:
    name: "MIT"
    url: "https://opensource.org/licenses/MIT"
basePath: "/api/v1"
schemes:
- "https"
paths:
  /:
    get:
      summary: "Get api entrypoint"
      operationId: "root"
      produces:
      - "application/json"
      responses:
        200:
          description: "List of objects"
        403:
          description: "Access denied"
  /watch/namespaces:
    get:
      tags:
      - "namespaces"
      summary: "Watch namespaces"
      description: "Watch namespaces in realtime"
      operationId: "watchNamespaces"
      produces:
      - "application/json;stream=watch"
      parameters:
      - in: "query"
        name: "query"
        description: "Specify a MongoDB based resource query (https://docs.mongodb.com/manual/tutorial/query-documents) using JSON (For example: {\"name\": {$regex: 'foo.*'}})."
        required: false
        type: "string"
      - in: "query"
        name: "attributes"
        description: "Filter attributes"
        required: false
        type: "array"
        items:
          type: "string"
      - in: "query"
        name: "offset"
        description: "Objects offset, per default it starts from 0. You may also request a negative offset which will return results from the end [total - offset]."
        required: false
        type: "number"
      - in: "query"
        name: "limit"
        description: "Objects limit, per default 20 objects will get returned"
        required: false
        type: "number"
      - in: "query"
        name: "sort"
        description: "Specify a MongoDB sort operation (https://docs.mongodb.com/manual/reference/method/cursor.sort/) using JSON (For example: {\"name\": -1})."
        required: false
        type: "string"
      responses:
        200:
          description: "List of objects"
        403:
          description: "Access denied"
  /namespaces:
    get:
      tags:
      - "namespaces"
      summary: "Get namespaces"
      description: "A namespace is a logical group of collections"
      operationId: "getNamespaces"
      produces:
      - "application/json"
      parameters:
      - in: "query"
        name: "query"
        description: "Specify a MongoDB based resource query (https://docs.mongodb.com/manual/tutorial/query-documents) using JSON (For example: {\"name\": {$regex: 'foo.*'}})."
        required: false
        type: "string"
      - in: "query"
        name: "attributes"
        description: "Filter attributes"
        required: false
        type: "array"
        items:
          type: "string"
      - in: "query"
        name: "offset"
        description: "Objects offset, per default it starts from 0. You may also request a negative offset which will return results from the end [total - offset]."
        required: false
        type: "number"
      - in: "query"
        name: "limit"
        description: "Objects limit, per default 20 objects will get returned"
        required: false
        type: "number"
      - in: "query"
        name: "sort"
        description: "Specify a MongoDB sort operation (https://docs.mongodb.com/manual/reference/method/cursor.sort/) using JSON (For example: {\"name\": -1})."
        required: false
        type: "string"
      responses:
        200:
          description: "List of namespaces"
          schema:
            $ref: "#/definitions/Namespaces"
        403:
          description: "Access denied"
    post:
      tags:
      - "namespaces"
      summary: "Add namespace"
      operationId: "addNamespace"
      produces:
      - "application/json"
      parameters:
      - in: body
        name: data
        schema:
          $ref: "#/definitions/Namespace"
      responses:
        201:
          description: "If successful the server will respond with 201 Created"
          schema:
            $ref: "#/definitions/Namespace"
        403:
          description: "Access denied"
  /namespaces/{namespace}:
    get:
      tags:
      - "namespaces"
      summary: "Get specific namespace"
      description: "A namespace is a logical group of collections"
      operationId: "getNamespace"
      produces:
      - "application/json"
      parameters:
      - in: "path"
        name: "namespace"
        description: "Namespace name"
        required: true
        type: "string"
      - in: "query"
        name: "attributes"
        description: "Filter attributes"
        required: false
        type: "array"
        items:
          type: "string"
      responses:
        200:
          description: "Namespace"
          schema:
            $ref: "#/definitions/Namespace"
        404:
          description: "Resource does not exists"
        403:
          description: "Access denied"
    delete:
      tags:
      - "namespaces"
      summary: "Delete specific namespace"
      operationId: "deleteNamespace"
      produces:
      - "application/json"
      parameters:
      - in: "path"
        name: "namespace"
        description: "Namespace name"
        required: true
        type: "string"
      responses:
        204:
          description: "If successful the server will respond with 204 No Content"
        404:
          description: "Resource does not exists"
        403:
          description: "Access denied"
    put:
      tags:
      - "namespaces"
      summary: "Create or replace namespace"
      operationId: "replaceNamespace"
      produces:
      - "application/json"
      parameters:
      - in: "path"
        name: "namespace"
        description: "Namespace name"
        required: true
        type: "string"
      - in: body
        name: data
        schema:
          $ref: "#/definitions/Namespace"
      responses:
        200:
          description: "If successful the server will respond with 200 OK"
          schema:
            $ref: "#/definitions/Namespace"
        201:
          description: "If successful and the object was newly created the server will respond with 201 Created"
          schema:
            $ref: "#/definitions/Namespace"
        403:
          description: "Access denied"
    patch:
      tags:
      - "namespaces"
      summary: "Patch namespace as rfc6902 request"
      operationId: "updateNamespace"
      description: "Update specific attributes of a namespace"
      produces:
      - "application/json"
      parameters:
      - in: "path"
        name: "namespace"
        description: "Namespace name"
        required: true
        type: "string"
      - in: body
        name: data
        description: "Namespace"
        schema:
          type: array
          items:
            $ref: "#/definitions/JsonPatch"
      responses:
        200:
          description: "Namespace"
          schema:
            $ref: "#/definitions/Namespace"
        404:
          description: "Resource does not exists"
        403:
          description: "Access denied"
  /watch/namespaces/{namespace}/collections:
    get:
      tags:
      - "collections"
      summary: "Watch collections"
      description: "Watch collections in realtime"
      operationId: "watchCollections"
      produces:
      - "application/json;stream=watch"
      parameters:
      - in: "path"
        name: "namespace"
        description: "Namespace name"
        required: true
        type: "string"
      - in: "query"
        name: "query"
        description: "Specify a MongoDB based resource query (https://docs.mongodb.com/manual/tutorial/query-documents) using JSON (For example: {\"name\": {$regex: 'foo.*'}})."
        required: false
        type: "string"
      - in: "query"
        name: "attributes"
        description: "Filter attributes"
        required: false
        type: "array"
        items:
          type: "string"
      - in: "query"
        name: "offset"
        description: "Objects offset, per default it starts from 0. You may also request a negative offset which will return results from the end [total - offset]."
        required: false
        type: "number"
      - in: "query"
        name: "limit"
        description: "Objects limit, per default 20 objects will get returned"
        required: false
        type: "number"
      - in: "query"
        name: "sort"
        description: "Specify a MongoDB sort operation (https://docs.mongodb.com/manual/reference/method/cursor.sort/) using JSON (For example: {\"name\": -1})."
        required: false
        type: "string"
      responses:
        200:
          description: "List of objects"
        403:
          description: "Access denied"
  /namespaces/{namespace}/collections:
    get:
      tags:
      - "collections"
      summary: "Get collections"
      description: "A collection is collection of data objects of a specific type"
      operationId: "getCollections"
      produces:
      - "application/json"
      parameters:
      - in: "path"
        name: "namespace"
        description: "Namespace name"
        required: true
        type: "string"
      - in: "query"
        name: "query"
        description: "Specify a MongoDB based resource query (https://docs.mongodb.com/manual/tutorial/query-documents) using JSON (For example: {\"name\": {$regex: 'foo.*'}})."
        required: false
        type: "string"
      - in: "query"
        name: "attributes"
        description: "Filter attributes"
        required: false
        type: "array"
        items:
          type: "string"
      - in: "query"
        name: "offset"
        description: "Objects offset, per default it starts from 0. You may also request a negative offset which will return results from the end [total - offset]."
        required: false
        type: "number"
      - in: "query"
        name: "limit"
        description: "Objects limit, per default 20 objects will get returned"
        required: false
        type: "number"
      - in: "query"
        name: "sort"
        description: "Specify a MongoDB sort operation (https://docs.mongodb.com/manual/reference/method/cursor.sort/) using JSON (For example: {\"name\": -1})."
        required: false
        type: "string"
      responses:
        200:
          description: "List of collections"
          schema:
            $ref: "#/definitions/Collections"
        404:
          description: "Resource does not exists"
        403:
          description: "Access denied"
    post:
      tags:
      - "collections"
      summary: "Add collection"
      operationId: "addCollection"
      produces:
      - "application/json"
      parameters:
      - in: "path"
        name: "namespace"
        description: "Namespace name"
        required: true
        type: "string"
      - in: body
        name: data
        schema:
           $ref: "#/definitions/Collection"
      responses:
        201:
          description: "If successful the server will respond with 201 Created"
          schema:
            $ref: "#/definitions/Collection"
        403:
          description: "Access denied"
        404:
          description: "Resource does not exists"
  /namespaces/{namespace}/collections/{collection}:
    get:
      tags:
      - "collections"
      summary: "Get specific collection"
      description: "A collection is collection of dataobjects of a specific type"
      operationId: "getCollection"
      produces:
      - "application/json"
      parameters:
      - in: "path"
        name: "namespace"
        description: "Namespace name"
        required: true
        type: "string"
      - in: "path"
        name: "collection"
        description: "Collection"
        required: true
        type: "string"
      - in: "query"
        name: "attributes"
        description: "Filter attributes"
        required: false
        type: "array"
        items:
          type: "string"
      responses:
        200:
          description: "Collection"
          schema:
            $ref: "#/definitions/Collection"
        404:
          description: "Resource does not exists"
        403:
          description: "Access denied"
    delete:
      tags:
      - "collections"
      summary: "Delete specific collection"
      operationId: "deleteCollection"
      produces:
      - "application/json"
      parameters:
      - in: "path"
        name: "namespace"
        description: "Namespace name"
        required: true
        type: "string"
      - in: "path"
        name: "collection"
        description: "Collection"
        required: true
        type: "string"
      responses:
        204:
          description: "If successful the server will respond with 204 No Content"
        404:
          description: "Resource does not exists"
        403:
          description: "Access denied"
    put:
      tags:
      - "collections"
      summary: "Create or replace collection"
      operationId: "replaceCollection"
      produces:
      - "application/json"
      parameters:
      - in: "path"
        name: "namespace"
        description: "Namespace name"
        required: true
        type: "string"
      - in: "path"
        name: "collection"
        description: "Collection"
        required: true
        type: "string"
      - in: body
        name: data
        schema:
          $ref: "#/definitions/Collection"
      responses:
        200:
          description: "If successful the server will respond with 200 OK"
          schema:
            $ref: "#/definitions/Collection"
        201:
          description: "If successful and the object was newly created the server will respond with 201 Created"
          schema:
            $ref: "#/definitions/Collection"
        403:
          description: "Access denied"
    patch:
      tags:
      - "collections"
      summary: "Patch collection as rfc6902 request"
      description: "Update specific attributes of a collection"
      operationId: "updateCollection"
      produces:
      - "application/json"
      parameters:
      - in: "path"
        name: "namespace"
        description: "Namespace name"
        required: true
        type: "string"
      - in: "path"
        name: "collection"
        description: "Collection"
        required: true
        type: "string"
      - in: body
        name: data
        description: "Collection"
        schema:
          type: array
          items:
            $ref: "#/definitions/JsonPatch"
      responses:
        200:
          description: "Collection"
          schema:
            $ref: "#/definitions/Collection"
        404:
          description: "Resource does not exists"
        403:
          description: "Access denied"
  /watch/namespaces/{namespace}/collections/{collection}/endpoints:
    get:
      tags:
      - "endpoints"
      summary: "Watch endpoints"
      description: "Watch updates in realtime"
      operationId: "watchEndpoints"
      produces:
      - "application/json;stream=watch"
      parameters:
      - in: "path"
        name: "namespace"
        description: "Namespace name"
        required: true
        type: "string"
      - in: "path"
        name: "collection"
        description: "Collection"
        required: true
        type: "string"
      - in: "query"
        name: "query"
        description: "Specify a MongoDB based resource query (https://docs.mongodb.com/manual/tutorial/query-documents) using JSON (For example: {\"name\": {$regex: 'foo.*'}})."
        required: false
        type: "string"
      - in: "query"
        name: "attributes"
        description: "Filter attributes"
        required: false
        type: "array"
        items:
          type: "string"
      - in: "query"
        name: "offset"
        description: "Objects offset, per default it starts from 0. You may also request a negative offset which will return results from the end [total - offset]."
        required: false
        type: "number"
      - in: "query"
        name: "limit"
        description: "Objects limit, per default 20 objects will get returned"
        required: false
        type: "number"
      - in: "query"
        name: "sort"
        description: "Specify a MongoDB sort operation (https://docs.mongodb.com/manual/reference/method/cursor.sort/) using JSON (For example: {\"name\": -1})."
        required: false
        type: "string"
      responses:
        200:
          description: "List of objects"
        403:
          description: "Access denied"
  /namespaces/{namespace}/collections/{collection}/endpoints:
    get:
      tags:
      - "endpoints"
      summary: "Get endpoints"
      description: "An endpoint is either of type source or destination and defines an import/export destination"
      operationId: "getEndpoints"
      produces:
      - "application/json"
      parameters:
      - in: "path"
        name: "namespace"
        description: "Namespace name"
        required: true
        type: "string"
      - in: "path"
        name: "collection"
        description: "Collection"
        required: true
        type: "string"
      - in: "query"
        name: "query"
        description: "Specify a MongoDB based resource query (https://docs.mongodb.com/manual/tutorial/query-documents) using JSON (For example: {\"name\": {$regex: 'foo.*'}})."
        required: false
        type: "string"
      - in: "query"
        name: "attributes"
        description: "Filter attributes"
        required: false
        type: "array"
        items:
          type: "string"
      - in: "query"
        name: "offset"
        description: "Objects offset, per default it starts from 0. You may also request a negative offset which will return results from the end [total - offset]."
        required: false
        type: "number"
      - in: "query"
        name: "limit"
        description: "Objects limit, per default 20 objects will get returned"
        required: false
        type: "number"
      - in: "query"
        name: "sort"
        description: "Specify a MongoDB sort operation (https://docs.mongodb.com/manual/reference/method/cursor.sort/) using JSON (For example: {\"name\": -1})."
        required: false
        type: "string"
      responses:
        200:
          description: "List of endpoints"
          schema:
            $ref: "#/definitions/Endpoints"
        404:
          description: "Resource does not exists"
        403:
          description: "Access denied"
    post:
      tags:
      - "endpoints"
      summary: "Add Endpoint"
      operationId: "addEndpoint"
      produces:
      - "application/json"
      parameters:
      - in: "path"
        name: "namespace"
        description: "Namespace name"
        required: true
        type: "string"
      - in: "path"
        name: "collection"
        description: "Collection"
        required: true
        type: "string"
      - in: body
        name: data
        schema:
          type: object
      responses:
        201:
          description: "If successful the server will respond with 201 Created"
          schema:
            $ref: "#/definitions/Endpoint"
        403:
          description: "Access denied"
        404:
          description: "Resource does not exists"
  /namespaces/{namespace}/collections/{collection}/endpoints/{endpoint}:
    get:
      tags:
      - "endpoints"
      summary: "Get specific endpoint"
      description: "An endpoint is either of type source or destination and defines an import/export destination"
      operationId: "getEndpoint"
      produces:
      - "application/json"
      parameters:
      - in: "path"
        name: "namespace"
        description: "Namespace name"
        required: true
        type: "string"
      - in: "path"
        name: "collection"
        description: "Collection"
        required: true
        type: "string"
      - in: "path"
        name: "endpoint"
        description: "Endpoint name"
        required: true
        type: "string"
      - in: "query"
        name: "attributes"
        description: "Filter attributes"
        required: false
        type: "array"
        items:
          type: "string"
      responses:
        200:
          description: "Endpoint"
          schema:
            $ref: "#/definitions/Endpoint"
        404:
          description: "Resource does not exists"
        403:
          description: "Access denied"
    delete:
      tags:
      - "endpoints"
      summary: "Delete specific endpoint"
      operationId: "deleteEndpoint"
      produces:
      - "application/json"
      parameters:
      - in: "path"
        name: "namespace"
        description: "Namespace name"
        required: true
        type: "string"
      - in: "path"
        name: "collection"
        description: "Collection"
        required: true
        type: "string"
      - in: "path"
        name: "endpoint"
        description: "Endpoint name"
        required: true
        type: "string"
      responses:
        204:
          description: "If successful the server will respond with 204 No Content"
        404:
          description: "Resource does not exists"
        403:
          description: "Access denied"
    put:
      tags:
      - "endpoints"
      summary: "Create or replace endppoint"
      operationId: "replaceEndpoint"
      produces:
      - "application/json"
      parameters:
      - in: "path"
        name: "namespace"
        description: "Namespace name"
        required: true
        type: "string"
      - in: "path"
        name: "collection"
        description: "Collection"
        required: true
        type: "string"
      - in: "path"
        name: "endpoint"
        description: "Endpoint name"
        required: true
        type: "string"
      - in: body
        name: data
        schema:
          $ref: "#/definitions/Endpoint"
      responses:
        200:
          description: "If successful the server will respond with 200 OK"
          schema:
            $ref: "#/definitions/Endpoint"
        201:
          description: "If successful and the object was newly created the server will respond with 201 Created"
          schema:
            $ref: "#/definitions/Endpoint"
        403:
          description: "Access denied"
    patch:
      tags:
      - "endpoints"
      summary: "Patch collection as rfc6902 request"
      description: "Update specific attributes of a endpoint"
      operationId: "updateEndpoint"
      produces:
      - "application/json"
      parameters:
      - in: "path"
        name: "namespace"
        description: "Namespace name"
        required: true
        type: "string"
      - in: "path"
        name: "collection"
        description: "Collection"
        required: true
        type: "string"
      - in: "path"
        name: "endpoint"
        description: "Endpoint name"
        required: true
        type: "string"
      - in: body
        name: data
        description: "Collection"
        schema:
          type: array
          items:
            $ref: "#/definitions/JsonPatch"
      responses:
        200:
          description: "Endpoint"
          schema:
            $ref: "#/definitions/Endpoint"
        404:
          description: "Resource does not exists"
        403:
          description: "Access denied"
  /watch/namespaces/{namespace}/collections/{collection}/endpoints/{endpoint}/workflows:
    get:
      tags:
      - "workflows"
      summary: "Watch workflows"
      description: "Watch updates in realtime"
      operationId: "watchWorkflows"
      produces:
      - "application/json;stream=watch"
      parameters:
      - in: "path"
        name: "namespace"
        description: "Namespace name"
        required: true
        type: "string"
      - in: "path"
        name: "collection"
        description: "Collection"
        required: true
        type: "string"
      - in: "path"
        name: "endpoint"
        description: "Endpoint name"
        required: true
        type: "string"
      - in: "query"
        name: "query"
        description: "Specify a MongoDB based resource query (https://docs.mongodb.com/manual/tutorial/query-documents) using JSON (For example: {\"name\": {$regex: 'foo.*'}})."
        required: false
        type: "string"
      - in: "query"
        name: "attributes"
        description: "Filter attributes"
        required: false
        type: "array"
        items:
          type: "string"
      - in: "query"
        name: "offset"
        description: "Objects offset, per default it starts from 0. You may also request a negative offset which will return results from the end [total - offset]."
        required: false
        type: "number"
      - in: "query"
        name: "limit"
        description: "Objects limit, per default 20 objects will get returned"
        required: false
        type: "number"
      - in: "query"
        name: "sort"
        description: "Specify a MongoDB sort operation (https://docs.mongodb.com/manual/reference/method/cursor.sort/) using JSON (For example: {\"name\": -1})."
        required: false
        type: "string"
      responses:
        200:
          description: "List of objects"
        403:
          description: "Access denied"
  /namespaces/{namespace}/collections/{collection}/endpoints/{endpoint}/workflows:
    get:
      tags:
      - "workflows"
      summary: "Get endpoint workflows"
      description: "A workflow is an action how to import/export a collection and with what attribute map"
      operationId: "getWorkflows"
      produces:
      - "application/json"
      parameters:
      - in: "path"
        name: "namespace"
        description: "Namespace name"
        required: true
        type: "string"
      - in: "path"
        name: "collection"
        description: "Collection"
        required: true
        type: "string"
      - in: "path"
        name: "endpoint"
        description: "Endpoint name"
        required: true
        type: "string"
      - in: "query"
        name: "query"
        description: "Specify a MongoDB based resource query (https://docs.mongodb.com/manual/tutorial/query-documents) using JSON (For example: {\"name\": {$regex: 'foo.*'}})."
        required: false
        type: "string"
      - in: "query"
        name: "attributes"
        description: "Filter attributes"
        required: false
        type: "array"
        items:
          type: "string"
      - in: "query"
        name: "offset"
        description: "Objects offset, per default it starts from 0. You may also request a negative offset which will return results from the end [total - offset]."
        required: false
        type: "number"
      - in: "query"
        name: "limit"
        description: "Objects limit, per default 20 objects will get returned"
        required: false
        type: "number"
      - in: "query"
        name: "sort"
        description: "Specify a MongoDB sort operation (https://docs.mongodb.com/manual/reference/method/cursor.sort/) using JSON (For example: {\"name\": -1})."
        required: false
        type: "string"
      responses:
        200:
          description: "List of workflows"
          schema:
            $ref: "#/definitions/Workflows"
        403:
          description: "Access denied"
    post:
      tags:
      - "workflows"
      summary: "Add worfklow to endpoint"
      operationId: "addWorkflow"
      produces:
      - "application/json"
      parameters:
      - in: "path"
        name: "namespace"
        description: "Namespace name"
        required: true
        type: "string"
      - in: "path"
        name: "collection"
        description: "Collection"
        required: true
        type: "string"
      - in: "path"
        name: "endpoint"
        description: "Endpoint name"
        required: true
        type: "string"
      - in: body
        name: data
        schema:
          $ref: "#/definitions/Workflow"
      responses:
        201:
          description: "If successful the server will respond with 201 Created"
          schema:
            $ref: "#/definitions/Workflow"
        403:
          description: "Access denied"
        404:
          description: "Resource does not exists"
  /namespaces/{namespace}/collections/{collection}/endpoints/{endpoint}/workflows/{workflow}:
    get:
      tags:
      - "workflows"
      summary: "Get specifc endpoint workflow"
      description: "A workflow is an action how to import/export a collection and with what attribute map"
      operationId: "getWorkflow"
      produces:
      - "application/json"
      parameters:
      - in: "path"
        name: "namespace"
        description: "Namespace name"
        required: true
        type: "string"
      - in: "path"
        name: "collection"
        description: "Collection"
        required: true
        type: "string"
      - in: "path"
        name: "endpoint"
        description: "Endpoint name"
        required: true
        type: "string"
      - in: "path"
        name: "workflow"
        description: "Workflow name"
        required: true
        type: "string"
      - in: "query"
        name: "attributes"
        description: "Filter attributes"
        required: false
        type: "array"
        items:
          type: "string"
      responses:
        200:
          description: "Workflow"
          schema:
            $ref: "#/definitions/Workflow"
        404:
          description: "Resource does not exists"
        403:
          description: "Access denied"
    delete:
      tags:
      - "workflows"
      summary: "Delete specific workflow from"
      operationId: "deleteWorkflow"
      produces:
      - "application/json"
      parameters:
      - in: "path"
        name: "namespace"
        description: "Namespace name"
        required: true
        type: "string"
      - in: "path"
        name: "collection"
        description: "Collection"
        required: true
        type: "string"
      - in: "path"
        name: "endpoint"
        description: "Endpoint name"
        required: true
        type: "string"
      - in: "path"
        name: "workflow"
        description: "Workflow name"
        required: true
        type: "string"
      responses:
        204:
          description: "If successful the server will respond with 204 No Content"
        404:
          description: "Resource does not exists"
        403:
          description: "Access denied"
    put:
      tags:
      - "workflows"
      summary: "Create or replace workflow"
      operationId: "replaceWorkflow"
      produces:
      - "application/json"
      parameters:
      - in: "path"
        name: "namespace"
        description: "Namespace name"
        required: true
        type: "string"
      - in: "path"
        name: "collection"
        description: "Collection"
        required: true
        type: "string"
      - in: "path"
        name: "endpoint"
        description: "Endpoint name"
        required: true
        type: "string"
      - in: "path"
        name: "workflow"
        description: "Workflow name"
        required: true
        type: "string"
      - in: body
        name: data
        schema:
          $ref: "#/definitions/Workflow"
      responses:
        200:
          description: "If successful the server will respond with 200 OK"
          schema:
            $ref: "#/definitions/Workflow"
        201:
          description: "If successful and the object was newly created the server will respond with 201 Created"
          schema:
            $ref: "#/definitions/Workflow"
        403:
          description: "Access denied"
    patch:
      tags:
      - "workflows"
      summary: "Patch workflow as rfc6902 request"
      description: "Update specific attributes of a workflow"
      operationId: "updateWorkflow"
      produces:
      - "application/json"
      parameters:
      - in: "path"
        name: "namespace"
        description: "Namespace name"
        required: true
        type: "string"
      - in: "path"
        name: "collection"
        description: "Collection"
        required: true
        type: "string"
      - in: "path"
        name: "endpoint"
        description: "Endpoint name"
        required: true
        type: "string"
      - in: "path"
        name: "workflow"
        description: "Workflow name"
        required: true
        type: "string"
      - in: body
        name: data
        description: "Workflow"
        schema:
          type: array
          items:
            $ref: "#/definitions/JsonPatch"
      responses:
        200:
          description: "Workflow"
          schema:
            $ref: "#/definitions/Workflow"
        404:
          description: "Resource does not exists"
        403:
          description: "Access denied"
  /namespaces/{namespace}/collections/{collection}/objects/{object}:
    get:
      tags:
      - "data"
      summary: "Get specific object"
      description: "Get an object of a specific collection"
      operationId: "getObject"
      produces:
      - "application/json"
      parameters:
      - in: "path"
        name: "namespace"
        description: "Namespace name"
        required: true
        type: "string"
      - in: "path"
        name: "collection"
        description: "Collection"
        required: true
        type: "string"
      - in: "path"
        name: "object"
        description: "Object ID"
        required: true
        type: "string"
      - in: "query"
        name: "attributes"
        description: "Filter attributes"
        required: false
        type: "array"
        items:
          type: "string"
      responses:
        200:
          description: "Data object"
        404:
          description: "Resource does not exists"
        403:
          description: "Access denied"
    patch:
      tags:
      - "data"
      summary: "Patch object as rfc6902 request"
      description: "Update specific attributes of an object"
      operationId: "updateObject"
      consumes:
      - "application/json-patch+json"
      produces:
      - "application/json"
      parameters:
      - in: "path"
        name: "namespace"
        description: "Namespace name"
        required: true
        type: "string"
      - in: "path"
        name: "collection"
        description: "Collection"
        required: true
        type: "string"
      - in: "path"
        name: "object"
        description: "Object ID"
        required: true
        type: "string"
      - in: body
        name: data
        description: "Object"
        schema:
          type: array
          items:
            $ref: "#/definitions/JsonPatch"
      responses:
        200:
          description: "If successful the server will respond with 200 OK"
          schema:
            $ref: "#/definitions/DataObject"
        202:
          description: "If write argument is true the server will respond with 202 Accepted since this is an asynchronous request."
          schema:
            $ref: "#/definitions/Job"
        404:
          description: "Resource does not exists"
        403:
          description: "Access denied"
    put:
      tags:
      - "data"
      summary: "Replace or create object"
      description: "Replace all data attributes of an object (Or create one if not exists)"
      operationId: "replaceObject"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - in: "path"
        name: "namespace"
        description: "Namespace name"
        required: true
        type: "string"
      - in: "path"
        name: "collection"
        description: "Collection"
        required: true
        type: "string"
      - in: "path"
        name: "object"
        description: "Object ID"
        required: true
        type: "string"
      - in: "query"
        name: "write"
        description: "If true, the objects gets synced to all configured destination endpoints"
        required: false
        type: "boolean"
      - in: body
        name: data
        schema:
          $ref: "#/definitions/DataObject"
      responses:
        200:
          description: "If successful the server will respond with 200 OK"
          schema:
            $ref: "#/definitions/DataObject"
        201:
          description: "If successful and the object was newly created the server will respond with 201 Created"
          schema:
            $ref: "#/definitions/DataObject"
        202:
          description: "If write argument is true the server will respond with 202 Accepted since this is an asynchronous request."
          schema:
            $ref: "#/definitions/Job"
        404:
          description: "Resource does not exists"
        403:
          description: "Access denied"
    delete:
      tags:
      - "data"
      summary: "Delete object"
      description: "Delete a specific object"
      operationId: "deleteObject"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - in: "path"
        name: "namespace"
        description: "Namespace name"
        required: true
        type: "string"
      - in: "path"
        name: "collection"
        description: "Collection"
        required: true
        type: "string"
      - in: "path"
        name: "object"
        description: "Object ID"
        required: true
        type: "string"
      responses:
        202:
          description: "If write argument is true the server will respond with 202 Accepted since this is an asynchronous request."
          schema:
            $ref: "#/definitions/Job"
        204:
          description: "If successful the server will respond with 204 No Content"
        404:
          description: "Resource does not exists"
        403:
          description: "Access denied"
  /watch/namespaces/{namespace}/collections/{collection}/objects/{object}/relatives:
    get:
      tags:
      - "data"
      summary: "Watch object relatives"
      description: "Watch updates in realtime"
      operationId: "watchObjectRelatives"
      produces:
      - "application/json;stream=watch"
      parameters:
      - in: "path"
        name: "namespace"
        description: "Namespace name"
        required: true
        type: "string"
      - in: "path"
        name: "collection"
        description: "Collection"
        required: true
        type: "string"
      - in: "path"
        name: "object"
        description: "Object ID"
        required: true
        type: "string"
      - in: "query"
        name: "query"
        description: "Specify a MongoDB based resource query (https://docs.mongodb.com/manual/tutorial/query-documents) using JSON (For example: {\"name\": {$regex: 'foo.*'}})."
        required: false
        type: "string"
      - in: "query"
        name: "attributes"
        description: "Filter attributes"
        required: false
        type: "array"
        items:
          type: "string"
      - in: "query"
        name: "offset"
        description: "Objects offset, per default it starts from 0. You may also request a negative offset which will return results from the end [total - offset]."
        required: false
        type: "number"
      - in: "query"
        name: "limit"
        description: "Objects limit, per default 20 objects will get returned"
        required: false
        type: "number"
      - in: "query"
        name: "sort"
        description: "Specify a MongoDB sort operation (https://docs.mongodb.com/manual/reference/method/cursor.sort/) using JSON (For example: {\"name\": -1})."
        required: false
        type: "string"
      responses:
        200:
          description: "List of objects"
        403:
          description: "Access denied"
  /namespaces/{namespace}/collections/{collection}/objects/{object}/relatives:
    get:
      tags:
      - "data"
      summary: "Get relative objects of an object"
      description: "Get all objects the object is related to"
      operationId: "getObjectRelatives"
      produces:
      - "application/json"
      parameters:
      - in: "path"
        name: "namespace"
        description: "Namespace name"
        required: true
        type: "string"
      - in: "path"
        name: "collection"
        description: "Collection"
        required: true
        type: "string"
      - in: "path"
        name: "object"
        description: "Object ID"
        required: true
        type: "string"
      - in: "query"
        name: "query"
        description: "Specify a MongoDB based resource query (https://docs.mongodb.com/manual/tutorial/query-documents) using JSON (For example: {\"name\": {$regex: 'foo.*'}})."
        required: false
        type: "string"
      - in: "query"
        name: "attributes"
        description: "Filter attributes"
        required: false
        type: "array"
        items:
          type: "string"
      - in: "query"
        name: "offset"
        description: "Objects offset, per default it starts from 0. You may also request a negative offset which will return results from the end [total - offset]."
        required: false
        type: "number"
      - in: "query"
        name: "limit"
        description: "Objects limit, per default 20 objects will get returned"
        required: false
        type: "number"
      - in: "query"
        name: "sort"
        description: "Specify a MongoDB sort operation (https://docs.mongodb.com/manual/reference/method/cursor.sort/) using JSON (For example: {\"name\": -1})."
        required: false
        type: "string"
      responses:
        200:
          description: "Object relatives"
          schema:
            $ref: "#/definitions/ObjectRelatives"
        403:
          description: "Access denied"
        404:
          description: "Resource not found"
    post:
      tags:
      - "data"
      summary: "Add new object relation to an object"
      operationId: "addObjectRelative"
      produces:
      - "application/json"
      parameters:
      - in: "path"
        name: "namespace"
        description: "Namespace name"
        required: true
        type: "string"
      - in: "path"
        name: "collection"
        description: "Collection"
        required: true
        type: "string"
      - in: "path"
        name: "object"
        description: "Object ID"
        required: true
        type: "string"
      - in: body
        name: data
        schema:
          $ref: "#/definitions/ObjectRelative"
      responses:
        200:
          description: "Object relative"
          schema:
            $ref: "#/definitions/ObjectRelative"
        403:
          description: "Access denied"
        404:
          description: "Resource not found"
  /namespaces/{namespace}/collections/{collection}/objects/{object}/relatives/{relative}:
    get:
      tags:
      - "data"
      summary: "Get single relative object of an object"
      operationId: "getObjectRelative"
      produces:
      - "application/json"
      parameters:
      - in: "path"
        name: "namespace"
        description: "Namespace name"
        required: true
        type: "string"
      - in: "path"
        name: "collection"
        description: "Collection"
        required: true
        type: "string"
      - in: "path"
        name: "object"
        description: "Object ID"
        required: true
        type: "string"
      - in: "path"
        name: "relative"
        description: "Object ID"
        required: true
        type: "string"
      responses:
        200:
          description: "Object relative"
          schema:
            $ref: "#/definitions/ObjectRelative"
        403:
          description: "Access denied"
        404:
          description: "Resource not found"
    put:
      tags:
      - "data"
      summary: "Update object relation"
      operationId: "updateObjectRelative"
      produces:
      - "application/json"
      parameters:
      - in: "path"
        name: "namespace"
        description: "Namespace name"
        required: true
        type: "string"
      - in: "path"
        name: "collection"
        description: "Collection"
        required: true
        type: "string"
      - in: "path"
        name: "object"
        description: "Object ID"
        required: true
        type: "string"
      - in: "path"
        name: "relative"
        description: "Object ID"
        required: true
        type: "string"
      - in: body
        name: data
        schema:
          $ref: "#/definitions/ObjectRelative"
      responses:
        200:
          description: "Object relative"
          schema:
            $ref: "#/definitions/ObjectRelative"
        403:
          description: "Access denied"
        404:
          description: "Resource not found"
    delete:
      tags:
      - "data"
      summary: "Delete object relation"
      operationId: "deleteObjectRelative"
      produces:
      - "application/json"
      parameters:
      - in: "path"
        name: "namespace"
        description: "Namespace name"
        required: true
        type: "string"
      - in: "path"
        name: "collection"
        description: "Collection"
        required: true
        type: "string"
      - in: "path"
        name: "object"
        description: "Object ID"
        required: true
        type: "string"
      - in: "path"
        name: "relative"
        description: "Object ID"
        required: true
        type: "string"
      responses:
        204:
          description: "No body if successfully deleted"
        403:
          description: "Access denied"
        404:
          description: "Resource not found"
  /namespaces/{namespace}/collections/{collection}/endpoints/{endpoint}/objects:
    get:
      tags:
      - "data"
      summary: "Get objects from endpoint"
      description: "An endpoint is either of type source or destination and defines an import/export destination"
      operationId: "getEndpointObjects"
      produces:
      - "application/json"
      parameters:
      - in: "path"
        name: "namespace"
        description: "Namespace name"
        required: true
        type: "string"
      - in: "path"
        name: "collection"
        description: "Collection"
        required: true
        type: "string"
      - in: "path"
        name: "endpoint"
        description: "Endpoint"
        required: true
        type: "string"
      - in: "query"
        name: "query"
        description: "Specify a MongoDB based resource query (https://docs.mongodb.com/manual/tutorial/query-documents) using JSON (For example: {\"name\": {$regex: 'foo.*'}})."
        required: false
        type: "string"
      - in: "query"
        name: "attributes"
        description: "Filter attributes"
        required: false
        type: "array"
        items:
          type: "string"
      - in: "query"
        name: "offset"
        description: "Objects offset, per default it starts from 0. You may also request a negative offset which will return results from the end [total - offset]."
        required: false
        type: "number"
      - in: "query"
        name: "limit"
        description: "Objects limit, per default 20 objects will get returned"
        required: false
        type: "number"
      - in: "query"
        name: "sort"
        description: "Specify a MongoDB sort operation (https://docs.mongodb.com/manual/reference/method/cursor.sort/) using JSON (For example: {\"name\": -1})."
        required: false
        type: "string"
      responses:
        200:
          description: "List of objects"
          schema:
            $ref: "#/definitions/EndpointObjects"
        404:
          description: "Resource does not exists"
        403:
          description: "Access denied"
  /namespaces/{namespace}/collections/{collection}/objects/{object}/history:
    get:
      tags:
      - "data"
      summary: "Get object history"
      description: "Get the history of all modifications from a specific object"
      operationId: "getObjectHistory"
      produces:
      - "application/json"
      parameters:
      - in: "path"
        name: "namespace"
        description: "Namespace name"
        required: true
        type: "string"
      - in: "path"
        name: "collection"
        description: "Collection"
        required: true
        type: "string"
      - in: "path"
        name: "object"
        description: "Object ID"
        required: true
        type: "string"
      - in: "query"
        name: "query"
        description: "Specify a MongoDB based resource query (https://docs.mongodb.com/manual/tutorial/query-documents) using JSON (For example: {\"name\": {$regex: 'foo.*'}})."
        required: false
        type: "string"
      - in: "query"
        name: "attributes"
        description: "Filter attributes"
        required: false
        type: "array"
        items:
          type: "string"
      - in: "query"
        name: "offset"
        description: "Objects offset, per default it starts from 0. You may also request a negative offset which will return results from the end [total - offset]."
        required: false
        type: "number"
      - in: "query"
        name: "limit"
        description: "Objects limit, per default 20 objects will get returned"
        required: false
        type: "number"
      - in: "query"
        name: "sort"
        description: "Specify a MongoDB sort operation (https://docs.mongodb.com/manual/reference/method/cursor.sort/) using JSON (For example: {\"name\": -1})."
        required: false
        type: "string"
      responses:
        200:
          description: "Object history"
          schema:
            $ref: "#/definitions/DataObjects"
        404:
          description: "Resource does not exists"
        403:
          description: "Access denied"
  /watch/namespaces/{namespace}/collections/{collection}/objects:
    get:
      tags:
      - "data"
      summary: "Watch objects"
      description: "Watch updates in realtime"
      operationId: "watchObjects"
      produces:
      - "application/json;stream=watch"
      parameters:
      - in: "path"
        name: "namespace"
        description: "Namespace name"
        required: true
        type: "string"
      - in: "path"
        name: "collection"
        description: "Collection"
        required: true
        type: "string"
      - in: "query"
        name: "query"
        description: "Specify a MongoDB based resource query (https://docs.mongodb.com/manual/tutorial/query-documents) using JSON (For example: {\"name\": {$regex: 'foo.*'}})."
        required: false
        type: "string"
      - in: "query"
        name: "attributes"
        description: "Filter attributes"
        required: false
        type: "array"
        items:
          type: "string"
      - in: "query"
        name: "offset"
        description: "Objects offset, per default it starts from 0. You may also request a negative offset which will return results from the end [total - offset]."
        required: false
        type: "number"
      - in: "query"
        name: "limit"
        description: "Objects limit, per default 20 objects will get returned"
        required: false
        type: "number"
      - in: "query"
        name: "sort"
        description: "Specify a MongoDB sort operation (https://docs.mongodb.com/manual/reference/method/cursor.sort/) using JSON (For example: {\"name\": -1})."
        required: false
        type: "string"
      responses:
        200:
          description: "List of objects"
        403:
          description: "Access denied"
  /namespaces/{namespace}/collections/{collection}/objects:
    get:
      tags:
      - "data"
      summary: "Get objects of a specific collection"
      description: "A object is a data object from a specifc collection"
      operationId: "getObjects"
      produces:
      - "application/json"
      parameters:
      - in: "path"
        name: "namespace"
        description: "Namespace name"
        required: true
        type: "string"
      - in: "path"
        name: "collection"
        description: "Collection"
        required: true
        type: "string"
      - in: "query"
        name: "query"
        description: "Specify a MongoDB based resource query (https://docs.mongodb.com/manual/tutorial/query-documents) using JSON (For example: {\"name\": {$regex: 'foo.*'}})."
        required: false
        type: "string"
      - in: "query"
        name: "attributes"
        description: "Filter attributes"
        required: false
        type: "array"
        items:
          type: "string"
      - in: "query"
        name: "offset"
        description: "Objects offset, per default it starts from 0. You may also request a negative offset which will return results from the end [total - offset]."
        required: false
        type: "number"
      - in: "query"
        name: "limit"
        description: "Objects limit, per default 20 objects will get returned"
        required: false
        type: "number"
      - in: "query"
        name: "sort"
        description: "Specify a MongoDB sort operation (https://docs.mongodb.com/manual/reference/method/cursor.sort/) using JSON (For example: {\"name\": -1})."
        required: false
        type: "string"
      responses:
        200:
          description: "List of objects"
          schema:
            $ref: "#/definitions/DataObjects"
        404:
          description: "Resource does not exists"
        403:
          description: "Access denied"
    post:
      tags:
      - "data"
      summary: "Add a new object of a specifc collection"
      operationId: "addObject"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - in: "path"
        name: "namespace"
        description: "Namespace name"
        required: true
        type: "string"
      - in: "path"
        name: "collection"
        description: "Collection"
        required: true
        type: "string"
      - in: body
        name: data
        schema:
          $ref: "#/definitions/DataObject"
      responses:
        201:
          description: "If successful the server will respond with 201 Created"
          schema:
            $ref: "#/definitions/DataObject"
        202:
          description: "If write argument is true the server will respond with 202 Accepted since this is an asynchronous request."
          schema:
            $ref: "#/definitions/Job"
        404:
          description: "Resource does not exists"
        403:
          description: "Access denied"
  /watch/secrets:
    get:
      tags:
      - "secrets"
      summary: "Watch secrets"
      description: "Watch updates in realtime"
      operationId: "watchSecrets"
      produces:
      - "application/json;stream=watch"
      parameters:
      - in: "query"
        name: "query"
        description: "Specify a MongoDB based resource query (https://docs.mongodb.com/manual/tutorial/query-documents) using JSON (For example: {\"name\": {$regex: 'foo.*'}})."
        required: false
        type: "string"
      - in: "query"
        name: "attributes"
        description: "Filter attributes"
        required: false
        type: "array"
        items:
          type: "string"
      - in: "query"
        name: "offset"
        description: "Objects offset, per default it starts from 0. You may also request a negative offset which will return results from the end [total - offset]."
        required: false
        type: "number"
      - in: "query"
        name: "limit"
        description: "Objects limit, per default 20 objects will get returned"
        required: false
        type: "number"
      - in: "query"
        name: "sort"
        description: "Specify a MongoDB sort operation (https://docs.mongodb.com/manual/reference/method/cursor.sort/) using JSON (For example: {\"name\": -1})."
        required: false
        type: "string"
      responses:
        200:
          description: "List of secrets"
        403:
          description: "Access denied"
  /secrets:
    get:
      tags:
      - "secrets"
      summary: "Get secrets"
      description: "An secret defines what role is granted access to what resource"
      operationId: "getSecrets"
      produces:
      - "application/json"
      parameters:
      - in: "query"
        name: "query"
        description: "Specify a MongoDB based resource query (https://docs.mongodb.com/manual/tutorial/query-documents) using JSON (For example: {\"name\": {$regex: 'foo.*'}})."
        required: false
        type: "string"
      - in: "query"
        name: "attributes"
        description: "Filter attributes"
        required: false
        type: "array"
        items:
          type: "string"
      - in: "query"
        name: "offset"
        description: "Objects offset, per default it starts from 0. You may also request a negative offset which will return results from the end [total - offset]."
        required: false
        type: "number"
      - in: "query"
        name: "limit"
        description: "Objects limit, per default 20 objects will get returned"
        required: false
        type: "number"
      - in: "query"
        name: "sort"
        description: "Specify a MongoDB sort operation (https://docs.mongodb.com/manual/reference/method/cursor.sort/) using JSON (For example: {\"name\": -1})."
        required: false
        type: "string"
      responses:
        200:
          description: "List of secrets"
          schema:
            $ref: "#/definitions/Secrets"
        403:
          description: "Access denied"
    post:
      tags:
      - "secrets"
      summary: "Create a new secret"
      operationId: "addSecret"
      produces:
      - "application/json"
      parameters:
      - in: body
        name: data
        schema:
          $ref: "#/definitions/Secret"
      responses:
        201:
          description: "The created secret"
          schema:
            $ref: "#/definitions/Secret"
        403:
          description: "Access denied"
  /secrets/{secret}:
    get:
      tags:
      - "secrets"
      summary: "Get secret by name"
      operationId: "getSecret"
      produces:
      - "application/json"
      parameters:
      - in: "path"
        name: "secret"
        description: "secret name"
        required: true
        type: "string"
      responses:
        200:
          description: "secret"
          schema:
            $ref: "#/definitions/Secret"
        404:
          description: "secret does not exists"
        403:
          description: "Access denied"
    patch:
      tags:
      - "secrets"
      summary: "Patch secret as rfc6902 request"
      operationId: "updateSecret"
      consumes:
      - "application/json-patch+json"
      produces:
      - "application/json"
      parameters:
      - in: "path"
        name: "secret"
        description: "secret name"
        required: true
        type: "string"
      - in: body
        name: "job"
        description: "secret json patch"
        schema:
          type: array
          items:
            $ref: "#/definitions/JsonPatch"
      responses:
        200:
          description: "The updated secret"
          schema:
            $ref: "#/definitions/Secret"
        403:
          description: "Access denied"
    put:
      tags:
      - "secrets"
      summary: "Create or replace an secret"
      operationId: "replaceSecret"
      produces:
      - "application/json"
      parameters:
      - in: "path"
        name: "secret"
        description: "secret name"
        required: true
        type: "string"
      - in: body
        name: data
        schema:
          $ref: "#/definitions/Secret"
      responses:
        201:
          description: "The created secret"
          schema:
            $ref: "#/definitions/Secret"
        403:
          description: "Access denied"
    delete:
      tags:
      - "secrets"
      summary: "Delete secret by name"
      operationId: "deleteSecret"
      produces:
      - "application/json"
      parameters:
      - in: "path"
        name: "secret"
        description: "secret name"
        required: true
        type: "string"
      responses:
        204:
          description: "Server responds with 204 No Content if secret removal was successful"
        404:
          description: "secret does not exists"
        403:
          description: "Access denied"
  /watch/users:
    get:
      tags:
      - "users"
      summary: "Watch users"
      description: "Watch updates in realtime"
      operationId: "watchUsers"
      produces:
      - "application/json;stream=watch"
      parameters:
      - in: "query"
        name: "query"
        description: "Specify a MongoDB based resource query (https://docs.mongodb.com/manual/tutorial/query-documents) using JSON (For example: {\"name\": {$regex: 'foo.*'}})."
        required: false
        type: "string"
      - in: "query"
        name: "attributes"
        description: "Filter attributes"
        required: false
        type: "array"
        items:
          type: "string"
      - in: "query"
        name: "offset"
        description: "Objects offset, per default it starts from 0. You may also request a negative offset which will return results from the end [total - offset]."
        required: false
        type: "number"
      - in: "query"
        name: "limit"
        description: "Objects limit, per default 20 objects will get returned"
        required: false
        type: "number"
      - in: "query"
        name: "sort"
        description: "Specify a MongoDB sort operation (https://docs.mongodb.com/manual/reference/method/cursor.sort/) using JSON (For example: {\"name\": -1})."
        required: false
        type: "string"
      responses:
        200:
          description: "List of users"
        403:
          description: "Access denied"
  /users:
    get:
      tags:
      - "users"
      summary: "Get users"
      description: "An User defines what role is granted access to what resource"
      operationId: "getUsers"
      produces:
      - "application/json"
      parameters:
      - in: "query"
        name: "query"
        description: "Specify a MongoDB based resource query (https://docs.mongodb.com/manual/tutorial/query-documents) using JSON (For example: {\"name\": {$regex: 'foo.*'}})."
        required: false
        type: "string"
      - in: "query"
        name: "attributes"
        description: "Filter attributes"
        required: false
        type: "array"
        items:
          type: "string"
      - in: "query"
        name: "offset"
        description: "Objects offset, per default it starts from 0. You may also request a negative offset which will return results from the end [total - offset]."
        required: false
        type: "number"
      - in: "query"
        name: "limit"
        description: "Objects limit, per default 20 objects will get returned"
        required: false
        type: "number"
      - in: "query"
        name: "sort"
        description: "Specify a MongoDB sort operation (https://docs.mongodb.com/manual/reference/method/cursor.sort/) using JSON (For example: {\"name\": -1})."
        required: false
        type: "string"
      responses:
        200:
          description: "List of users"
          schema:
            $ref: "#/definitions/Users"
        403:
          description: "Access denied"
    post:
      tags:
      - "users"
      summary: "Create a new User"
      operationId: "addUser"
      produces:
      - "application/json"
      parameters:
      - in: body
        name: data
        schema:
          $ref: "#/definitions/User"
      responses:
        201:
          description: "The created User"
          schema:
            $ref: "#/definitions/User"
        403:
          description: "Access denied"
  /users/{User}:
    get:
      tags:
      - "users"
      summary: "Get User by name"
      operationId: "getUser"
      produces:
      - "application/json"
      parameters:
      - in: "path"
        name: "User"
        description: "User name"
        required: true
        type: "string"
      responses:
        200:
          description: "User"
          schema:
            $ref: "#/definitions/User"
        404:
          description: "User does not exists"
        403:
          description: "Access denied"
    patch:
      tags:
      - "users"
      summary: "Patch User as rfc6902 request"
      operationId: "updateUser"
      consumes:
      - "application/json-patch+json"
      produces:
      - "application/json"
      parameters:
      - in: "path"
        name: "User"
        description: "User name"
        required: true
        type: "string"
      - in: body
        name: "job"
        description: "User json patch"
        schema:
          type: array
          items:
            $ref: "#/definitions/JsonPatch"
      responses:
        200:
          description: "The updated User"
          schema:
            $ref: "#/definitions/User"
        403:
          description: "Access denied"
    put:
      tags:
      - "users"
      summary: "Create or replace an User"
      operationId: "replaceUser"
      produces:
      - "application/json"
      parameters:
      - in: "path"
        name: "User"
        description: "User name"
        required: true
        type: "string"
      - in: body
        name: data
        schema:
          $ref: "#/definitions/User"
      responses:
        201:
          description: "The created User"
          schema:
            $ref: "#/definitions/User"
        403:
          description: "Access denied"
    delete:
      tags:
      - "users"
      summary: "Delete User by name"
      operationId: "deleteUser"
      produces:
      - "application/json"
      parameters:
      - in: "path"
        name: "User"
        description: "User name"
        required: true
        type: "string"
      responses:
        204:
          description: "Server responds with 204 No Content if User removal was successful"
        404:
          description: "User does not exists"
        403:
          description: "Access denied"
  /watch/access-rules:
    get:
      tags:
      - "access-rules"
      summary: "Watch access rules"
      description: "Watch updates in realtime"
      operationId: "watchAccessRules"
      produces:
      - "application/json;stream=watch"
      parameters:
      - in: "query"
        name: "query"
        description: "Specify a MongoDB based resource query (https://docs.mongodb.com/manual/tutorial/query-documents) using JSON (For example: {\"name\": {$regex: 'foo.*'}})."
        required: false
        type: "string"
      - in: "query"
        name: "attributes"
        description: "Filter attributes"
        required: false
        type: "array"
        items:
          type: "string"
      - in: "query"
        name: "offset"
        description: "Objects offset, per default it starts from 0. You may also request a negative offset which will return results from the end [total - offset]."
        required: false
        type: "number"
      - in: "query"
        name: "limit"
        description: "Objects limit, per default 20 objects will get returned"
        required: false
        type: "number"
      - in: "query"
        name: "sort"
        description: "Specify a MongoDB sort operation (https://docs.mongodb.com/manual/reference/method/cursor.sort/) using JSON (For example: {\"name\": -1})."
        required: false
        type: "string"
      responses:
        200:
          description: "List of access rules"
        403:
          description: "Access denied"
  /access-rules:
    get:
      tags:
      - "access-rules"
      summary: "Get access rules"
      description: "An access rule defines what role is granted access to what resource"
      operationId: "getAccessRules"
      produces:
      - "application/json"
      parameters:
      - in: "query"
        name: "query"
        description: "Specify a MongoDB based resource query (https://docs.mongodb.com/manual/tutorial/query-documents) using JSON (For example: {\"name\": {$regex: 'foo.*'}})."
        required: false
        type: "string"
      - in: "query"
        name: "attributes"
        description: "Filter attributes"
        required: false
        type: "array"
        items:
          type: "string"
      - in: "query"
        name: "offset"
        description: "Objects offset, per default it starts from 0. You may also request a negative offset which will return results from the end [total - offset]."
        required: false
        type: "number"
      - in: "query"
        name: "limit"
        description: "Objects limit, per default 20 objects will get returned"
        required: false
        type: "number"
      - in: "query"
        name: "sort"
        description: "Specify a MongoDB sort operation (https://docs.mongodb.com/manual/reference/method/cursor.sort/) using JSON (For example: {\"name\": -1})."
        required: false
        type: "string"
      responses:
        200:
          description: "List of access rules"
          schema:
            $ref: "#/definitions/AccessRules"
        403:
          description: "Access denied"
    post:
      tags:
      - "access-rules"
      summary: "Create a new access rule"
      operationId: "addAccessRule"
      produces:
      - "application/json"
      parameters:
      - in: body
        name: data
        schema:
          $ref: "#/definitions/AccessRule"
      responses:
        201:
          description: "The created access rule"
          schema:
            $ref: "#/definitions/AccessRule"
        403:
          description: "Access denied"
  /access-rules/{access-rule}:
    get:
      tags:
      - "access-rules"
      summary: "Get access rule by name"
      operationId: "getAccessRule"
      produces:
      - "application/json"
      parameters:
      - in: "path"
        name: "access-rule"
        description: "Access rule name"
        required: true
        type: "string"
      responses:
        200:
          description: "Acccess rule"
          schema:
            $ref: "#/definitions/AccessRule"
        404:
          description: "access rule does not exists"
        403:
          description: "Access denied"
    patch:
      tags:
      - "access-rules"
      summary: "Patch access rule as rfc6902 request"
      operationId: "updateAccessRule"
      consumes:
      - "application/json-patch+json"
      produces:
      - "application/json"
      parameters:
      - in: "path"
        name: "access-rule"
        description: "Access rule name"
        required: true
        type: "string"
      - in: body
        name: "job"
        description: "Access rule json patch"
        schema:
          type: array
          items:
            $ref: "#/definitions/JsonPatch"
      responses:
        200:
          description: "The updated access rule"
          schema:
            $ref: "#/definitions/AccessRule"
        403:
          description: "Access denied"
    put:
      tags:
      - "access-rules"
      summary: "Create or replace an access rule"
      operationId: "replaceAccessRule"
      produces:
      - "application/json"
      parameters:
      - in: "path"
        name: "access-rule"
        description: "Access rule name"
        required: true
        type: "string"
      - in: body
        name: data
        schema:
          $ref: "#/definitions/AccessRule"
      responses:
        201:
          description: "The created access rule"
          schema:
            $ref: "#/definitions/AccessRule"
        403:
          description: "Access denied"
    delete:
      tags:
      - "access-rules"
      summary: "Delete access-rule by name"
      operationId: "deleteAccessRule"
      produces:
      - "application/json"
      parameters:
      - in: "path"
        name: "access-rule"
        description: "Access rule name"
        required: true
        type: "string"
      responses:
        204:
          description: "Server responds with 204 No Content if access rule removal was successful"
        404:
          description: "Access rule does not exists"
        403:
          description: "Access denied"
  /watch/access-roles:
    get:
      tags:
      - "access-roles"
      summary: "Watch access roles"
      description: "Watch updates in realtime"
      operationId: "watchAccessRoles"
      produces:
      - "application/json;stream=watch"
      parameters:
      - in: "query"
        name: "query"
        description: "Specify a MongoDB based resource query (https://docs.mongodb.com/manual/tutorial/query-documents) using JSON (For example: {\"name\": {$regex: 'foo.*'}})."
        required: false
        type: "string"
      - in: "query"
        name: "attributes"
        description: "Filter attributes"
        required: false
        type: "array"
        items:
          type: "string"
      - in: "query"
        name: "offset"
        description: "Objects offset, per default it starts from 0. You may also request a negative offset which will return results from the end [total - offset]."
        required: false
        type: "number"
      - in: "query"
        name: "limit"
        description: "Objects limit, per default 20 objects will get returned"
        required: false
        type: "number"
      - in: "query"
        name: "sort"
        description: "Specify a MongoDB sort operation (https://docs.mongodb.com/manual/reference/method/cursor.sort/) using JSON (For example: {\"name\": -1})."
        required: false
        type: "string"
      responses:
        200:
          description: "List of access roles"
        403:
          description: "Access denied"
  /access-roles:
    get:
      tags:
      - "access-roles"
      summary: "Get access roles"
      description: "An access role defines what role is granted access to what resource"
      operationId: "getAccessRoles"
      produces:
      - "application/json"
      parameters:
      - in: "query"
        name: "query"
        description: "Specify a MongoDB based resource query (https://docs.mongodb.com/manual/tutorial/query-documents) using JSON (For example: {\"name\": {$regex: 'foo.*'}})."
        required: false
        type: "string"
      - in: "query"
        name: "attributes"
        description: "Filter attributes"
        required: false
        type: "array"
        items:
          type: "string"
      - in: "query"
        name: "offset"
        description: "Objects offset, per default it starts from 0. You may also request a negative offset which will return results from the end [total - offset]."
        required: false
        type: "number"
      - in: "query"
        name: "limit"
        description: "Objects limit, per default 20 objects will get returned"
        required: false
        type: "number"
      - in: "query"
        name: "sort"
        description: "Specify a MongoDB sort operation (https://docs.mongodb.com/manual/reference/method/cursor.sort/) using JSON (For example: {\"name\": -1})."
        required: false
        type: "string"
      responses:
        200:
          description: "List of access roles"
          schema:
            $ref: "#/definitions/AccessRoles"
        403:
          description: "Access denied"
    post:
      tags:
      - "access-roles"
      summary: "Create a new access role"
      operationId: "addAccessRole"
      produces:
      - "application/json"
      parameters:
      - in: body
        name: data
        schema:
          $ref: "#/definitions/AccessRole"
      responses:
        201:
          description: "The created access role"
          schema:
            $ref: "#/definitions/AccessRole"
        403:
          description: "Access denied"
  /access-roles/{access-role}:
    get:
      tags:
      - "access-roles"
      summary: "Get access role by name"
      operationId: "getAccessRole"
      produces:
      - "application/json"
      parameters:
      - in: "path"
        name: "access-role"
        description: "Access role name"
        required: true
        type: "string"
      responses:
        200:
          description: "Acccess role"
          schema:
            $ref: "#/definitions/AccessRole"
        404:
          description: "access role does not exists"
        403:
          description: "Access denied"
    patch:
      tags:
      - "access-roles"
      summary: "Patch access role as rfc6902 request"
      operationId: "updateAccessRole"
      consumes:
      - "application/json-patch+json"
      produces:
      - "application/json"
      parameters:
      - in: "path"
        name: "access-role"
        description: "Access role name"
        required: true
        type: "string"
      - in: body
        name: "job"
        description: "Access role json patch"
        schema:
          type: array
          items:
            $ref: "#/definitions/JsonPatch"
      responses:
        200:
          description: "The updated access role"
          schema:
            $ref: "#/definitions/AccessRole"
        403:
          description: "Access denied"
    put:
      tags:
      - "access-roles"
      summary: "Create or replace an access role"
      operationId: "replaceAccessRole"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - in: "path"
        name: "access-role"
        description: "Access role name"
        required: true
        type: "string"
      - in: body
        name: data
        schema:
          $ref: "#/definitions/AccessRole"
      responses:
        200:
          description: "The updated access role"
          schema:
            $ref: "#/definitions/AccessRole"
        201:
          description: "The created access role if it did not exists yet"
          schema:
            $ref: "#/definitions/AccessRole"
        403:
          description: "Access denied"
    delete:
      tags:
      - "access-roles"
      summary: "Delete access-role by name"
      operationId: "deleteAccessRole"
      produces:
      - "application/json"
      parameters:
      - in: "path"
        name: "access-role"
        description: "Access role name"
        required: true
        type: "string"
      responses:
        204:
          description: "Server responds with 204 No Content if access role removal was successful"
        404:
          description: "Access role does not exists"
        403:
          description: "Access denied"
  /watch/jobs:
    get:
      tags:
      - "jobs"
      summary: "Get realtime updates"
      description: "A job is an asynchronous server process"
      operationId: "watchJobs"
      produces:
      - "application/json"
      parameters:
      - in: "query"
        name: "query"
        description: "Specify a MongoDB based resource query (https://docs.mongodb.com/manual/tutorial/query-documents) using JSON (For example: {\"name\": {$regex: 'foo.*'}})."
        required: false
        type: "string"
      - in: "query"
        name: "attributes"
        description: "Filter attributes"
        required: false
        type: "array"
        items:
          type: "string"
      - in: "query"
        name: "offset"
        description: "Objects offset, per default it starts from 0. You may also request a negative offset which will return results from the end [total - offset]."
        required: false
        type: "number"
      - in: "query"
        name: "limit"
        description: "Objects limit, per default 20 objects will get returned"
        required: false
        type: "number"
      - in: "query"
        name: "sort"
        description: "Specify a MongoDB sort operation (https://docs.mongodb.com/manual/reference/method/cursor.sort/) using JSON (For example: {\"name\": -1})."
        required: false
        type: "string"
      responses:
        200:
          description: "List of active jobs"
        403:
          description: "Access denied"
  /jobs:
    get:
      tags:
      - "jobs"
      summary: "Get list of active queued jobs"
      description: "A job is an asynchronous server process"
      operationId: "getJobs"
      produces:
      - "application/json"
      parameters:
      - in: "query"
        name: "query"
        description: "Specify a MongoDB based resource query (https://docs.mongodb.com/manual/tutorial/query-documents) using JSON (For example: {\"name\": {$regex: 'foo.*'}})."
        required: false
        type: "string"
      - in: "query"
        name: "attributes"
        description: "Filter attributes"
        required: false
        type: "array"
        items:
          type: "string"
      - in: "query"
        name: "offset"
        description: "Objects offset, per default it starts from 0. You may also request a negative offset which will return results from the end [total - offset]."
        required: false
        type: "number"
      - in: "query"
        name: "limit"
        description: "Objects limit, per default 20 objects will get returned"
        required: false
        type: "number"
      - in: "query"
        name: "sort"
        description: "Specify a MongoDB sort operation (https://docs.mongodb.com/manual/reference/method/cursor.sort/) using JSON (For example: {\"name\": -1})."
        required: false
        type: "string"
      responses:
        200:
          description: "List of active jobs"
          schema:
            $ref: "#/definitions/Jobs"
        403:
          description: "Access denied"
    post:
      tags:
      - "jobs"
      summary: "Create new job"
      operationId: "addJob"
      produces:
      - "application/json"
      parameters:
      - in: body
        name: data
        schema:
          $ref: "#/definitions/Job"
      responses:
        202:
          description: "The created job"
          schema:
            $ref: "#/definitions/Job"
        404:
          description: "Resource does not exists"
        403:
          description: "Access denied"
  /jobs/{job}:
    get:
      tags:
      - "jobs"
      summary: "Get job by id"
      operationId: "getJob"
      produces:
      - "application/json"
      parameters:
      - in: "path"
        name: "job"
        description: "Job ID"
        required: true
        type: "string"
      responses:
        200:
          description: "Job"
          schema:
            $ref: "#/definitions/Job"
        404:
          description: "Job does not exists"
        403:
          description: "Access denied"
    delete:
      tags:
      - "jobs"
      summary: "Delete job by id"
      operationId: "deleteJob"
      produces:
      - "application/json"
      parameters:
      - in: "path"
        name: "job"
        description: "Job ID"
        required: true
        type: "string"
      responses:
        204:
          description: "Server responds with 204 No Content if job removal was successful"
        404:
          description: "Job does not exists"
        403:
          description: "Access denied"
    patch:
      tags:
      - "jobs"
      summary: "Patch job as rfc6902 request"
      description: "Update specific attributes of a job"
      operationId: "updateJob"
      consumes:
      - "application/json-patch+json"
      produces:
      - "application/json"
      parameters:
      - in: "path"
        name: "job"
        description: "Job ID"
        required: true
        type: "string"
      - in: body
        name: data
        description: "Object"
        schema:
          type: array
          items:
            $ref: "#/definitions/JsonPatch"
      responses:
        200:
          description: "If successful the server will respond with 200 OK"
          schema:
            $ref: "#/definitions/Job"
        404:
          description: "Resource does not exists"
        403:
          description: "Access denied"
  /processes:
    get:
      tags:
      - "jobs"
      summary: "Get all processes"
      operationId: "getProcesses"
      produces:
      - "application/json"
      parameters:
      - in: "query"
        name: "query"
        description: "Specify a MongoDB based resource query (https://docs.mongodb.com/manual/tutorial/query-documents) using JSON (For example: {\"name\": {$regex: 'foo.*'}})."
        required: false
        type: "string"
      - in: "query"
        name: "attributes"
        description: "Filter attributes"
        required: false
        type: "array"
        items:
          type: "string"
      - in: "query"
        name: "offset"
        description: "Objects offset, per default it starts from 0. You may also request a negative offset which will return results from the end [total - offset]."
        required: false
        type: "number"
      - in: "query"
        name: "limit"
        description: "Objects limit, per default 20 objects will get returned"
        required: false
        type: "number"
      - in: "query"
        name: "sort"
        description: "Specify a MongoDB sort operation (https://docs.mongodb.com/manual/reference/method/cursor.sort/) using JSON (For example: {\"name\": -1})."
        required: false
        type: "string"
      responses:
        200:
          description: "Process"
          schema:
            $ref: "#/definitions/Processes"
        404:
          description: "Job does not exists"
        403:
          description: "Access denied"
    post:
      tags:
      - "jobs"
      summary: "Trigger a new process"
      operationId: "addProcess"
      produces:
      - "application/json"
      parameters:
      - in: body
        name: data
        schema:
          $ref: "#/definitions/Process"
      responses:
        202:
          description: "Returns a 202 if successful"
          schema:
            $ref: "#/definitions/Process"
        404:
          description: "Job does not exists"
        403:
          description: "Access denied"
  /watch/processes:
    get:
      tags:
      - "jobs"
      summary: "Watch job processes"
      operationId: "watchProcesses"
      produces:
      - "application/json+stream"
      parameters:
      - in: "query"
        name: "query"
        description: "Specify a MongoDB based resource query (https://docs.mongodb.com/manual/tutorial/query-documents) using JSON (For example: {\"name\": {$regex: 'foo.*'}})."
        required: false
        type: "string"
      - in: "query"
        name: "attributes"
        description: "Filter attributes"
        required: false
        type: "array"
        items:
          type: "string"
      - in: "query"
        name: "offset"
        description: "Objects offset, per default it starts from 0. You may also request a negative offset which will return results from the end [total - offset]."
        required: false
        type: "number"
      - in: "query"
        name: "limit"
        description: "Objects limit, per default 20 objects will get returned"
        required: false
        type: "number"
      - in: "query"
        name: "sort"
        description: "Specify a MongoDB sort operation (https://docs.mongodb.com/manual/reference/method/cursor.sort/) using JSON (For example: {\"name\": -1})."
        required: false
        type: "string"
      responses:
        200:
          description: "Processes"
        404:
          description: "Job does not exists"
        403:
          description: "Access denied"
  /processes/{process}:
    get:
      tags:
      - "jobs"
      summary: "Get a single process of a job"
      operationId: "getProcess"
      produces:
      - "application/json"
      parameters:
      - in: "path"
        name: "process"
        description: "Process ID"
        required: true
        type: "string"
      responses:
        200:
          description: "Process"
          schema:
            $ref: "#/definitions/Process"
        404:
          description: "Process does not exists"
        403:
          description: "Access denied"
    delete:
      tags:
      - "jobs"
      summary: "Abort running process"
      operationId: "deleteProcess"
      produces:
      - "application/json"
      parameters:
      - in: "path"
        name: "process"
        description: "Process ID"
        required: true
        type: "string"
      responses:
        204:
          description: "Server responds with 204 No Content if process abort was successful"
        404:
          description: "Process does not exists"
        403:
          description: "Access denied"
  /jobs/{job}/logs:
    get:
      tags:
      - "jobs"
      summary: "Get logs of a job"
      operationId: "getJobLogs"
      produces:
      - "application/json"
      parameters:
      - in: "path"
        name: "job"
        description: "Job ID"
        required: true
        type: "string"
      - in: "query"
        name: "query"
        description: "Specify a MongoDB based resource query (https://docs.mongodb.com/manual/tutorial/query-documents) using JSON (For example: {\"name\": {$regex: 'foo.*'}})."
        required: false
        type: "string"
      - in: "query"
        name: "attributes"
        description: "Filter attributes"
        required: false
        type: "array"
        items:
          type: "string"
      - in: "query"
        name: "offset"
        description: "Objects offset, per default it starts from 0. You may also request a negative offset which will return results from the end [total - offset]."
        required: false
        type: "number"
      - in: "query"
        name: "limit"
        description: "Objects limit, per default 20 objects will get returned"
        required: false
        type: "number"
      - in: "query"
        name: "sort"
        description: "Specify a MongoDB sort operation (https://docs.mongodb.com/manual/reference/method/cursor.sort/) using JSON (For example: {\"name\": -1})."
        required: false
        type: "string"
      responses:
        200:
          description: "Job"
          schema:
            $ref: "#/definitions/Log"
        404:
          description: "Job does not exists"
        403:
          description: "Access denied"
  /jobs/{job}/logs/{log}:
    get:
      tags:
      - "jobs"
      summary: "Get a single job error"
      operationId: "getJobLog"
      produces:
      - "application/json"
      parameters:
      - in: "path"
        name: "job"
        description: "Job ID"
        required: true
        type: "string"
      - in: "path"
        name: "log"
        description: "Log id"
        required: true
        type: "string"
      responses:
        200:
          description: "Log"
          schema:
            $ref: "#/definitions/Log"
        404:
          description: "Job does not exists"
        403:
          description: "Access denied"
  /watch/jobs/{job}/logs:
    get:
      tags:
      - "jobs"
      summary: "Watch log stream"
      operationId: "watchJobLogs"
      produces:
      - "application/json+stream"
      parameters:
      - in: "path"
        name: "job"
        description: "Job ID"
        required: true
        type: "string"
      - in: "query"
        name: "query"
        description: "Specify a MongoDB based resource query (https://docs.mongodb.com/manual/tutorial/query-documents) using JSON (For example: {\"name\": {$regex: 'foo.*'}})."
        required: false
        type: "string"
      - in: "query"
        name: "attributes"
        description: "Filter attributes"
        required: false
        type: "array"
        items:
          type: "string"
      - in: "query"
        name: "offset"
        description: "Objects offset, per default it starts from 0. You may also request a negative offset which will return results from the end [total - offset]."
        required: false
        type: "number"
      - in: "query"
        name: "limit"
        description: "Objects limit, per default 20 objects will get returned"
        required: false
        type: "number"
      - in: "query"
        name: "sort"
        description: "Specify a MongoDB sort operation (https://docs.mongodb.com/manual/reference/method/cursor.sort/) using JSON (For example: {\"name\": -1})."
        required: false
        type: "string"
      responses:
        200:
          description: "Logs"
        404:
          description: "Job does not exists"
        403:
          description: "Access denied"
  /processes/{process}/logs:
    get:
      tags:
      - "jobs"
      summary: "Get logs of a process"
      operationId: "getProcessLogs"
      produces:
      - "application/json"
      parameters:
      - in: "path"
        name: "process"
        description: "Process ID"
        required: true
        type: "string"
      - in: "query"
        name: "query"
        description: "Specify a MongoDB based resource query (https://docs.mongodb.com/manual/tutorial/query-documents) using JSON (For example: {\"name\": {$regex: 'foo.*'}})."
        required: false
        type: "string"
      - in: "query"
        name: "attributes"
        description: "Filter attributes"
        required: false
        type: "array"
        items:
          type: "string"
      - in: "query"
        name: "offset"
        description: "Objects offset, per default it starts from 0. You may also request a negative offset which will return results from the end [total - offset]."
        required: false
        type: "number"
      - in: "query"
        name: "limit"
        description: "Objects limit, per default 20 objects will get returned"
        required: false
        type: "number"
      - in: "query"
        name: "sort"
        description: "Specify a MongoDB sort operation (https://docs.mongodb.com/manual/reference/method/cursor.sort/) using JSON (For example: {\"name\": -1})."
        required: false
        type: "string"
      responses:
        200:
          description: "Log"
          schema:
            $ref: "#/definitions/Log"
        404:
          description: "Process does not exists"
        403:
          description: "Access denied"
  /process/{process}/logs/{log}:
    get:
      tags:
      - "jobs"
      summary: "Get a single process log"
      operationId: "getProcessLog"
      produces:
      - "application/json"
      parameters:
      - in: "path"
        name: "process"
        description: "Process ID"
        required: true
        type: "string"
      - in: "path"
        name: "log"
        description: "Log id"
        required: true
        type: "string"
      responses:
        200:
          description: "Log"
          schema:
            $ref: "#/definitions/Log"
        404:
          description: "Log does not exists"
        403:
          description: "Access denied"
  /watch/processes/{process}/logs:
    get:
      tags:
      - "jobs"
      summary: "Watch log stream"
      operationId: "watchProcessLogs"
      produces:
      - "application/json+stream"
      parameters:
      - in: "path"
        name: "process"
        description: "Process ID"
        required: true
        type: "string"
      - in: "query"
        name: "query"
        description: "Specify a MongoDB based resource query (https://docs.mongodb.com/manual/tutorial/query-documents) using JSON (For example: {\"name\": {$regex: 'foo.*'}})."
        required: false
        type: "string"
      - in: "query"
        name: "attributes"
        description: "Filter attributes"
        required: false
        type: "array"
        items:
          type: "string"
      - in: "query"
        name: "offset"
        description: "Objects offset, per default it starts from 0. You may also request a negative offset which will return results from the end [total - offset]."
        required: false
        type: "number"
      - in: "query"
        name: "limit"
        description: "Objects limit, per default 20 objects will get returned"
        required: false
        type: "number"
      - in: "query"
        name: "sort"
        description: "Specify a MongoDB sort operation (https://docs.mongodb.com/manual/reference/method/cursor.sort/) using JSON (For example: {\"name\": -1})."
        required: false
        type: "string"
      responses:
        200:
          description: "Logs"
        404:
          description: "Job does not exists"
        403:
          description: "Access denied"
definitions:
  JsonPatch:
    description: "A JSON Patch according rfc6902."
    type: "object"
    properties:
      op:
        type: "string"
      path:
        type: "string"
      value:
        type: "string"
  Links:
    description: "Contains resource links (URL) to other resources."
    type: "object"
    properties:
      self:
        $ref: "#/definitions/Link"
  ListLinks:
    type: "object"
    properties:
      self:
        $ref: "#/definitions/Link"
      prev:
        $ref: "#/definitions/Link"
      next:
        $ref: "#/definitions/Link"
  Link:
    type: "object"
    properties:
      href:
        type: "string"
  List:
    type: "object"
    properties:
      _links:
        description: "Holds a list of links rfc1738 to other resources."
        $ref: "#/definitions/ListLinks"
      kind:
        description: "The resource type, always List."
        type: "string"
        default: "List"
      count:
        description: "Holds the number of items in the current list response."
        type: "number"
      total:
        description: "Holds the number of total available items on the server. Note that a List resource is always paged. You need to traverse with offset and limit to request further resources in the list."
        type: "number"
  Resource:
    type: "object"
    properties:
      _links:
        $ref: "#/definitions/Links"
      name:
        description: "Resource identifier. Note that the name is immutable once created on the server and must be unique in its own resource context."
        type: "string"
      id:
        description: "Unique 12-byte resource identifier. Note this is a MongoDB ObjectId. The name is the standard resource identifier, the id only useful to verify that a given resource was completely recreated. An ID is immutable and will be created on the server."
        type: "string"
      version:
        description: "The version of the resource. A version gets increased once the resource have been modified."
        type: "number"
      created:
        description: "ISO 8601 timestamp when the resource was created."
        type: "string"
      changed:
        description: "ISO 8601 timestamp when the resource was changed."
        type: "string"
      secrets:
        description: "Injected secrets in this resource."
        type: "array"
        items:
          $ref: "#/definitions/SecretMount"
  SecretMount:
    type: "object"
    properties:
      secret:
        description: "The name of the secret from which the key's value should be injected."
        type: "string"
      key:
        description: "The name of the key which should be taken from a secret (You may use a recursive path by delimiting keys with '.', for example: password)."
        type: "string"
      to:
        description: "The resource path where the secret value should be injected (You may use a recursive path by delimiting keys with '.', for example: data.resource.password)."
        type: "string"
  Namespaces:
    description: "A list of namespaces."
    allOf:
      - $ref: '#/definitions/List'
      - type: object
        required:
          - rootCause
        properties:
          data:
            type: "array"
            items:
              $ref: "#/definitions/Namespace"
  Namespace:
    description: "A namespace is a namespace to separate resources."
    allOf:
      - $ref: '#/definitions/Resource'
      - type: object
        required:
          - rootCause
        properties:
          kind:
            description: "The resource type, always Namespace."
            type: "string"
            default: "Namespace"
  Secrets:
    description: "A list of secrets."
    allOf:
      - $ref: '#/definitions/List'
      - type: object
        required:
          - rootCause
        properties:
          data:
            type: "array"
            items:
              $ref: "#/definitions/Secret"
  Secret:
    description: "A secret is sensitive information which can be injected into another resource. A secret gets specially encrypted on the server and is always base64 encoded."
    allOf:
      - $ref: '#/definitions/Resource'
      - type: object
        required:
          - rootCause
        properties:
          kind:
            description: "The resource type, always Secret."
            type: "string"
            default: "Secret"
          data:
            description: "The secrets data. You may specify multiple keys. Important: You need to base64 encode the values!"
            type: "object"
  Users:
    description: "A list of users."
    allOf:
      - $ref: '#/definitions/List'
      - type: object
        required:
          - rootCause
        properties:
          data:
            type: "array"
            items:
              $ref: "#/definitions/User"
  User:
    description: "A local tubee user."
    allOf:
      - $ref: '#/definitions/Resource'
      - type: object
        required:
          - rootCause
        properties:
          kind:
            description: "The resource type, always User."
            type: "string"
            default: "User"
          data:
            description: "The user information."
            type: "object"
            properties:
              password:
                description: "The users password. Gets hashed on the server and can not be retrieved after."
                type: "string"
  AccessRules:
    description: "A list of access rules."
    allOf:
      - $ref: '#/definitions/List'
      - type: object
        required:
          - rootCause
        properties:
          data:
            type: "array"
            items:
              $ref: "#/definitions/AccessRule"
  AccessRule:
    description: "An access rule allows to specify what access roles can access which resources."
    allOf:
      - $ref: '#/definitions/Resource'
      - type: object
        required:
          - rootCause
        properties:
          kind:
            description: "The resource type, always AccessRule."
            type: "string"
            default: "AccessRule"
          data:
            type: "object"
            properties:
              roles:
                description: "A list of access-role names to match the given rule."
                type: "array"
                items:
                  type: "string"
              verbs:
                description: "List of allowed HTTP rfc7231 verbs, you may also specify a wildcard to match all verbs."
                type: "array"
                items:
                  type: "string"
                  enum:
                    - "*"
                    - GET
                    - POST
                    - PUT
                    - PATCH
                    - DELETE
                    - HEAD
              selectors:
                description: "A list of selectors to match resources, for example namespace, collection, endpoint, ..."
                type: "array"
                items:
                  type: "string"
              resources:
                description: "Values according to your selector list required to match a request."
                type: "array"
                items:
                  type: "string"
  AccessRoles:
    description: "A list of access roles."
    allOf:
      - $ref: '#/definitions/List'
      - type: object
        required:
          - rootCause
        properties:
          data:
            type: "array"
            items:
              $ref: "#/definitions/AccessRole"
  AccessRole:
    description: "An access role is defined list which matches authenticated user identifiers."
    allOf:
      - $ref: '#/definitions/Resource'
      - type: object
        required:
          - rootCause
        properties:
          kind:
            description: "The resource type, always AccessRole."
            type: "string"
            default: "AccessRole"
          data:
            type: "object"
            properties:
              selectors:
                description: "A list of user identifiers which the access role should match. It is also possible to specify a wildcard to match all identifiers."
                type: "array"
                items:
                  type: "string"
  Processes:
    description: "A list of processes."
    allOf:
      - $ref: '#/definitions/List'
      - type: object
        required:
          - rootCause
        properties:
          data:
            type: "array"
            items:
              $ref: "#/definitions/Process"
  Process:
    description: "A process is a sub resource of a job. Each process represents one job execution."
    allOf:
      - $ref: '#/definitions/Job'
      - type: object
        required:
          - rootCause
        properties:
          kind:
            description: "The resource type, always Process."
            type: "string"
            default: "Process"
          status:
            description: "Holds the status of this resource. Note that status is immutable."
            type: "object"
            properties:
              code:
                description: "The result code of the process."
                type: "number"
  Jobs:
    description: "A list of jobs."
    allOf:
      - $ref: '#/definitions/List'
      - type: object
        required:
          - rootCause
        properties:
          data:
            type: "array"
            items:
              $ref: "#/definitions/Job"
  Job:
    description: "A job is a synchronization job which declares when and what collections should be synchronized."
    allOf:
      - $ref: '#/definitions/Resource'
      - type: object
        required:
          - rootCause
        properties:
          kind:
            description: "The resource type, always Job."
            type: "string"
            default: "Job"
          data:
            type: "object"
            properties:
              notification:
                type: "object"
                properties:
                  enabled:
                    description: "You may enable mail notification for a given job."
                    default: false
                    type: boolean
                  receiver:
                    description: "A list of mail adresses which the notification should be sent to. This option has no affect if notification is disabled."
                    type: array
                    items:
                      type: string
              namespaces:
                description: "A list of namespaces (name) the job should match. You may use a wildcard to specify all namespaces."
                type: array
                items:
                  type: string
                default: ["*"]
              collections:
                description: "A list of collections (name) the job should match. You may use a wildcard to specify all collections."
                type: array
                items:
                  type: string
                default: ["*"]
              endpoints:
                description: "A list of endoints (name) the job should match. You may use a wildcard to specify all endpoints."
                type: array
                items:
                  type: string
                default: ["*"]
              filter:
                description: "Data object filter."
                type: object
              loadbalance:
                description: "If enabled the server tries to splitt the job into multiple parallel processes."
                type: boolean
                default: true
              ignore:
                description: "If enabled the server does ignores any sync errors and continue with the process."
                type: boolean
                default: false
              log_level:
                description: "You may change the log level which gets applied during a sync job. Note that a log level too verbose has a big impact on the sync performance."
                type: string
                default: error
                enum:
                  - emerg
                  - error
                  - warn
                  - info
                  - notice
                  - debug
              options:
                description: "Holds options about when a job should start and with what interval."
                type: object
                properties:
                  at:
                    description: "Holds a unix timestamp at what time the job should be executed."
                    type: "string"
                    format: "integer"
                    default: 0
                  interval:
                    description: "The number of secconds after the job should be executed again. The default is only run once."
                    type: "integer"
                    default: 0
                  retry:
                    description: "The number of times a failed job should be restarted. The default is never."
                    type: "integer"
                    default: 0
                  retry_interval:
                    description: "The number of secconds beween failed job retries. The default is 300 (5min)."
                    type: "integer"
                    default: 0
  Logs:
    description: "A list of logs."
    allOf:
      - $ref: '#/definitions/List'
      - type: object
        required:
          - rootCause
        properties:
          data:
            type: "array"
            items:
              $ref: "#/definitions/Log"
  Log:
    description: "A log messagage from a process."
    allOf:
      - $ref: '#/definitions/Resource'
      - type: object
        required:
          - rootCause
        properties:
          kind:
            description: "The resource type, always Log."
            type: "string"
            default: "Log"
          data:
            type: "object"
            properties:
              level:
                type: "integer"
              level_name:
                type: "string"
              message:
                description: "The log message."
                type: "string"
              category:
                description: "The server component which logged the message."
                type: "string"
              exception:
                description: "Holds an exception object if the log message holds an exception reference."
                type: "object"
  Collections:
    description: "A list of collections."
    allOf:
      - $ref: '#/definitions/List'
      - type: object
        required:
          - rootCause
        properties:
          data:
            type: "array"
            items:
              $ref: "#/definitions/Collections"
  Collection:
    description: "A collection is a collection of data objects, meaning a collection of similar objects."
    allOf:
      - $ref: '#/definitions/Resource'
      - type: object
        required:
          - rootCause
        properties:
          kind:
            description: "The resource type, always Collection."
            type: "string"
            default: "Collection"
          data:
            type: "object"
            properties:
              schema:
                type: "object"
                default: {}
  Endpoints:
    description: "A list of endpoints."
    allOf:
      - $ref: '#/definitions/List'
      - type: object
        required:
          - rootCause
        properties:
          data:
            type: "array"
            items:
              $ref: "#/definitions/Endpoint"
  Endpoint:
    description: "An endpoint represents an external resource to browse (proxy), import or export. This may be a database, a file, a http service, ..."
    allOf:
      - $ref: '#/definitions/Resource'
      - type: object
        required:
          - rootCause
        properties:
          kind:
            description: "The type of endpoint."
            type: "string"
            enum:
              - PdoEndpoint
              - MysqlEndpoint
              - XmlEndpoint
              - CsvEndpoint
              - ImageEndpoint
              - JsonEndpoint
              - MongodbEndpoint
              - MoodleEndpoint
              - BalloonEndpoint
              - OdataRestEndpoint
          data:
            type: "object"
            properties:
              type:
                description: "Specify the type of the endpoint."
                type: "string"
                enum:
                  - browse
                  - source
                  - destination
                  - bidirectional
              options:
                type: "object"
                properties:
                  identifier:
                    description: "A list of attributes which gets used to uniquely identify an object on the endpoint."
                    type: "array"
                    items:
                      type: string
                  import:
                    description: "A list of attributes which gets used to uniquely identify an object on the endpoint."
                    type: "array"
                    items:
                      type: string
                  flush:
                    description: "If true and the endpoint is of type source, the endpoint gets flushed before export. If the type is destination, the endpoints collection gets flushed before import. Pay attention with flush as it may result in data loss!"
                    type: "boolean"
                    default: false
                  filter_one:
                    description: "Specify an endpoint filter which gets used to filter for a single object."
                    type: "string"
                  filter_all:
                    description: "Specify a filter which always gets applied to the endpoint if objects are retrieved."
                    type: "string"
  PdoEndpoint:
    description: "Pdo endpoint"
    allOf:
      - $ref: '#/definitions/Endpoint'
      - type: object
        required:
          - rootCause
        properties:
          kind:
            description: "The type of endpoint. Always PdoEndpoint."
            type: "string"
            default: "PdoEndpoint"
          data:
            properties:
              table:
                description: "Table or view"
                type: "string"
              resource:
                description: "Holds the relevant options of how to connect to the endpoint."
                type: "object"
                properties:
                  dsn:
                    description: "Data source name (DSN)."
                    type: string
                  username:
                    description: "Username if required."
                    type: string
                  passwd:
                    description: "Password if required. Note the password gets encrypted on the server an can't be retrieved after it. If a password was set, has_password will be true."
                    type: string
                  has_password:
                    description: "Is true if a password has been set."
                    type: boolean
                    default: false
                  options:
                    description: "Driver specific connection options."
                    type: object
                    default: {}
  MysqlEndpoint:
    description: "MySQL/MariaDB (and other MySQL forks) endpoint"
    allOf:
      - $ref: '#/definitions/Endpoint'
      - type: object
        required:
          - rootCause
        properties:
          kind:
            description: "The type of endpoint. Always MysqlEndpoint."
            type: "string"
            default: "MysqlEndpoint"
          data:
            properties:
              table:
                description: "Table or view"
                type: "string"
              resource:
                description: "Holds the relevant options of how to connect to the endpoint."
                type: "object"
                properties:
                  host:
                    description: "MySQL Server (Or compatible MySQL fork like MariaDB)."
                    type: string
                  username:
                    description: "Username."
                    type: string
                  passwd:
                    description: "Password if required. Note the password gets encrypted on the server an can't be retrieved after it. If a password was set, has_password will be true."
                    type: string
                  has_password:
                    description: "Is true if a password has been set."
                    type: boolean
                    default: false
                  port:
                    description: "Specifies the port number to attempt to connect to the MySQL server."
                    type: integer
                    default: 3306
                  socket:
                    description: "Specifies the socket or named pipe that should be used."
                    type: string
  LdapEndpoint:
    description: "LDAP (OpenLDAP, Microsoft AD and other LDAP compatible Server) endpoint"
    allOf:
      - $ref: '#/definitions/Endpoint'
      - type: object
        required:
          - rootCause
        properties:
          kind:
            description: "The type of endpoint. Always LdapEndpoint."
            type: "string"
            default: "LdapEndpoint"
          data:
            properties:
              resource:
                description: "Holds the relevant options of how to connect to the endpoint."
                type: "object"
                properties:
                  uri:
                    description: "A full LDAP URI of the form ldap://hostname:port or ldaps://hostname:port for SSL encryption."
                    type: string
                  binddn:
                    description: "Bind DN if required."
                    type: string
                  bindpw:
                    description: "Bind password if required. Note the password gets encrypted on the server an can't be retrieved after it. If a password was set, has_password will be true."
                    type: string
                  has_password:
                    description: "Is true if a password has been set."
                    type: boolean
                    default: false
                  basedn:
                    description: "Specifies the base dn (Like dc=example,dc=net)."
                    type: string
                  tls:
                    description: "Set to true if TLS shall be used."
                    type: boolean
                    default: false
                  options:
                    description: "More ldap specific settings (http://php.net/manual/en/function.ldap-set-option.php)."
                    type: object
  OdataRestEndpoint:
    description: "OData REST API endpoint (Compatible with Microsoft graph (Office365 and more) and other OData compatible api's)"
    allOf:
      - $ref: '#/definitions/Endpoint'
      - type: object
        required:
          - rootCause
        properties:
          kind:
            description: "The type of endpoint. Always OdataRestEndpoint."
            type: "string"
            default: "OdataRestEndpoint"
          data:
            properties:
              resource:
                description: "Holds the relevant options of how to connect to the endpoint."
                type: "object"
                properties:
                  base_uri:
                    description: "Base uri to resources (Like https://rest.api/v1/resources)."
                    type: string
                  options:
                    description: "Advanced request options, see http://docs.guzzlephp.org/en/stable/request-options.html"
                    type: object
                  auth:
                    description: "Authentication adapter, either of none, http basic authentication or oauth2 using client_credentials flow."
                    type: string
                    enum:
                      - basic
                      - oauth2
                  basic:
                    description: "HTTP Basic authentication. auth must be set to basic if this adapter should be used."
                    type: object
                    properties:
                      username:
                        description: "Basic authentication username."
                        type: string
                      password:
                        description: "Password if required. Note the password gets encrypted on the server an can't be retrieved after it. If a password was set, has_password will be true."
                        type: string
                      has_password:
                        description: "Is true if a password has been set."
                        type: boolean
                        default: false
                  oauth2:
                    description: "Oauth2 client credentials flow. auth must be set to oauth2 if this adapter should be used."
                    type: object
                    properties:
                      token_uri:
                        description: "URI to token endpoint."
                        type: string
                      client_id:
                        description: "OAuth2 client_id."
                        type: string
                      client_secret:
                        description: "OAuth2 client_secret. Note the client_secret gets encrypted on the server an can't be retrieved after it."
                        type: string
  MongodbEndpoint:
    description: "MongoDB endpoint"
    allOf:
      - $ref: '#/definitions/Endpoint'
      - type: object
        required:
          - rootCause
        properties:
          kind:
            description: "The type of endpoint. Always MongodbEndpoint."
            type: "string"
            default: "MongodbEndpoint"
          data:
            properties:
              collection:
                description: "The name of the MongoDB collection where the data is located at."
                type: string
              resource:
                description: "Holds the relevant options of how to connect to the endpoint."
                type: "object"
                properties:
                  uri:
                    description: "MongoDB connection uri"
                    type: string
                    default: "mongodb://127.0.0.1"
                  uri_options:
                    description: "Advanced URI options"
                    type: object
                    default: {}
                  driver_options:
                    description: "Advanced Driver options"
                    type: object
                    default: {}
  BalloonEndpoint:
    description: "Balloon cloud server endpoint"
    allOf:
      - $ref: '#/definitions/Endpoint'
      - type: object
        required:
          - rootCause
        properties:
          kind:
            description: "The type of endpoint. Always BalloonEndpoint."
            type: "string"
            default: "BalloonEndpoint"
          data:
            properties:
              resource:
                description: "Holds the relevant options of how to connect to the endpoint."
                type: "object"
                properties:
                  base_uri:
                    description: "Base uri to resources (Like https://rest.api/v2/users)."
                    type: string
                  options:
                    description: "Advanced request options, see http://docs.guzzlephp.org/en/stable/request-options.html"
                    type: object
                  auth:
                    description: "Authentication adapter, either of none, http basic authentication or oauth2 using client_credentials flow."
                    type: string
                    enum:
                      - basic
                      - oauth2
                  basic:
                    description: "HTTP Basic authentication. auth must be set to basic if this adapter should be used."
                    type: object
                    properties:
                      username:
                        description: "Basic authentication username."
                        type: string
                      password:
                        description: "Password if required. Note the password gets encrypted on the server an can't be retrieved after it. If a password was set, has_password will be true."
                        type: string
                      has_password:
                        description: "Is true if a password has been set."
                        type: boolean
                        default: false
                  oauth2:
                    description: "Oauth2 client credentials flow. auth must be set to oauth2 if this adapter should be used."
                    type: object
                    properties:
                      token_uri:
                        description: "URI to token endpoint."
                        type: string
                      client_id:
                        description: "OAuth2 client_id."
                        type: string
                      client_secret:
                        description: "OAuth2 client_secret. Note the client_secret gets encrypted on the server an can't be retrieved after it."
                        type: string
  CsvEndpoint:
    description: "CSV data format endpoint"
    allOf:
      - $ref: '#/definitions/Endpoint'
      - type: object
        required:
          - rootCause
        properties:
          kind:
            description: "The type of endpoint. Always CsvEndpoint."
            type: "string"
            default: "CsvEndpoint"
          data:
            properties:
              storage:
                $ref: '#/definitions/Storage'
              file:
                description: "File uri or pattern, depends what storage you have choosen."
                type: string
              resource:
                description: "CSV parse options."
                type: object
                properties:
                  delimiter:
                    description: "Field delimiter."
                    type: string
                    default: ","
                  enclosure:
                    description: "Field enclosure."
                    type: string
                    default: '"'
                  escape:
                    description: "Escape character."
                    type: string
                    default: "\\"
  XmlEndpoint:
    description: "XML data format endpoint"
    allOf:
      - $ref: '#/definitions/Endpoint'
      - type: object
        required:
          - rootCause
        properties:
          kind:
            description: "The type of endpoint. Always XmlEndpoint."
            type: "string"
            default: "XmlEndpoint"
          data:
            properties:
              storage:
                $ref: '#/definitions/Storage'
              file:
                description: "File uri or pattern, depends what storage you have choosen."
                type: string
              resource:
                description: "CSV parse options."
                type: object
                properties:
                  root_name:
                    description: "The name of the root element."
                    type: string
                    default: "data"
                  node_name:
                    description: "The name of the sub node of the root element. For example: <root><row><a>0</a></row><a>1</a><row></row</root>"
                    type: string
                    default: "row"
                  pretty:
                    description: "Prettify xml output, note this is only useful if the XmlEndpoint is a destination endpoint."
                    type: boolean
                    default: true
                  preserve_whitespace:
                    description: "Preserve whitespace, note this is only useful if the XmlEndpoint is a destination endpoint."
                    type: boolean
                    default: false
  JsonEndpoint:
    description: "JSON data format endpoint"
    allOf:
      - $ref: '#/definitions/Endpoint'
      - type: object
        required:
          - rootCause
        properties:
          kind:
            description: "The type of endpoint. Always JsonEndpoint."
            type: "string"
            default: "JsonEndpoint"
          data:
            properties:
              storage:
                $ref: '#/definitions/Storage'
              file:
                description: "File uri or pattern, depends what storage you have choosen."
                type: string
  Storage:
    description: "The storage defines where data can be fetched."
    type: object
    properties:
      kind:
        description: "The kind of storage where data shall be fetched."
        type: string
        default: "Stream"
        enum:
          - Stream
          - LocalFilesystem
          - Smb
          - Balloon
  Workflows:
    description: "A list of workflows."
    allOf:
      - $ref: '#/definitions/List'
      - type: object
        required:
          - rootCause
        properties:
          data:
            type: "array"
            items:
              $ref: "#/definitions/Workflow"
  Workflow:
    description: "A workflow gets used if an endpoint gets imported or exported. A workflow defines if and what object and also if and what attributes of an object should be written to or from an endpoint."
    allOf:
      - $ref: '#/definitions/Resource'
      - type: object
        required:
          - rootCause
        properties:
          kind:
            description: "The resource type, always Workflow."
            type: "string"
            default: "Workflow"
          data:
            type: "object"
            properties:
              ensure:
                type: string
                enum:
                  - last
                  - exists
                  - absent
                  - merge
                default: last
              condition:
                description: "Holds a scripted condition if a given workflow gets matched and executed."
                type: string
              map:
                description: "Map attributes from the endpoint to the collection schema (if the endpoint is of type source) or map attributes from the collection to the endpoint if the endpoint is of type destination."
                type: object
                default: {}
  AttributeMap:
    type: "object"
    properties:
      map:
        type: "object"
        description: "Attribute map"
  EndpointObjects:
    description: "A list of endpoint objects."
    allOf:
      - $ref: '#/definitions/List'
      - type: object
        required:
          - rootCause
        properties:
          kind:
            description: "The resource type, always EndpointObject."
            type: "string"
            default: "EndpointObject"
          data:
            type: "array"
            items:
              $ref: "#/definitions/EndpointObject"
  EndpointObject:
    description: "An endpoint object is the actual object on an endpoint itself."
    allOf:
      - $ref: '#/definitions/Resource'
      - type: object
        required:
          - rootCause
        properties:
          data:
            description: "Attributes"
            type: "object"
  DataObjects:
    description: "List of data objects."
    allOf:
      - $ref: '#/definitions/List'
      - type: object
        required:
          - rootCause
        properties:
          data:
            type: "array"
            items:
              $ref: "#/definitions/DataObject"
  DataObject:
    description: "A data object represents a single object in a collection (data collection)."
    allOf:
      - $ref: '#/definitions/Resource'
      - type: object
        required:
          - rootCause
        properties:
          kind:
            description: "The resource type, always DataObject."
            type: "string"
            default: "DataObject"
          data:
            description: "Attributes"
            type: "object"
  ObjectRelatives:
    description: "A list of related objects."
    allOf:
      - $ref: '#/definitions/List'
      - type: object
        required:
          - rootCause
        properties:
          data:
            type: "array"
            items:
              $ref: "#/definitions/ObjectRelative"
  ObjectRelative:
    description: "An object relation represents a releationship between two data objects. A relationship may apply to objects of different collections and/or namespaces."
    allOf:
      - $ref: '#/definitions/Resource'
      - type: object
        required:
          - rootCause
        properties:
          kind:
            description: "The resource type, always Namespace."
            type: "string"
            default: "Namespace"
          data:
            type: object
            properties:
              context:
                description: "Optional context context data which describes the relationship."
                type: "object"
                default: {}
              object:
                $ref: "#/definitions/DataObject"