OpenMetadata Document Store API

openapi: 3.0.1
info:
  title: OpenMetadata APIs Agent Executions Document Store 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: Document Store
  description: A `Document` is an generic entity in OpenMetadata.
paths:
  /v1/docStore:
    get:
      tags:
      - Document Store
      summary: List Documents
      description: Get a list of Documents. Use `fields` parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params.
      operationId: listDocuments
      parameters:
      - name: limit
        in: query
        description: Limit the number of personas returned. (1 to 1000000, default = 10)
        schema:
          maximum: 1000000
          minimum: 0
          type: integer
          format: int32
          default: 10
      - name: entityType
        in: query
        description: Filter docs by entityType
        schema:
          type: string
          example: KnowledgePanel
      - name: fqnPrefix
        in: query
        description: Filter docs by fqnPrefix
        schema:
          type: string
          example: fqnPrefix
      - name: before
        in: query
        description: Returns list of personas before this cursor
        schema:
          type: string
      - name: after
        in: query
        description: Returns list of personas after this cursor
        schema:
          type: string
      responses:
        '200':
          description: List of personas
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentList'
    put:
      tags:
      - Document Store
      summary: Update Document
      description: Create or Update a Document.
      operationId: createOrUpdateDocument
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDocument'
      responses:
        '200':
          description: The Document.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Document'
        '400':
          description: Bad request
    post:
      tags:
      - Document Store
      summary: Create a Document
      description: Create a new Document.
      operationId: createDocument
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDocument'
      responses:
        '200':
          description: The Knowledge Panel.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Document'
        '400':
          description: Bad request
  /v1/docStore/name/{name}:
    get:
      tags:
      - Document Store
      summary: Get a Document by name
      description: Get a Document by `name`.
      operationId: getDocumentByFQN
      parameters:
      - name: name
        in: path
        description: Name of the Document
        required: true
        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: The Document
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Document'
        '404':
          description: Document for instance {name} is not found
    delete:
      tags:
      - Document Store
      summary: Delete a Document by name
      description: Delete a Document by given `name`.
      operationId: deleteDocumentByName
      parameters:
      - name: name
        in: path
        description: Name of the Document
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
        '404':
          description: Knowledge Panel for instance {name} is not found
  /v1/docStore/{id}:
    get:
      tags:
      - Document Store
      summary: Get a Document by id
      description: Get a Document by `id`.
      operationId: get_2
      parameters:
      - name: id
        in: path
        description: Id of the Document
        required: true
        schema:
          type: string
          format: uuid
      - 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: The Document
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Document'
        '404':
          description: Document for instance {id} is not found
    delete:
      tags:
      - Document Store
      summary: Delete a Document by id
      description: Delete a Document by given `id`.
      operationId: deleteDocument
      parameters:
      - name: id
        in: path
        description: Id of the Document
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
        '404':
          description: Document for instance {id} is not found
    patch:
      tags:
      - Document Store
      summary: Update a Document.
      description: Update an existing Document with JsonPatch.
      externalDocs:
        description: JsonPatch RFC
        url: https://tools.ietf.org/html/rfc6902
      operationId: patchDocument_1
      parameters:
      - name: id
        in: path
        description: Id of the Document
        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/docStore/async/{id}:
    delete:
      tags:
      - Document Store
      summary: Asynchronously delete a Document by id
      description: Asynchronously delete a Document by given `id`.
      operationId: deleteDocumentAsync
      parameters:
      - name: id
        in: path
        description: Id of the Document
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
        '404':
          description: Document for instance {id} is not found
  /v1/docStore/{id}/versions/{version}:
    get:
      tags:
      - Document Store
      summary: Get a version of the Document
      description: Get a version of the Document by given `id`
      operationId: getSpecificDocumentVersion
      parameters:
      - name: id
        in: path
        description: Id of the Document
        required: true
        schema:
          type: string
          format: uuid
      - name: version
        in: path
        description: Document version number in the form `major`.`minor`
        required: true
        schema:
          type: string
          example: 0.1 or 1.1
      responses:
        '200':
          description: KnowledgePanel
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Document'
        '404':
          description: Document for instance {id} and version {version} is not found
  /v1/docStore/history:
    get:
      tags:
      - Document Store
      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_18
      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/docStore/{id}/versions:
    get:
      tags:
      - Document Store
      summary: List Document versions
      description: Get a list of all the versions of a Document identified by `id`
      operationId: listAllDocumentVersion
      parameters:
      - name: id
        in: path
        description: Id of the Document
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: List of persona versions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityHistory'
  /v1/docStore/name/{fqn}:
    patch:
      tags:
      - Document Store
      summary: Update a Document by name.
      description: Update an existing Document with JsonPatch.
      externalDocs:
        description: JsonPatch RFC
        url: https://tools.ietf.org/html/rfc6902
      operationId: patchDocument
      parameters:
      - name: fqn
        in: path
        description: Name of the Document
        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/docStore/resetEmailTemplate:
    post:
      tags:
      - Document Store
      summary: Reset seed data of EmailTemplate type
      description: Deletes seed data of the EmailTemplate type from the document store and reinitializes it from resources.
      operationId: resetEmailTemplate
      responses:
        '200':
          description: Seed Data init successfully
          content:
            application/json:
              schema:
                type: string
        '400':
          description: Seed Data init failed
          content:
            application/json:
              schema:
                type: string
  /v1/docStore/validateTemplate/{templateName}:
    put:
      tags:
      - Document Store
      summary: Validate Email Template
      description: Validates is the give content is a valid Email Template.
      operationId: validateEmailTemplate
      parameters:
      - name: templateName
        in: path
        description: Template name for the email template to be validated
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmailTemplate'
      responses:
        '200':
          description: The Template Validation Response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemplateValidationResponse'
        '400':
          description: Bad request
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'
    Document:
      required:
      - data
      - entityType
      - fullyQualifiedName
      - name
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          maxLength: 256
          minLength: 1
          pattern: ^((?!::).)*$
          type: string
        displayName:
          type: string
        fullyQualifiedName:
          maxLength: 3072
          minLength: 1
          type: string
        description:
          type: string
        entityType:
          type: string
        data:
          $ref: '#/components/schemas/Data'
        updatedAt:
          type: integer
          format: int64
        updatedBy:
          type: string
        impersonatedBy:
          type: string
        version:
          type: number
          format: double
        changeDescription:
          $ref: '#/components/schemas/ChangeDescription'
        incrementalChangeDescription:
          $ref: '#/components/schemas/ChangeDescription'
        href:
          type: string
          format: uri
        domains:
          type: array
          items:
            $ref: '#/components/schemas/EntityReference'
        owners:
          type: array
          items:
            $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'
        tags:
          type: array
          items:
            $ref: '#/components/schemas/TagLabel'
        followers:
          type: array
          items:
            $ref: '#/components/schemas/EntityReference'
        experts:
          type: array
          items:
            $ref: '#/components/schemas/EntityReference'
        reviewers:
          type: array
          items:
            $ref: '#/components/schemas/EntityReference'
        dataProducts:
          type: array
          items:
            $ref: '#/components/schemas/EntityReference'
        deleted:
          type: boolean
        dataContract:
          $ref: '#/components/schemas/EntityReference'
        usageSummary:
          $ref: '#/components/schemas/UsageDetails'
        entityStatus:
          type: string
          enum:
          - Draft
          - In Review
          - Approved
          - Archived
          - Deprecated
          - Rejected
          - Unprocessed
        votes:
          $ref: '#/components/schemas/Votes'
        lifeCycle:
          $ref: '#/components/schemas/LifeCycle'
        certification:
          $ref: '#/components/schemas/AssetCertification'
    Data:
      type: object
    ChangeSummaryMap:
      type: object
    AccessDetails:
      required:
      - timestamp
      type: object
      properties:
        timestamp:
          type: integer
          format: int64
        accessedBy:
          $ref: '#/components/schemas/EntityReference'
        accessedByAProcess:
          type: string
    CreateDocument:
      required:
      - data
      - entityType
      - fullyQualifiedName
      - name
      type: object
      properties:
        name:
          maxLength: 256
          minLength: 1
          pattern: ^((?!::).)*$
          type: string
        displayName:
          type: string
        fullyQualifiedName:
          maxLength: 3072
          minLength: 1
          type: string
        description:
          type: string
        entityType:
          type: string
        data:
          $ref: '#/components/schemas/Data'
        domains:
          type: array
          items:
            type: string
        owners:
          type: array
          items:
            $ref: '#/components/schemas/EntityReference'
        extension:
          type: object
        tags:
          type: array
          items:
            $ref: '#/components/schemas/TagLabel'
        reviewers:
          type: array
          items:
            $ref: '#/components/schemas/EntityReference'
        dataProducts:
          type: array
          items:
            type: string
        lifeCycle:
          $ref: '#/components/schemas/LifeCycle'
    FieldChange:
      type: object
      properties:
        name:
          type: string
        oldValue:
          type: object
        newValue:
          type: object
    CoverImage:
      type: object
      properties:
        url:
          type: string
        position:
          type: string
    TemplateValidationResponse:
      type: object
      properties:
        isValid:
          type: boolean
        missingPlaceholder:
          uniqueItems: true
          type: array
          items:
            type: string
        additionalPlaceholder:
          uniqueItems: true
          type: array
          items:
            type: string
        message:
          type: string
    LifeCycle:
      type: object
      properties:
        created:
          $ref: '#/components/schemas/AccessDetails'
        updated:
          $ref: '#/components/schemas/AccessDetails'
        accessed:
          $ref: '#/components/schemas/AccessDetails'
    EmailTemplate:
      required:
      - placeHolders
      - template
      type: object
      properties:
        template:
          type: string
        placeHolders:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/EmailTemplatePlaceholder'
    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
    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
    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'
    EmailTemplatePlaceholder:
      required:
      - description
      - name
      type: object
      properties:
        name:
          type: string
        description:
          type: string
    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'
    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
    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
    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
    DocumentList:
      required:
      - data
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Document'
        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'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT