# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for OpenSanctions System information API
  version: 1.0.0
extends: openapi/opensanctions-system-information-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/healthz'].get
  update:
    x-apievangelist-phrasing:
      intent: Check that the service is responsive
      effect: read
      questions:
      - Is the screening service up and responding to requests?
      - What liveness endpoint can Kubernetes probe for this service?
      instructions:
      - text: Run the basic health check on the service.
      - text: Ping the liveness probe to confirm the API is responsive.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/readyz'].get
  update:
    x-apievangelist-phrasing:
      intent: Check whether the search index is built
      effect: read
      questions:
      - Has the search index finished building so queries will return results?
      - Can I tell if the service is ready to serve searches after a restart?
      instructions:
      - text: Check the readiness probe to see if index building is complete.
      - text: Confirm the search index is ready before I start screening.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/algorithms'].get
  update:
    x-apievangelist-phrasing:
      intent: List the supported matching algorithms
      effect: read
      questions:
      - Which scoring algorithms can the matcher use?
      - What algorithm names are valid when I tune entity matching?
      instructions:
      - text: List the available matching and scoring algorithms.
      - text: Show me every algorithm the match endpoint supports.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/updatez'].post
  update:
    x-apievangelist-phrasing:
      intent: Force the search index to rebuild
      effect: write
      questions:
      - How do I trigger a rebuild of the index on my self-hosted instance?
      - Does forcing an index regeneration need the update token configured in the container environment?
      instructions:
      - text: Force an index update using update token {token}.
        slots:
          token: query.token
      - text: Regenerate the index with token {token} and sync set to {sync}.
        slots:
          token: query.token
          sync: query.sync
      method: generated
      generated: '2026-10-01'