API Evangelist conversational phrasing for Administration Custom Settings API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Administration Custom Settings API
  version: 1.0.0
extends: openapi/conga-customsettings-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: 25
- target: $.paths['/flows'].get
  update:
    x-apievangelist-phrasing:
      intent: List flows
      effect: read
      questions:
      - Which custom flows are defined in my Conga admin settings?
      - Where can I see every flow I've configured?
      instructions:
      - text: List all flows.
      - text: Show every custom flow.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/flows'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a flow
      effect: write
      questions:
      - How do I create a new custom flow?
      - Does creating a flow also set up default display actions and columns?
      instructions:
      - text: Create a flow named {Name}.
        slots:
          Name: requestBody.Name
      - text: Add custom flow {Name} described as {Description}.
        slots:
          Name: requestBody.Name
          Description: requestBody.Description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/flows/{flowName}/views'].get
  update:
    x-apievangelist-phrasing:
      intent: List views for a flow
      effect: read
      questions:
      - What views are configured for a flow?
      - Can I search or sort the views of a flow by display type?
      instructions:
      - text: List views for flow {flowName}.
        slots:
          flowName: path.flowName
      - text: Search views of flow {flowName} for {search} for display {viewFor}.
        slots:
          flowName: path.flowName
          search: query.search
          viewFor: query.viewFor
      method: generated
      generated: '2026-10-01'
- target: $.paths['/flows/{flowName}/views'].put
  update:
    x-apievangelist-phrasing:
      intent: Update views for a flow
      effect: write
      questions:
      - How do I update the views on a flow?
      - Can I change several views of one flow in one request?
      instructions:
      - text: Update the views of flow {flowName}.
        slots:
          flowName: path.flowName
      - text: Edit flow {flowName} views used for {viewFor}.
        slots:
          flowName: path.flowName
          viewFor: query.viewFor
      method: generated
      generated: '2026-10-01'
