# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Harness IP Allowlist API
  version: 1.0.0
extends: openapi/harness-ip-allowlist-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['/v1/ip-allowlist'].get
  update:
    x-apievangelist-phrasing:
      intent: List IP allowlist configurations
      effect: read
      questions:
      - Which IP allowlist configurations are set up on my Harness account?
      - Can I filter IP allowlists by the source type they apply to, like UI or API?
      instructions:
      - text: List all IP allowlist configs.
      - text: Search IP allowlist configs for {search_term}.
        slots:
          search_term: query.search_term
      - text: Show IP allowlist configs for source type {allowed_source_type}.
        slots:
          allowed_source_type: query.allowed_source_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/ip-allowlist'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an IP allowlist configuration
      effect: write
      questions:
      - How do I restrict access to my Harness account to a set of IP ranges?
      - Can I add a new allowlisted IP block for my office network?
      instructions:
      - text: Create an IP allowlist config {ip_allowlist_config}.
        slots:
          ip_allowlist_config: requestBody.ip_allowlist_config
      - text: Add a new IP allowlist entry with settings {ip_allowlist_config}.
        slots:
          ip_allowlist_config: requestBody.ip_allowlist_config
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/ip-allowlist/{ip-config-identifier}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one IP allowlist configuration
      effect: read
      questions:
      - What IP range and status does a specific allowlist config have?
      - Can I look up a single IP allowlist entry by identifier?
      instructions:
      - text: Get IP allowlist config {config}.
        slots:
          config: path.ip-config-identifier
      - text: Show the details of allowlist entry {config}.
        slots:
          config: path.ip-config-identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/ip-allowlist/{ip-config-identifier}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an IP allowlist configuration
      effect: write
      questions:
      - How do I change the IP range on an existing allowlist config?
      - Can I disable an IP allowlist entry without deleting it?
      instructions:
      - text: Update IP allowlist config {config} to {ip_allowlist_config}.
        slots:
          config: path.ip-config-identifier
          ip_allowlist_config: requestBody.ip_allowlist_config
      - text: Edit allowlist entry {config} with new settings {ip_allowlist_config}.
        slots:
          config: path.ip-config-identifier
          ip_allowlist_config: requestBody.ip_allowlist_config
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/ip-allowlist/{ip-config-identifier}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an IP allowlist configuration
      effect: destructive
      questions:
      - How do I remove an IP allowlist entry from my account?
      - Can I delete an allowlist config that is no longer needed?
      instructions:
      - text: Delete IP allowlist config {config}.
        slots:
          config: path.ip-config-identifier
      - text: Remove allowlist entry {config}.
        slots:
          config: path.ip-config-identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/ip-allowlist/validate-unique-identifier/{ip-config-identifier}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check an allowlist identifier is unique
      effect: read
      questions:
      - Is an IP allowlist identifier already taken before I create a new config?
      - Can I validate that a proposed allowlist config ID is unique?
      instructions:
      - text: Check whether allowlist identifier {config} is unique.
        slots:
          config: path.ip-config-identifier
      - text: Validate that {config} is not already used as an IP allowlist identifier.
        slots:
          config: path.ip-config-identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/ip-allowlist/validate/ip-address'].get
  update:
    x-apievangelist-phrasing:
      intent: Test an IP against allowlists or a custom block
      effect: read
      questions:
      - Does a given IP address fall inside a specific CIDR block I provide?
      - Can I test an IP against allowlist configs including disabled ones?
      instructions:
      - text: Check whether IP {ip_address} falls within block {custom_ip_address_block}.
        slots:
          ip_address: query.ip_address
          custom_ip_address_block: query.custom_ip_address_block
      - text: Validate IP {ip_address} against allowlists, including disabled configs {include_disabled_configs}.
        slots:
          ip_address: query.ip_address
          include_disabled_configs: query.include_disabled_configs
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/ip-allowlist/allowed/ip-address'].get
  update:
    x-apievangelist-phrasing:
      intent: Check if an IP address is allowed
      effect: read
      questions:
      - Will requests from this IP address be allowed into my Harness account?
      - Is a particular IP permitted by my current allowlist setup?
      instructions:
      - text: Tell me if IP address {ip_address} is allowed.
        slots:
          ip_address: query.ip_address
      - text: Check access for IP {ip_address} against the enabled allowlists.
        slots:
          ip_address: query.ip_address
      method: generated
      generated: '2026-09-26'