Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Account Banner API

8 actions 8 updates phrasing extends openapi/harness-account-banner-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Harness's API. It is a proposal applied on top of the contract, not a document Harness publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 8

$.info

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

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

$.paths['/v1/banners/validate-unique-identifier/{bannerId}'].get

$.paths['/v1/banners/allowed'].get

$.paths['/v1/banners/{banner}'].put

$.paths['/v1/banners/{banner}'].delete

$.paths['/v1/banners/active'].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 Harness Account Banner API
  version: 1.0.0
extends: openapi/harness-account-banner-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: 7
- target: $.paths['/v1/banners'].get
  update:
    x-apievangelist-phrasing:
      intent: List account banners
      effect: read
      questions:
      - What announcement banners have been set up for our Harness account?
      - Can I list only the enabled or disabled banners?
      instructions:
      - text: List all account banners.
      - text: Search account banners for {search_term}.
        slots:
          search_term: query.search_term
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/banners'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an account banner
      effect: write
      questions:
      - How do I post a banner message to everyone in our account?
      - Can a banner include call-to-action buttons?
      instructions:
      - text: Create banner {identifier} named {name} with title {title} and message {message}, intent {intent}.
        slots:
          identifier: requestBody.identifier
          name: requestBody.name
          title: requestBody.title
          message: requestBody.message
          intent: requestBody.intent
      - text: Add a new {intent} account banner titled {title}.
        slots:
          intent: requestBody.intent
          title: requestBody.title
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/banners/validate-unique-identifier/{bannerId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a banner identifier is available
      effect: read
      questions:
      - Is a banner identifier already taken in my account?
      - Can I check a banner ID is unique before creating it?
      instructions:
      - text: Check whether banner identifier {bannerId} is available.
        slots:
          bannerId: path.bannerId
      - text: Validate that {bannerId} is unique for a new banner.
        slots:
          bannerId: path.bannerId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/banners/allowed'].get
  update:
    x-apievangelist-phrasing:
      intent: Check if more banners can be enabled
      effect: read
      questions:
      - Have we already hit the five enabled banner limit?
      - Can I enable another banner right now?
      instructions:
      - text: Check whether the account has reached its max of 5 enabled banners.
      - text: Tell me if another banner can be enabled.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/banners/{banner}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an account banner
      effect: write
      questions:
      - How do I change the message on an existing banner?
      - Can I disable a banner without deleting it?
      instructions:
      - text: Update banner {banner} to show message {message}.
        slots:
          banner: path.banner
          message: requestBody.message
      - text: Set enabled to {enabled} on banner {banner}.
        slots:
          enabled: requestBody.enabled
          banner: path.banner
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/banners/{banner}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an account banner
      effect: destructive
      questions:
      - How do I remove a banner from the account for good?
      - Can a deleted banner be brought back?
      instructions:
      - text: Delete banner {banner}.
        slots:
          banner: path.banner
      - text: Remove the {banner} banner from the account.
        slots:
          banner: path.banner
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/banners/active'].get
  update:
    x-apievangelist-phrasing:
      intent: List currently active banners
      effect: read
      questions:
      - Which banners are users seeing right now?
      - What active banners are displayed, up to the five allowed?
      instructions:
      - text: Show the currently active account banners.
      - text: List active banners matching {search_term}.
        slots:
          search_term: query.search_term
      method: generated
      generated: '2026-09-26'