openapi: 3.2.0
info:
  title: Catalog Asset Watch API
  version: '1.0'
  description: API for managing the ADOC data catalog, including assets, asset metadata, tags, labels, sampling, lineage, and watched assets, as well as data reliability policies (data quality, reconciliation, data drift, schema drift, and related rule types) and their executions. Covers discovering and searching assets, retrieving asset configuration and activity, and creating, scheduling, and running policies against catalog assets.
tags:
- name: Asset Watch
paths:
  /catalog-server/api/assets/{id}/watch:
    post:
      operationId: watchAsset
      tags:
      - Asset Watch
      summary: Watch an asset
      description: 'This endpoint monitors a selected asset by its `ID` and triggers notifications whenever there are changes to the asset.


        **Authorization**: requires `ASSET_CONFIGURATION_MODIFY`.


        ### Response


        Returns `Response` confirming the asset was added to the watch list.'
      parameters:
      - name: id
        in: path
        description: Asset ID
        required: true
        schema:
          type: integer
      - name: accessKey
        in: header
        description: API access key generated from ADOC UI
        required: true
        schema:
          type: string
      - name: secretKey
        in: header
        description: API secret key generated from ADOC UI
        required: true
        schema:
          type: string
      - name: Accept
        in: header
        description: Always set to application/json
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Watch added
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
        '403':
          description: Either the asset is not present, or the user doesn't have permissions to perform the operation.
    delete:
      operationId: unwatchAsset
      tags:
      - Asset Watch
      summary: Unwatch an asset
      description: 'This endpoint removes a selected asset from the watch list by its `ID`. This action will stop all notifications for any changes to the asset.


        **Authorization**: requires `ASSET_CONFIGURATION_MODIFY`.'
      parameters:
      - name: id
        in: path
        description: Asset ID
        required: true
        schema:
          type: integer
      - name: accessKey
        in: header
        description: API access key generated from ADOC UI
        required: true
        schema:
          type: string
      - name: secretKey
        in: header
        description: API secret key generated from ADOC UI
        required: true
        schema:
          type: string
      - name: Accept
        in: header
        description: Always set to application/json
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Watch removed successfully
        '403':
          description: Either the asset is not present, or the user doesn't have permissions to perform the operation.
        '404':
          description: Resource not found
  /catalog-server/api/assets/byUid/{uid}/watch:
    post:
      operationId: watchAssetByUid
      tags:
      - Asset Watch
      summary: Watch an asset by UID
      description: 'This endpoint is used to monitor a selected asset by its `UID`. This request will also trigger notifications whenever there are changes to the asset.


        **Authorization**: requires `ASSET_CONFIGURATION_MODIFY`. Missing or inaccessible asset returns 403 via `getAssetId`.


        ### Response


        Returns `Response` confirming the asset was added to the watch list.'
      parameters:
      - name: uid
        in: path
        description: Asset unique identifier
        required: true
        schema:
          type: string
      - name: accessKey
        in: header
        description: API access key generated from ADOC UI
        required: true
        schema:
          type: string
      - name: secretKey
        in: header
        description: API secret key generated from ADOC UI
        required: true
        schema:
          type: string
      - name: Accept
        in: header
        description: Always set to application/json
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Watch added
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
        '403':
          description: Either the asset is not present, or the user doesn't have permissions to perform the operation.
    delete:
      operationId: unwatchAssetByUid
      tags:
      - Asset Watch
      summary: Unwatch an asset by UID
      description: 'The endpoint is used to remove a selected asset from the watch list by its UID. This request will stop all notifications for any changes to the asset.


        **Authorization**: requires `ASSET_CONFIGURATION_MODIFY`. Missing or inaccessible asset returns 403 via `getAssetId`.'
      parameters:
      - name: uid
        in: path
        description: Asset unique identifier
        required: true
        schema:
          type: string
      - name: accessKey
        in: header
        description: API access key generated from ADOC UI
        required: true
        schema:
          type: string
      - name: secretKey
        in: header
        description: API secret key generated from ADOC UI
        required: true
        schema:
          type: string
      - name: Accept
        in: header
        description: Always set to application/json
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Watch removed successfully
        '403':
          description: Either the asset is not present, or the user doesn't have permissions to perform the operation.
        '404':
          description: Resource not found
components:
  schemas:
    Response:
      type: object
      title: io.ad.catalog.api.model.Response
      required:
      - data
      properties:
        data:
          $ref: '#/components/schemas/AssetWatcher'
    DateTime:
      type: object
      title: org.joda.time.DateTime
    AssetWatcher:
      type: object
      title: io.ad.catalog.api.model.AssetWatcher
      required:
      - assetId
      - createdAt
      - updatedAt
      - userId
      properties:
        assetId:
          type: integer
        createdAt:
          $ref: '#/components/schemas/DateTime'
        id:
          type: integer
        updatedAt:
          $ref: '#/components/schemas/DateTime'
        userId:
          type: string