# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Data Record Share API
  version: 1.0.0
extends: openapi/conga-record-share-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: 6
- target: $.paths['/api/data/v1/objects/{objectName}/{recordId}/access-level'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a shared record's access level
      effect: write
      questions:
      - How do I change someone's access on a shared record from View to Edit?
      - Can I change the access level a user group has on a record I shared?
      instructions:
      - text: Set access on {objectName} record {recordId} to {AccessLevel} for user {UserId}.
        slots:
          objectName: path.objectName
          recordId: path.recordId
          AccessLevel: requestBody.AccessLevel
          UserId: requestBody.UserId
      - text: Change group {UserGroupId}'s access level on {objectName} record {recordId}.
        slots:
          UserGroupId: requestBody.UserGroupId
          objectName: path.objectName
          recordId: path.recordId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/data/v1/objects/{objectName}/{recordId}/share'].post
  update:
    x-apievangelist-phrasing:
      intent: Share a record with users or groups
      effect: write
      questions:
      - How do I share a record with other users and groups in Conga?
      - Can I send an email notification when I share a record?
      instructions:
      - text: Share {objectName} record {recordId} with {RecordShareInfo}.
        slots:
          objectName: path.objectName
          recordId: path.recordId
          RecordShareInfo: requestBody.RecordShareInfo
      - text: Share record {recordId} of {objectName} and email them the message {EmailMessage}.
        slots:
          recordId: path.recordId
          objectName: path.objectName
          EmailMessage: requestBody.EmailMessage
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/data/v1/objects/{objectName}/{recordId}/sharing-info'].get
  update:
    x-apievangelist-phrasing:
      intent: See who a record is shared with
      effect: read
      questions:
      - Who has access to this record, and with what permissions?
      - Can I page through the users and groups a record is shared with?
      instructions:
      - text: Show who {objectName} record {recordId} is shared with.
        slots:
          objectName: path.objectName
          recordId: path.recordId
      - text: List sharing info for record {recordId} of {objectName}, {pageSize} per page.
        slots:
          recordId: path.recordId
          objectName: path.objectName
          pageSize: query.pageSize
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/data/v1/objects/{objectName}/{recordId}/un-share'].delete
  update:
    x-apievangelist-phrasing:
      intent: Un-share a record
      effect: destructive
      questions:
      - How do I revoke someone's access to a record I shared?
      - Can I stop sharing a record with a user group?
      instructions:
      - text: Un-share {objectName} record {recordId} from user {UserId}.
        slots:
          objectName: path.objectName
          recordId: path.recordId
          UserId: requestBody.UserId
      - text: Remove group {UserGroupId}'s access to record {recordId} of {objectName}.
        slots:
          UserGroupId: requestBody.UserGroupId
          recordId: path.recordId
          objectName: path.objectName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/data/v1/objects/{objectName}/{recordId}/{trackingId}/sharing-status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a group record-share's progress
      effect: read
      questions:
      - Has sharing a record with a user group finished yet?
      - What does the STARTED or IN PROGRESS status mean for a group share?
      instructions:
      - text: Check sharing status {trackingId} for {objectName} record {recordId}.
        slots:
          trackingId: path.trackingId
          objectName: path.objectName
          recordId: path.recordId
      - text: Tell me whether group share {trackingId} on record {recordId} of {objectName} has finished.
        slots:
          trackingId: path.trackingId
          recordId: path.recordId
          objectName: path.objectName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/data/v1/objects/{objectName}/{recordId}/{userId}/access-level'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one user's access on a shared record
      effect: read
      questions:
      - Can a specific user view, edit or delete this shared record?
      - What access level does one person have on a record?
      instructions:
      - text: Show user {userId}'s access level on {objectName} record {recordId}.
        slots:
          userId: path.userId
          objectName: path.objectName
          recordId: path.recordId
      - text: Check what user {userId} can do with record {recordId} of {objectName}.
        slots:
          userId: path.userId
          recordId: path.recordId
          objectName: path.objectName
      method: generated
      generated: '2026-10-01'