openapi: 3.0.2
info:
  title: Keep actions deduplications API
  description: Rest API powering https://platform.keephq.dev and friends 🏄‍♀️
  version: 0.24.5
tags:
- name: deduplications
paths:
  /deduplications:
    get:
      tags:
      - deduplications
      summary: Get Deduplications
      description: Get Deduplications
      operationId: get_deduplications_deduplications_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      security:
      - API Key: []
      - HTTPBasic: []
      - OAuth2PasswordBearer: []
    post:
      tags:
      - deduplications
      summary: Create Deduplication Rule
      description: Create Deduplication Rule
      operationId: create_deduplication_rule_deduplications_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeduplicationRuleRequestDto'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - API Key: []
      - HTTPBasic: []
      - OAuth2PasswordBearer: []
  /deduplications/fields:
    get:
      tags:
      - deduplications
      summary: Get Deduplication Fields
      description: Get Optional Fields For Deduplications
      operationId: get_deduplication_fields_deduplications_fields_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties:
                  items:
                    type: string
                  type: array
                type: object
                title: Response Get Deduplication Fields Deduplications Fields Get
      security:
      - API Key: []
      - HTTPBasic: []
      - OAuth2PasswordBearer: []
  /deduplications/{rule_id}:
    put:
      tags:
      - deduplications
      summary: Update Deduplication Rule
      description: Update Deduplication Rule
      operationId: update_deduplication_rule_deduplications__rule_id__put
      parameters:
      - required: true
        schema:
          type: string
          title: Rule Id
        name: rule_id
        in: path
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeduplicationRuleRequestDto'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - API Key: []
      - HTTPBasic: []
      - OAuth2PasswordBearer: []
    delete:
      tags:
      - deduplications
      summary: Delete Deduplication Rule
      description: Delete Deduplication Rule
      operationId: delete_deduplication_rule_deduplications__rule_id__delete
      parameters:
      - required: true
        schema:
          type: string
          title: Rule Id
        name: rule_id
        in: path
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - API Key: []
      - HTTPBasic: []
      - OAuth2PasswordBearer: []
components:
  schemas:
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    DeduplicationRuleRequestDto:
      properties:
        name:
          type: string
          title: Name
        description:
          type: string
          title: Description
        provider_type:
          type: string
          title: Provider Type
        provider_id:
          type: string
          title: Provider Id
        fingerprint_fields:
          items:
            type: string
          type: array
          title: Fingerprint Fields
        full_deduplication:
          type: boolean
          title: Full Deduplication
          default: false
        ignore_fields:
          items:
            type: string
          type: array
          title: Ignore Fields
      type: object
      required:
      - name
      - provider_type
      - fingerprint_fields
      title: DeduplicationRuleRequestDto
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
  securitySchemes:
    API Key:
      type: apiKey
      in: header
      name: X-API-KEY
    HTTPBasic:
      type: http
      scheme: basic
    OAuth2PasswordBearer:
      type: oauth2
      flows:
        password:
          scopes: {}
          tokenUrl: token