Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Layouts V3 API

7 actions 7 updates phrasing extends openapi/harness-layoutsv3-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 7

$.info
$.paths['/v3/layout'].get
$.paths['/v3/layout'].post
$.paths['/v3/layout'].delete
$.paths['/v3/layout/{layout-identifier}'].get
$.paths['/v3/layout/health'].get
$.paths['/v3/layout/ingest'].post

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 Layouts V3 API
  version: 1.0.0
extends: openapi/harness-layoutsv3-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: 6
- target: $.paths['/v3/layout'].get
  update:
    x-apievangelist-phrasing:
      intent: List developer portal layouts
      effect: read
      questions:
      - Which page layouts are defined in my Harness developer portal?
      - Can I list all v3 layouts for my account?
      instructions:
      - text: List all portal layouts.
      - text: Show every v3 layout for account {account}.
        slots:
          account: header.Harness-Account
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/layout'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a developer portal layout
      effect: write
      questions:
      - How do I add a new page layout to the developer portal?
      - Can I define a layout's YAML and display name when creating it?
      instructions:
      - text: Create layout {name} of type {type} with YAML {yaml}.
        slots:
          name: requestBody.name
          type: requestBody.type
          yaml: requestBody.yaml
      - text: Add a portal layout called {display_name}.
        slots:
          display_name: requestBody.display_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/layout'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a developer portal layout
      effect: destructive
      questions:
      - How do I remove a layout from the developer portal?
      - Can I delete a portal layout by name?
      instructions:
      - text: Delete portal layout {name}.
        slots:
          name: requestBody.name
      - text: Remove layout with ID {layout_id}.
        slots:
          layout_id: requestBody.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/layout/{layout-identifier}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one developer portal layout
      effect: read
      questions:
      - What does a particular portal layout's YAML look like?
      - Can I fetch one layout by its identifier?
      instructions:
      - text: Get layout {layout}.
        slots:
          layout: path.layout-identifier
      - text: Show the YAML of portal layout {layout}.
        slots:
          layout: path.layout-identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/layout/health'].get
  update:
    x-apievangelist-phrasing:
      intent: Check developer portal layout health
      effect: read
      questions:
      - Are my developer portal layouts healthy?
      - Is anything wrong with the portal layout configuration?
      instructions:
      - text: Check the health of the portal layouts.
      - text: Run a layout health check for account {account}.
        slots:
          account: header.Harness-Account
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/layout/ingest'].post
  update:
    x-apievangelist-phrasing:
      intent: Ingest layout exports into the portal
      effect: write
      questions:
      - How do I bulk-load layout exports into the developer portal?
      - Can I ingest layouts with a chosen operation type?
      instructions:
      - text: Ingest layout exports {exports} with operation {operation}.
        slots:
          exports: requestBody.exports
          operation: requestBody.operation_type
      - text: 'Run a {operation} layout ingest for these exports: {exports}.'
        slots:
          operation: requestBody.operation_type
          exports: requestBody.exports
      method: generated
      generated: '2026-09-26'