OpenMetadata Search Services API

openapi: 3.0.1
info:
  title: OpenMetadata APIs Agent Executions Search Services API
  description: Common types and API definition for OpenMetadata
  contact:
    name: OpenMetadata
    url: https://open-metadata.org
    email: openmetadata-dev@googlegroups.com
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  version: '1.13'
servers:
- url: /api
  description: Current Host
- url: http://localhost:8585/api
  description: Endpoint URL
security:
- BearerAuth: []
tags:
- name: Search Services
  description: APIs related `Search Service` entities, such as ElasticSearch, OpenSearch.
paths:
  /v1/services/searchServices/{id}/followers:
    put:
      tags:
      - Search Services
      summary: Add a follower
      description: Add a user identified by `userId` as followed of this Search Index service
      operationId: addFollowerToDatabaseService_3
      parameters:
      - name: id
        in: path
        description: Id of the Search Index Service
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        description: Id of the user to be added as follower
        content:
          application/json:
            schema:
              type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChangeEvent'
        '404':
          description: Search Index Service for instance {id} is not found
  /v1/services/searchServices/{id}/testConnectionResult:
    put:
      tags:
      - Search Services
      summary: Add test connection result
      description: Add test connection result to the service.
      operationId: addTestConnectionResult_10
      parameters:
      - name: id
        in: path
        description: Id of the service
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TestConnectionResult'
      responses:
        '200':
          description: Successfully updated the service
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchService'
  /v1/services/searchServices:
    get:
      tags:
      - Search Services
      summary: List search services
      description: Get a list of search services.
      operationId: listSearchServices
      parameters:
      - name: fields
        in: query
        description: Fields requested in the returned resource
        schema:
          type: string
          example: pipelines,owners,tags,domains,followers
      - name: domain
        in: query
        description: Filter services by domain
        schema:
          type: string
          example: Marketing
      - name: limit
        in: query
        schema:
          maximum: 1000000
          minimum: 0
          type: integer
          format: int32
          default: 10
      - name: before
        in: query
        description: Returns list of search services before this cursor
        schema:
          type: string
      - name: after
        in: query
        description: Returns list of search services after this cursor
        schema:
          type: string
      - name: include
        in: query
        description: Include all, deleted, or non-deleted entities.
        schema:
          type: string
          default: non-deleted
          enum:
          - all
          - deleted
          - non-deleted
      responses:
        '200':
          description: List of search service instances
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchServiceList'
    put:
      tags:
      - Search Services
      summary: Update search service
      description: Update an existing or create a new search service.
      operationId: createOrUpdateSearchService
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSearchService'
      responses:
        '200':
          description: Object store service instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchService'
        '400':
          description: Bad request
    post:
      tags:
      - Search Services
      summary: Create search service
      description: Create a new search service.
      operationId: createSearchService
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSearchService'
      responses:
        '200':
          description: Search service instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchService'
        '400':
          description: Bad request
  /v1/services/searchServices/name/{fqn}:
    delete:
      tags:
      - Search Services
      summary: Delete an SearchService by fully qualified name
      description: Delete an SearchService by `fullyQualifiedName`.
      operationId: deleteSearchServiceByFQN
      parameters:
      - name: recursive
        in: query
        description: Recursively delete this entity and it's children. (Default `false`)
        schema:
          type: boolean
          default: false
      - name: hardDelete
        in: query
        description: Hard delete the entity. (Default = `false`)
        schema:
          type: boolean
          default: false
      - name: fqn
        in: path
        description: Name of the SearchService
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
        '404':
          description: SearchService for instance {fqn} is not found
    patch:
      tags:
      - Search Services
      summary: Update an search service using name.
      description: Update an existing search service using JsonPatch.
      externalDocs:
        description: JsonPatch RFC
        url: https://tools.ietf.org/html/rfc6902
      operationId: patchSearchService
      parameters:
      - name: fqn
        in: path
        required: true
        schema:
          type: string
      requestBody:
        description: JsonPatch with array of operations
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/JsonPatch'
            example: '[{op:remove, path:/a},{op:add, path: /b, value: val}]'
      responses:
        default:
          description: default response
          content:
            application/json: {}
  /v1/services/searchServices/{id}:
    get:
      tags:
      - Search Services
      summary: Get an search service
      description: Get an search service by `id`.
      operationId: getSearchServiceByID
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: fields
        in: query
        description: Fields requested in the returned resource
        schema:
          type: string
          example: pipelines,owners,tags,domains,followers
      - name: include
        in: query
        description: Include all, deleted, or non-deleted entities.
        schema:
          type: string
          default: non-deleted
          enum:
          - all
          - deleted
          - non-deleted
      - name: includeRelations
        in: query
        description: 'Per-relation include control. Format: field:value,field2:value2. Example: owners:non-deleted,followers:all. Valid values: all, deleted, non-deleted. If not specified for a field, uses the entity''s include value.'
        schema:
          type: string
          example: owners:non-deleted,followers:all
      responses:
        '200':
          description: search service instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchService'
        '404':
          description: search service for instance {id} is not found
    delete:
      tags:
      - Search Services
      summary: Delete an search service
      description: Delete an search services. If containers belong the service, it can't be deleted.
      operationId: deleteSearchService
      parameters:
      - name: recursive
        in: query
        description: Recursively delete this entity and it's children. (Default `false`)
        schema:
          type: boolean
          default: false
      - name: hardDelete
        in: query
        description: Hard delete the entity. (Default = `false`)
        schema:
          type: boolean
          default: false
      - name: id
        in: path
        description: Id of the search service
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
        '404':
          description: SearchService service for instance {id} is not found
    patch:
      tags:
      - Search Services
      summary: Update an search service
      description: Update an existing search service using JsonPatch.
      externalDocs:
        description: JsonPatch RFC
        url: https://tools.ietf.org/html/rfc6902
      operationId: patchSearchService_1
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        description: JsonPatch with array of operations
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/JsonPatch'
            example: '[{op:remove, path:/a},{op:add, path: /b, value: val}]'
      responses:
        default:
          description: default response
          content:
            application/json: {}
  /v1/services/searchServices/async/{id}:
    delete:
      tags:
      - Search Services
      summary: Asynchronously delete an search service
      description: Asynchronously delete an search services. If containers belong the service, it can't be deleted.
      operationId: deleteSearchServiceAsync
      parameters:
      - name: recursive
        in: query
        description: Recursively delete this entity and it's children. (Default `false`)
        schema:
          type: boolean
          default: false
      - name: hardDelete
        in: query
        description: Hard delete the entity. (Default = `false`)
        schema:
          type: boolean
          default: false
      - name: id
        in: path
        description: Id of the search service
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
        '404':
          description: SearchService service for instance {id} is not found
  /v1/services/searchServices/{id}/followers/{userId}:
    delete:
      tags:
      - Search Services
      summary: Remove a follower
      description: Remove the user identified `userId` as a follower of the entity.
      operationId: deleteFollower_25
      parameters:
      - name: id
        in: path
        description: Id of the Entity
        required: true
        schema:
          type: string
          format: uuid
      - name: userId
        in: path
        description: Id of the user being removed as follower
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChangeEvent'
  /v1/services/searchServices/name/{name}:
    get:
      tags:
      - Search Services
      summary: Get search service by name
      description: Get a search service by the service `name`.
      operationId: getSearchServiceByFQN
      parameters:
      - name: name
        in: path
        required: true
        schema:
          type: string
      - name: fields
        in: query
        description: Fields requested in the returned resource
        schema:
          type: string
          example: pipelines,owners,tags,domains,followers
      - name: include
        in: query
        description: Include all, deleted, or non-deleted entities.
        schema:
          type: string
          default: non-deleted
          enum:
          - all
          - deleted
          - non-deleted
      - name: includeRelations
        in: query
        description: 'Per-relation include control. Format: field:value,field2:value2. Example: owners:non-deleted,followers:all. Valid values: all, deleted, non-deleted. If not specified for a field, uses the entity''s include value.'
        schema:
          type: string
          example: owners:non-deleted,followers:all
      responses:
        '200':
          description: search service instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchService'
        '404':
          description: search service for instance {id} is not found
  /v1/services/searchServices/{id}/versions/{version}:
    get:
      tags:
      - Search Services
      summary: Get a version of the search service
      description: Get a version of the search service by given `id`
      operationId: getSpecificSearchServiceVersion
      parameters:
      - name: id
        in: path
        description: search service Id
        required: true
        schema:
          type: string
      - name: version
        in: path
        description: search service version number in the form `major`.`minor`
        required: true
        schema:
          type: string
          example: 0.1 or 1.1
      responses:
        '200':
          description: search service
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchService'
        '404':
          description: Object store service for instance {id} and version {version} is not found
  /v1/services/searchServices/history:
    get:
      tags:
      - Search Services
      summary: List all entity versions within a time range
      description: 'Get a paginated list of all entity versions within a given time range specified by `startTs` and `endTs` in milliseconds since epoch. '
      operationId: listAllEntityVersionsByTimestamp_51
      parameters:
      - name: startTs
        in: query
        description: Start timestamp in milliseconds since epoch
        required: true
        schema:
          type: integer
          format: int64
      - name: endTs
        in: query
        description: End timestamp in milliseconds since epoch
        required: true
        schema:
          type: integer
          format: int64
      - name: limit
        in: query
        description: Limit the number of entity returned (1 to 1000000, default = 10)
        schema:
          maximum: 500
          minimum: 1
          type: integer
          format: int32
          default: 10
      - name: before
        in: query
        description: Returns list of entity versions before this cursor
        schema:
          type: string
      - name: after
        in: query
        description: Returns list of entity versions after this cursor
        schema:
          type: string
      responses:
        '200':
          description: List of all versions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultList'
  /v1/services/searchServices/{id}/versions:
    get:
      tags:
      - Search Services
      summary: List search service versions
      description: Get a list of all the versions of an search service identified by `id`
      operationId: listAllSearchServiceVersion
      parameters:
      - name: id
        in: path
        description: search service Id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: List of search service versions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityHistory'
  /v1/services/searchServices/restore:
    put:
      tags:
      - Search Services
      summary: Restore a soft deleted SearchService.
      description: Restore a soft deleted SearchService.
      operationId: restore_41
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RestoreEntity'
      responses:
        '200':
          description: Successfully restored the SearchService.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchService'
