info:
  contact:
    email: support@3djuump.com
    url: 3djuump.com
  description: "HTTP API of the Document indexer used by the generator to retrieve\
    \ documents. The Document indexer could be replaced by an ElasticSearch index,\
    \ or any custom implementation that provide the same _search endpoint.\n\n## Flow\
    \ types\n\n\n\n ### Flow `back.connector`\n\nMachine to Machine : Connector, PSConverter,\
    \ Generator flow"
  license:
    name: Close Source
  title: 3D Juump Infinite CLI doc indexer API
  version: 4.1.24.7186-9a016eff14406b1e
openapi: 3.0.0
paths:
  /:
    get:
      description: "Redirects '/' to './docindexer/api/getversion'.\n\n## Authentication\n\
        \nSee `Overview` for schema and flow description\nThis route is authorized\
        \ only when fulfilling one of the schemas described below.\n  - 1: Without\
        \ authentication on vhost accepting one of following flow : `back.connector`\n\
        \n"
      responses:
        '302':
          description: n/a
          headers:
            location:
              schema:
                description: Absolute or relative redirect location.
                format: url
                maxLength: 8096
                pattern: ^(\.{1,2}|https?:\/)\/.*$
                type: string
        '400':
          content:
            application/json; charset=utf-8:
              schema:
                additionalProperties: false
                description: Error object return by HTTP API endpoints.
                properties:
                  code:
                    description: '`E_BadContentType`: <br/>`E_BadMethod_405`: <br/>`E_Conflict_409`:
                      <br/>`E_Disabled_403`: <br/>`E_Forbidden_403`: <br/>`E_InternalError`:
                      <br/>`E_InternalServerError_500`: <br/>`E_InvalidBody`: <br/>`E_InvalidHttpMethod`:
                      <br/>`E_InvalidIpStack`: <br/>`E_InvalidLicense_403`: <br/>`E_InvalidParameter`:
                      <br/>`E_InvalidRequest`: <br/>`E_Missing_404`: <br/>`E_No_Error`:
                      <br/>`E_ServiceUnavailable_503`: <br/>`E_TooManyRequests_429`:
                      <br/>`E_Unauthorized_401`: <br/>`E_UnknownError`:'
                    enum:
                    - E_BadContentType
                    - E_BadMethod_405
                    - E_Conflict_409
                    - E_Disabled_403
                    - E_Forbidden_403
                    - E_InternalError
                    - E_InternalServerError_500
                    - E_InvalidBody
                    - E_InvalidHttpMethod
                    - E_InvalidIpStack
                    - E_InvalidLicense_403
                    - E_InvalidParameter
                    - E_InvalidRequest
                    - E_Missing_404
                    - E_No_Error
                    - E_ServiceUnavailable_503
                    - E_TooManyRequests_429
                    - E_Unauthorized_401
                    - E_UnknownError
                    type: string
                  datetime:
                    description: ''
                    type: string
                  error:
                    description: ''
                    enum:
                    - true
                    type: boolean
                  errorinfo:
                    items:
                      type: string
                    type: array
                  source:
                    description: Information on error emitter.
                    example: directory http api
                    maxLength: 32
                    type: string
                  uuid:
                    description: An identifier to retrieve more information from backend
                      logs, if provided by the client this will contain the value
                      of the X-Request-ID header.
                    type: string
                required:
                - error
                - code
                - uuid
                type: object
          description: JSON generic error.
        '403':
          content:
            application/json; charset=utf-8:
              schema:
                additionalProperties: false
                description: Error object return by HTTP API endpoints.
                properties:
                  code:
                    description: '`E_BadContentType`: <br/>`E_BadMethod_405`: <br/>`E_Conflict_409`:
                      <br/>`E_Disabled_403`: <br/>`E_Forbidden_403`: <br/>`E_InternalError`:
                      <br/>`E_InternalServerError_500`: <br/>`E_InvalidBody`: <br/>`E_InvalidHttpMethod`:
                      <br/>`E_InvalidIpStack`: <br/>`E_InvalidLicense_403`: <br/>`E_InvalidParameter`:
                      <br/>`E_InvalidRequest`: <br/>`E_Missing_404`: <br/>`E_No_Error`:
                      <br/>`E_ServiceUnavailable_503`: <br/>`E_TooManyRequests_429`:
                      <br/>`E_Unauthorized_401`: <br/>`E_UnknownError`:'
                    enum:
                    - E_BadContentType
                    - E_BadMethod_405
                    - E_Conflict_409
                    - E_Disabled_403
                    - E_Forbidden_403
                    - E_InternalError
                    - E_InternalServerError_500
                    - E_InvalidBody
                    - E_InvalidHttpMethod
                    - E_InvalidIpStack
                    - E_InvalidLicense_403
                    - E_InvalidParameter
                    - E_InvalidRequest
                    - E_Missing_404
                    - E_No_Error
                    - E_ServiceUnavailable_503
                    - E_TooManyRequests_429
                    - E_Unauthorized_401
                    - E_UnknownError
                    type: string
                  datetime:
                    description: ''
                    type: string
                  error:
                    description: ''
                    enum:
                    - true
                    type: boolean
                  errorinfo:
                    items:
                      type: string
                    type: array
                  source:
                    description: Information on error emitter.
                    example: directory http api
                    maxLength: 32
                    type: string
                  uuid:
                    description: An identifier to retrieve more information from backend
                      logs, if provided by the client this will contain the value
                      of the X-Request-ID header.
                    type: string
                required:
                - error
                - code
                - uuid
                type: object
          description: JSON generic error.
      security:
      - noauth: []
  /docindexer/api:
    get:
      description: "Redirects '/docindexer/api' to './api/getversion'.\n\n## Authentication\n\
        \nSee `Overview` for schema and flow description\nThis route is authorized\
        \ only when fulfilling one of the schemas described below.\n  - 1: Without\
        \ authentication on vhost accepting one of following flow : `back.connector`\n\
        \n"
      responses:
        '302':
          description: n/a
          headers:
            location:
              schema:
                description: Absolute or relative redirect location.
                format: url
                maxLength: 8096
                pattern: ^(\.{1,2}|https?:\/)\/.*$
                type: string
        '400':
          content:
            application/json; charset=utf-8:
              schema:
                additionalProperties: false
                description: Error object return by HTTP API endpoints.
                properties:
                  code:
                    description: '`E_BadContentType`: <br/>`E_BadMethod_405`: <br/>`E_Conflict_409`:
                      <br/>`E_Disabled_403`: <br/>`E_Forbidden_403`: <br/>`E_InternalError`:
                      <br/>`E_InternalServerError_500`: <br/>`E_InvalidBody`: <br/>`E_InvalidHttpMethod`:
                      <br/>`E_InvalidIpStack`: <br/>`E_InvalidLicense_403`: <br/>`E_InvalidParameter`:
                      <br/>`E_InvalidRequest`: <br/>`E_Missing_404`: <br/>`E_No_Error`:
                      <br/>`E_ServiceUnavailable_503`: <br/>`E_TooManyRequests_429`:
                      <br/>`E_Unauthorized_401`: <br/>`E_UnknownError`:'
                    enum:
                    - E_BadContentType
                    - E_BadMethod_405
                    - E_Conflict_409
                    - E_Disabled_403
                    - E_Forbidden_403
                    - E_InternalError
                    - E_InternalServerError_500
                    - E_InvalidBody
                    - E_InvalidHttpMethod
                    - E_InvalidIpStack
                    - E_InvalidLicense_403
                    - E_InvalidParameter
                    - E_InvalidRequest
                    - E_Missing_404
                    - E_No_Error
                    - E_ServiceUnavailable_503
                    - E_TooManyRequests_429
                    - E_Unauthorized_401
                    - E_UnknownError
                    type: string
                  datetime:
                    description: ''
                    type: string
                  error:
                    description: ''
                    enum:
                    - true
                    type: boolean
                  errorinfo:
                    items:
                      type: string
                    type: array
                  source:
                    description: Information on error emitter.
                    example: directory http api
                    maxLength: 32
                    type: string
                  uuid:
                    description: An identifier to retrieve more information from backend
                      logs, if provided by the client this will contain the value
                      of the X-Request-ID header.
                    type: string
                required:
                - error
                - code
                - uuid
                type: object
          description: JSON generic error.
        '403':
          content:
            application/json; charset=utf-8:
              schema:
                additionalProperties: false
                description: Error object return by HTTP API endpoints.
                properties:
                  code:
                    description: '`E_BadContentType`: <br/>`E_BadMethod_405`: <br/>`E_Conflict_409`:
                      <br/>`E_Disabled_403`: <br/>`E_Forbidden_403`: <br/>`E_InternalError`:
                      <br/>`E_InternalServerError_500`: <br/>`E_InvalidBody`: <br/>`E_InvalidHttpMethod`:
                      <br/>`E_InvalidIpStack`: <br/>`E_InvalidLicense_403`: <br/>`E_InvalidParameter`:
                      <br/>`E_InvalidRequest`: <br/>`E_Missing_404`: <br/>`E_No_Error`:
                      <br/>`E_ServiceUnavailable_503`: <br/>`E_TooManyRequests_429`:
                      <br/>`E_Unauthorized_401`: <br/>`E_UnknownError`:'
                    enum:
                    - E_BadContentType
                    - E_BadMethod_405
                    - E_Conflict_409
                    - E_Disabled_403
                    - E_Forbidden_403
                    - E_InternalError
                    - E_InternalServerError_500
                    - E_InvalidBody
                    - E_InvalidHttpMethod
                    - E_InvalidIpStack
                    - E_InvalidLicense_403
                    - E_InvalidParameter
                    - E_InvalidRequest
                    - E_Missing_404
                    - E_No_Error
                    - E_ServiceUnavailable_503
                    - E_TooManyRequests_429
                    - E_Unauthorized_401
                    - E_UnknownError
                    type: string
                  datetime:
                    description: ''
                    type: string
                  error:
                    description: ''
                    enum:
                    - true
                    type: boolean
                  errorinfo:
                    items:
                      type: string
                    type: array
                  source:
                    description: Information on error emitter.
                    example: directory http api
                    maxLength: 32
                    type: string
                  uuid:
                    description: An identifier to retrieve more information from backend
                      logs, if provided by the client this will contain the value
                      of the X-Request-ID header.
                    type: string
                required:
                - error
                - code
                - uuid
                type: object
          description: JSON generic error.
      security:
      - noauth: []
  /docindexer/api/:
    get:
      description: "Redirects '/docindexer/api/' to './getversion'.\n\n## Authentication\n\
        \nSee `Overview` for schema and flow description\nThis route is authorized\
        \ only when fulfilling one of the schemas described below.\n  - 1: Without\
        \ authentication on vhost accepting one of following flow : `back.connector`\n\
        \n"
      responses:
        '302':
          description: n/a
          headers:
            location:
              schema:
                description: Absolute or relative redirect location.
                format: url
                maxLength: 8096
                pattern: ^(\.{1,2}|https?:\/)\/.*$
                type: string
        '400':
          content:
            application/json; charset=utf-8:
              schema:
                additionalProperties: false
                description: Error object return by HTTP API endpoints.
                properties:
                  code:
                    description: '`E_BadContentType`: <br/>`E_BadMethod_405`: <br/>`E_Conflict_409`:
                      <br/>`E_Disabled_403`: <br/>`E_Forbidden_403`: <br/>`E_InternalError`:
                      <br/>`E_InternalServerError_500`: <br/>`E_InvalidBody`: <br/>`E_InvalidHttpMethod`:
                      <br/>`E_InvalidIpStack`: <br/>`E_InvalidLicense_403`: <br/>`E_InvalidParameter`:
                      <br/>`E_InvalidRequest`: <br/>`E_Missing_404`: <br/>`E_No_Error`:
                      <br/>`E_ServiceUnavailable_503`: <br/>`E_TooManyRequests_429`:
                      <br/>`E_Unauthorized_401`: <br/>`E_UnknownError`:'
                    enum:
                    - E_BadContentType
                    - E_BadMethod_405
                    - E_Conflict_409
                    - E_Disabled_403
                    - E_Forbidden_403
                    - E_InternalError
                    - E_InternalServerError_500
                    - E_InvalidBody
                    - E_InvalidHttpMethod
                    - E_InvalidIpStack
                    - E_InvalidLicense_403
                    - E_InvalidParameter
                    - E_InvalidRequest
                    - E_Missing_404
                    - E_No_Error
                    - E_ServiceUnavailable_503
                    - E_TooManyRequests_429
                    - E_Unauthorized_401
                    - E_UnknownError
                    type: string
                  datetime:
                    description: ''
                    type: string
                  error:
                    description: ''
                    enum:
                    - true
                    type: boolean
                  errorinfo:
                    items:
                      type: string
                    type: array
                  source:
                    description: Information on error emitter.
                    example: directory http api
                    maxLength: 32
                    type: string
                  uuid:
                    description: An identifier to retrieve more information from backend
                      logs, if provided by the client this will contain the value
                      of the X-Request-ID header.
                    type: string
                required:
                - error
                - code
                - uuid
                type: object
          description: JSON generic error.
        '403':
          content:
            application/json; charset=utf-8:
              schema:
                additionalProperties: false
                description: Error object return by HTTP API endpoints.
                properties:
                  code:
                    description: '`E_BadContentType`: <br/>`E_BadMethod_405`: <br/>`E_Conflict_409`:
                      <br/>`E_Disabled_403`: <br/>`E_Forbidden_403`: <br/>`E_InternalError`:
                      <br/>`E_InternalServerError_500`: <br/>`E_InvalidBody`: <br/>`E_InvalidHttpMethod`:
                      <br/>`E_InvalidIpStack`: <br/>`E_InvalidLicense_403`: <br/>`E_InvalidParameter`:
                      <br/>`E_InvalidRequest`: <br/>`E_Missing_404`: <br/>`E_No_Error`:
                      <br/>`E_ServiceUnavailable_503`: <br/>`E_TooManyRequests_429`:
                      <br/>`E_Unauthorized_401`: <br/>`E_UnknownError`:'
                    enum:
                    - E_BadContentType
                    - E_BadMethod_405
                    - E_Conflict_409
                    - E_Disabled_403
                    - E_Forbidden_403
                    - E_InternalError
                    - E_InternalServerError_500
                    - E_InvalidBody
                    - E_InvalidHttpMethod
                    - E_InvalidIpStack
                    - E_InvalidLicense_403
                    - E_InvalidParameter
                    - E_InvalidRequest
                    - E_Missing_404
                    - E_No_Error
                    - E_ServiceUnavailable_503
                    - E_TooManyRequests_429
                    - E_Unauthorized_401
                    - E_UnknownError
                    type: string
                  datetime:
                    description: ''
                    type: string
                  error:
                    description: ''
                    enum:
                    - true
                    type: boolean
                  errorinfo:
                    items:
                      type: string
                    type: array
                  source:
                    description: Information on error emitter.
                    example: directory http api
                    maxLength: 32
                    type: string
                  uuid:
                    description: An identifier to retrieve more information from backend
                      logs, if provided by the client this will contain the value
                      of the X-Request-ID header.
                    type: string
                required:
                - error
                - code
                - uuid
                type: object
          description: JSON generic error.
      security:
      - noauth: []
  /docindexer/api/_doc/{docid}:
    get:
      description: "Fetch a single document.\n\n## Authentication\n\nSee `Overview`\
        \ for schema and flow description\nThis route is authorized only when fulfilling\
        \ one of the schemas described below.\n  - 1: Without authentication on vhost\
        \ accepting one of following flow : `back.connector`\n\n"
      parameters:
      - description: Body is limited to 256MB.
        in: header
        name: content-length
        required: true
        schema:
          maximum: 268435456
          type: integer
      - description: Document id.
        in: path
        name: docid
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json; charset=utf-8:
              schema:
                additionalProperties: true
                type: object
          description: n/a
        '400':
          content:
            application/json; charset=utf-8:
              schema:
                additionalProperties: false
                description: Error object return by HTTP API endpoints.
                properties:
                  code:
                    description: '`E_BadContentType`: <br/>`E_BadMethod_405`: <br/>`E_Conflict_409`:
                      <br/>`E_Disabled_403`: <br/>`E_Forbidden_403`: <br/>`E_InternalError`:
                      <br/>`E_InternalServerError_500`: <br/>`E_InvalidBody`: <br/>`E_InvalidHttpMethod`:
                      <br/>`E_InvalidIpStack`: <br/>`E_InvalidLicense_403`: <br/>`E_InvalidParameter`:
                      <br/>`E_InvalidRequest`: <br/>`E_Missing_404`: <br/>`E_No_Error`:
                      <br/>`E_ServiceUnavailable_503`: <br/>`E_TooManyRequests_429`:
                      <br/>`E_Unauthorized_401`: <br/>`E_UnknownError`:'
                    enum:
                    - E_BadContentType
                    - E_BadMethod_405
                    - E_Conflict_409
                    - E_Disabled_403
                    - E_Forbidden_403
                    - E_InternalError
                    - E_InternalServerError_500
                    - E_InvalidBody
                    - E_InvalidHttpMethod
                    - E_InvalidIpStack
                    - E_InvalidLicense_403
                    - E_InvalidParameter
                    - E_InvalidRequest
                    - E_Missing_404
                    - E_No_Error
                    - E_ServiceUnavailable_503
                    - E_TooManyRequests_429
                    - E_Unauthorized_401
                    - E_UnknownError
                    type: string
                  datetime:
                    description: ''
                    type: string
                  error:
                    description: ''
                    enum:
                    - true
                    type: boolean
                  errorinfo:
                    items:
                      type: string
                    type: array
                  source:
                    description: Information on error emitter.
                    example: directory http api
                    maxLength: 32
                    type: string
                  uuid:
                    description: An identifier to retrieve more information from backend
                      logs, if provided by the client this will contain the value
                      of the X-Request-ID header.
                    type: string
                required:
                - error
                - code
                - uuid
                type: object
          description: JSON generic error.
        '403':
          content:
            application/json; charset=utf-8:
              schema:
                additionalProperties: false
                description: Error object return by HTTP API endpoints.
                properties:
                  code:
                    description: '`E_BadContentType`: <br/>`E_BadMethod_405`: <br/>`E_Conflict_409`:
                      <br/>`E_Disabled_403`: <br/>`E_Forbidden_403`: <br/>`E_InternalError`:
                      <br/>`E_InternalServerError_500`: <br/>`E_InvalidBody`: <br/>`E_InvalidHttpMethod`:
                      <br/>`E_InvalidIpStack`: <br/>`E_InvalidLicense_403`: <br/>`E_InvalidParameter`:
                      <br/>`E_InvalidRequest`: <br/>`E_Missing_404`: <br/>`E_No_Error`:
                      <br/>`E_ServiceUnavailable_503`: <br/>`E_TooManyRequests_429`:
                      <br/>`E_Unauthorized_401`: <br/>`E_UnknownError`:'
                    enum:
                    - E_BadContentType
                    - E_BadMethod_405
                    - E_Conflict_409
                    - E_Disabled_403
                    - E_Forbidden_403
                    - E_InternalError
                    - E_InternalServerError_500
                    - E_InvalidBody
                    - E_InvalidHttpMethod
                    - E_InvalidIpStack
                    - E_InvalidLicense_403
                    - E_InvalidParameter
                    - E_InvalidRequest
                    - E_Missing_404
                    - E_No_Error
                    - E_ServiceUnavailable_503
                    - E_TooManyRequests_429
                    - E_Unauthorized_401
                    - E_UnknownError
                    type: string
                  datetime:
                    description: ''
                    type: string
                  error:
                    description: ''
                    enum:
                    - true
                    type: boolean
                  errorinfo:
                    items:
                      type: string
                    type: array
                  source:
                    description: Information on error emitter.
                    example: directory http api
                    maxLength: 32
                    type: string
                  uuid:
                    description: An identifier to retrieve more information from backend
                      logs, if provided by the client this will contain the value
                      of the X-Request-ID header.
                    type: string
                required:
                - error
                - code
                - uuid
                type: object
          description: JSON generic error.
      security:
      - noauth: []
  /docindexer/api/_index:
    post:
      description: "Index a batch of documents.\n\n## Authentication\n\nSee `Overview`\
        \ for schema and flow description\nThis route is authorized only when fulfilling\
        \ one of the schemas described below.\n  - 1: Without authentication on vhost\
        \ accepting one of following flow : `back.connector`\n\n"
      parameters:
      - description: Body is limited to 256MB.
        in: header
        name: content-length
        required: true
        schema:
          maximum: 268435456
          type: integer
      requestBody:
        content:
          application/x-ndjson; charset=utf-8:
            schema:
              format: binary
              type: string
        description: X-ndjson stream of JSON pair, a command and the document to index,
          command format is {"id":"...","ts":1,"type":"..."}.
        required: true
      responses:
        '200':
          description: n/a
        '400':
          content:
            application/json; charset=utf-8:
              schema:
                additionalProperties: false
                description: Error object return by HTTP API endpoints.
                properties:
                  code:
                    description: '`E_BadContentType`: <br/>`E_BadMethod_405`: <br/>`E_Conflict_409`:
                      <br/>`E_Disabled_403`: <br/>`E_Forbidden_403`: <br/>`E_InternalError`:
                      <br/>`E_InternalServerError_500`: <br/>`E_InvalidBody`: <br/>`E_InvalidHttpMethod`:
                      <br/>`E_InvalidIpStack`: <br/>`E_InvalidLicense_403`: <br/>`E_InvalidParameter`:
                      <br/>`E_InvalidRequest`: <br/>`E_Missing_404`: <br/>`E_No_Error`:
                      <br/>`E_ServiceUnavailable_503`: <br/>`E_TooManyRequests_429`:
                      <br/>`E_Unauthorized_401`: <br/>`E_UnknownError`:'
                    enum:
                    - E_BadContentType
                    - E_BadMethod_405
                    - E_Conflict_409
                    - E_Disabled_403
                    - E_Forbidden_403
                    - E_InternalError
                    - E_InternalServerError_500
                    - E_InvalidBody
                    - E_InvalidHttpMethod
                    - E_InvalidIpStack
                    - E_InvalidLicense_403
                    - E_InvalidParameter
                    - E_InvalidRequest
                    - E_Missing_404
                    - E_No_Error
                    - E_ServiceUnavailable_503
                    - E_TooManyRequests_429
                    - E_Unauthorized_401
                    - E_UnknownError
                    type: string
                  datetime:
                    description: ''
                    type: string
                  error:
                    description: ''
                    enum:
                    - true
                    type: boolean
                  errorinfo:
                    items:
                      type: string
                    type: array
                  source:
                    description: Information on error emitter.
                    example: directory http api
                    maxLength: 32
                    type: string
                  uuid:
                    description: An identifier to retrieve more information from backend
                      logs, if provided by the client this will contain the value
                      of the X-Request-ID header.
                    type: string
                required:
                - error
                - code
                - uuid
                type: object
          description: JSON generic error.
        '403':
          content:
            application/json; charset=utf-8:
              schema:
                additionalProperties: false
                description: Error object return by HTTP API endpoints.
                properties:
                  code:
                    description: '`E_BadContentType`: <br/>`E_BadMethod_405`: <br/>`E_Conflict_409`:
                      <br/>`E_Disabled_403`: <br/>`E_Forbidden_403`: <br/>`E_InternalError`:
                      <br/>`E_InternalServerError_500`: <br/>`E_InvalidBody`: <br/>`E_InvalidHttpMethod`:
                      <br/>`E_InvalidIpStack`: <br/>`E_InvalidLicense_403`: <br/>`E_InvalidParameter`:
                      <br/>`E_InvalidRequest`: <br/>`E_Missing_404`: <br/>`E_No_Error`:
                      <br/>`E_ServiceUnavailable_503`: <br/>`E_TooManyRequests_429`:
                      <br/>`E_Unauthorized_401`: <br/>`E_UnknownError`:'
                    enum:
                    - E_BadContentType
                    - E_BadMethod_405
                    - E_Conflict_409
                    - E_Disabled_403
                    - E_Forbidden_403
                    - E_InternalError
                    - E_InternalServerError_500
                    - E_InvalidBody
                    - E_InvalidHttpMethod
                    - E_InvalidIpStack
                    - E_InvalidLicense_403
                    - E_InvalidParameter
                    - E_InvalidRequest
                    - E_Missing_404
                    - E_No_Error
                    - E_ServiceUnavailable_503
                    - E_TooManyRequests_429
                    - E_Unauthorized_401
                    - E_UnknownError
                    type: string
                  datetime:
                    description: ''
                    type: string
                  error:
                    description: ''
                    enum:
                    - true
                    type: boolean
                  errorinfo:
                    items:
                      type: string
                    type: array
                  source:
                    description: Information on error emitter.
                    example: directory http api
                    maxLength: 32
                    type: string
                  uuid:
                    description: An identifier to retrieve more information from backend
                      logs, if provided by the client this will contain the value
                      of the X-Request-ID header.
                    type: string
                required:
                - error
                - code
                - uuid
                type: object
          description: JSON generic error.
      security:
      - noauth: []
  /docindexer/api/_search:
    post:
      description: "Fetch documents using elasticsearch like query (see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-search.html).\
        \ This endpoint is used by the generator to retrieve documents.\n\n## Authentication\n\
        \nSee `Overview` for schema and flow description\nThis route is authorized\
        \ only when fulfilling one of the schemas described below.\n  - 1: Without\
        \ authentication on vhost accepting one of following flow : `back.connector`\n\
        \n"
      parameters:
      - description: Body is limited to 64MB.
        in: header
        name: content-length
        required: true
        schema:
          maximum: 67108864
          type: integer
      requestBody:
        content:
          application/json; charset=utf-8:
            schema:
              additionalProperties: false
              properties:
                _source:
                  oneOf:
                  - type: boolean
                  - additionalProperties: false
                    properties:
                      includes:
                        items:
                          minLength: 1
                          type: string
                        minItems: 1
                        type: array
                        uniqueItems: true
                    required:
                    - includes
                    type: object
                query:
                  additionalProperties: false
                  properties:
                    bool:
                      additionalProperties: false
                      properties:
                        minimum_should_match:
                          maximum: 1
                          minimum: 1
                          type: integer
                        should:
                          items:
                            additionalProperties: false
                            properties:
                              bool:
                                additionalProperties: false
                                properties:
                                  filter:
                                    additionalProperties: false
                                    properties:
                                      term:
                                        additionalProperties: false
                                        properties:
                                          type:
                                            minLength: 1
                                            type: string
                                        required:
                                        - type
                                        type: object
                                    required:
                                    - term
                                    type: object
                                  must:
                                    items:
                                      oneOf:
                                      - additionalProperties: false
                                        properties:
                                          range:
                                            additionalProperties: false
                                            properties:
                                              ts:
                                                additionalProperties: false
                                                properties:
                                                  gt:
                                                    minimum: 0
                                                    type: integer
                                                required:
                                                - gt
                                                type: object
                                            required:
                                            - ts
                                            type: object
                                        required:
                                        - range
                                        type: object
                                      - additionalProperties: false
                                        properties:
                                          ids:
                                            additionalProperties: false
                                            properties:
                                              values:
                                                items:
                                                  minLength: 1
                                                  type: string
                                                type: array
                                                uniqueItems: true
                                            required:
                                            - values
                                            type: object
                                        required:
                                        - ids
                                        type: object
                                      - additionalProperties: false
                                        properties:
                                          match_all:
                                            additionalProperties: false
                                            type: object
                                        required:
                                        - match_all
                                        type: object
                                    minItems: 1
                                    type: array
                                required:
                                - must
                                type: object
                            required:
                            - bool
                            type: object
                          minItems: 1
                          type: array
                      required:
                      - should
                      type: object
                  required:
                  - bool
                  type: object
                size:
                  maximum: 10000
                  minimum: 0
                  type: integer
                track_total_hits:
                  oneOf:
                  - type: boolean
                  - type: integer
              required:
              - size
              - _source
              - query
              type: object
        required: true
      responses:
        '200':
          content:
            application/json; charset=utf-8:
              schema:
                additionalProperties: true
                properties:
                  hits:
                    additionalProperties: true
                    properties:
                      hits:
                        items:
                          additionalProperties: true
                          type: object
                        type: array
                      total:
                        additionalProperties: true
                        properties:
                          relation:
                            enum:
                            - eq
                            type: string
                          value:
                            type: integer
                        required:
                        - value
                        - relation
                        type: object
                    required:
                    - total
                    - hits
                    type: object
                required:
                - hits
                type: object
          description: Elasticsearch like query result.
        '400':
          content:
            application/json; charset=utf-8:
              schema:
                additionalProperties: true
                type: object
          description: Elasticsearch like query result.
        '403':
          content:
            application/json; charset=utf-8:
              schema:
                additionalProperties: false
                description: Error object return by HTTP API endpoints.
                properties:
                  code:
                    description: '`E_BadContentType`: <br/>`E_BadMethod_405`: <br/>`E_Conflict_409`:
                      <br/>`E_Disabled_403`: <br/>`E_Forbidden_403`: <br/>`E_InternalError`:
                      <br/>`E_InternalServerError_500`: <br/>`E_InvalidBody`: <br/>`E_InvalidHttpMethod`:
                      <br/>`E_InvalidIpStack`: <br/>`E_InvalidLicense_403`: <br/>`E_InvalidParameter`:
                      <br/>`E_InvalidRequest`: <br/>`E_Missing_404`: <br/>`E_No_Error`:
                      <br/>`E_ServiceUnavailable_503`: <br/>`E_TooManyRequests_429`:
                      <br/>`E_Unauthorized_401`: <br/>`E_UnknownError`:'
                    enum:
                    - E_BadContentType
                    - E_BadMethod_405
                    - E_Conflict_409
                    - E_Disabled_403
                    - E_Forbidden_403
                    - E_InternalError
                    - E_InternalServerError_500
                    - E_InvalidBody
                    - E_InvalidHttpMethod
                    - E_InvalidIpStack
                    - E_InvalidLicense_403
                    - E_InvalidParameter
                    - E_InvalidRequest
                    - E_Missing_404
                    - E_No_Error
                    - E_ServiceUnavailable_503
                    - E_TooManyRequests_429
                    - E_Unauthorized_401
                    - E_UnknownError
                    type: string
                  datetime:
                    description: ''
                    type: string
                  error:
                    description: ''
                    enum:
                    - true
                    type: boolean
                  errorinfo:
                    items:
                      type: string
                    type: array
                  source:
                    description: Information on error emitter.
                    example: directory http api
                    maxLength: 32
                    type: string
                  uuid:
                    description: An identifier to retrieve more information from backend
                      logs, if provided by the client this will contain the value
                      of the X-Request-ID header.
                    type: string
                required:
                - error
                - code
                - uuid
                type: object
          description: JSON generic error.
      security:
      - noauth: []
  /docindexer/api/getversion:
    get:
      description: "Returns the version of the API. Could be used to run API healthcheck.\n\
        \n## Authentication\n\nSee `Overview` for schema and flow description\nThis\
        \ route is authorized only when fulfilling one of the schemas described below.\n\
        \  - 1: Without authentication on vhost accepting one of following flow :\
        \ `back.connector`\n\n"
      responses:
        '200':
          content:
            application/json; charset=utf-8:
              schema:
                additionalProperties: false
                properties:
                  comment:
                    type: string
                  status:
                    description: '- ok: the node is running correctly.<br/>- warning:
                      the node is partly functional, but some services may be unusable
                      or requires attention.<br/>- critical: the node is totally unusable.'
                    enum:
                    - ok
                    - warning
                    - critical
                    type: string
                  statusreasons:
                    description: List of enums describing issues. See administration
                      manual for detailed documentation on Infinite Status Reasons.
                    items:
                      maxLength: 512
                      minLength: 1
                      type: string
                    maxItems: 256
                    minItems: 0
                    type: array
                  timebase:
                    minLength: 1
                    type: string
                  type:
                    enum:
                    - directoryapi
                    - proxyapi
                    - docindexerapi
                    type: string
                  version:
                    additionalProperties: false
                    properties:
                      backend:
                        type: string
                      clientfeature:
                        description: A version number reflecting the feature level
                          version of the client.
                        minLength: 1
                        type: string
                      number:
                        type: string
                    required:
                    - backend
                    - number
                    type: object
                required:
                - comment
                - type
                - version
                type: object
            text/html; charset=utf-8:
              schema:
                type: string
          description: n/a
        '400':
          content:
            application/json; charset=utf-8:
              schema:
                additionalProperties: false
                description: Error object return by HTTP API endpoints.
                properties:
                  code:
                    description: '`E_BadContentType`: <br/>`E_BadMethod_405`: <br/>`E_Conflict_409`:
                      <br/>`E_Disabled_403`: <br/>`E_Forbidden_403`: <br/>`E_InternalError`:
                      <br/>`E_InternalServerError_500`: <br/>`E_InvalidBody`: <br/>`E_InvalidHttpMethod`:
                      <br/>`E_InvalidIpStack`: <br/>`E_InvalidLicense_403`: <br/>`E_InvalidParameter`:
                      <br/>`E_InvalidRequest`: <br/>`E_Missing_404`: <br/>`E_No_Error`:
                      <br/>`E_ServiceUnavailable_503`: <br/>`E_TooManyRequests_429`:
                      <br/>`E_Unauthorized_401`: <br/>`E_UnknownError`:'
                    enum:
                    - E_BadContentType
                    - E_BadMethod_405
                    - E_Conflict_409
                    - E_Disabled_403
                    - E_Forbidden_403
                    - E_InternalError
                    - E_InternalServerError_500
                    - E_InvalidBody
                    - E_InvalidHttpMethod
                    - E_InvalidIpStack
                    - E_InvalidLicense_403
                    - E_InvalidParameter
                    - E_InvalidRequest
                    - E_Missing_404
                    - E_No_Error
                    - E_ServiceUnavailable_503
                    - E_TooManyRequests_429
                    - E_Unauthorized_401
                    - E_UnknownError
                    type: string
                  datetime:
                    description: ''
                    type: string
                  error:
                    description: ''
                    enum:
                    - true
                    type: boolean
                  errorinfo:
                    items:
                      type: string
                    type: array
                  source:
                    description: Information on error emitter.
                    example: directory http api
                    maxLength: 32
                    type: string
                  uuid:
                    description: An identifier to retrieve more information from backend
                      logs, if provided by the client this will contain the value
                      of the X-Request-ID header.
                    type: string
                required:
                - error
                - code
                - uuid
                type: object
          description: JSON generic error.
        '403':
          content:
            application/json; charset=utf-8:
              schema:
                additionalProperties: false
                description: Error object return by HTTP API endpoints.
                properties:
                  code:
                    description: '`E_BadContentType`: <br/>`E_BadMethod_405`: <br/>`E_Conflict_409`:
                      <br/>`E_Disabled_403`: <br/>`E_Forbidden_403`: <br/>`E_InternalError`:
                      <br/>`E_InternalServerError_500`: <br/>`E_InvalidBody`: <br/>`E_InvalidHttpMethod`:
                      <br/>`E_InvalidIpStack`: <br/>`E_InvalidLicense_403`: <br/>`E_InvalidParameter`:
                      <br/>`E_InvalidRequest`: <br/>`E_Missing_404`: <br/>`E_No_Error`:
                      <br/>`E_ServiceUnavailable_503`: <br/>`E_TooManyRequests_429`:
                      <br/>`E_Unauthorized_401`: <br/>`E_UnknownError`:'
                    enum:
                    - E_BadContentType
                    - E_BadMethod_405
                    - E_Conflict_409
                    - E_Disabled_403
                    - E_Forbidden_403
                    - E_InternalError
                    - E_InternalServerError_500
                    - E_InvalidBody
                    - E_InvalidHttpMethod
                    - E_InvalidIpStack
                    - E_InvalidLicense_403
                    - E_InvalidParameter
                    - E_InvalidRequest
                    - E_Missing_404
                    - E_No_Error
                    - E_ServiceUnavailable_503
                    - E_TooManyRequests_429
                    - E_Unauthorized_401
                    - E_UnknownError
                    type: string
                  datetime:
                    description: ''
                    type: string
                  error:
                    description: ''
                    enum:
                    - true
                    type: boolean
                  errorinfo:
                    items:
                      type: string
                    type: array
                  source:
                    description: Information on error emitter.
                    example: directory http api
                    maxLength: 32
                    type: string
                  uuid:
                    description: An identifier to retrieve more information from backend
                      logs, if provided by the client this will contain the value
                      of the X-Request-ID header.
                    type: string
                required:
                - error
                - code
                - uuid
                type: object
          description: JSON generic error.
      security:
      - noauth: []
  /docindexer/api/shutdown:
    put:
      description: "Ask the docindexer to exit. This endpoint should be use to gracefully\
        \ stop the docindexer if CTRL_C/SIGINT could not be send to it.\n\n## Authentication\n\
        \nSee `Overview` for schema and flow description\nThis route is authorized\
        \ only when fulfilling one of the schemas described below.\n  - 1: Without\
        \ authentication on vhost accepting one of following flow : `back.connector`\n\
        \n"
      responses:
        '202':
          description: Request was accepted, wait for exit of the process.
        '400':
          content:
            application/json; charset=utf-8:
              schema:
                additionalProperties: false
                description: Error object return by HTTP API endpoints.
                properties:
                  code:
                    description: '`E_BadContentType`: <br/>`E_BadMethod_405`: <br/>`E_Conflict_409`:
                      <br/>`E_Disabled_403`: <br/>`E_Forbidden_403`: <br/>`E_InternalError`:
                      <br/>`E_InternalServerError_500`: <br/>`E_InvalidBody`: <br/>`E_InvalidHttpMethod`:
                      <br/>`E_InvalidIpStack`: <br/>`E_InvalidLicense_403`: <br/>`E_InvalidParameter`:
                      <br/>`E_InvalidRequest`: <br/>`E_Missing_404`: <br/>`E_No_Error`:
                      <br/>`E_ServiceUnavailable_503`: <br/>`E_TooManyRequests_429`:
                      <br/>`E_Unauthorized_401`: <br/>`E_UnknownError`:'
                    enum:
                    - E_BadContentType
                    - E_BadMethod_405
                    - E_Conflict_409
                    - E_Disabled_403
                    - E_Forbidden_403
                    - E_InternalError
                    - E_InternalServerError_500
                    - E_InvalidBody
                    - E_InvalidHttpMethod
                    - E_InvalidIpStack
                    - E_InvalidLicense_403
                    - E_InvalidParameter
                    - E_InvalidRequest
                    - E_Missing_404
                    - E_No_Error
                    - E_ServiceUnavailable_503
                    - E_TooManyRequests_429
                    - E_Unauthorized_401
                    - E_UnknownError
                    type: string
                  datetime:
                    description: ''
                    type: string
                  error:
                    description: ''
                    enum:
                    - true
                    type: boolean
                  errorinfo:
                    items:
                      type: string
                    type: array
                  source:
                    description: Information on error emitter.
                    example: directory http api
                    maxLength: 32
                    type: string
                  uuid:
                    description: An identifier to retrieve more information from backend
                      logs, if provided by the client this will contain the value
                      of the X-Request-ID header.
                    type: string
                required:
                - error
                - code
                - uuid
                type: object
          description: JSON generic error.
        '403':
          content:
            application/json; charset=utf-8:
              schema:
                additionalProperties: false
                description: Error object return by HTTP API endpoints.
                properties:
                  code:
                    description: '`E_BadContentType`: <br/>`E_BadMethod_405`: <br/>`E_Conflict_409`:
                      <br/>`E_Disabled_403`: <br/>`E_Forbidden_403`: <br/>`E_InternalError`:
                      <br/>`E_InternalServerError_500`: <br/>`E_InvalidBody`: <br/>`E_InvalidHttpMethod`:
                      <br/>`E_InvalidIpStack`: <br/>`E_InvalidLicense_403`: <br/>`E_InvalidParameter`:
                      <br/>`E_InvalidRequest`: <br/>`E_Missing_404`: <br/>`E_No_Error`:
                      <br/>`E_ServiceUnavailable_503`: <br/>`E_TooManyRequests_429`:
                      <br/>`E_Unauthorized_401`: <br/>`E_UnknownError`:'
                    enum:
                    - E_BadContentType
                    - E_BadMethod_405
                    - E_Conflict_409
                    - E_Disabled_403
                    - E_Forbidden_403
                    - E_InternalError
                    - E_InternalServerError_500
                    - E_InvalidBody
                    - E_InvalidHttpMethod
                    - E_InvalidIpStack
                    - E_InvalidLicense_403
                    - E_InvalidParameter
                    - E_InvalidRequest
                    - E_Missing_404
                    - E_No_Error
                    - E_ServiceUnavailable_503
                    - E_TooManyRequests_429
                    - E_Unauthorized_401
                    - E_UnknownError
                    type: string
                  datetime:
                    description: ''
                    type: string
                  error:
                    description: ''
                    enum:
                    - true
                    type: boolean
                  errorinfo:
                    items:
                      type: string
                    type: array
                  source:
                    description: Information on error emitter.
                    example: directory http api
                    maxLength: 32
                    type: string
                  uuid:
                    description: An identifier to retrieve more information from backend
                      logs, if provided by the client this will contain the value
                      of the X-Request-ID header.
                    type: string
                required:
                - error
                - code
                - uuid
                type: object
          description: JSON generic error.
      security:
      - noauth: []
  /docindexer/static/{*}:
    get:
      description: "Docindexer static files.\n\n## Authentication\n\nSee `Overview`\
        \ for schema and flow description\nThis route is authorized only when fulfilling\
        \ one of the schemas described below.\n  - 1: Without authentication on vhost\
        \ accepting one of following flow : `back.connector`\n\n"
      parameters:
      - in: path
        name: '*'
        required: true
        schema:
          format: path
          type: string
      responses:
        '200':
          description: n/a
        '302':
          description: n/a
        '304':
          description: n/a
        '400':
          content:
            text/html; charset=utf-8:
              schema:
                type: string
          description: Html generic error page.
        '403':
          content:
            application/json; charset=utf-8:
              schema:
                additionalProperties: false
                description: Error object return by HTTP API endpoints.
                properties:
                  code:
                    description: '`E_BadContentType`: <br/>`E_BadMethod_405`: <br/>`E_Conflict_409`:
                      <br/>`E_Disabled_403`: <br/>`E_Forbidden_403`: <br/>`E_InternalError`:
                      <br/>`E_InternalServerError_500`: <br/>`E_InvalidBody`: <br/>`E_InvalidHttpMethod`:
                      <br/>`E_InvalidIpStack`: <br/>`E_InvalidLicense_403`: <br/>`E_InvalidParameter`:
                      <br/>`E_InvalidRequest`: <br/>`E_Missing_404`: <br/>`E_No_Error`:
                      <br/>`E_ServiceUnavailable_503`: <br/>`E_TooManyRequests_429`:
                      <br/>`E_Unauthorized_401`: <br/>`E_UnknownError`:'
                    enum:
                    - E_BadContentType
                    - E_BadMethod_405
                    - E_Conflict_409
                    - E_Disabled_403
                    - E_Forbidden_403
                    - E_InternalError
                    - E_InternalServerError_500
                    - E_InvalidBody
                    - E_InvalidHttpMethod
                    - E_InvalidIpStack
                    - E_InvalidLicense_403
                    - E_InvalidParameter
                    - E_InvalidRequest
                    - E_Missing_404
                    - E_No_Error
                    - E_ServiceUnavailable_503
                    - E_TooManyRequests_429
                    - E_Unauthorized_401
                    - E_UnknownError
                    type: string
                  datetime:
                    description: ''
                    type: string
                  error:
                    description: ''
                    enum:
                    - true
                    type: boolean
                  errorinfo:
                    items:
                      type: string
                    type: array
                  source:
                    description: Information on error emitter.
                    example: directory http api
                    maxLength: 32
                    type: string
                  uuid:
                    description: An identifier to retrieve more information from backend
                      logs, if provided by the client this will contain the value
                      of the X-Request-ID header.
                    type: string
                required:
                - error
                - code
                - uuid
                type: object
          description: JSON generic error.
        '404':
          content:
            text/html; charset=utf-8:
              schema:
                type: string
          description: Html generic error page.
      security:
      - noauth: []
      summary: /docindexer/static/{*}
      tags:
      - static
servers: []
