# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Adobe Workfront Categoryaccessrule API
  version: 1.0.0
extends: openapi/adobe-suite-categoryaccessrule-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: 9
- target: $.paths['/categoryaccessrule/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one custom form access rule
      effect: read
      questions:
      - Who has access to a custom form according to a specific category access rule?
      - Can I look up a single category access rule by ID?
      instructions:
      - text: Show category access rule {id}.
        slots:
          id: path.id
      - text: Get the {fields} of category access rule {id}.
        slots:
          fields: query.fields
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/categoryaccessrule/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a single category access rule
      effect: destructive
      questions:
      - Can I revoke one sharing rule on a custom form?
      - Does removing a category access rule need to be forced?
      instructions:
      - text: Delete category access rule {id}.
        slots:
          id: path.id
      - text: Revoke the custom form sharing rule {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/categoryaccessrule'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch several category access rules by ID
      effect: read
      questions:
      - Can I pull multiple category access rules in one request by ID?
      - What do these specific custom form access rules grant?
      instructions:
      - text: Get category access rules {ids}.
        slots:
          ids: query.id
      - text: 'Fetch these form access rules together: {ids}.'
        slots:
          ids: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/categoryaccessrule'].post
  update:
    x-apievangelist-phrasing:
      intent: Share a custom form via an access rule
      effect: write
      questions:
      - How do I share a custom form with another user or team?
      - Can I create a category access rule through the API?
      instructions:
      - text: Create a category access rule sharing this form with the design team.
      - text: Add an access rule so this user can use the custom form.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/categoryaccessrule'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several category access rules by ID
      effect: destructive
      questions:
      - Can I remove many custom form sharing rules at once?
      - What is required to bulk delete category access rules?
      instructions:
      - text: Delete category access rules {ids}.
        slots:
          ids: query.id
      - text: 'Remove all these form sharing rules: {ids}.'
        slots:
          ids: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/categoryaccessrule/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count category access rules
      effect: read
      questions:
      - How many custom form access rules exist?
      - What number of category access rules match a filter?
      instructions:
      - text: Count category access rules matching {filters}.
        slots:
          filters: query.filters
      - text: Tell me how many category access rules we have.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/categoryaccessrule/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search category access rules
      effect: read
      questions:
      - Which access rules grant a particular team access to custom forms?
      - Can I search form sharing rules with filters?
      instructions:
      - text: Search category access rules where {filters}.
        slots:
          filters: query.filters
      - text: Find access rules matching {filters} and return {fields}.
        slots:
          filters: query.filters
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/categoryaccessrule/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Run an aggregate report on access rules
      effect: read
      questions:
      - Can I get grouped totals of category access rules by access level?
      - What does an aggregated category access rule report show?
      instructions:
      - text: Run a grouped report on category access rules filtered on {filters}.
        slots:
          filters: query.filters
      - text: Summarize category access rules using {listOptions}.
        slots:
          listOptions: query.listOptions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/categoryaccessrule/getForObject'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the access rules on a specific form
      effect: read
      questions:
      - Which access rules apply to a particular custom form object?
      - Can I see sharing rules for a given object code and ID?
      instructions:
      - text: Show the access rules for object {objID} of type {objCode}.
        slots:
          objID: query.objID
          objCode: query.objCode
      - text: Get the category access rules attached to object {objID}.
        slots:
          objID: query.objID
      method: generated
      generated: '2026-09-26'