- target: $.paths['/flows/{flowName}/views'].post
  update:
    x-apievangelist-phrasing:
      intent: Create views for a flow
      effect: write
      questions:
      - How do I add new views to a flow?
      - Can I create views for a particular display type on a flow?
      instructions:
      - text: Create views for flow {flowName}.
        slots:
          flowName: path.flowName
      - text: Add new {viewFor} views to flow {flowName}.
        slots:
          viewFor: query.viewFor
          flowName: path.flowName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/flows/{flowName}/views/{viewName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a named view of a flow
      effect: read
      questions:
      - How do I see one specific view on a flow by name?
      - Can I fetch a single flow view?
      instructions:
      - text: Show view {viewName} of flow {flowName}.
        slots:
          viewName: path.viewName
          flowName: path.flowName
      - text: Get flow {flowName}'s {viewName} view for {viewFor}.
        slots:
          flowName: path.flowName
          viewName: path.viewName
          viewFor: query.viewFor
      method: generated
      generated: '2026-10-01'
- target: $.paths['/flows/{flowName}/views/{viewName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a named view of a flow
      effect: destructive
      questions:
      - How do I remove a view from a flow?
      - Can I delete just one named view on a flow?
      instructions:
      - text: Delete view {viewName} from flow {flowName}.
        slots:
          viewName: path.viewName
          flowName: path.flowName
      - text: Remove the {viewName} view from flow {flowName}.
        slots:
          viewName: path.viewName
          flowName: path.flowName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/flows/{flowname}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a flow by name
      effect: read
      questions:
      - How do I look up a single flow by its name?
      - Can I see the record for one flow?
      instructions:
      - text: Show flow {flowname}.
        slots:
          flowname: path.flowname
      - text: Get the flow record named {flowname}.
        slots:
          flowname: path.flowname
      method: generated
      generated: '2026-10-01'
- target: $.paths['/flows/{flowname}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a flow
      effect: write
      questions:
      - How do I rename a flow or change its description?
      - Can I edit a flow's details by its name?
      instructions:
      - text: Rename flow {flowname} to {Name}.
        slots:
          flowname: path.flowname
          Name: requestBody.Name
      - text: Change the description of flow {flowname} to {Description}.
        slots:
          flowname: path.flowname
          Description: requestBody.Description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/flows/{flowname}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a flow
      effect: destructive
      questions:
      - How do I delete a whole flow?
      - Can I remove a flow by name?
      instructions:
      - text: Delete flow {flowname}.
        slots:
          flowname: path.flowname
      - text: Remove the entire flow named {flowname}.
        slots:
          flowname: path.flowname
      method: generated
      generated: '2026-10-01'
- target: $.paths['/flows/{flowname}/actions'].get
  update:
    x-apievangelist-phrasing:
      intent: List actions for a flow
      effect: read
      questions:
      - Which display actions are configured on a flow?
      - What actions show up for a flow based on its display action settings?
      instructions:
      - text: List actions for flow {flowname}.
        slots:
          flowname: path.flowname
      - text: Show the display actions configured on flow {flowname}.
        slots:
          flowname: path.flowname
      method: generated
      generated: '2026-10-01'
- target: $.paths['/flows/{flowname}/actions'].put
  update:
    x-apievangelist-phrasing:
      intent: Sync actions for a flow
      effect: write
      questions:
      - Can I create, update and delete a flow's actions in one request?
      - How do I replace the action set on a flow?
      instructions:
      - text: Sync the action list on flow {flowname} to match this payload.
        slots:
          flowname: path.flowname
      - text: Create, update and remove flow actions in a single request.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/flows/{flowname}/actions'].post
  update:
    x-apievangelist-phrasing:
      intent: Add actions to a flow
      effect: write
      questions:
      - How do I add new actions to a flow?
      - Can I create several flow actions at once?
      instructions:
      - text: Add new actions to flow {flowname}.
        slots:
          flowname: path.flowname
      - text: Create one or more additional flow actions.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/flows/{flowname}/displays'].get
  update:
    x-apievangelist-phrasing:
      intent: List column displays for a flow
      effect: read
      questions:
      - Which column displays are configured for a flow?
      - How are a flow's columns set up under its display column settings?
      instructions:
      - text: List column displays for flow {flowname}.
        slots:
          flowname: path.flowname
      - text: Show the display column settings for flow {flowname}.
        slots:
          flowname: path.flowname
      method: generated
      generated: '2026-10-01'
- target: $.paths['/flows/{flowname}/displays'].put
  update:
    x-apievangelist-phrasing:
      intent: Update column displays for a flow
      effect: write
      questions:
      - How do I change the column displays on a flow?
      - Can I update several displays of a flow together?
      instructions:
      - text: Update column displays on flow {flowname}.
        slots:
          flowname: path.flowname
      - text: Edit existing flow column displays.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/flows/{flowname}/displays'].post
  update:
    x-apievangelist-phrasing:
      intent: Create column displays for a flow
      effect: write
      questions:
      - How do I add new column displays to a flow?
      - Can I create several displays for a flow at once?
      instructions:
      - text: Create new column displays for flow {flowname}.
        slots:
          flowname: path.flowname
      - text: Add one or more column displays to a flow.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/flows/{flowname}/settings'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom settings for a flow
      effect: read
      questions:
      - What custom settings are defined for a flow?
      - When a setting exists at both flow and global level, which one do I get?
      instructions:
      - text: List all custom settings for flow {flowname}.
        slots:
          flowname: path.flowname
      - text: Show every setting defined on flow {flowname}.
        slots:
          flowname: path.flowname
      method: generated
      generated: '2026-10-01'
- target: $.paths['/flows/{flowname}/settings/{settingname}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a setting category for a flow
      effect: read
      questions:
      - How do I read one setting category, like catalog page settings, for a flow?
      - Can I fetch a specific named setting on a flow and filter to a child setting?
      instructions:
      - text: Get setting {settingname} for flow {flowname}.
        slots:
          settingname: path.settingname
          flowname: path.flowname
      - text: Show setting {settingname} on flow {flowname} filtered to child {childsettingname}.
        slots:
          settingname: path.settingname
          flowname: path.flowname
          childsettingname: query.childsettingname
      method: generated
      generated: '2026-10-01'
- target: $.paths['/flows/{flowname}/settings/{settingname}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a setting category for a flow
      effect: write
      questions:
      - How do I change a named setting category like config page settings on a flow?
      - Can I update a flow setting by name?
      instructions:
      - text: Update setting {settingname} on flow {flowname}.
        slots:
          settingname: path.settingname
          flowname: path.flowname
      - text: Edit the {settingname} setting category of flow {flowname}, child {childsettingname} via query.
        slots:
          settingname: path.settingname
          flowname: path.flowname
          childsettingname: query.childsettingname
      method: generated
      generated: '2026-10-01'
- target: $.paths['/flows/{flowname}/settings/{settingname}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a setting on a flow
      effect: write
      questions:
      - How do I create a new setting on a flow?
      - Can I add a setting by name to a flow, passing the child name as a query value?
      instructions:
      - text: Create setting {settingname} on flow {flowname}.
        slots:
          settingname: path.settingname
          flowname: path.flowname
      - text: Add setting {settingname} to flow {flowname} with child {childsettingname} in the query.
        slots:
          settingname: path.settingname
          flowname: path.flowname
          childsettingname: query.childsettingname
      method: generated
      generated: '2026-10-01'
- target: $.paths['/flows/{flowname}/settings/{settingname}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a setting on a flow
      effect: destructive
      questions:
      - How do I delete a named setting from a flow?
      - Can I remove a flow setting, passing a child name as a query value?
      instructions:
      - text: Delete setting {settingname} from flow {flowname}.
        slots:
          settingname: path.settingname
          flowname: path.flowname
      - text: Remove setting {settingname} on flow {flowname} with child {childsettingname} in the query.
        slots:
          settingname: path.settingname
          flowname: path.flowname
          childsettingname: query.childsettingname
      method: generated
      generated: '2026-10-01'
- target: $.paths['/flows/{flowname}/settings/{settingname}/{childsettingname}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a child setting on a flow
      effect: read
      questions:
      - How do I read a specific child setting nested under a flow setting?
      - Can I fetch one child setting directly by its path?
      instructions:
      - text: Get child setting {childsettingname} under {settingname} for flow {flowname}.
        slots:
          childsettingname: path.childsettingname
          settingname: path.settingname
          flowname: path.flowname
      - text: Show nested setting {settingname}/{childsettingname} on flow {flowname}.
        slots:
          settingname: path.settingname
          childsettingname: path.childsettingname
          flowname: path.flowname
      method: generated
      generated: '2026-10-01'
- target: $.paths['/flows/{flowname}/settings/{settingname}/{childsettingname}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a child setting on a flow
      effect: write
      questions:
      - How do I change one nested child setting under a flow's setting?
      - Can I edit a child setting addressed directly in the path?
      instructions:
      - text: Update child setting {childsettingname} under {settingname} on flow {flowname}.
        slots:
          childsettingname: path.childsettingname
          settingname: path.settingname
          flowname: path.flowname
      - text: Edit nested setting {settingname}/{childsettingname} of flow {flowname}.
        slots:
          settingname: path.settingname
          childsettingname: path.childsettingname
          flowname: path.flowname
      method: generated
      generated: '2026-10-01'
- target: $.paths['/flows/{flowname}/settings/{settingname}/{childsettingname}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a child setting on a flow
      effect: write
      questions:
      - How do I add a new child setting beneath an existing flow setting?
      - Can I create a nested setting with its name in the path?
      instructions:
      - text: Create child setting {childsettingname} under {settingname} on flow {flowname}.
        slots:
          childsettingname: path.childsettingname
          settingname: path.settingname
          flowname: path.flowname
      - text: Add nested setting {settingname}/{childsettingname} to flow {flowname}.
        slots:
          settingname: path.settingname
          childsettingname: path.childsettingname
          flowname: path.flowname
      method: generated
      generated: '2026-10-01'
- target: $.paths['/flows/{flowname}/settings/{settingname}/{childsettingname}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a child setting on a flow
      effect: destructive
      questions:
      - How do I delete one nested child setting from a flow?
      - Can I remove a child setting addressed in the path?
      instructions:
      - text: Delete child setting {childsettingname} under {settingname} from flow {flowname}.
        slots:
          childsettingname: path.childsettingname
          settingname: path.settingname
          flowname: path.flowname
      - text: Remove nested setting {settingname}/{childsettingname} from flow {flowname}.
        slots:
          settingname: path.settingname
          childsettingname: path.childsettingname
          flowname: path.flowname
      method: generated
      generated: '2026-10-01'