# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Kibana Links API
  version: 1.0.0
extends: openapi/elk-stack-links-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: 5
- target: $.paths['/api/links'].get
  update:
    x-apievangelist-phrasing:
      intent: List links library items in Kibana
      effect: read
      questions:
      - How do I see all the saved links panels in my Kibana library?
      - Can I filter my links library by tag or exclude certain tags?
      - Which links library items mention a word in their title or description?
      instructions:
      - text: List every links library item in Kibana.
      - text: Find links library items matching {query}.
        slots:
          query: query.query
      - text: Show links library items tagged {tag_names}, {per_page} per page.
        slots:
          tag_names: query.tag_names
          per_page: query.per_page
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/links'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a links library item
      effect: write
      questions:
      - How do I save a new set of dashboard links to the Kibana library?
      - Can a new links panel be laid out vertically instead of horizontally?
      instructions:
      - text: Create a links library item called {title} with the links {links}.
        slots:
          title: requestBody.title
          links: requestBody.links
      - text: Add a new links panel {title} to the library containing {links}, using the {layout} layout.
        slots:
          title: requestBody.title
          links: requestBody.links
          layout: requestBody.layout
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/links/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a links library item by ID
      effect: read
      questions:
      - How do I look up one specific links panel from the library by its ID?
      - What links and layout does a given library item contain?
      instructions:
      - text: Get links library item {id}.
        slots:
          id: path.id
      - text: Show me the links saved in library item {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/links/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or replace a links library item by ID
      effect: write
      questions:
      - Can I upsert a links library item at an ID I choose?
      - How do I change the title or links on an existing links panel in the library?
      instructions:
      - text: Upsert links library item {id} with title {title} and links {links}.
        slots:
          id: path.id
          title: requestBody.title
          links: requestBody.links
      - text: Replace the links in existing library item {id} with {links}, keeping the title {title}.
        slots:
          id: path.id
          links: requestBody.links
          title: requestBody.title
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/links/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a links library item
      effect: destructive
      questions:
      - How do I remove a links panel from the Kibana library for good?
      - Can a deleted links library item be removed by its ID alone?
      instructions:
      - text: Delete links library item {id}.
        slots:
          id: path.id
      - text: Remove the links panel {id} from the library.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'