Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Administration Visibility Rules API

8 actions 8 updates phrasing extends openapi/conga-visibility-rules-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Conga's API. It is a proposal applied on top of the contract, not a document Conga publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 8

$.info
$.paths['/visibility-rule'].get
$.paths['/visibility-rule'].post
$.paths['/visibility-rule'].delete
$.paths['/visibility-rule'].patch
$.paths['/visibility-rule/{Id}'].get
$.paths['/visibility-rule/{Id}'].delete
$.paths['/visibility-rule/{Id}'].patch

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Administration Visibility Rules API
  version: 1.0.0
extends: openapi/conga-visibility-rules-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: 7
- target: $.paths['/visibility-rule'].get
  update:
    x-apievangelist-phrasing:
      intent: List catalog visibility rules
      effect: read
      questions:
      - Which visibility rules control what products show in my Conga catalog?
      - Can I narrow the list of visibility rules down by rule name?
      - Are inactive visibility rules included when I list them?
      instructions:
      - text: List all visibility rules matching {filter}.
        slots:
          filter: query.filter
      - text: Show {limit} visibility rules per page, page {page}, sorted by {sort}.
        slots:
          limit: query.limit
          page: query.page
          sort: query.sort
      - text: Find visibility rules where {filterExpression}.
        slots:
          filterExpression: query.filterExpression
      method: generated
      generated: '2026-10-01'
- target: $.paths['/visibility-rule'].post
  update:
    x-apievangelist-phrasing:
      intent: Create visibility rules
      effect: write
      questions:
      - How do I set up a new rule that hides certain products from the catalog?
      - Can I create several product visibility rules in one request?
      instructions:
      - text: Create these new visibility rules to control which products appear in the catalog.
      - text: Add a batch of catalog visibility rules from this payload.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/visibility-rule'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several visibility rules at once
      effect: destructive
      questions:
      - Can I remove a whole batch of visibility rules in one go?
      - Is there a bulk delete for product visibility rules?
      instructions:
      - text: Bulk-delete the visibility rules in this list.
      - text: Remove all of these catalog visibility rules together.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/visibility-rule'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update several visibility rules at once
      effect: write
      questions:
      - Can I deactivate many visibility rules with a single update?
      - Which call edits multiple product visibility rules together?
      instructions:
      - text: Apply these changes to multiple visibility rules in bulk.
      - text: Bulk-update the listed catalog visibility rules.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/visibility-rule/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one visibility rule
      effect: read
      questions:
      - What does one particular visibility rule contain?
      - Can I fetch a single visibility rule along with its related records?
      instructions:
      - text: Show visibility rule {Id}.
        slots:
          Id: path.Id
      - text: Get visibility rule {Id} including {includes}.
        slots:
          Id: path.Id
          includes: query.includes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/visibility-rule/{Id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one visibility rule
      effect: destructive
      questions:
      - How do I delete a single visibility rule by its ID?
      - If I delete one visibility rule, do the other rules stay in place?
      instructions:
      - text: Delete visibility rule {Id}.
        slots:
          Id: path.Id
      - text: Remove the single catalog visibility rule {Id}.
        slots:
          Id: path.Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/visibility-rule/{Id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update one visibility rule
      effect: write
      questions:
      - Can I edit just one visibility rule without touching the rest?
      - Is it possible to switch off a single product visibility rule?
      instructions:
      - text: Update visibility rule {Id} with these changes.
        slots:
          Id: path.Id
      - text: Edit the one visibility rule {Id}.
        slots:
          Id: path.Id
      method: generated
      generated: '2026-10-01'