# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Cohesity REST Ldap Provider API
  version: 1.0.0
extends: openapi/cohesity-ldapprovider-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: 5
- target: $.paths['/public/ldapProvider'].get
  update:
    x-apievangelist-phrasing:
      intent: List LDAP providers
      effect: read
      questions:
      - Which LDAP providers are configured on the cluster?
      - Can I list LDAP providers for a specific tenant?
      instructions:
      - text: List all LDAP providers.
      - text: Show LDAP providers {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/ldapProvider'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an LDAP provider
      effect: write
      questions:
      - How do I change the bind credentials an LDAP provider uses?
      - Can I switch an existing LDAP provider to use SSL?
      instructions:
      - text: Update LDAP provider {id} to port {port} with SSL.
        slots:
          id: requestBody.id
          port: requestBody.port
      - text: Change LDAP provider {id}'s preferred servers to {preferredLdapServerList}.
        slots:
          id: requestBody.id
          preferredLdapServerList: requestBody.preferredLdapServerList
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/ldapProvider'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an LDAP provider
      effect: write
      questions:
      - How do I connect the cluster to an LDAP directory?
      - What base distinguished name and bind user does a new LDAP provider need?
      instructions:
      - text: Create LDAP provider {name} for domain {domainName} with base DN {baseDistinguishedName}.
        slots:
          name: requestBody.name
          domainName: requestBody.domainName
          baseDistinguishedName: requestBody.baseDistinguishedName
      - text: Add LDAP provider {name} using servers {preferredLdapServerList} on port {port}.
        slots:
          name: requestBody.name
          preferredLdapServerList: requestBody.preferredLdapServerList
          port: requestBody.port
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/ldapProvider/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an LDAP provider
      effect: destructive
      questions:
      - How do I remove an LDAP provider from the cluster?
      - Will users who log in through an LDAP provider lose access if it is deleted?
      instructions:
      - text: Delete LDAP provider {id}.
        slots:
          id: path.id
      - text: Remove the LDAP configuration with id {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/ldapProvider/{id}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check an LDAP provider's connection status
      effect: read
      questions:
      - Is the cluster able to reach its LDAP servers?
      - Why might an LDAP provider show as disconnected?
      instructions:
      - text: Check the connection status of LDAP provider {id}.
        slots:
          id: path.id
      - text: Test whether LDAP provider {id} is connected.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'