components:
  schemas:
    TagLabelRecognizerMetadata:
      required:
      - recognizerId
      - recognizerName
      - score
      type: object
      properties:
        recognizerId:
          type: string
          format: uuid
        recognizerName:
          type: string
        score:
          type: number
          format: double
        target:
          type: string
          enum:
          - content
          - column_name
        patterns:
          type: array
          items:
            $ref: '#/components/schemas/PatternMatch'
    ChangeSummaryMap:
      type: object
    AccessDetails:
      required:
      - timestamp
      type: object
      properties:
        timestamp:
          type: integer
          format: int64
        accessedBy:
          $ref: '#/components/schemas/EntityReference'
        accessedByAProcess:
          type: string
    FieldChange:
      type: object
      properties:
        name:
          type: string
        oldValue:
          type: object
        newValue:
          type: object
    CoverImage:
      type: object
      properties:
        url:
          type: string
        position:
          type: string
    RestoreEntity:
      required:
      - id
      type: object
      properties:
        id:
          type: string
          format: uuid
    CreateSearchService:
      required:
      - name
      - serviceType
      type: object
      properties:
        name:
          maxLength: 256
          minLength: 1
          pattern: ^((?!::).)*$
          type: string
        displayName:
          type: string
        description:
          type: string
        serviceType:
          type: string
          enum:
          - ElasticSearch
          - OpenSearch
          - CustomSearch
        connection:
          $ref: '#/components/schemas/SearchConnection'
        tags:
          type: array
          items:
            $ref: '#/components/schemas/TagLabel'
        owners:
          type: array
          items:
            $ref: '#/components/schemas/EntityReference'
        dataProducts:
          type: array
          items:
            type: string
        domains:
          type: array
          items:
            type: string
        ingestionRunner:
          $ref: '#/components/schemas/EntityReference'
        extension:
          type: object
        reviewers:
          type: array
          items:
            $ref: '#/components/schemas/EntityReference'
        lifeCycle:
          $ref: '#/components/schemas/LifeCycle'
    LifeCycle:
      type: object
      properties:
        created:
          $ref: '#/components/schemas/AccessDetails'
        updated:
          $ref: '#/components/schemas/AccessDetails'
        accessed:
          $ref: '#/components/schemas/AccessDetails'
    EntityHistory:
      required:
      - entityType
      - versions
      type: object
      properties:
        entityType:
          type: string
        versions:
          type: array
          items:
            type: object
    AssetCertification:
      required:
      - appliedDate
      - expiryDate
      - tagLabel
      type: object
      properties:
        tagLabel:
          $ref: '#/components/schemas/TagLabel'
        appliedDate:
          type: integer
          format: int64
        expiryDate:
          type: integer
          format: int64
    SearchServiceList:
      required:
      - data
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/SearchService'
        paging:
          $ref: '#/components/schemas/Paging'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/EntityError'
        warningsCount:
          type: integer
          format: int32
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/EntityError'
    ResultList:
      required:
      - data
      type: object
      properties:
        data:
          type: array
          items:
            type: object
        paging:
          $ref: '#/components/schemas/Paging'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/EntityError'
        warningsCount:
          type: integer
          format: int32
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/EntityError'
    Paging:
      required:
      - total
      type: object
      properties:
        before:
          type: string
        after:
          type: string
        offset:
          type: integer
          format: int32
        limit:
          type: integer
          format: int32
        total:
          type: integer
          format: int32
    TestConnectionResult:
      required:
      - steps
      type: object
      properties:
        lastUpdatedAt:
          type: integer
          format: int64
        status:
          type: string
          enum:
          - Successful
          - Failed
          - Running
        steps:
          type: array
          items:
            $ref: '#/components/schemas/TestConnectionStepResult'
    JsonPatch:
      type: object
    ChangeDescription:
      type: object
      properties:
        fieldsAdded:
          type: array
          items:
            $ref: '#/components/schemas/FieldChange'
        fieldsUpdated:
          type: array
          items:
            $ref: '#/components/schemas/FieldChange'
        fieldsDeleted:
          type: array
          items:
            $ref: '#/components/schemas/FieldChange'
        previousVersion:
          type: number
          format: double
        changeSummary:
          $ref: '#/components/schemas/ChangeSummaryMap'
    ChangeEvent:
      required:
      - entityId
      - entityType
      - eventType
      - id
      - timestamp
      type: object
      properties:
        id:
          type: string
          format: uuid
        eventType:
          type: string
          enum:
          - entityCreated
          - entityUpdated
          - entityFieldsChanged
          - entityNoChange
          - entitySoftDeleted
          - entityDeleted
          - entityRestored
          - threadCreated
          - threadUpdated
          - postCreated
          - postUpdated
          - taskResolved
          - taskClosed
          - logicalTestCaseAdded
          - suggestionCreated
          - suggestionUpdated
          - suggestionAccepted
          - suggestionRejected
          - suggestionDeleted
          - userLogin
          - userLogout
        entityType:
          type: string
        entityId:
          type: string
          format: uuid
        domains:
          type: array
          items:
            type: string
            format: uuid
        entityFullyQualifiedName:
          type: string
        previousVersion:
          type: number
          format: double
        currentVersion:
          type: number
          format: double
        userName:
          type: string
        impersonatedBy:
          type: string
        timestamp:
          type: integer
          format: int64
        changeDescription:
          $ref: '#/components/schemas/ChangeDescription'
        incrementalChangeDescription:
          $ref: '#/components/schemas/ChangeDescription'
        entity:
          type: object
    UsageStats:
      required:
      - count
      type: object
      properties:
        count:
          minimum: 0
          exclusiveMinimum: false
          type: integer
          format: int32
        percentileRank:
          type: number
          format: double
    Style:
      type: object
      properties:
        color:
          type: string
        iconURL:
          type: string
        coverImage:
          $ref: '#/components/schemas/CoverImage'
    SearchService:
      required:
      - id
      - name
      - serviceType
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          maxLength: 256
          minLength: 1
          pattern: ^((?!::).)*$
          type: string
        fullyQualifiedName:
          maxLength: 3072
          minLength: 1
          type: string
        displayName:
          type: string
        serviceType:
          type: string
          enum:
          - ElasticSearch
          - OpenSearch
          - CustomSearch
        description:
          type: string
        connection:
          $ref: '#/components/schemas/SearchConnection'
        pipelines:
          type: array
          items:
            $ref: '#/components/schemas/EntityReference'
        testConnectionResult:
          $ref: '#/components/schemas/TestConnectionResult'
        tags:
          type: array
          items:
            $ref: '#/components/schemas/TagLabel'
        version:
          type: number
          format: double
        updatedAt:
          type: integer
          format: int64
        updatedBy:
          type: string
        impersonatedBy:
          type: string
        href:
          type: string
          format: uri
        owners:
          type: array
          items:
            $ref: '#/components/schemas/EntityReference'
        changeDescription:
          $ref: '#/components/schemas/ChangeDescription'
        incrementalChangeDescription:
          $ref: '#/components/schemas/ChangeDescription'
        deleted:
          type: boolean
        entityStatus:
          type: string
          enum:
          - Draft
          - In Review
          - Approved
          - Archived
          - Deprecated
          - Rejected
          - Unprocessed
        dataProducts:
          type: array
          items:
            $ref: '#/components/schemas/EntityReference'
        dataContract:
          $ref: '#/components/schemas/EntityReference'
        followers:
          type: array
          items:
            $ref: '#/components/schemas/EntityReference'
        domains:
          type: array
          items:
            $ref: '#/components/schemas/EntityReference'
        ingestionRunner:
          $ref: '#/components/schemas/EntityReference'
        provider:
          type: string
          enum:
          - system
          - user
          - automation
        extension:
          type: object
        children:
          type: array
          items:
            $ref: '#/components/schemas/EntityReference'
        service:
          $ref: '#/components/schemas/EntityReference'
        style:
          $ref: '#/components/schemas/Style'
        experts:
          type: array
          items:
            $ref: '#/components/schemas/EntityReference'
        reviewers:
          type: array
          items:
            $ref: '#/components/schemas/EntityReference'
        usageSummary:
          $ref: '#/components/schemas/UsageDetails'
        votes:
          $ref: '#/components/schemas/Votes'
        lifeCycle:
          $ref: '#/components/schemas/LifeCycle'
        certification:
          $ref: '#/components/schemas/AssetCertification'
    Votes:
      type: object
      properties:
        upVotes:
          type: integer
          format: int32
        downVotes:
          type: integer
          format: int32
        upVoters:
          type: array
          items:
            $ref: '#/components/schemas/EntityReference'
        downVoters:
          type: array
          items:
            $ref: '#/components/schemas/EntityReference'
    TagLabel:
      required:
      - labelType
      - source
      - state
      - tagFQN
      type: object
      properties:
        tagFQN:
          type: string
        name:
          type: string
        displayName:
          type: string
        description:
          type: string
        style:
          $ref: '#/components/schemas/Style'
        source:
          type: string
          enum:
          - Classification
          - Glossary
        labelType:
          type: string
          enum:
          - Manual
          - Propagated
          - Automated
          - Derived
          - Generated
        state:
          type: string
          enum:
          - Suggested
          - Confirmed
        href:
          type: string
          format: uri
        reason:
          type: string
        appliedAt:
          type: string
          format: date-time
        appliedBy:
          type: string
        metadata:
          $ref: '#/components/schemas/TagLabelMetadata'
    PatternMatch:
      required:
      - name
      - score
      type: object
      properties:
        name:
          type: string
        regex:
          type: string
        score:
          type: number
          format: double
    TagLabelMetadata:
      type: object
      properties:
        recognizer:
          $ref: '#/components/schemas/TagLabelRecognizerMetadata'
        expiryDate:
          type: integer
          format: int64
    EntityError:
      type: object
      properties:
        message:
          type: string
        entity:
          type: object
    TestConnectionStepResult:
      required:
      - mandatory
      - name
      - passed
      type: object
      properties:
        name:
          type: string
        mandatory:
          type: boolean
        passed:
          type: boolean
        message:
          type: string
        errorLog:
          type: string
    EntityReference:
      required:
      - id
      - type
      type: object
      properties:
        id:
          type: string
          format: uuid
        type:
          type: string
        name:
          type: string
        fullyQualifiedName:
          type: string
        description:
          type: string
        displayName:
          type: string
        deleted:
          type: boolean
        inherited:
          type: boolean
        href:
          type: string
          format: uri
    SearchConnection:
      type: object
      properties:
        config:
          type: object
    UsageDetails:
      required:
      - dailyStats
      - date
      type: object
      properties:
        dailyStats:
          $ref: '#/components/schemas/UsageStats'
        weeklyStats:
          $ref: '#/components/schemas/UsageStats'
        monthlyStats:
          $ref: '#/components/schemas/UsageStats'
        date:
          type: string
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT