Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Home Page Layout API

8 actions 8 updates phrasing extends openapi/harness-homepagelayout-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/home-page-layout'].get
$.paths['/v1/home-page-layout'].post
$.paths['/v1/home-page-layout/yaml'].get
$.paths['/v1/home-page-layout/custom-card/{card-identifier}/quick-links/{quick-link-identifier}/icon'].delete
$.paths['/v1/home-page-layout/header/quick-links/{quick-link-identifier}/icon'].delete
$.paths['/v1/home-page-layout/card/{card-identifier}/icon'].delete
$.paths['/v1/home-page-layout/icon'].delete

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 Harness Home Page Layout API
  version: 1.0.0
extends: openapi/harness-homepagelayout-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/home-page-layout'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the home page layout
      effect: read
      questions:
      - What cards and quick links are on my account's home page layout?
      - Can I read the current home page configuration as JSON?
      instructions:
      - text: Show the home page layout for account {account}.
        slots:
          account: header.Harness-Account
      - text: Get my current home page layout details.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/home-page-layout'].post
  update:
    x-apievangelist-phrasing:
      intent: Save the home page layout
      effect: write
      questions:
      - How do I customize the cards on my Harness home page?
      - Can I save a new home page layout for the whole account?
      instructions:
      - text: Save home page layout {layout}.
        slots:
          layout: requestBody.home_page_layout
      - text: Replace account {account}'s home page layout with {layout}.
        slots:
          account: header.Harness-Account
          layout: requestBody.home_page_layout
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/home-page-layout/yaml'].get
  update:
    x-apievangelist-phrasing:
      intent: Export the home page layout as YAML
      effect: read
      questions:
      - Can I get the home page layout as YAML for version control?
      - Is there a YAML export of the home page configuration?
      instructions:
      - text: Export the home page layout YAML.
      - text: Get the YAML for account {account}'s home page layout.
        slots:
          account: header.Harness-Account
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/home-page-layout/custom-card/{card-identifier}/quick-links/{quick-link-identifier}/icon'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a quick link icon on a custom card
      effect: destructive
      questions:
      - Can I remove the icon from a quick link inside a custom home page card?
      - How would I clear a quick link's image on a custom link card?
      instructions:
      - text: Delete the icon of quick link {quick_link} on custom card {card}.
        slots:
          quick_link: path.quick-link-identifier
          card: path.card-identifier
      - text: Remove quick link {quick_link}'s icon from custom link card {card}.
        slots:
          quick_link: path.quick-link-identifier
          card: path.card-identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/home-page-layout/header/quick-links/{quick-link-identifier}/icon'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a header quick link icon
      effect: destructive
      questions:
      - Can I remove the icon from a quick link in the home page header?
      - What's the way to clear a header shortcut's image?
      instructions:
      - text: Delete the icon of header quick link {quick_link}.
        slots:
          quick_link: path.quick-link-identifier
      - text: Clear the image on home page header link {quick_link}.
        slots:
          quick_link: path.quick-link-identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/home-page-layout/card/{card-identifier}/icon'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a home page card icon
      effect: destructive
      questions:
      - Can I remove the icon shown on a home page card?
      - Is there a way to reset a card's image to nothing?
      instructions:
      - text: Delete the icon on home page card {card}.
        slots:
          card: path.card-identifier
      - text: Remove card {card}'s own icon.
        slots:
          card: path.card-identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/home-page-layout/icon'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete the home page layout icon
      effect: destructive
      questions:
      - Can I delete the main icon used on my home page layout?
      - How do I remove an uploaded layout icon by its URL?
      instructions:
      - text: Delete the home page layout icon at {icon_url}.
        slots:
          icon_url: requestBody.icon_url
      - text: Remove layout icon {icon_url} from account {account}.
        slots:
          icon_url: requestBody.icon_url
          account: header.Harness-Account
      method: generated
      generated: '2026-09-26'