Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Ingress Custom Branding API

7 actions 7 updates phrasing extends openapi/conga-custom-branding-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 7

$.info

$.paths['/v1/CustomBranding'].get

$.paths['/v1/CustomBranding'].post

$.paths['/v1/CustomBranding/{id}'].get

$.paths['/v1/CustomBranding/{id}'].delete

$.paths['/v1/CustomBranding/{id}'].patch

$.paths['/v1/CustomBranding/{id}/download'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Ingress Custom Branding API
  version: 1.0.0
extends: openapi/conga-custom-branding-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['/v1/CustomBranding'].get
  update:
    x-apievangelist-phrasing:
      intent: List uploaded custom branding logos
      effect: read
      questions:
      - Which custom branding logos have we uploaded?
      - Can I search uploaded brandings by custom name and page through them?
      instructions:
      - text: List all uploaded custom branding logos.
      - text: Find custom brandings named {customName}, page {pageNumber} with {pageSize} per page.
        slots:
          customName: query.customName
          pageNumber: query.pageNumber
          pageSize: query.pageSize
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/CustomBranding'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a new branding logo
      effect: write
      questions:
      - How do I upload our company logo for document branding?
      - Can I give an uploaded logo a custom name?
      instructions:
      - text: Upload logo file {file} as custom branding named {customName}.
        slots:
          file: requestBody.file
          customName: requestBody.CustomName
      - text: Add a new branding logo called {customName}.
        slots:
          customName: requestBody.CustomName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/CustomBranding/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of a branding logo
      effect: read
      questions:
      - What are the details of a specific uploaded logo?
      - Can I look up one custom branding entry by ID?
      instructions:
      - text: Get the details of custom branding {id}.
        slots:
          id: path.id
      - text: Show logo record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/CustomBranding/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a branding logo
      effect: destructive
      questions:
      - Can I delete an old logo we no longer brand documents with?
      - Is removing a custom branding entry permanent?
      instructions:
      - text: Delete custom branding {id}.
        slots:
          id: path.id
      - text: Remove the uploaded logo {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/CustomBranding/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Replace a logo image or rename it
      effect: write
      questions:
      - Can I swap the image on an existing branding logo without re-creating it?
      - Is it possible to just rename a custom branding entry?
      instructions:
      - text: Rename custom branding {id} to {customName}.
        slots:
          id: path.id
          customName: requestBody.CustomName
      - text: Replace the logo image on branding {id} with {logo}.
        slots:
          id: path.id
          logo: requestBody.Logo
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/CustomBranding/{id}/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a branding logo file
      effect: read
      questions:
      - How do I download the actual image file of an uploaded logo?
      - Can I get the original logo file back from custom branding?
      instructions:
      - text: Download the logo file for custom branding {id}.
        slots:
          id: path.id
      - text: Save a copy of logo image {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'