# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for dotCMS REST Data Integrity API
  version: 1.0.0
extends: openapi/dotcms-data-integrity-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 8
- target: $.paths['/api/integrity/checkintegrity/{params}'].get
  update:
    x-apievangelist-phrasing:
      intent: Start an integrity check against an endpoint
      effect: read
      questions:
      - How do I check data integrity between this server and a push-publishing endpoint?
      - Can I look for conflicting records before pushing content?
      instructions:
      - text: Run a data integrity check with parameters {params}.
        slots:
          params: path.params
      - text: Start checking for integrity conflicts against the endpoint in {params}.
        slots:
          params: path.params
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/integrity/checkIntegrityProcessStatus/{params}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check an integrity check's progress
      effect: read
      questions:
      - Is my data integrity check still running?
      - What is the status of the integrity process for an endpoint?
      instructions:
      - text: Get the status of the integrity check process for {params}.
        slots:
          params: path.params
      - text: Tell me whether the integrity check for {params} has finished.
        slots:
          params: path.params
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/integrity/discardconflicts/{params}'].get
  update:
    x-apievangelist-phrasing:
      intent: Discard detected integrity conflicts
      effect: destructive
      questions:
      - How do I throw away integrity conflicts without fixing them?
      - Can I clear the conflict results from a previous integrity check?
      instructions:
      - text: Discard the integrity conflicts found for {params}.
        slots:
          params: path.params
      - text: Drop the detected conflict results for {params} without fixing them.
        slots:
          params: path.params
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/integrity/fixconflicts/{params}'].get
  update:
    x-apievangelist-phrasing:
      intent: Fix detected integrity conflicts
      effect: write
      questions:
      - How do I resolve the conflicts an integrity check found?
      - Can I automatically repair mismatched records between servers?
      instructions:
      - text: Fix the integrity conflicts found for {params}.
        slots:
          params: path.params
      - text: Resolve the detected data conflicts for {params} on this server.
        slots:
          params: path.params
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/integrity/_fixconflictsfromremote'].post
  update:
    x-apievangelist-phrasing:
      intent: Apply conflict fixes sent by a remote server
      effect: write
      questions:
      - How does a remote server push integrity fixes to this one?
      - Which conflict types can be fixed from a remote request?
      instructions:
      - text: Apply remote integrity fixes {DATA_TO_FIX} of type {TYPE}.
        slots:
          DATA_TO_FIX: requestBody.DATA_TO_FIX
          TYPE: requestBody.TYPE
      - text: Fix {TYPE} conflicts on this server using the data a remote endpoint sent.
        slots:
          TYPE: requestBody.TYPE
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/integrity/_generateintegritydata'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate integrity data for comparison
      effect: write
      questions:
      - How do I produce this server's integrity data so another server can compare it?
      - What starts the generation of integrity check data?
      instructions:
      - text: Generate integrity data on this server.
      - text: Start building the integrity dataset for a remote comparison.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/integrity/{requestId}/integrityData'].get
  update:
    x-apievangelist-phrasing:
      intent: Download generated integrity data
      effect: read
      questions:
      - How do I fetch the integrity data produced for a request?
      - Can I retrieve the generated integrity dataset by request ID?
      instructions:
      - text: Get the integrity data for request {requestId}.
        slots:
          requestId: path.requestId
      - text: Download the generated integrity dataset {requestId}.
        slots:
          requestId: path.requestId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/integrity/getIntegrityResult/{params}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get integrity check results
      effect: read
      questions:
      - What conflicts did the integrity check find?
      - Can I see the results of the last integrity check for an endpoint?
      instructions:
      - text: Show the integrity check results for {params}.
        slots:
          params: path.params
      - text: List the conflicts found by the integrity check for {params}.
        slots:
          params: path.params
      method: generated
      generated: '2026-09-26'